source: vtkvis/branches/1.7/protocol.txt @ 4777

Last change on this file since 4777 was 4777, checked in by ldelgass, 8 years ago

update protocol doc

  • Property svn:eol-style set to native
File size: 44.3 KB
Line 
1================================================================================
2================================================================================
3Protocol for vtkvis render server. 
4
5Commands take the general form of command and arguments using Tcl syntax and are
6terminated by a newline.  Some command arguments expect a Tcl list which can be
7sent by enclosing the list in curly braces to prevent the interpreter from
8splitting the list into multiple arguments.  Likewise, strings with spaces
9should be quoted or enclosed in curly braces.  In the documentation below,
10arguments are indicated by angle brackets and optional arguments are surrounded
11by question marks -- the brackets and question marks are not part of the
12protocol and should not be included in argument strings.  The arguments shown
13in angle brackets should be replaced with a string (where there are fixed
14choices this document indicates valid values by separating them with pipe
15symbols), a list in Tcl syntax, or a numeric value.  Boolean arguments can take
16the form of 0|1, true|false, or yes|no.  Since the protocol commands are
17executed in a Tcl interpreter, Tcl code such as math expressions in expr
18commands enclosed in square brackets are also allowed.  Since the interpreter
19is a "safe" interpreter, some Tcl commands that could cause security issues may
20not be available for use.
21
22When binary data is to be sent, it should follow the newline after a command
23that indicates incoming data including a byte count argument.
24================================================================================
25================================================================================
26Requests:
27================================================================================
28
29== General dataset, scene and renderer commands ==
30
31axis autobounds <axis> <bool>
32     Toggle between automatic and explicit bounds settings.  To set an explicit
33     range use the 'axis bounds...' command.
34     <axis> = x|y|z|all
35axis autorange <axis> <bool>
36     Toggle between automatic and explicit range settings.  To set an explicit
37     range use the 'axis range...' command.  For scaling based on axis bounds,
38     see 'axis scale...'
39     <axis> = x|y|z|all
40axis bounds <axis> <min> <max>
41     Explicitly specify bounds to use for an axis.
42     <axis> = x|y|z|all
43axis color <axis> <r> <g> <b> <?opacity?>
44     Set color of axis lines, labels, titles, ticks
45     <axis> = x|y|z|all
46axis exp <xPower> <yPower> <zPower> <?useCustom?>
47     Control power scaling of labels.  When an exponent is set, the labels
48     are adjusted to show mantissa and the exponent is indicated in the title.
49     <xPower> = Base 10 exponent for X axis
50     <yPower> = Base 10 exponent for Y axis
51     <zPower> = Base 10 exponent for Z axis
52     <useCustom> = Flag to control if custom/manual powers are used.  Setting
53     this to off will re-enable automatic power scaling.
54axis flymode <mode>
55     <mode> = static_edges|static_triad|outer_edges|furthest_triad|closest_triad
56axis fontsz <fontPixelSize>
57     Controls size of labels and text in 3D mode
58axis gpcolor <axis> <r> <g> <b> <?opacity?>
59     Set color/opacity of inner grid polygons
60     <axis> = x|y|z|all
61axis gpolys <axis> <bool>
62     Turn on/off inner grid polygons/planes
63     <axis> = x|y|z|all
64axis grcolor <axis> <r> <g> <b> <?opacity?>
65     Set color/opacity of gridlines
66     <axis> = x|y|z|all
67axis grid <axis> <bool>
68     Turn on/off outer gridlines
69     <axis> = x|y|z|all
70axis igcolor <axis> <r> <g> <b> <?opacity?>
71     Set color/opacity of inner gridlines
72     <axis> = x|y|z|all
73axis igrid <axis> <bool>
74     Turn on/off inner gridlines
75     <axis> = x|y|z|all
76axis labels <axis> <bool>
77     Toggle visibility of axis labels
78     <axis> = x|y|z|all
79axis lcolor <axis> <r> <g> <b> <?opacity?>
80     Set color/opacity of tick labels
81     <axis> = x|y|z|all
82axis lfont <axis> <fontName>
83     Set label font family
84     <axis> = x|y|z|all
85     <fontName> = Arial|Courier|Times
86axis lformat <axis> <formatString>
87     <axis> = x|y|z|all
88     <formatString> = printf style format string
89axis lfsize <axis> <fontSizePts>
90     Set font size of labels in 2D mode - currently relies on patched VTK in
91     runtime
92     <axis> = x|y|z|all
93     <fontSizePts> = Font size in points
94axis linecolor <axis> <r> <g> <b> <?opacity?>
95     Set color/opacity of main axis lines
96     <axis> = x|y|z|all
97axis lrot <axis> <rotation>
98     <axis> = x|y|z|all
99     <rotation> = rotation angle in degrees
100axis lscale <axis> <boolAuto> <xpow> <ypow> <zpow>
101     Control (auto-)scaling of labels with powers of 10
102     <axis> = x|y|z|all
103     <boolAuto> = Enable/disable automatic scaling with powers of 10
104     <xpow> = Explicitly set power on X axis
105     <ypow> = Explicitly set power on Y axis
106     <zpow> = Explicitly set power on Z axis
107axis minticks <axis> <bool>
108     Toggle visibility of axis minor tick marks
109     <axis> = x|y|z|all
110axis name <axis> <title>
111     <axis> = x|y|z|all
112     <title> = Title of axis
113axis origin <x> <y> <z> <?useCustom?>
114     <x>,<y>,<z> = point inside world coordinate bounds of axes box where axes
115     should intersect
116     <useCustom> = Set to false to disable use of custom origin and re-enable
117     automatic origin
118axis range <axis> <min> <max>
119     Explicitly set min,max range of axis labels.  Note that the min and max
120     values themselves may not be given labels if they don't fall on tick
121     divisions -- the min/max determine the value of the axis endpoints.  This
122     setting allows labeling axes independently of the world coordinate bounds.
123     <axis> = x|y|z|all
124     <min> = minimum value of axis for labels
125     <max> = maximum value of axis for labels
126axis scale <axis> <scale>
127     Set axis range to be computed based on scaling the axis bounds by the given
128     scale factor.
129     <axis> = x|y|z|all
130     <scale> = scale factor where range = bounds * scale
131axis tcolor <axis> <r> <g> <b> <?opacity?>
132     Set color/opacity of axis title
133     <axis> = x|y|z|all
134axis tickpos <position>
135     Set position of ticks on 3D axes (not implemented for 2D axes)
136     <position> = inside|outside|both
137axis ticks <axis> <bool>
138     Toggle visibility of axis tick marks
139     <axis> = x|y|z|all
140axis tfont <axis> <fontName>
141     Set title font family
142     <axis> = x|y|z|all
143     <fontName> = Arial|Courier|Times
144axis tfsize <axis> <fontSizePts>
145     Set font size of title in 2D mode - currently relies on patched VTK in
146     runtime
147     <axis> = x|y|z|all
148     <fontSizePts> = Font size in points
149axis trot <axis> <rotation>
150     Currently a no-op -- needs a fix in vtkCubeAxesActor
151     <axis> = x|y|z|all
152     <rotation> = rotation angle in degrees
153axis units <axis> <units>
154     Currently only supported when camera mode is not image mode
155axis visible <axis> <bool>
156     <axis> = x|y|z|all
157     Note: 'all' means all enabled axes.  To force all axes on, set each axis on
158     individually -- however, it is best to let the server determine which of
159     the individual axes are enabled based on the dataset bounds.
160
161camera aspect <aspectMode>
162       Set 2D aspect ratio mode
163       <aspectMode> = native|square|window
164camera get
165       Request current camera parameters
166camera mode <mode>
167       <mode> = persp|ortho|image
168camera orient <quatW> <quatX> <quatY> <quatZ>
169       Set scene orientation using a quaternion
170camera ortho <coordMode> <x> <y> <width> <height>
171       <coordMode> = pixel|world
172       Supply bounds of plot area for image camera mode
173camera pan <x> <y>
174       <x,y> viewport coordinates (window center at 0,0).  Positive x pan
175       means pan object to right (camera to left).  Positive y pan means
176       pan object down (camera up).  For example a pan of 0.5, 0.5 would
177       move the object center to the lower right corner of the window
178camera reset <?all?>
179       Option all resets orientation/rotation as well as pan/zoom/clip range
180camera rotate <yaw> <pitch> <roll>
181       Specify relative rotation in Euler angles
182camera set <posX> <posY> <posZ> <focalPtX> <focalPtY> <focalPtZ> <viewUpX> <viewUpY> <viewUpZ>
183       Set camera parameters: camera position, focal point and view up vector
184camera zoom <z>
185       Specify zoom ratio.  z > 1 is a zoom in, z < 1 is zoom out. z = 1
186       resets to default.
187
188clientinfo <list>
189
190colormap add <colorMapName> <colorMap> <opacityMap>
191         (Re-)define a colormap.  If colorMapName doesn't exist, it is created,
192         otherwise the colormap is redefined and all users will be updated.
193         colorMap = Tcl list of {value r g b} control points
194         opacityMap = Tcl list of {value alpha} control points
195colormap define <colorMapName> <colorMap> <opacityMap>
196         (Re-)define a colormap (same as 'add')
197colormap delete <?colorMapName?>
198colormap res <numberOfTableEntries>
199         Set the "resolution" or number of lookup table entries in the colormap
200         <numberOfTableEntries> = integer or "default"
201
202dataset add <datasetName> data follows <nbytes>
203dataset delete <?datasetName?>
204dataset getscalar world <x> <y> <z> <datasetName>
205dataset getscalar pixel <x> <y> <datasetName>
206dataset getvector world <x> <y> <z> <datasetName>
207dataset getvector pixel <x> <y> <datasetName>
208        Use pixel for image camera mode
209dataset maprange <val> <?min?> <?max?> <?fieldName?> <?fieldType?> <?numComp?> <?component?>
210        Controls if data range for colormapping and contours is based on
211        cumulative range of all datasets ("all"), only visible datasets
212        ("visible") or each individual dataset ("separate").  Defaults to
213        "all"
214        <val> = all|explicit|visible|separate
215        The following arguments are only used for 'explicit' mode:
216        <min>,<max> = Required in explicit mode, specify the range to use
217        <fieldName> = Required in explicit mode, specify the field to which the
218        range should be applied
219        <fieldType> = point_data|cell_data|field_data, optional (defaults to
220        point_data)
221        <numComp> = Number of components (1 = scalar, 3 = vector), optional (1
222        is default)
223        <component> = Component index for vector fields, required if numComp is
224        3, otherwise unused.
225dataset names
226        Returns a list of the loaded data sets
227dataset opacity <val> <?datasetName?>
228dataset scalar <scalarName> <?datasetName?>
229        Set the active scalar field to plot
230dataset vector <vectorName> <?datasetName?>
231        Set the active vector field to plot
232dataset visible <bool> <?datasetName?>
233
234legend <colormapName> <legendType> <fieldName> <legendTitle> <width> <height> <numLabels> <?datasetName?>
235       Causes legend to be rendered and written back with labels and title
236       (title may be left blank)
237       <legendType> = scalar|vmag|vx|vy|vz
238       <numLabels> Can be zero or more 'tick' value labels
239       If datasetName is omitted, the cumulative data range of all data sets
240       will be used to label the legend -- otherwise, the current setting of
241       'dataset maprange' will be used to determine if the individual dataset
242       range or cumulative range will be used.
243
244legend2 <colormapName> <width> <height>
245        Simple legend command for rendering legend without labels or title
246
247renderer clipplane <axis> <ratio> <direction>
248         Set a user clipping plane, ratio is [0,1] and is always interpreted as
249         0 = min_bound, 1 = max_bound, regardless of direction.  Sign of
250         direction determines normal of clipping plane.  User clip planes do not
251         apply if camera mode is image.
252renderer depthpeel <bool> <?occlusionRatio?> <?maxPeels?>
253         Set use of depth peeling algorithm for transparency
254         <occlusionRatio> = [0,0.5] Value of 0 means exact rendering, higher
255         values can speed rendering at the cost of some quality.  From VTK docs:
256         "the threshold under which the algorithm stops to iterate over peel
257         layers. This is the ratio of the number of pixels that have been
258         touched by the last layer over the total number of pixels of the
259         viewport area."
260         <maxPeels> = 0 means unlimited passes, positive value limits the number
261         of rendering passes
262renderer light2side <bool>
263         Toggle use of two-sided lighting (controls if backfaces are lit with a
264         flipped normal)
265renderer lights <lightNum> <bool>
266         Toggle lights on/off.  Light 0 is the headlight, light 1 the skylight
267renderer render
268         Force a new image to be rendered - use for advancing animation
269
270screen bgcolor <r> <g> <b>
271screen size <width> <height>
272
273== Graphics objects ==
274
275arc add <centerX> <centerY> <centerZ> <startX> <startY> <startZ> <normX> <normY> <normZ> <angle> <name>
276    Creates a circular arc given a center and starting point, a normal and a
277    sweep angle.
278arc color <r> <g> <b> <?name?>
279arc delete <?name?>
280arc linecolor <r> <g> <b> <?name?>
281arc linewidth <val> <?name?>
282arc opacity <val> <?name?>
283arc orient <qw> <qx> <qy> <qz> <?name?>
284arc origin <x> <y> <z> <?name?>
285arc pos <x> <y> <z> <?name?>
286arc resolution <res> <?name?>
287arc scale <sx> <sy> <sz> <?name?>
288arc visible <bool> <?name?>
289
290arrow add <tipRadius> <shaftRadius> <tipLength> <name>
291      Arrow will have base at 0,0,0 and tip at 1, 0, 0
292arrow color <r> <g> <b> <?name?>
293arrow culling <bool> <?name?>
294arrow delete <?name?>
295arrow edges <bool> <?name?>
296arrow flipnorms <bool> <?name?>
297arrow lighting <bool> <?name?>
298arrow linecolor <r> <g> <b> <?name?>
299arrow linewidth <val> <?name?>
300arrow material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
301arrow opacity <val> <?name?>
302arrow orient <qw> <qx> <qy> <qz> <?name?>
303arrow origin <x> <y> <z> <?name?>
304arrow pos <x> <y> <z> <?name?>
305arrow resolution <tipRes> <shaftRes> <?name?>
306arrow scale <sx> <sy> <sz> <?name?>
307arrow shading <val> <?name?>
308      val = flat|smooth
309arrow visible <bool> <?name?>
310arrow wireframe <bool> <?name?>
311
312box add <xLen> <yLen> <zLen> <name>
313box color <r> <g> <b> <?name?>
314box culling <bool> <?name?>
315box delete <?name?>
316box edges <bool> <?name?>
317box flipnorms <bool> <?name?>
318box lighting <bool> <?name?>
319box linecolor <r> <g> <b> <?name?>
320box linewidth <val> <?name?>
321box material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
322box opacity <val> <?name?>
323box orient <qw> <qx> <qy> <qz> <?name?>
324box origin <x> <y> <z> <?name?>
325box pos <x> <y> <z> <?name?>
326box scale <sx> <sy> <sz> <?name?>
327box shading <val> <?name?>
328    val = flat|smooth
329box visible <bool> <?name?>
330box wireframe <bool> <?name?>
331
332cone add <radius> <height> <cap> <name>
333     <cap> = boolean flag for cap disks
334cone color <r> <g> <b> <?name?>
335cone culling <bool> <?name?>
336cone delete <?name?>
337cone edges <bool> <?name?>
338cone flipnorms <bool> <?name?>
339cone lighting <bool> <?name?>
340cone linecolor <r> <g> <b> <?name?>
341cone linewidth <val> <?name?>
342cone material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
343cone opacity <val> <?name?>
344cone orient <qw> <qx> <qy> <qz> <?name?>
345cone origin <x> <y> <z> <?name?>
346cone pos <x> <y> <z> <?name?>
347cone resolution <res> <?name?>
348cone scale <sx> <sy> <sz> <?name?>
349cone shading <val> <?name?>
350     val = flat|smooth
351cone visible <bool> <?name?>
352cone wireframe <bool> <?name?>
353
354contour2d add numcontours <n> <?datasetName?>
355          Generate evenly spaced contours including range endpoints.  See also
356          'dataset maprange' command.
357contour2d add contourlist <list> <?datasetName?>
358          list = {isoval1 isoval2 isoval3...}
359contour2d color <r> <g> <b> <?datasetName?>
360          synonym for linecolor
361contour2d colormap <colormapName> <?datasetName?>
362contour2d colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
363          Set the field used to color the object.  'constant' means to use
364          the constant color defined by the color subcommand.  'scalar' uses
365          the active scalar field.  'vmag' uses the magnitude of the current
366          vector field, and 'vx','vy','vz' use the corresponding component of
367          the active vector field.
368contour2d contourlist <list> <?dataSetName?>
369contour2d delete <?datasetName?>
370contour2d lighting <bool> <?datasetName?>
371contour2d linecolor <r> <g> <b> <?datasetName?>
372          synonym for color
373contour2d linewidth <val> <?datasetName?>
374contour2d numcontours <n> <?dataSetName?>
375contour2d opacity <val> <?datasetName?>
376contour2d orient <qw> <qx> <qy> <qz> <?dataSetName?>
377contour2d pos <x> <y> <z> <?dataSetName?>
378contour2d scale <sx> <sy> <sz> <?dataSetName?>
379contour2d visible <bool> <?datasetName?>
380
381contour3d add numcontours <n> <?datasetName?>
382          Generate evenly spaced contours including range endpoints.  See also
383          'dataset maprange' command.
384contour3d add contourlist <list> <?datasetName?>
385          list = {isoval1 isoval2 isoval3...}
386contour3d color r g b <?datasetName?>
387contour3d colormap <colorMapName> <?dataSetName?>
388contour3d colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
389          Set the field used to color the object.  'constant' means to use
390          the constant color defined by the color subcommand.  'scalar' uses
391          the active scalar field.  'vmag' uses the magnitude of the current
392          vector field, and 'vx','vy','vz' use the corresponding component of
393          the active vector field.
394contour3d contourlist <list> <?dataSetName?>
395contour3d delete <?datasetName?>
396contour3d edges <bool> <?datasetName?>
397contour3d lighting <bool> <?datasetName?>
398contour3d linecolor <r> <g> <b> <?datasetName?>
399contour3d linewidth <val> <?datasetName?>
400contour3d numcontours <n> <?dataSetName?>
401contour3d opacity <val> <?datasetName?>
402contour3d orient <qw> <qx> <qy> <qz> <?dataSetName?>
403contour3d pos <x> <y> <z> <?dataSetName?>
404contour3d scale <sx> <sy> <sz> <?dataSetName?>
405contour3d visible <bool> <?datasetName?>
406contour3d wireframe <bool> <?datasetName?>
407
408cutplane add <?dataSetName?>
409cutplane axis <axis> <bool> <?dataSetName?>
410         Toggle visibility of the 3 principal axis cutplanes
411cutplane cloudstyle <style> <?datasetName?>
412         <style> = mesh | splat
413cutplane color r g b <?datasetName?>
414         Set color of outline bounding box
415cutplane colormap <colorMapName> <?dataSetName?>
416cutplane colormode <scalar|vmag|vx|vy|vz> <fieldName> <?datasetName?>
417         Set the field used to color the object.  'scalar' uses
418         the active scalar field.  'vmag' uses the magnitude of the current
419         vector field, and 'vx','vy','vz' use the corresponding component of
420         the active vector field.
421cutplane delete <?dataSetName?>
422cutplane edges <bool> <?dataSetName?>
423cutplane lighting <bool> <?dataSetName?>
424cutplane linecolor <r> <g> <b> <?dataSetName?>
425cutplane linewidth <width> <?dataSetName?>
426cutplane opacity <value> <?dataSetName?>
427cutplane orient <qw> <qx> <qy> <qz> <?dataSetName?>
428cutplane outline <bool> <?dataSetName?>
429         Toggle rendering of cutplane outlines
430cutplane pos <x> <y> <z> <?dataSetName?>
431cutplane preinterp <bool> <?dataSetName?>
432         Controls if VTK's InterpolateScalarsBeforeMapping option is set.
433         Setting this on will give more correct colors, as the interpolation
434         is done on texture coordinates that lookup into a 1D texture instead
435         of using color interpolation from triangle vertices.
436cutplane scale <sx> <sy> <sz> <?dataSetName?>
437cutplane slice axis ratio <?dataSetName?>
438         For 3D data, select a slice along a principle axis of the volume. The
439         ratio is [0,1]
440cutplane visible <bool> <?dataSetName?>
441cutplane wireframe <bool> <?datasetName?>
442
443cylinder add <radius> <height> <cap> <name>
444         <cap> = boolean flag for cap disks
445cylinder color <r> <g> <b> <?name?>
446cylinder culling <bool> <?name?>
447cylinder delete <?name?>
448cylinder edges <bool> <?name?>
449cylinder flipnorms <bool> <?name?>
450cylinder lighting <bool> <?name?>
451cylinder linecolor <r> <g> <b> <?name?>
452cylinder linewidth <val> <?name?>
453cylinder material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
454cylinder opacity <val> <?name?>
455cylinder orient <qw> <qx> <qy> <qz> <?name?>
456cylinder origin <x> <y> <z> <?name?>
457cylinder pos <x> <y> <z> <?name?>
458cylinder resolution <res> <?name?>
459cylinder scale <sx> <sy> <sz> <?name?>
460cylinder shading <val> <?name?>
461         val = flat|smooth
462cylinder visible <bool> <?name?>
463cylinder wireframe <bool> <?name?>
464
465disk add <innerRadius> <outerRadius> <name>
466disk color <r> <g> <b> <?name?>
467disk culling <bool> <?name?>
468disk delete <?name?>
469disk edges <bool> <?name?>
470disk flipnorms <bool> <?name?>
471disk lighting <bool> <?name?>
472disk linecolor <r> <g> <b> <?name?>
473disk linewidth <val> <?name?>
474disk material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
475disk opacity <val> <?name?>
476disk orient <qw> <qx> <qy> <qz> <?name?>
477disk origin <x> <y> <z> <?name?>
478disk pos <x> <y> <z> <?name?>
479disk resolution <resRadial> <resCircum> <?name?>
480disk scale <sx> <sy> <sz> <?name?>
481disk shading <val> <?name?>
482     val = flat|smooth
483disk visible <bool> <?name?>
484disk wireframe <bool> <?name?>
485
486glyphs add <shape> <?dataSetName?>
487       See 'glyphs shape' for list of shapes
488glyphs color r g b <?datasetName?>
489glyphs colormap <colorMapName> <?dataSetName?>
490glyphs colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?dataSetName?>
491       Set the color mode: color by scalar field or
492       vector magnitude -- uses the current color map,
493       or color for constant color
494glyphs delete <?dataSetName?>
495glyphs edges <bool> <?datasetName?>
496glyphs gorient <bool> <fieldName> <?datasetName?>
497       Set the glyph orientation mode: orient glyphs by
498       a named vector field, or set to default orientation (off)
499glyphs gscale <scaleFactor> <?datasetName?>
500       Set glyph scaling factor
501glyphs lighting <bool> <?datasetName?>
502glyphs linecolor <r> <g> <b> <?datasetName?>
503glyphs linewidth <val> <?datasetName?>
504glyphs normscale <bool> <?datasetName?>
505       Control if data values are normalized to [0,1] range before applying
506       glyph scaling factor (gscale)
507glyphs numglyphs <max> <random> <offset> <ratio> <?dataSetName?>
508       Limit the maximum number of glyphs displayed.  Can use either a random
509       sampling or every nth point sampling (useful for uniform grids)
510       <max> = integer maximum number of glyphs
511       <random> = bool indicating if random sampling should be used
512       <offset> = offset point index from which to start sampling
513       <ratio> = If random is false, use this to control every nth point sampling
514glyphs opacity <val> <?datasetName?>
515glyphs orient <qw> <qx> <qy> <qz> <?dataSetName?>
516glyphs pos <x> <y> <z> <?dataSetName?>
517glyphs ptsize <size> <?dataSetName?>
518glyphs quality <val> <?dataSetName?>
519       Set glyph shape resolution quality val=[0,10], 1 is default
520glyphs scale <sx> <sy> <sz> <?dataSetName?>
521glyphs shape <arrow|cone|cube|cylinder|dodecahedron|icosahedron|line|octahedron|point|sphere|tetrahedron> <?datasetName?>
522glyphs smode <scalar|vmag|vcomp|off> <fieldName> <?dataSetName?>
523       Set the scaling mode: use the scalar field, vector magnitude,
524       vector components, or disable scaling
525glyphs visible <bool> <?datasetName?>
526glyphs wireframe <bool> <?datasetName?>
527
528group add <nodeList> <name>
529      Add listed nodes to group named <name>.  Group will be created if
530      it doesn't exist, but nodes may be added to existing groups.  The
531      nodes will be removed from the virtual root scene.
532group delete <?name?>
533group orient <qw> <qx> <qy> <qz> <?name?>
534group origin <x> <y> <z> <?name?>
535group pos <x> <y> <z> <?name?>
536group remove <nodeList> <name>
537      Remove listed nodes from group.  Currently, nodes will be added back
538      to the virtual root scene, and so nodes must be explicitly deleted to
539      remove them from the scene.
540group scale <sx> <sy> <sz> <?name?>
541group visible <bool> <?name?>
542
543heightmap add numcontours <n> <heightScale> <?dataSetName?>
544          Generate evenly spaced contours including range endpoints.  See also
545          'dataset maprange' command.
546heightmap add contourlist <list> <heightScale> <?dataSetName?>
547          list = {isoval1 isoval2 isoval3...}
548heightmap aspect <aspectRatio>
549          Set scaling by aspect ratio
550          <aspectRatio> = width/height or 0 for native aspect
551heightmap cloudstyle <style> <?datasetName?>
552          <style> = mesh | splat
553heightmap colormap <colorMapName> <?dataSetName?>
554heightmap colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
555          Set the field used to color the object.  'constant' means to use
556          the constant color defined by the color subcommand.  'scalar' uses
557          the active scalar field.  'vmag' uses the magnitude of the current
558          vector field, and 'vx','vy','vz' use the corresponding component of
559          the active vector field.
560heightmap colormode2 <scalar|vmag|vx|vy|vz|constant> <fieldName> <point_data|cell_data|field_data|any> <min> <max> <?datasetName?>
561          Set the field used to color the object.  'constant' means to use
562          the constant color defined by the color subcommand.  'scalar' uses
563          the active scalar field.  'vmag' uses the magnitude of the current
564          vector field, and 'vx','vy','vz' use the corresponding component of
565          the active vector field.
566heightmap contourlist <list> <?dataSetName?>
567heightmap delete <?dataSetName?>
568heightmap edges <bool> <?dataSetName?>
569heightmap heightscale <value> <?dataSetName?>
570heightmap isolinecmap <bool> <?dataSetName?>
571          Toggle colormapping of isolines (false means to use constant color)
572heightmap isolinecolor <r> <g> <b> <?dataSetName?>
573heightmap isolines <bool> <?dataSetName?>
574heightmap isolinewidth <width> <?dataSetName?>
575heightmap lighting <bool> <?dataSetName?>
576heightmap linecolor <r> <g> <b> <?dataSetName?>
577heightmap linewidth <width> <?dataSetName?>
578heightmap numcontours <n> <?dataSetName?>
579heightmap opacity <value> <?dataSetName?>
580heightmap orient <qw> <qx> <qy> <qz> <?dataSetName?>
581heightmap pos <x> <y> <z> <?dataSetName?>
582heightmap preinterp <bool> <?dataSetName?>
583          Controls if VTK's InterpolateScalarsBeforeMapping option is set.
584          Setting this on will give more correct colors, as the interpolation
585          is done on texture coordinates that lookup into a 1D texture instead
586          of using color interpolation from triangle vertices.
587heightmap scale <sx> <sy> <sz> <?dataSetName?>
588heightmap slice <axis> <ratio> <?dataSetName?>
589          For 3D data, select a slice along a principle axis of the volume. The
590          ratio is [0,1]
591heightmap surface <bool> <?dataSetName?>
592          Toggle rendering of colormapped surface (mountain plot or cutplane)
593heightmap visible <bool> <?dataSetName?>
594heightmap wireframe <bool> <?datasetName?>
595
596image add <?dataSetName?>
597      Create an image from a vtkImageData data set
598image backing <bool> <?dataSetName?>
599image bg <bool> <?dataSetName?>
600image border <bool> <?dataSetName?>
601image color <r> <g> <b> <?dataSetName?>
602image colormap <colorMapName> <?dataSetName?>
603image delete <?dataSetName?>
604image extents <xmin> <xmax> <ymin> <ymax> <zmin> <zmax> <?dataSetName?>
605image level <level> <?dataSetName?>
606image opacity <opacity> <?dataSetName?>
607image orient <qw> <qx> <qy> <qz> <?dataSetName?>
608image pos <x> <y> <z> <?dataSetName?>
609image scale <sx> <sy> <sz> <?dataSetName?>
610image visible <bool> <?dataSetName?>
611image window <windowWidth> <?dataSetName?>
612image zslice <sliceNum> <?dataSetName?>
613
614lic add <?datasetName?>
615lic colormap <colormapName> <?datasetName?>
616lic delete <?datasetName?>
617lic edges <bool> <?datasetName?>
618lic lighting <bool> <?datasetName?>
619lic linecolor <r> <g> <b> <?datasetName?>
620lic linewidth <val> <?datasetName?>
621lic opacity <val> <?datasetName?>
622lic orient <qw> <qx> <qy> <qz> <?dataSetName?>
623lic pos <x> <y> <z> <?dataSetName?>
624lic preinterp <bool> <?dataSetName?>
625    Controls if VTK's InterpolateScalarsBeforeMapping option is set.
626    Setting this on will give more correct colors, as the interpolation
627    is done on texture coordinates that lookup into a 1D texture instead
628    of using color interpolation from triangle vertices.
629lic scale <sx> <sy> <sz> <?dataSetName?>
630lic slice <axis> <ratio> <?datasetName?>
631    For 3D data, select a slice along a principle axis of the volume. The
632    ratio is [0,1]
633lic visible <bool> <?datasetName?>
634
635line add <points> <name>
636     Create a polyline from the list of point coordinates in <points>. The
637     list size must be a multiple of 3 (each point's x,y,z coordinates)
638line color <r> <g> <b> <?name?>
639line delete <?name?>
640line linecolor <r> <g> <b> <?name?>
641     Synonym for color
642line linewidth <val> <?name?>
643line opacity <val> <?name?>
644line orient <qw> <qx> <qy> <qz> <?name?>
645line origin <x> <y> <z> <?name?>
646line pos <x> <y> <z> <?name?>
647line scale <sx> <sy> <sz> <?name?>
648line visible <bool> <?name?>
649
650molecule add <?datasetName?>
651molecule aquality <val> <?datasetName?>
652         Set atom sphere resolution quality val=[0,10], 1 is default
653molecule ascale <val> <?datasetName?>
654         Set atom scale factor
655molecule atoms <bool> <?datasetName?>
656         Toggle rendering of atoms
657molecule bcmode <by_elements|constant> <?datasetName?>
658         Set bond color mode
659molecule bcolor <r> <g> <b> <?datasetName?>
660         Set constant bond color
661molecule bonds <bool> <?datasetName?>
662         Toggle rendering of bonds
663molecule bquality <val> <?datasetName?>
664         Set bond cylinder resolution quality val=[0,10], 1 is default
665molecule bscale <val> <?datasetName?>
666         Set bond scale factor
667molecule bstyle <cylinder|line> <?datasetName?>
668         Set bond render style
669molecule color r g b <?datasetName?>
670molecule colormap <colormapName> <?datasetName?>
671molecule colormode <by_elements|scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
672         Set the field used to color the object.  'constant' means to use
673         the constant color defined by the color subcommand.  'scalar' uses
674         the active scalar field.  'vmag' uses the magnitude of the current
675         vector field, and 'vx','vy','vz' use the corresponding component of
676         the active vector field.
677molecule delete <?datasetName?>
678molecule edges <bool> <?datasetName?>
679molecule labels <bool> <?datasetName?>
680         Toggle display of atom labels
681molecule lfield <fieldName> <?datasetName?>
682         Set the field used for atom labels
683molecule lighting <bool> <?datasetName?>
684molecule linecolor <r> <g> <b> <?datasetName?>
685molecule linewidth <val> <?datasetName?>
686molecule material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?datasetName?>
687molecule opacity <val> <?datasetName?>
688molecule orient <qw> <qx> <qy> <qz> <?dataSetName?>
689molecule pos <x> <y> <z> <?dataSetName?>
690molecule rscale <val> <?dataSetName?>
691         Atom radius scaling
692         val = van_der_waals|covalent|atomic|none
693molecule scale <sx> <sy> <sz> <?dataSetName?>
694molecule visible <bool> <?datasetName?>
695molecule wireframe <bool> <?datasetName?>
696
697outline add <?datasetName?>
698outline color <r> <g> <b> <?datasetName?>
699outline delete <?datasetName?>
700outline linecolor <r> <g> <b> <?datasetName?>
701        Synonym for color
702outline linewidth <val> <?datasetName?>
703outline opacity <val> <?datasetName?>
704outline orient <qw> <qx> <qy> <qz> <?datasetName?>
705outline pos <x> <y> <z> <?datasetName?>
706outline scale <sx> <sy> <sz> <?datasetName?>
707outline visible <bool> <?datasetName?>
708
709parallelepiped add <v0x> <v0y> <v0z> <v1x> <v1y> <v1z> <v2x> <v2y> <v2z> <name>
710               Specify parallelepiped using 3 basis vectors.  The 3 vectors should
711               be given in order to create a right-handed coordinate system, i.e.
712               (v0 cross v1) dot v2 should be positive.
713parallelepiped color <r> <g> <b> <?name?>
714parallelepiped culling <bool> <?name?>
715parallelepiped delete <?name?>
716parallelepiped edges <bool> <?name?>
717parallelepiped flipnorms <bool> <?name?>
718parallelepiped lighting <bool> <?name?>
719parallelepiped linecolor <r> <g> <b> <?name?>
720parallelepiped linewidth <val> <?name?>
721parallelepiped material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
722parallelepiped opacity <val> <?name?>
723parallelepiped orient <qw> <qx> <qy> <qz> <?name?>
724parallelepiped origin <x> <y> <z> <?name?>
725parallelepiped pos <x> <y> <z> <?name?>
726parallelepiped scale <sx> <sy> <sz> <?name?>
727parallelepiped shading <val> <?name?>
728               val = flat|smooth
729parallelepiped visible <bool> <?name?>
730parallelepiped wireframe <bool> <?name?>
731
732polydata add <?datasetName?>
733polydata cloudstyle <style> <?datasetName?>
734         <style> = mesh | points
735polydata color <r> <g> <b> <?datasetName?>
736polydata colormap <colormapName> <?datasetName?>
737polydata colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
738         Set the field used to color the object.  'constant' means to use
739         the constant color defined by the color subcommand.  'scalar' uses
740         the active scalar field.  'vmag' uses the magnitude of the current
741         vector field, and 'vx','vy','vz' use the corresponding component of
742         the active vector field.
743polydata culling <bool> <?name?>
744polydata delete <?datasetName?>
745polydata edges <bool> <?datasetName?>
746polydata lighting <bool> <?datasetName?>
747polydata linecolor <r> <g> <b> <?datasetName?>
748polydata linewidth <val> <?datasetName?>
749polydata material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp>
750polydata opacity <val> <?datasetName?>
751polydata orient <qw> <qx> <qy> <qz> <?dataSetName?>
752polydata origin <x> <y> <z> <?name?>
753polydata pos <x> <y> <z> <?dataSetName?>
754polydata preinterp <bool> <?dataSetName?>
755         Controls if VTK's InterpolateScalarsBeforeMapping option is set.
756         Setting this on will give more correct colors, as the interpolation
757         is done on texture coordinates that lookup into a 1D texture instead
758         of using color interpolation from triangle vertices.
759polydata ptsize <size> <?dataSetName?>
760polydata scale <sx> <sy> <sz> <?dataSetName?>
761polydata shading <val> <?name?>
762         val = flat|smooth
763polydata visible <bool> <?datasetName?>
764polydata wireframe <bool> <?datasetName?>
765
766polygon add <numSides> <centerX> <centerY> <centerZ> <normX> <normY> <normZ> <radius> <name>
767polygon color <r> <g> <b> <?name?>
768polygon culling <bool> <?name?>
769polygon delete <?name?>
770polygon edges <bool> <?name?>
771polygon flipnorms <bool> <?name?>
772polygon lighting <bool> <?name?>
773polygon linecolor <r> <g> <b> <?name?>
774polygon linewidth <val> <?name?>
775polygon material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
776polygon opacity <val> <?name?>
777polygon orient <qw> <qx> <qy> <qz> <?name?>
778polygon origin <x> <y> <z> <?name?>
779polygon pos <x> <y> <z> <?name?>
780polygon scale <sx> <sy> <sz> <?name?>
781polygon shading <val> <?name?>
782        val = flat|smooth
783polygon visible <bool> <?name?>
784polygon wireframe <bool> <?name?>
785
786pseudocolor add <?datasetName?>
787pseudocolor cloudstyle <style> <?datasetName?>
788            <style> = mesh | points | splat
789pseudocolor color <r> <g> <b> <?datasetName?>
790pseudocolor colormap <colormapName> <?datasetName?>
791pseudocolor colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
792            Set the field used to color the object.  'constant' means to use
793            the constant color defined by the color subcommand.  'scalar' uses
794            the active scalar field.  'vmag' uses the magnitude of the current
795            vector field, and 'vx','vy','vz' use the corresponding component of
796            the active vector field.
797pseudocolor delete <?datasetName?>
798pseudocolor edges <bool> <?datasetName?>
799pseudocolor lighting <bool> <?datasetName?>
800pseudocolor linecolor <r> <g> <b> <?datasetName?>
801pseudocolor linewidth <val> <?datasetName?>
802pseudocolor opacity <val> <?datasetName?>
803pseudocolor orient <qw> <qx> <qy> <qz> <?dataSetName?>
804pseudocolor pos <x> <y> <z> <?dataSetName?>
805pseudocolor preinterp <bool> <?dataSetName?>
806            Controls if VTK's InterpolateScalarsBeforeMapping option is set.
807            Setting this on will give more correct colors, as the interpolation
808            is done on texture coordinates that lookup into a 1D texture instead
809            of using color interpolation from triangle vertices.
810pseudocolor ptsize <size> <?dataSetName?>
811pseudocolor scale <sx> <sy> <sz> <?dataSetName?>
812pseudocolor visible <bool> <?datasetName?>
813pseudocolor wireframe <bool> <?datasetName?>
814
815sphere add <centerX> <centerY> <centerZ> <radius> <name>
816sphere color <r> <g> <b> <?name?>
817sphere culling <bool> <?name?>
818sphere delete <?name?>
819sphere edges <bool> <?name?>
820sphere flipnorms <bool> <?name?>
821sphere lighting <bool> <?name?>
822sphere linecolor <r> <g> <b> <?name?>
823sphere linewidth <val> <?name?>
824sphere material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
825sphere opacity <val> <?name?>
826sphere orient <qw> <qx> <qy> <qz> <?name?>
827sphere origin <x> <y> <z> <?name?>
828sphere pos <x> <y> <z> <?name?>
829sphere resolution <thetaRes> <phiRes> <?name?>
830sphere scale <sx> <sy> <sz> <?name?>
831sphere section <thetaStart> <thetaEnd> <phiStart> <phiEnd> <?name?>
832       Angles are in degrees
833sphere shading <val> <?name?>
834       val = flat|smooth
835sphere visible <bool> <?name?>
836sphere wireframe <bool> <?name?>
837
838streamlines add <?datasetName?>
839streamlines color <r> <g> <b> <?datasetName?>
840            Set the constant color of streamlines used for color mode 'constant'
841streamlines colormap <colormapName> <?datasetName?>
842            Colormap used to color streamlines/tubes/ribbons by vector magnitude
843streamlines colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
844            Set the field used to color the streamlines.  'constant' means to use
845            the constant color defined by the color subcommand.  'scalar' uses
846            the active scalar field.  'vmag' uses the magnitude of the current
847            vector field, and 'vx','vy','vz' use the corresponding component of
848            the active vector field.
849streamlines delete <?datasetName?>
850streamlines edges <bool> <?datasetName?>
851            Turn on/off edges for tubes, ribbons
852streamlines length <?datasetName?>
853            Set maximum length in world coordinates of streamlines
854streamlines lighting <bool> <?datasetName?>
855streamlines linecolor <r> <g> <b> <?datasetName?>
856            Set color of edges for tubes, ribbons (lines are colored by
857            colormap)
858streamlines lines <?datasetName?>
859            Set rendering type to polylines
860streamlines linewidth <val> <?datasetName?>
861streamlines opacity <val> <?datasetName?>
862streamlines orient <qw> <qx> <qy> <qz> <?dataSetName?>
863streamlines pos <x> <y> <z> <?dataSetName?>
864streamlines ribbons <width> <angle> <?datasetName?>
865            Set rendering type to ribbons, width is minimum half-width, angle is
866            degrees offset from normal orientation
867streamlines scale <sx> <sy> <sz> <?dataSetName?>
868streamlines seed color <r> <g> <b> <?datasetName?>
869streamlines seed disk <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <radius> <innerRadius> <numPoints> <?dataSetName?>
870            Create a disk seed area with optional hole, filled with randomly
871            placed points
872streamlines seed fmesh <numPoints> data follows <nbytes> <?datasetName?>
873            Fill a mesh supplied as a VTK data file with randomly placed points
874streamlines seed fpoly <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <angle> <radius> <numSides> <numPoints> <?dataSetName?>
875            Create a regular n-sided polygonal seed area filled with randomly
876            placed points
877streamlines seed mesh data follows <nbytes> <?datasetName?>
878            Use points of a mesh supplied as a VTK data file
879streamlines seed numpts <?datasetName?>
880            If seeds have been created using 'seed random', 'seed fmesh',
881            'seed mesh' or 'seed points' this command can be used to change the
882            number of randomly distributed seeds.  In the case of 'seed mesh'
883            or 'seed points', the number is the maximum number of points of the
884            mesh to be used -- the actual number may be fewer if the mesh
885            contains fewer points.  Set to a number less than 0 to use all the
886            points of the mesh.
887streamlines seed points <?datasetName?>
888            Use points of the streamlines' dataset mesh
889streamlines seed polygon <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <angle> <radius> <numSides> <?dataSetName?>
890            Create seed points from vertices of a regular n-sided polygon
891streamlines seed ptsize <size> <?datasetName?>
892            Set the point size for rendering seed points
893streamlines seed rake <startX> <startY> <startZ> <endX> <endY> <endZ> <numPoints> <?datasetName?>
894streamlines seed random <numPoints> <?datasetName?>
895            Fill the streamlines' dataset mesh with randomly placed points
896streamlines seed visible <bool> <?datasetName?>
897streamlines tubes <numSides> <radius> <?datasetName?>
898            Set rendering type to tubes, numSides is number of sides of tubes,
899            radius is minimum tube radius
900streamlines visible <bool> <?datasetName?>
901
902text3d add <textString> <name>
903text3d bold <bool> <?name?>
904text3d color <r> <g> <b> <?name?>
905text3d delete <?name?>
906text3d fntfamily <fontName> <?name?>
907text3d fntsize <fontSize> <?name?>
908text3d follow <bool> <?name?>
909       Toggle text automatically aligning toward camera
910text3d italic <bool> <?name?>
911text3d opacity <opacity> <?name?>
912text3d orient <qw> <qx> <qy> <qz> <?name?>
913text3d origin <x> <y> <z> <?name?>
914text3d pos <x> <y> <z> <?name?>
915text3d scale <sx> <sy> <sz> <?name?>
916text3d shadow <bool> <?name?>
917text3d text <text> <?name?>
918text3d visible <bool> <?name?>
919
920volume add <?datasetName?>
921volume blendmode <mode> <?dataSetName?>
922       mode = composite|max_intensity|min_intensity|additive
923volume colormap <colorMapName> <?datasetName?>
924volume delete <?datasetName?>
925volume lighting <bool> <?datasetName?>
926volume opacity <opacity> <?datasetName?>
927volume orient <qw> <qx> <qy> <qz> <?dataSetName?>
928volume pos <x> <y> <z> <?dataSetName?>
929volume quality <val> <?datasetName?>
930       val = [0,1]
931volume scale <sx> <sy> <sz> <?dataSetName?>
932volume shading ambient <coeff> <?datasetName?>
933volume shading diffuse <coeff> <?datasetName?>
934volume shading specular <coeff> <power> <?datasetName?>
935volume visible <bool> <?datasetName?>
936
937warp add <?dataSetName?>
938warp cloudstyle <style> <?datasetName?>
939     <style> = mesh | points
940warp color <r> <g> <b> <?datasetName?>
941warp colormap <colormapName> <?datasetName?>
942warp colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
943     Set the field used to color the object.  'constant' means to use
944     the constant color defined by the color subcommand.  'scalar' uses
945     the active scalar field.  'vmag' uses the magnitude of the current
946     vector field, and 'vx','vy','vz' use the corresponding component of
947     the active vector field.
948warp delete <?dataSetName?>
949warp edges <bool> <?dataSetName?>
950warp lighting <bool> <?dataSetName?>
951warp linecolor <r> <g> <b> <?dataSetName?>
952warp linewidth <width> <?dataSetName?>
953warp opacity <value> <?dataSetName?>
954warp orient <qw> <qx> <qy> <qz> <?dataSetName?>
955warp pos <x> <y> <z> <?dataSetName?>
956warp preinterp <bool> <?dataSetName?>
957     Controls if VTK's InterpolateScalarsBeforeMapping option is set.
958     Setting this on will give more correct colors, as the interpolation
959     is done on texture coordinates that lookup into a 1D texture instead
960     of using color interpolation from triangle vertices.
961warp ptsize <size> <?dataSetName?>
962warp scale <sx> <sy> <sz> <?dataSetName?>
963warp visible <bool> <?dataSetName?>
964warp warpscale <value> <?dataSetName?>
965     Specify amount to scale vector magnitudes when warping
966warp wireframe <bool> <?datasetName?>
967
968================================================================================
969Replies:
970================================================================================
971nv>camera set <posX> <posY> <posZ> <focalPtX> <focalPtY> <focalPtZ> <viewUpX> <viewUpY> <viewUpZ>
972   Reply to "camera get"
973nv>image -type image -bytes <nbytes>
974  <binary RGB data>
975nv>image -type image -bbox {x y w h} -bytes <nbytes>
976  <binary RGB data>
977  The bounding box of the 2D image camera zoom region is supplied
978  Note: The bbox coordinates are in the form used by 'camera ortho world ...':
979  x,y - world coord. of lower left corner, w,h - width height in world coords
980  This form is currently used only if the camera mode is set to 'image'.
981nv>legend <colormapName> <title> <rmin> <rmax> <nbytes>
982  <binary RGB data>
983nv>dataset names <Tcl list of names>
984nv>dataset scalar world <x> <y> <z> <value> <dataSetName>
985nv>dataset scalar pixel <x> <y> <value> <dataSetName>
986nv>dataset vector world <x> <y> <z> <valueX> <valueY> <valueZ> <dataSetName>
987nv>dataset vector pixel <x> <y> <valueX> <valueY> <valueZ> <dataSetName>
988nv>ok -token <seqnum>
989   Reply indicated commands through <seqnum> (numbered beginning at 1) have been
990   processed, but no new image was rendered
991================================================================================
992Error Replies:
993================================================================================
994nv>viserror -bytes <nbytes>
995   <multi-line error string of nbytes>
996================================================================================
Note: See TracBrowser for help on using the repository browser.