source: branches/1.3/packages/vizservers/vtkvis/protocol.txt @ 3844

Last change on this file since 3844 was 3844, checked in by ldelgass, 11 years ago

Sync with trunk. Branch now differs only from trunk by r3722 (branch is version
1.3, trunk is version 1.4)

  • Property svn:eol-style set to native
File size: 41.5 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
128     given 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         colorMap = Tcl list of {value r g b} control points
192         opacityMap = Tcl list of {value alpha} control points
193colormap delete <?colorMapName?>
194colormap res <numberOfTableEntries>
195         Set the "resolution" or number of lookup table entries in the colormap
196         <numberOfTableEntries> = integer or "default"
197
198dataset add <datasetName> data follows <nbytes>
199dataset delete <?datasetName?>
200dataset getscalar world <x> <y> <z> <datasetName>
201dataset getscalar pixel <x> <y> <datasetName>
202dataset getvector world <x> <y> <z> <datasetName>
203dataset getvector pixel <x> <y> <datasetName>
204        Use pixel for image camera mode
205dataset maprange <val> <?min?> <?max?> <?fieldName?> <?fieldType?> <?numComp?> <?component?>
206        Controls if data range for colormapping and contours is based on
207        cumulative range of all datasets ("all"), only visible datasets
208        ("visible") or each individual dataset ("separate").  Defaults to
209        "all"
210        <val> = all|explicit|visible|separate
211        The following arguments are only used for 'explicit' mode:
212        <min>,<max> = Required in explicit mode, specify the range to use
213        <fieldName> = Required in explicit mode, specify the field to which the
214        range should be applied
215        <fieldType> = point_data|cell_data|field_data, optional (defaults to
216        point_data)
217        <numComp> = Number of components (1 = scalar, 3 = vector), optional (1
218        is default)
219        <component> = Component index for vector fields, required if numComp is
220        3, otherwise unused.
221dataset names
222        Returns a list of the loaded data sets
223dataset opacity <val> <?datasetName?>
224dataset scalar <scalarName> <?datasetName?>
225        Set the active scalar field to plot
226dataset vector <vectorName> <?datasetName?>
227        Set the active vector field to plot
228dataset visible <bool> <?datasetName?>
229
230legend <colormapName> <legendType> <fieldName> <legendTitle> <width> <height> <numLabels> <?datasetName?>
231       Causes legend to be rendered and written back with labels and title
232       (title may be left blank)
233       <legendType> = scalar|vmag|vx|vy|vz
234       <numLabels> Can be zero or more 'tick' value labels
235       If datasetName is omitted, the cumulative data range of all data sets
236       will be used to label the legend -- otherwise, the current setting of
237       'dataset maprange' will be used to determine if the individual dataset
238       range or cumulative range will be used.
239
240renderer clipplane <axis> <ratio> <direction>
241         Set a user clipping plane, ratio is [0,1] and is always interpreted as
242         0 = min_bound, 1 = max_bound, regardless of direction.  Sign of
243         direction determines normal of clipping plane.  User clip planes do not
244         apply if camera mode is image.
245renderer depthpeel <bool>
246         Set use of depth peeling algorithm for transparency
247renderer light2side <bool>
248         Toggle use of two-sided lighting (controls if backfaces are lit with a
249         flipped normal)
250renderer lights <lightNum> <bool>
251         Toggle lights on/off.  Light 0 is the headlight, light 1 the skylight
252renderer render
253         Force a new image to be rendered - use for advancing animation
254
255screen bgcolor <r> <g> <b>
256screen size <width> <height>
257
258== Graphics objects ==
259
260arc add <centerX> <centerY> <centerZ> <startX> <startY> <startZ> <normX> <normY> <normZ> <angle> <name>
261    Creates a circular arc given a center and starting point, a normal and a
262    sweep angle.
263arc color <r> <g> <b> <?name?>
264arc delete <?name?>
265arc linecolor <r> <g> <b> <?name?>
266arc linewidth <val> <?name?>
267arc opacity <val> <?name?>
268arc orient <qw> <qx> <qy> <qz> <?name?>
269arc origin <x> <y> <z> <?name?>
270arc pos <x> <y> <z> <?name?>
271arc resolution <res> <?name?>
272arc scale <sx> <sy> <sz> <?name?>
273arc visible <bool> <?name?>
274
275arrow add <tipRadius> <shaftRadius> <tipLength> <name>
276      Arrow will have base at 0,0,0 and tip at 1, 0, 0
277arrow color <r> <g> <b> <?name?>
278arrow culling <bool> <?name?>
279arrow delete <?name?>
280arrow edges <bool> <?name?>
281arrow flipnorm <bool> <?name?>
282arrow lighting <bool> <?name?>
283arrow linecolor <r> <g> <b> <?name?>
284arrow linewidth <val> <?name?>
285arrow material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
286arrow opacity <val> <?name?>
287arrow orient <qw> <qx> <qy> <qz> <?name?>
288arrow origin <x> <y> <z> <?name?>
289arrow pos <x> <y> <z> <?name?>
290arrow resolution <tipRes> <shaftRes> <?name?>
291arrow scale <sx> <sy> <sz> <?name?>
292arrow shading <val> <?name?>
293      val = flat|smooth
294arrow visible <bool> <?name?>
295arrow wireframe <bool> <?name?>
296
297box add <xLen> <yLen> <zLen> <name>
298box color <r> <g> <b> <?name?>
299box culling <bool> <?name?>
300box delete <?name?>
301box edges <bool> <?name?>
302box flipnorm <bool> <?name?>
303box lighting <bool> <?name?>
304box linecolor <r> <g> <b> <?name?>
305box linewidth <val> <?name?>
306box material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
307box opacity <val> <?name?>
308box orient <qw> <qx> <qy> <qz> <?name?>
309box origin <x> <y> <z> <?name?>
310box pos <x> <y> <z> <?name?>
311box scale <sx> <sy> <sz> <?name?>
312box shading <val> <?name?>
313    val = flat|smooth
314box visible <bool> <?name?>
315box wireframe <bool> <?name?>
316
317cone add <radius> <height> <cap> <name>
318     <cap> = boolean flag for cap disks
319cone color <r> <g> <b> <?name?>
320cone culling <bool> <?name?>
321cone delete <?name?>
322cone edges <bool> <?name?>
323cone flipnorm <bool> <?name?>
324cone lighting <bool> <?name?>
325cone linecolor <r> <g> <b> <?name?>
326cone linewidth <val> <?name?>
327cone material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
328cone opacity <val> <?name?>
329cone orient <qw> <qx> <qy> <qz> <?name?>
330cone origin <x> <y> <z> <?name?>
331cone pos <x> <y> <z> <?name?>
332cone resolution <res> <?name?>
333cone scale <sx> <sy> <sz> <?name?>
334cone shading <val> <?name?>
335     val = flat|smooth
336cone visible <bool> <?name?>
337cone wireframe <bool> <?name?>
338
339contour2d add numcontours <n> <?datasetName?>
340          Generate evenly spaced contours including range endpoints.  See also
341          'dataset maprange' command.
342contour2d add contourlist <list> <?datasetName?>
343          list = {isoval1 isoval2 isoval3...}
344contour2d color <r> <g> <b> <?datasetName?>
345          synonym for linecolor
346contour2d colormap <colormapName> <?datasetName?>
347contour2d colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
348          Set the field used to color the object.  'constant' means to use
349          the constant color defined by the color subcommand.  'scalar' uses
350          the active scalar field.  'vmag' uses the magnitude of the current
351          vector field, and 'vx','vy','vz' use the corresponding component of
352          the active vector field.
353contour2d contourlist <list> <?dataSetName?>
354contour2d delete <?datasetName?>
355contour2d lighting <bool> <?datasetName?>
356contour2d linecolor <r> <g> <b> <?datasetName?>
357          synonym for color
358contour2d linewidth <val> <?datasetName?>
359contour2d numcontours <n> <?dataSetName?>
360contour2d opacity <val> <?datasetName?>
361contour2d orient <qw> <qx> <qy> <qz> <?dataSetName?>
362contour2d pos <x> <y> <z> <?dataSetName?>
363contour2d scale <sx> <sy> <sz> <?dataSetName?>
364contour2d visible <bool> <?datasetName?>
365
366contour3d add numcontours <n> <?datasetName?>
367          Generate evenly spaced contours including range endpoints.  See also
368          'dataset maprange' command.
369contour3d add contourlist <list> <?datasetName?>
370          list = {isoval1 isoval2 isoval3...}
371contour3d color r g b <?datasetName?>
372contour3d colormap <colorMapName> <?dataSetName?>
373contour3d colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
374          Set the field used to color the object.  'constant' means to use
375          the constant color defined by the color subcommand.  'scalar' uses
376          the active scalar field.  'vmag' uses the magnitude of the current
377          vector field, and 'vx','vy','vz' use the corresponding component of
378          the active vector field.
379contour3d contourlist <list> <?dataSetName?>
380contour3d delete <?datasetName?>
381contour3d edges <bool> <?datasetName?>
382contour3d lighting <bool> <?datasetName?>
383contour3d linecolor <r> <g> <b> <?datasetName?>
384contour3d linewidth <val> <?datasetName?>
385contour3d numcontours <n> <?dataSetName?>
386contour3d opacity <val> <?datasetName?>
387contour3d orient <qw> <qx> <qy> <qz> <?dataSetName?>
388contour3d pos <x> <y> <z> <?dataSetName?>
389contour3d scale <sx> <sy> <sz> <?dataSetName?>
390contour3d visible <bool> <?datasetName?>
391contour3d wireframe <bool> <?datasetName?>
392
393cutplane add <?dataSetName?>
394cutplane axis <axis> <bool> <?dataSetName?>
395         Toggle visibility of the 3 principal axis cutplanes
396cutplane color r g b <?datasetName?>
397         Set color of outline bounding box
398cutplane cloudstyle <style> <?datasetName?>
399         <style> = mesh | splat
400cutplane colormap <colorMapName> <?dataSetName?>
401cutplane colormode <scalar|vmag|vx|vy|vz> <fieldName> <?datasetName?>
402         Set the field used to color the object.  'scalar' uses
403         the active scalar field.  'vmag' uses the magnitude of the current
404         vector field, and 'vx','vy','vz' use the corresponding component of
405         the active vector field.
406cutplane delete <?dataSetName?>
407cutplane edges <bool> <?dataSetName?>
408cutplane lighting <bool> <?dataSetName?>
409cutplane linecolor <r> <g> <b> <?dataSetName?>
410cutplane linewidth <width> <?dataSetName?>
411cutplane opacity <value> <?dataSetName?>
412cutplane orient <qw> <qx> <qy> <qz> <?dataSetName?>
413cutplane outline <bool> <?dataSetName?>
414         Toggle rendering of cutplane outlines
415cutplane pos <x> <y> <z> <?dataSetName?>
416cutplane preinterp <bool> <?dataSetName?>
417         Controls if VTK's InterpolateScalarsBeforeMapping option is set.
418         Setting this on will give more correct colors, as the interpolation
419         is done on texture coordinates that lookup into a 1D texture instead
420         of using color interpolation from triangle vertices.
421cutplane scale <sx> <sy> <sz> <?dataSetName?>
422cutplane slice axis ratio <?dataSetName?>
423         For 3D data, select a slice along a principle axis of the volume. The
424         ratio is [0,1]
425cutplane visible <bool> <?dataSetName?>
426cutplane wireframe <bool> <?datasetName?>
427
428cylinder add <radius> <height> <cap> <name>
429         <cap> = boolean flag for cap disks
430cylinder color <r> <g> <b> <?name?>
431cylinder culling <bool> <?name?>
432cylinder delete <?name?>
433cylinder edges <bool> <?name?>
434cylinder flipnorm <bool> <?name?>
435cylinder lighting <bool> <?name?>
436cylinder linecolor <r> <g> <b> <?name?>
437cylinder linewidth <val> <?name?>
438cylinder material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
439cylinder opacity <val> <?name?>
440cylinder orient <qw> <qx> <qy> <qz> <?name?>
441cylinder origin <x> <y> <z> <?name?>
442cylinder pos <x> <y> <z> <?name?>
443cylinder resolution <res> <?name?>
444cylinder scale <sx> <sy> <sz> <?name?>
445cylinder shading <val> <?name?>
446         val = flat|smooth
447cylinder visible <bool> <?name?>
448cylinder wireframe <bool> <?name?>
449
450disk add <innerRadius> <outerRadius> <name>
451disk color <r> <g> <b> <?name?>
452disk culling <bool> <?name?>
453disk delete <?name?>
454disk edges <bool> <?name?>
455disk flipnorm <bool> <?name?>
456disk lighting <bool> <?name?>
457disk linecolor <r> <g> <b> <?name?>
458disk linewidth <val> <?name?>
459disk material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
460disk opacity <val> <?name?>
461disk orient <qw> <qx> <qy> <qz> <?name?>
462disk origin <x> <y> <z> <?name?>
463disk pos <x> <y> <z> <?name?>
464disk resolution <resRadial> <resCircum> <?name?>
465disk scale <sx> <sy> <sz> <?name?>
466disk shading <val> <?name?>
467     val = flat|smooth
468disk visible <bool> <?name?>
469disk wireframe <bool> <?name?>
470
471glyphs add <shape> <?dataSetName?>
472       See 'glyphs shape' for list of shapes
473glyphs color r g b <?datasetName?>
474glyphs colormap <colorMapName> <?dataSetName?>
475glyphs colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?dataSetName?>
476       Set the color mode: color by scalar field or
477       vector magnitude -- uses the current color map,
478       or color for constant color
479glyphs delete <?dataSetName?>
480glyphs edges <bool> <?datasetName?>
481glyphs gorient <bool> <fieldName> <?datasetName?>
482       Set the glyph orientation mode: orient glyphs by
483       a named vector field, or set to default orientation (off)
484glyphs gscale <scaleFactor> <?datasetName?>
485       Set glyph scaling factor
486glyphs lighting <bool> <?datasetName?>
487glyphs linecolor <r> <g> <b> <?datasetName?>
488glyphs linewidth <val> <?datasetName?>
489glyphs normscale <bool> <?datasetName?>
490       Control if data values are normalized to [0,1] range before applying
491       glyph scaling factor (gscale)
492glyphs numglyphs <max> <random> <offset> <ratio> <?dataSetName?>
493       Limit the maximum number of glyphs displayed.  Can use either a random
494       sampling or every nth point sampling (useful for uniform grids)
495       <max> = integer maximum number of glyphs
496       <random> = bool indicating if random sampling should be used
497       <offset> = offset point index from which to start sampling
498       <ratio> = If random is false, use this to control every nth point sampling
499glyphs opacity <val> <?datasetName?>
500glyphs orient <qw> <qx> <qy> <qz> <?dataSetName?>
501glyphs pos <x> <y> <z> <?dataSetName?>
502glyphs ptsize <size> <?dataSetName?>
503glyphs quality <val> <?dataSetName?>
504       Set glyph shape resolution quality val=[0,10], 1 is default
505glyphs scale <sx> <sy> <sz> <?dataSetName?>
506glyphs shape <arrow|cone|cube|cylinder|dodecahedron|icosahedron|line|octahedron|point|sphere|tetrahedron> <?datasetName?>
507glyphs smode <scalar|vmag|vcomp|off> <fieldName> <?dataSetName?>
508       Set the scaling mode: use the scalar field, vector magnitude
509       (uniform scale), vector components, or disable scaling
510glyphs visible <bool> <?datasetName?>
511glyphs wireframe <bool> <?datasetName?>
512
513group add <nodeList> <name>
514      Add listed nodes to group named <name>.  Group will be created if
515      it doesn't exist, but nodes may be added to existing groups.  The
516      nodes will be removed from the virtual root scene.
517group delete <?name?>
518group orient <qw> <qx> <qy> <qz> <?name?>
519group origin <x> <y> <z> <?name?>
520group pos <x> <y> <z> <?name?>
521group remove <nodeList> <name>
522      Remove listed nodes from group.  Currently, nodes will be added back
523      to the virtual root scene, and so nodes must be explicitly deleted to
524      remove them from the scene.
525group scale <sx> <sy> <sz> <?name?>
526group visible <bool> <?name?>
527
528heightmap add numcontours <n> <heightScale> <?dataSetName?>
529          Generate evenly spaced contours including range endpoints.  See also
530          'dataset maprange' command.
531heightmap add contourlist <list> <heightScale> <?dataSetName?>
532          list = {isoval1 isoval2 isoval3...}
533heightmap aspect <aspectRatio>
534          Set scaling by aspect ratio
535          <aspectRatio> = width/height or 0 for native aspect
536heightmap cloudstyle <style> <?datasetName?>
537          <style> = mesh | splat
538heightmap colormap <colorMapName> <?dataSetName?>
539heightmap colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
540          Set the field used to color the object.  'constant' means to use
541          the constant color defined by the color subcommand.  'scalar' uses
542          the active scalar field.  'vmag' uses the magnitude of the current
543          vector field, and 'vx','vy','vz' use the corresponding component of
544          the active vector field.
545heightmap contourlist <list> <?dataSetName?>
546heightmap delete <?dataSetName?>
547heightmap edges <bool> <?dataSetName?>
548heightmap heightscale <value> <?dataSetName?>
549heightmap isolinecmap <bool> <?dataSetName?>
550          Toggle colormapping of isolines (false means to use constant color)
551heightmap isolinecolor <r> <g> <b> <?dataSetName?>
552heightmap isolines <bool> <?dataSetName?>
553heightmap isolinewidth <width> <?dataSetName?>
554heightmap lighting <bool> <?dataSetName?>
555heightmap linecolor <r> <g> <b> <?dataSetName?>
556heightmap linewidth <width> <?dataSetName?>
557heightmap numcontours <n> <?dataSetName?>
558heightmap opacity <value> <?dataSetName?>
559heightmap orient <qw> <qx> <qy> <qz> <?dataSetName?>
560heightmap pos <x> <y> <z> <?dataSetName?>
561heightmap preinterp <bool> <?dataSetName?>
562          Controls if VTK's InterpolateScalarsBeforeMapping option is set.
563          Setting this on will give more correct colors, as the interpolation
564          is done on texture coordinates that lookup into a 1D texture instead
565          of using color interpolation from triangle vertices.
566heightmap scale <sx> <sy> <sz> <?dataSetName?>
567heightmap slice <axis> <ratio> <?dataSetName?>
568          For 3D data, select a slice along a principle axis of the volume. The
569          ratio is [0,1]
570heightmap surface <bool> <?dataSetName?>
571          Toggle rendering of colormapped surface (mountain plot or cutplane)
572heightmap visible <bool> <?dataSetName?>
573heightmap wireframe <bool> <?datasetName?>
574
575image add <?dataSetName?>
576      Create an image from a vtkImageData data set
577image backing <bool> <?dataSetName?>
578image bg <bool> <?dataSetName?>
579image border <bool> <?dataSetName?>
580image color <r> <g> <b> <?dataSetName?>
581image colormap <colorMapName> <?dataSetName?>
582image delete <?dataSetName?>
583image extents <xmin> <xmax> <ymin> <ymax> <zmin> <zmax> <?dataSetName?>
584image level <level> <?dataSetName?>
585image opacity <opacity> <?dataSetName?>
586image orient <qw> <qx> <qy> <qz> <?dataSetName?>
587image pos <x> <y> <z> <?dataSetName?>
588image scale <sx> <sy> <sz> <?dataSetName?>
589image visible <bool> <?dataSetName?>
590image window <windowWidth> <?dataSetName?>
591image zslice <sliceNum> <?dataSetName?>
592
593lic add <?datasetName?>
594lic colormap <colormapName> <?datasetName?>
595lic delete <?datasetName?>
596lic edges <bool> <?datasetName?>
597lic lighting <bool> <?datasetName?>
598lic linecolor <r> <g> <b> <?datasetName?>
599lic linewidth <val> <?datasetName?>
600lic opacity <val> <?datasetName?>
601lic orient <qw> <qx> <qy> <qz> <?dataSetName?>
602lic pos <x> <y> <z> <?dataSetName?>
603lic preinterp <bool> <?dataSetName?>
604    Controls if VTK's InterpolateScalarsBeforeMapping option is set.
605    Setting this on will give more correct colors, as the interpolation
606    is done on texture coordinates that lookup into a 1D texture instead
607    of using color interpolation from triangle vertices.
608lic scale <sx> <sy> <sz> <?dataSetName?>
609lic slice <axis> <ratio> <?datasetName?>
610    For 3D data, select a slice along a principle axis of the volume. The
611    ratio is [0,1]
612lic visible <bool> <?datasetName?>
613
614line add <points> <name>
615     Create a polyline from the list of point coordinates in <points>. The
616     list size must be a multiple of 3 (each point's x,y,z coordinates)
617line color <r> <g> <b> <?name?>
618line delete <?name?>
619line linecolor <r> <g> <b> <?name?>
620     Synonym for color
621line linewidth <val> <?name?>
622line opacity <val> <?name?>
623line orient <qw> <qx> <qy> <qz> <?name?>
624line origin <x> <y> <z> <?name?>
625line pos <x> <y> <z> <?name?>
626line scale <sx> <sy> <sz> <?name?>
627line visible <bool> <?name?>
628
629molecule add <?datasetName?>
630molecule aquality <val> <?datasetName?>
631         Set atom sphere resolution quality val=[0,10], 1 is default
632molecule ascale <val> <?datasetName?>
633         Set atom scale factor
634molecule atoms <bool> <?datasetName?>
635         Toggle rendering of atoms
636molecule bcmode <by_elements|constant> <?datasetName?>
637         Set bond color mode
638molecule bcolor <r> <g> <b> <?datasetName?>
639         Set constant bond color
640molecule bonds <bool> <?datasetName?>
641         Toggle rendering of bonds
642molecule bquality <val> <?datasetName?>
643         Set bond cylinder resolution quality val=[0,10], 1 is default
644molecule bscale <val> <?datasetName?>
645         Set bond scale factor
646molecule bstyle <cylinder|line> <?datasetName?>
647         Set bond render style
648molecule color r g b <?datasetName?>
649molecule colormap <colormapName> <?datasetName?>
650molecule colormode <by_elements|scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
651         Set the field used to color the object.  'constant' means to use
652         the constant color defined by the color subcommand.  'scalar' uses
653         the active scalar field.  'vmag' uses the magnitude of the current
654         vector field, and 'vx','vy','vz' use the corresponding component of
655         the active vector field.
656molecule delete <?datasetName?>
657molecule edges <bool> <?datasetName?>
658molecule labels <bool> <?datasetName?>
659         Toggle display of atom labels
660molecule lfield <fieldName> <?datasetName?>
661         Set the field used for atom labels
662molecule lighting <bool> <?datasetName?>
663molecule linecolor <r> <g> <b> <?datasetName?>
664molecule linewidth <val> <?datasetName?>
665molecule material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?datasetName?>
666molecule opacity <val> <?datasetName?>
667molecule orient <qw> <qx> <qy> <qz> <?dataSetName?>
668molecule pos <x> <y> <z> <?dataSetName?>
669molecule rscale <val> <?dataSetName?>
670         Atom radius scaling
671         val = van_der_waals|covalent|atomic|none
672molecule scale <sx> <sy> <sz> <?dataSetName?>
673molecule visible <bool> <?datasetName?>
674molecule wireframe <bool> <?datasetName?>
675
676outline add <?datasetName?>
677outline color <r> <g> <b> <?datasetName?>
678outline delete <?datasetName?>
679outline linecolor <r> <g> <b> <?datasetName?>
680        Synonym for color
681outline linewidth <val> <?datasetName?>
682outline opacity <val> <?datasetName?>
683outline orient <qw> <qx> <qy> <qz> <?datasetName?>
684outline pos <x> <y> <z> <?datasetName?>
685outline scale <sx> <sy> <sz> <?datasetName?>
686outline visible <bool> <?datasetName?>
687
688polydata add <?datasetName?>
689polydata color <r> <g> <b> <?datasetName?>
690polydata cloudstyle <style> <?datasetName?>
691         <style> = mesh | points
692polydata colormap <colormapName> <?datasetName?>
693polydata colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
694         Set the field used to color the object.  'constant' means to use
695         the constant color defined by the color subcommand.  'scalar' uses
696         the active scalar field.  'vmag' uses the magnitude of the current
697         vector field, and 'vx','vy','vz' use the corresponding component of
698         the active vector field.
699polydata culling <bool> <?name?>
700polydata delete <?datasetName?>
701polydata edges <bool> <?datasetName?>
702polydata lighting <bool> <?datasetName?>
703polydata linecolor <r> <g> <b> <?datasetName?>
704polydata linewidth <val> <?datasetName?>
705polydata material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp>
706polydata opacity <val> <?datasetName?>
707polydata orient <qw> <qx> <qy> <qz> <?dataSetName?>
708polydata origin <x> <y> <z> <?name?>
709polydata pos <x> <y> <z> <?dataSetName?>
710polydata preinterp <bool> <?dataSetName?>
711         Controls if VTK's InterpolateScalarsBeforeMapping option is set.
712         Setting this on will give more correct colors, as the interpolation
713         is done on texture coordinates that lookup into a 1D texture instead
714         of using color interpolation from triangle vertices.
715polydata ptsize <size> <?dataSetName?>
716polydata scale <sx> <sy> <sz> <?dataSetName?>
717polydata shading <val> <?name?>
718         val = flat|smooth
719polydata visible <bool> <?datasetName?>
720polydata wireframe <bool> <?datasetName?>
721
722polygon add <numSides> <centerX> <centerY> <centerZ> <normX> <normY> <normZ> <radius> <name>
723polygon color <r> <g> <b> <?name?>
724polygon culling <bool> <?name?>
725polygon delete <?name?>
726polygon edges <bool> <?name?>
727polygon flipnorm <bool> <?name?>
728polygon lighting <bool> <?name?>
729polygon linecolor <r> <g> <b> <?name?>
730polygon linewidth <val> <?name?>
731polygon material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
732polygon opacity <val> <?name?>
733polygon orient <qw> <qx> <qy> <qz> <?name?>
734polygon origin <x> <y> <z> <?name?>
735polygon pos <x> <y> <z> <?name?>
736polygon scale <sx> <sy> <sz> <?name?>
737polygon shading <val> <?name?>
738        val = flat|smooth
739polygon visible <bool> <?name?>
740polygon wireframe <bool> <?name?>
741
742pseudocolor add <?datasetName?>
743pseudocolor color <r> <g> <b> <?datasetName?>
744pseudocolor cloudstyle <style> <?datasetName?>
745            <style> = mesh | points | splat
746pseudocolor colormap <colormapName> <?datasetName?>
747pseudocolor colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
748            Set the field used to color the object.  'constant' means to use
749            the constant color defined by the color subcommand.  'scalar' uses
750            the active scalar field.  'vmag' uses the magnitude of the current
751            vector field, and 'vx','vy','vz' use the corresponding component of
752            the active vector field.
753pseudocolor delete <?datasetName?>
754pseudocolor edges <bool> <?datasetName?>
755pseudocolor lighting <bool> <?datasetName?>
756pseudocolor linecolor <r> <g> <b> <?datasetName?>
757pseudocolor linewidth <val> <?datasetName?>
758pseudocolor opacity <val> <?datasetName?>
759pseudocolor orient <qw> <qx> <qy> <qz> <?dataSetName?>
760pseudocolor pos <x> <y> <z> <?dataSetName?>
761pseudocolor preinterp <bool> <?dataSetName?>
762            Controls if VTK's InterpolateScalarsBeforeMapping option is set.
763            Setting this on will give more correct colors, as the interpolation
764            is done on texture coordinates that lookup into a 1D texture instead
765            of using color interpolation from triangle vertices.
766pseudocolor ptsize <size> <?dataSetName?>
767pseudocolor scale <sx> <sy> <sz> <?dataSetName?>
768pseudocolor visible <bool> <?datasetName?>
769pseudocolor wireframe <bool> <?datasetName?>
770
771sphere add <centerX> <centerY> <centerZ> <radius> <name>
772sphere color <r> <g> <b> <?name?>
773sphere culling <bool> <?name?>
774sphere delete <?name?>
775sphere edges <bool> <?name?>
776sphere flipnorm <bool> <?name?>
777sphere lighting <bool> <?name?>
778sphere linecolor <r> <g> <b> <?name?>
779sphere linewidth <val> <?name?>
780sphere material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
781sphere opacity <val> <?name?>
782sphere orient <qw> <qx> <qy> <qz> <?name?>
783sphere origin <x> <y> <z> <?name?>
784sphere pos <x> <y> <z> <?name?>
785sphere resolution <thetaRes> <phiRes> <?name?>
786sphere scale <sx> <sy> <sz> <?name?>
787sphere section <thetaStart> <thetaEnd> <phiStart> <phiEnd> <?name?>
788       Angles are in degrees
789sphere shading <val> <?name?>
790       val = flat|smooth
791sphere visible <bool> <?name?>
792sphere wireframe <bool> <?name?>
793
794streamlines add <?datasetName?>
795streamlines color <r> <g> <b> <?datasetName?>
796            Set the constant color of streamlines used for color mode 'constant'
797streamlines colormap <colormapName> <?datasetName?>
798            Colormap used to color streamlines/tubes/ribbons by vector magnitude
799streamlines colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
800            Set the field used to color the streamlines.  'constant' means to use
801            the constant color defined by the color subcommand.  'scalar' uses
802            the active scalar field.  'vmag' uses the magnitude of the current
803            vector field, and 'vx','vy','vz' use the corresponding component of
804            the active vector field.
805streamlines delete <?datasetName?>
806streamlines edges <bool> <?datasetName?>
807            Turn on/off edges for tubes, ribbons
808streamlines length <?datasetName?>
809            Set maximum length in world coordinates of streamlines
810streamlines lighting <bool> <?datasetName?>
811streamlines linecolor <r> <g> <b> <?datasetName?>
812            Set color of edges for tubes, ribbons (lines are colored by
813            colormap)
814streamlines lines <?datasetName?>
815            Set rendering type to polylines
816streamlines linewidth <val> <?datasetName?>
817streamlines opacity <val> <?datasetName?>
818streamlines orient <qw> <qx> <qy> <qz> <?dataSetName?>
819streamlines pos <x> <y> <z> <?dataSetName?>
820streamlines ribbons <width> <angle> <?datasetName?>
821            Set rendering type to ribbons, width is minimum half-width, angle is
822            degrees offset from normal orientation
823streamlines scale <sx> <sy> <sz> <?dataSetName?>
824streamlines seed color <r> <g> <b> <?datasetName?>
825streamlines seed disk <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <radius> <innerRadius> <numPoints> <?dataSetName?>
826            Create a disk seed area with optional hole, filled with randomly
827            placed points
828streamlines seed fmesh <numPoints> data follows <nbytes> <?datasetName?>
829            Fill a mesh supplied as a VTK data file with randomly placed points
830streamlines seed fpoly <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <angle> <radius> <numSides> <numPoints> <?dataSetName?>
831            Create a regular n-sided polygonal seed area filled with randomly
832            placed points
833streamlines seed mesh data follows <nbytes> <?datasetName?>
834            Use points of a mesh supplied as a VTK data file
835streamlines seed numpts <?datasetName?>
836            If seeds have been created using 'seed random', 'seed fmesh',
837            'seed mesh' or 'seed points' this command can be used to change the
838            number of randomly distributed seeds.  In the case of 'seed mesh'
839            or 'seed points', the number is the maximum number of points of the
840            mesh to be used -- the actual number may be fewer if the mesh
841            contains fewer points.  Set to a number less than 0 to use all the
842            points of the mesh.
843streamlines seed points <?datasetName?>
844            Use points of the streamlines' dataset mesh
845streamlines seed polygon <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <angle> <radius> <numSides> <?dataSetName?>
846            Create seed points from vertices of a regular n-sided polygon
847streamlines seed ptsize <size> <?datasetName?>
848            Set the point size for rendering seed points
849streamlines seed rake <startX> <startY> <startZ> <endX> <endY> <endZ> <numPoints> <?datasetName?>
850streamlines seed random <numPoints> <?datasetName?>
851            Fill the streamlines' dataset mesh with randomly placed points
852streamlines seed visible <bool> <?datasetName?>
853streamlines tubes <numSides> <radius> <?datasetName?>
854            Set rendering type to tubes, numSides is number of sides of tubes,
855            radius is minimum tube radius
856streamlines visible <bool> <?datasetName?>
857
858text3d add <textString> <name>
859text3d color <r> <g> <b> <?name?>
860text3d delete <?name?>
861text3d fntfamily <fontName> <?name?>
862text3d fntsize <fontSize> <?name?>
863text3d opacity <opacity> <?name?>
864text3d orient <qw> <qx> <qy> <qz> <?name?>
865text3d origin <x> <y> <z> <?name?>
866text3d pos <x> <y> <z> <?name?>
867text3d scale <sx> <sy> <sz> <?name?>
868text3d visible <bool> <?name?>
869
870volume add <?datasetName?>
871volume colormap <colorMapName> <?datasetName?>
872volume delete <?datasetName?>
873volume lighting <bool> <?datasetName?>
874volume orient <qw> <qx> <qy> <qz> <?dataSetName?>
875volume pos <x> <y> <z> <?dataSetName?>
876volume quality <val> <?datasetName?>
877       val = [0,1]
878volume scale <sx> <sy> <sz> <?dataSetName?>
879volume shading ambient <coeff> <?datasetName?>
880volume shading diffuse <coeff> <?datasetName?>
881volume shading specular <coeff> <power> <?datasetName?>
882volume visible <bool> <?datasetName?>
883
884warp add <?dataSetName?>
885warp color <r> <g> <b> <?datasetName?>
886warp cloudstyle <style> <?datasetName?>
887     <style> = mesh | points
888warp colormap <colormapName> <?datasetName?>
889warp colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
890     Set the field used to color the object.  'constant' means to use
891     the constant color defined by the color subcommand.  'scalar' uses
892     the active scalar field.  'vmag' uses the magnitude of the current
893     vector field, and 'vx','vy','vz' use the corresponding component of
894     the active vector field.
895warp delete <?dataSetName?>
896warp edges <bool> <?dataSetName?>
897warp lighting <bool> <?dataSetName?>
898warp linecolor <r> <g> <b> <?dataSetName?>
899warp linewidth <width> <?dataSetName?>
900warp opacity <value> <?dataSetName?>
901warp orient <qw> <qx> <qy> <qz> <?dataSetName?>
902warp ptsize <size> <?dataSetName?>
903warp pos <x> <y> <z> <?dataSetName?>
904warp preinterp <bool> <?dataSetName?>
905     Controls if VTK's InterpolateScalarsBeforeMapping option is set.
906     Setting this on will give more correct colors, as the interpolation
907     is done on texture coordinates that lookup into a 1D texture instead
908     of using color interpolation from triangle vertices.
909warp scale <sx> <sy> <sz> <?dataSetName?>
910warp visible <bool> <?dataSetName?>
911warp warpscale <value> <?dataSetName?>
912     Specify amount to scale vector magnitudes when warping
913warp wireframe <bool> <?datasetName?>
914
915================================================================================
916Replies:
917================================================================================
918nv>camera set <posX> <posY> <posZ> <focalPtX> <focalPtY> <focalPtZ> <viewUpX> <viewUpY> <viewUpZ>
919   Reply to "camera get"
920nv>image -type image -bytes <nbytes>
921  <binary RGB data>
922nv>image -type image -bbox {x y w h} -bytes <nbytes>
923  <binary RGB data>
924  The bounding box of the 2D image camera zoom region is supplied
925  Note: The bbox coordinates are in the form used by 'camera ortho world ...':
926  x,y - world coord. of lower left corner, w,h - width height in world coords
927  This form is currently used only if the camera mode is set to 'image'.
928nv>legend <colormapName> <title> <rmin> <rmax> <nbytes>
929  <binary RGB data>
930nv>dataset names <Tcl list of names>
931nv>dataset scalar world <x> <y> <z> <value> <dataSetName>
932nv>dataset scalar pixel <x> <y> <value> <dataSetName>
933nv>dataset vector world <x> <y> <z> <valueX> <valueY> <valueZ> <dataSetName>
934nv>dataset vector pixel <x> <y> <valueX> <valueY> <valueZ> <dataSetName>
935nv>ok -token <seqnum>
936   Reply indicated commands through <seqnum> (numbered beginning at 1) have been
937   processed, but no new image was rendered
938================================================================================
939Error Replies:
940================================================================================
941nv>viserror -bytes <nbytes>
942   <multi-line error string of nbytes>
943================================================================================
Note: See TracBrowser for help on using the repository browser.