← Back to branch summary

~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/fr/graphics/param3d.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
http://bugs.debian.org/255869
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/fr/graphics/param3d.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
 
 
6
  <TITLE>param3d</TITLE>
 
7
 
 
8
  <TYPE>Scilab Function</TYPE>
 
9
 
 
10
  <DATE>April 1993</DATE>
 
11
 
 
12
  <SHORT_DESCRIPTION name="param3d">3D plot of a parametric
 
13
  curve</SHORT_DESCRIPTION>
 
14
 
 
15
  <CALLING_SEQUENCE>
 
16
    <CALLING_SEQUENCE_ITEM>param3d(x,y,z,[theta,alpha,leg,flag,ebox])</CALLING_SEQUENCE_ITEM>
 
17
  </CALLING_SEQUENCE>
 
18
 
 
19
  <PARAM>
 
20
    <PARAM_INDENT>
 
21
      <PARAM_ITEM>
 
22
        <PARAM_NAME>x,y,z</PARAM_NAME>
 
23
 
 
24
        <PARAM_DESCRIPTION>
 
25
          <SP>: three vectors of the same size (points of the parametric
 
26
          curve).</SP>
 
27
        </PARAM_DESCRIPTION>
 
28
      </PARAM_ITEM>
 
29
 
 
30
      <PARAM_ITEM>
 
31
        <PARAM_NAME>theta, alpha</PARAM_NAME>
 
32
 
 
33
        <PARAM_DESCRIPTION>
 
34
          <SP>: real values giving in degree the spherical coordinates of the
 
35
          observation point.</SP>
 
36
        </PARAM_DESCRIPTION>
 
37
      </PARAM_ITEM>
 
38
 
 
39
      <PARAM_ITEM>
 
40
        <PARAM_NAME>leg</PARAM_NAME>
 
41
 
 
42
        <PARAM_DESCRIPTION>
 
43
          <SP>: string defining the labels for each axis with @ as a field
 
44
          separator, for example "X@Y@Z".</SP>
 
45
        </PARAM_DESCRIPTION>
 
46
      </PARAM_ITEM>
 
47
 
 
48
      <PARAM_ITEM>
 
49
        <PARAM_NAME>flag=[type,box]</PARAM_NAME>
 
50
 
 
51
        <PARAM_DESCRIPTION>
 
52
          <SP>: <VERB>type</VERB> and <VERB>box</VERB> have the same meaning
 
53
          as in <VERB>plot3d</VERB>:</SP>
 
54
 
 
55
          <PARAM_INDENT>
 
56
            <PARAM_ITEM>
 
57
              <PARAM_NAME>type</PARAM_NAME>
 
58
 
 
59
              <PARAM_DESCRIPTION>
 
60
                <SP>: an integer (scaling).</SP>
 
61
 
 
62
                <PARAM_INDENT>
 
63
                  <PARAM_ITEM>
 
64
                    <PARAM_NAME>type=0</PARAM_NAME>
 
65
 
 
66
                    <PARAM_DESCRIPTION>
 
67
                      <SP>the plot is made using the current 3D scaling (set
 
68
                      by a previous call to <VERB>param3d</VERB>,
 
69
                      <VERB>plot3d</VERB>, <VERB>contour</VERB> or
 
70
                      <VERB>plot3d1</VERB>).</SP>
 
71
                    </PARAM_DESCRIPTION>
 
72
                  </PARAM_ITEM>
 
73
 
 
74
                  <PARAM_ITEM>
 
75
                    <PARAM_NAME>type=1</PARAM_NAME>
 
76
 
 
77
                    <PARAM_DESCRIPTION>
 
78
                      <SP>rescales automatically 3d boxes with extreme aspect
 
79
                      ratios, the boundaries are specified by the value of the
 
80
                      optional argument <VERB>ebox</VERB>.</SP>
 
81
                    </PARAM_DESCRIPTION>
 
82
                  </PARAM_ITEM>
 
83
 
 
84
                  <PARAM_ITEM>
 
85
                    <PARAM_NAME>type=2</PARAM_NAME>
 
86
 
 
87
                    <PARAM_DESCRIPTION>
 
88
                      <SP>rescales automatically 3d boxes with extreme aspect
 
89
                      ratios, the boundaries are computed using the given
 
90
                      data.</SP>
 
91
                    </PARAM_DESCRIPTION>
 
92
                  </PARAM_ITEM>
 
93
 
 
94
                  <PARAM_ITEM>
 
95
                    <PARAM_NAME>type=3</PARAM_NAME>
 
96
 
 
97
                    <PARAM_DESCRIPTION>
 
98
                      <SP>3d isometric with box bounds given by optional
 
99
                      <VERB>ebox</VERB>, similarily to
 
100
                      <VERB>type=1</VERB>.</SP>
 
101
                    </PARAM_DESCRIPTION>
 
102
                  </PARAM_ITEM>
 
103
 
 
104
                  <PARAM_ITEM>
 
105
                    <PARAM_NAME>type=4</PARAM_NAME>
 
106
 
 
107
                    <PARAM_DESCRIPTION>
 
108
                      <SP>3d isometric bounds derived from the data, to
 
109
                      similarily<VERB>type=2</VERB>.</SP>
 
110
                    </PARAM_DESCRIPTION>
 
111
                  </PARAM_ITEM>
 
112
 
 
113
                  <PARAM_ITEM>
 
114
                    <PARAM_NAME>type=5</PARAM_NAME>
 
115
 
 
116
                    <PARAM_DESCRIPTION>
 
117
                      <SP>3d expanded isometric bounds with box bounds given
 
118
                      by optional <VERB>ebox</VERB>, similarily to
 
119
                      <VERB>type=1</VERB>.</SP>
 
120
                    </PARAM_DESCRIPTION>
 
121
                  </PARAM_ITEM>
 
122
 
 
123
                  <PARAM_ITEM>
 
124
                    <PARAM_NAME>type=6</PARAM_NAME>
 
125
 
 
126
                    <PARAM_DESCRIPTION>
 
127
                      <SP>3d expanded isometric bounds derived from the data,
 
128
                      similarily to <VERB>type=2</VERB>.Note that axes
 
129
                      boundaries can be customized through the axes entity
 
130
                      properties (see <LINK>axes_properties</LINK>).</SP>
 
131
                    </PARAM_DESCRIPTION>
 
132
                  </PARAM_ITEM>
 
133
                </PARAM_INDENT>
 
134
              </PARAM_DESCRIPTION>
 
135
            </PARAM_ITEM>
 
136
 
 
137
            <PARAM_ITEM>
 
138
              <PARAM_NAME>box</PARAM_NAME>
 
139
 
 
140
              <PARAM_DESCRIPTION>
 
141
                <SP>: an integer (frame around the plot).</SP>
 
142
 
 
143
                <PARAM_INDENT>
 
144
                  <PARAM_ITEM>
 
145
                    <PARAM_NAME>box=0</PARAM_NAME>
 
146
 
 
147
                    <PARAM_DESCRIPTION>
 
148
                      <SP>nothing is drawn around the plot.</SP>
 
149
                    </PARAM_DESCRIPTION>
 
150
                  </PARAM_ITEM>
 
151
 
 
152
                  <PARAM_ITEM>
 
153
                    <PARAM_NAME>box=1</PARAM_NAME>
 
154
 
 
155
                    <PARAM_DESCRIPTION>
 
156
                      <SP>unimplemented (like box=0).</SP>
 
157
                    </PARAM_DESCRIPTION>
 
158
                  </PARAM_ITEM>
 
159
 
 
160
                  <PARAM_ITEM>
 
161
                    <PARAM_NAME>box=2</PARAM_NAME>
 
162
 
 
163
                    <PARAM_DESCRIPTION>
 
164
                      <SP>only the axes behind the surface are drawn.</SP>
 
165
                    </PARAM_DESCRIPTION>
 
166
                  </PARAM_ITEM>
 
167
 
 
168
                  <PARAM_ITEM>
 
169
                    <PARAM_NAME>box=3</PARAM_NAME>
 
170
 
 
171
                    <PARAM_DESCRIPTION>
 
172
                      <SP>a box surrounding the surface is drawn and captions
 
173
                      are added.</SP>
 
174
                    </PARAM_DESCRIPTION>
 
175
                  </PARAM_ITEM>
 
176
 
 
177
                  <PARAM_ITEM>
 
178
                    <PARAM_NAME>box=4</PARAM_NAME>
 
179
 
 
180
                    <PARAM_DESCRIPTION>
 
181
                      <SP>a box surrounding the surface is drawn, captions and
 
182
                      axes are added.Note that axes aspect can also be
 
183
                      customized through the axes entity properties (see
 
184
                      <LINK>axes_properties</LINK>).</SP>
 
185
                    </PARAM_DESCRIPTION>
 
186
                  </PARAM_ITEM>
 
187
                </PARAM_INDENT>
 
188
              </PARAM_DESCRIPTION>
 
189
            </PARAM_ITEM>
 
190
          </PARAM_INDENT>
 
191
        </PARAM_DESCRIPTION>
 
192
      </PARAM_ITEM>
 
193
 
 
194
      <PARAM_ITEM>
 
195
        <PARAM_NAME>ebox</PARAM_NAME>
 
196
 
 
197
        <PARAM_DESCRIPTION>
 
198
          <SP>: It specifies the boundaries of the plot as the vector
 
199
          <VERB>[xmin,xmax,ymin,ymax,zmin,zmax]</VERB>. This argument is used
 
200
          together with <VERB>type</VERB> in <VERB>flag</VERB> : if it is set
 
201
          to <VERB>1</VERB>, <VERB>3</VERB> or <VERB>5</VERB> (see above to
 
202
          see the corresponding behaviour). If <VERB>flag</VERB> is missing,
 
203
          <VERB>ebox</VERB> is not taken into acoount. Note that, when
 
204
          specified, the <VERB>ebox</VERB> argument acts on the
 
205
          <VERB>data_bounds</VERB> field that can also be reset through the
 
206
          axes entity properties (see <LINK>axes_properties</LINK>).</SP>
 
207
        </PARAM_DESCRIPTION>
 
208
      </PARAM_ITEM>
 
209
    </PARAM_INDENT>
 
210
  </PARAM>
 
211
 
 
212
  <DESCRIPTION>
 
213
    <P><VERB>param3d</VERB> is used to plot a 3D curve defined by its
 
214
    coordinates <VERB>x</VERB>, <VERB>y</VERB> and <VERB>z</VERB>. Note that
 
215
    data can also be set or get through the surface entity properties (see
 
216
    <LINK>surface_properties</LINK>).</P>
 
217
 
 
218
    <P>Note that properties like <VERB>rotation angles</VERB>,
 
219
    <VERB>colors</VERB> and <VERB>thickness</VERB> of the plotted curves can
 
220
    also be set through the param3d entity properties (see
 
221
    <LINK>param3d_properties</LINK>).</P>
 
222
 
 
223
    <P>Use <VERB>param3d1</VERB> to do multiple plots.</P>
 
224
 
 
225
    <P>Enter the command <VERB>param3d()</VERB> to see a demo.</P>
 
226
  </DESCRIPTION>
 
227
 
 
228
  <EXAMPLE><![CDATA[
 
229
 
 
230
t=0:0.1:5*%pi;
 
231
param3d(sin(t),cos(t),t/10,35,45,"X@Y@Z",[2,3])
 
232
 
 
233
  ]]></EXAMPLE>
 
234
 
 
235
  <SEE_ALSO>
 
236
    <SEE_ALSO_ITEM>
 
237
      <LINK>param3d1</LINK>
 
238
    </SEE_ALSO_ITEM>
 
239
 
 
240
    <SEE_ALSO_ITEM>
 
241
      <LINK>plot3d</LINK>
 
242
    </SEE_ALSO_ITEM>
 
243
  </SEE_ALSO>
 
244
 
 
245
  <AUTHOR>J.Ph.C.</AUTHOR>
 
246
</MAN>
 
 
b'\\ No newline at end of file'