source: trunk/packages/vizservers/vtkvis/protocol.txt @ 4040

Last change on this file since 4040 was 4040, checked in by ldelgass, 9 years ago

Add protocol for setting depth peeling params and bump version

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