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

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

Add protocol to set atom/bond tesselation quality in molecules

  • Property svn:eol-style set to native
File size: 38.4 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> <pt1X> <pt1Y> <pt1Z> <pt2X> <pt2Y> <pt2Z> <name>
261arc color <r> <g> <b> <?name?>
262arc delete <?name?>
263arc linecolor <r> <g> <b> <?name?>
264arc linewidth <val> <?name?>
265arc opacity <val> <?name?>
266arc orient <qw> <qx> <qy> <qz> <?name?>
267arc origin <x> <y> <z> <?name?>
268arc pos <x> <y> <z> <?name?>
269arc resolution <res> <?name?>
270arc scale <sx> <sy> <sz> <?name?>
271arc visible <bool> <?name?>
272
273arrow add <tipRadius> <shaftRadius> <tipLength> <name>
274      Arrow will have base at 0,0,0 and tip at 1, 0, 0
275arrow color <r> <g> <b> <?name?>
276arrow culling <bool> <?name?>
277arrow delete <?name?>
278arrow edges <bool> <?name?>
279arrow flipnorm <bool> <?name?>
280arrow lighting <bool> <?name?>
281arrow linecolor <r> <g> <b> <?name?>
282arrow linewidth <val> <?name?>
283arrow material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
284arrow opacity <val> <?name?>
285arrow orient <qw> <qx> <qy> <qz> <?name?>
286arrow origin <x> <y> <z> <?name?>
287arrow pos <x> <y> <z> <?name?>
288arrow resolution <tipRes> <shaftRes> <?name?>
289arrow scale <sx> <sy> <sz> <?name?>
290arrow shading <val> <?name?>
291      val = flat|smooth
292arrow visible <bool> <?name?>
293arrow wireframe <bool> <?name?>
294
295box add <xLen> <yLen> <zLen> <name>
296box color <r> <g> <b> <?name?>
297box culling <bool> <?name?>
298box delete <?name?>
299box edges <bool> <?name?>
300box flipnorm <bool> <?name?>
301box lighting <bool> <?name?>
302box linecolor <r> <g> <b> <?name?>
303box linewidth <val> <?name?>
304box material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
305box opacity <val> <?name?>
306box orient <qw> <qx> <qy> <qz> <?name?>
307box origin <x> <y> <z> <?name?>
308box pos <x> <y> <z> <?name?>
309box scale <sx> <sy> <sz> <?name?>
310box shading <val> <?name?>
311    val = flat|smooth
312box visible <bool> <?name?>
313box wireframe <bool> <?name?>
314
315cone add <radius> <height> <cap> <name>
316     <cap> = boolean flag for cap disks
317cone color <r> <g> <b> <?name?>
318cone culling <bool> <?name?>
319cone delete <?name?>
320cone edges <bool> <?name?>
321cone flipnorm <bool> <?name?>
322cone lighting <bool> <?name?>
323cone linecolor <r> <g> <b> <?name?>
324cone linewidth <val> <?name?>
325cone material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
326cone opacity <val> <?name?>
327cone orient <qw> <qx> <qy> <qz> <?name?>
328cone origin <x> <y> <z> <?name?>
329cone pos <x> <y> <z> <?name?>
330cone resolution <res> <?name?>
331cone scale <sx> <sy> <sz> <?name?>
332cone shading <val> <?name?>
333     val = flat|smooth
334cone visible <bool> <?name?>
335cone wireframe <bool> <?name?>
336
337contour2d add numcontours <n> <?datasetName?>
338          Generate evenly spaced contours including range endpoints.  See also
339          'dataset maprange' command.
340contour2d add contourlist <list> <?datasetName?>
341          list = {isoval1 isoval2 isoval3...}
342contour2d ccolor <r> <g> <b> <?datasetName?>
343          synonym for linecolor
344contour2d colormap <colormapName> <?datasetName?>
345contour2d colormode <scalar|vmag|vx|vy|vz|ccolor> <fieldName> <?datasetName?>
346          Set the field used to color the object.  'ccolor' means to use
347          the constant color defined by the ccolor subcommand.  'scalar' uses
348          the active scalar field.  'vmag' uses the magnitude of the current
349          vector field, and 'vx','vy','vz' use the corresponding component of
350          the active vector field.
351contour2d contourlist <list> <?dataSetName?>
352contour2d delete <?datasetName?>
353contour2d lighting <bool> <?datasetName?>
354contour2d linecolor <r> <g> <b> <?datasetName?>
355          synonym for color
356contour2d linewidth <val> <?datasetName?>
357contour2d numcontours <n> <?dataSetName?>
358contour2d opacity <val> <?datasetName?>
359contour2d orient <qw> <qx> <qy> <qz> <?dataSetName?>
360contour2d pos <x> <y> <z> <?dataSetName?>
361contour2d scale <sx> <sy> <sz> <?dataSetName?>
362contour2d visible <bool> <?datasetName?>
363
364contour3d add numcontours <n> <?datasetName?>
365          Generate evenly spaced contours including range endpoints.  See also
366          'dataset maprange' command.
367contour3d add contourlist <list> <?datasetName?>
368          list = {isoval1 isoval2 isoval3...}
369contour3d ccolor r g b <?datasetName?>
370contour3d colormap <colorMapName> <?dataSetName?>
371contour3d colormode <scalar|vmag|vx|vy|vz|ccolor> <fieldName> <?datasetName?>
372          Set the field used to color the object.  'ccolor' means to use
373          the constant color defined by the ccolor subcommand.  'scalar' uses
374          the active scalar field.  'vmag' uses the magnitude of the current
375          vector field, and 'vx','vy','vz' use the corresponding component of
376          the active vector field.
377contour3d contourlist <list> <?dataSetName?>
378contour3d delete <?datasetName?>
379contour3d edges <bool> <?datasetName?>
380contour3d lighting <bool> <?datasetName?>
381contour3d linecolor <r> <g> <b> <?datasetName?>
382contour3d linewidth <val> <?datasetName?>
383contour3d numcontours <n> <?dataSetName?>
384contour3d opacity <val> <?datasetName?>
385contour3d orient <qw> <qx> <qy> <qz> <?dataSetName?>
386contour3d pos <x> <y> <z> <?dataSetName?>
387contour3d scale <sx> <sy> <sz> <?dataSetName?>
388contour3d visible <bool> <?datasetName?>
389contour3d wireframe <bool> <?datasetName?>
390
391cutplane add <?dataSetName?>
392cutplane axis <axis> <bool> <?dataSetName?>
393         Toggle visibility of the 3 principal axis cutplanes
394cutplane ccolor r g b <?datasetName?>
395         Set color of outline bounding box
396cutplane cloudstyle <style> <?datasetName?>
397         <style> = mesh | splat
398cutplane colormap <colorMapName> <?dataSetName?>
399cutplane colormode <scalar|vmag|vx|vy|vz> <fieldName> <?datasetName?>
400         Set the field used to color the object.  'scalar' uses
401         the active scalar field.  'vmag' uses the magnitude of the current
402         vector field, and 'vx','vy','vz' use the corresponding component of
403         the active vector field.
404cutplane delete <?dataSetName?>
405cutplane edges <bool> <?dataSetName?>
406cutplane lighting <bool> <?dataSetName?>
407cutplane linecolor <r> <g> <b> <?dataSetName?>
408cutplane linewidth <width> <?dataSetName?>
409cutplane opacity <value> <?dataSetName?>
410cutplane orient <qw> <qx> <qy> <qz> <?dataSetName?>
411cutplane outline <bool> <?dataSetName?>
412         Toggle rendering of cutplane outlines
413cutplane pos <x> <y> <z> <?dataSetName?>
414cutplane preinterp <bool> <?dataSetName?>
415         Controls if VTK's InterpolateScalarsBeforeMapping option is set.
416         Setting this on will give more correct colors, as the interpolation
417         is done on texture coordinates that lookup into a 1D texture instead
418         of using color interpolation from triangle vertices.
419cutplane scale <sx> <sy> <sz> <?dataSetName?>
420cutplane slice axis ratio <?dataSetName?>
421         For 3D data, select a slice along a principle axis of the volume. The
422         ratio is [0,1]
423cutplane visible <bool> <?dataSetName?>
424cutplane wireframe <bool> <?datasetName?>
425
426cylinder add <radius> <height> <cap> <name>
427         <cap> = boolean flag for cap disks
428cylinder color <r> <g> <b> <?name?>
429cylinder culling <bool> <?name?>
430cylinder delete <?name?>
431cylinder edges <bool> <?name?>
432cylinder flipnorm <bool> <?name?>
433cylinder lighting <bool> <?name?>
434cylinder linecolor <r> <g> <b> <?name?>
435cylinder linewidth <val> <?name?>
436cylinder material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
437cylinder opacity <val> <?name?>
438cylinder orient <qw> <qx> <qy> <qz> <?name?>
439cylinder origin <x> <y> <z> <?name?>
440cylinder pos <x> <y> <z> <?name?>
441cylinder resolution <res> <?name?>
442cylinder scale <sx> <sy> <sz> <?name?>
443cylinder shading <val> <?name?>
444         val = flat|smooth
445cylinder visible <bool> <?name?>
446cylinder wireframe <bool> <?name?>
447
448disk add <innerRadius> <outerRadius> <name>
449disk color <r> <g> <b> <?name?>
450disk culling <bool> <?name?>
451disk delete <?name?>
452disk edges <bool> <?name?>
453disk flipnorm <bool> <?name?>
454disk lighting <bool> <?name?>
455disk linecolor <r> <g> <b> <?name?>
456disk linewidth <val> <?name?>
457disk material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
458disk opacity <val> <?name?>
459disk orient <qw> <qx> <qy> <qz> <?name?>
460disk origin <x> <y> <z> <?name?>
461disk pos <x> <y> <z> <?name?>
462disk resolution <resRadial> <resCircum> <?name?>
463disk scale <sx> <sy> <sz> <?name?>
464disk shading <val> <?name?>
465     val = flat|smooth
466disk visible <bool> <?name?>
467disk wireframe <bool> <?name?>
468
469glyphs add <shape> <?dataSetName?>
470       See 'glyphs shape' for list of shapes
471glyphs ccolor r g b <?datasetName?>
472glyphs colormap <colorMapName> <?dataSetName?>
473glyphs colormode <scalar|vmag|vx|vy|vz|ccolor> <fieldName> <?dataSetName?>
474       Set the color mode: color by scalar field or
475       vector magnitude -- uses the current color map,
476       or ccolor for constant color
477glyphs delete <?dataSetName?>
478glyphs edges <bool> <?datasetName?>
479glyphs gorient <bool> <fieldName> <?datasetName?>
480       Set the glyph orientation mode: orient glyphs by
481       a named vector field, or set to default orientation (off)
482glyphs gscale <scaleFactor> <?datasetName?>
483       Set glyph scaling factor
484glyphs lighting <bool> <?datasetName?>
485glyphs linecolor <r> <g> <b> <?datasetName?>
486glyphs linewidth <val> <?datasetName?>
487glyphs normscale <bool> <?datasetName?>
488       Control if data values are normalized to [0,1] range before applying
489       glyph scaling factor (gscale)
490glyphs opacity <val> <?datasetName?>
491glyphs orient <qw> <qx> <qy> <qz> <?dataSetName?>
492glyphs pos <x> <y> <z> <?dataSetName?>
493glyphs ptsize <size> <?dataSetName?>
494glyphs scale <sx> <sy> <sz> <?dataSetName?>
495glyphs shape <arrow|cone|cube|cylinder|dodecahedron|icosahedron|line|octahedron|point|sphere|tetrahedron> <?datasetName?>
496glyphs smode <scalar|vmag|vcomp|off> <fieldName> <?dataSetName?>
497       Set the scaling mode: use the scalar field, vector magnitude
498       (uniform scale), vector components, or disable scaling
499glyphs visible <bool> <?datasetName?>
500glyphs wireframe <bool> <?datasetName?>
501
502group add <nodeList> <name>
503group delete <?name?>
504group orient <qw> <qx> <qy> <qz> <?name?>
505group origin <x> <y> <z> <?name?>
506group pos <x> <y> <z> <?name?>
507group remove <nodeList> <name>
508group scale <sx> <sy> <sz> <?name?>
509group visible <bool> <?name?>
510
511heightmap add numcontours <n> <heightScale> <?dataSetName?>
512          Generate evenly spaced contours including range endpoints.  See also
513          'dataset maprange' command.
514heightmap add contourlist <list> <heightScale> <?dataSetName?>
515          list = {isoval1 isoval2 isoval3...}
516heightmap aspect <aspectRatio>
517          Set scaling by aspect ratio
518          <aspectRatio> = width/height or 0 for native aspect
519heightmap cloudstyle <style> <?datasetName?>
520          <style> = mesh | splat
521heightmap colormap <colorMapName> <?dataSetName?>
522heightmap colormode <scalar|vmag|vx|vy|vz|ccolor> <fieldName> <?datasetName?>
523          Set the field used to color the object.  'ccolor' means to use
524          the constant color defined by the ccolor subcommand.  'scalar' uses
525          the active scalar field.  'vmag' uses the magnitude of the current
526          vector field, and 'vx','vy','vz' use the corresponding component of
527          the active vector field.
528heightmap contourlist <list> <?dataSetName?>
529heightmap delete <?dataSetName?>
530heightmap edges <bool> <?dataSetName?>
531heightmap heightscale <value> <?dataSetName?>
532heightmap isolinecmap <bool> <?dataSetName?>
533          Toggle colormapping of isolines (false means to use constant color)
534heightmap isolinecolor <r> <g> <b> <?dataSetName?>
535heightmap isolines <bool> <?dataSetName?>
536heightmap isolinewidth <width> <?dataSetName?>
537heightmap lighting <bool> <?dataSetName?>
538heightmap linecolor <r> <g> <b> <?dataSetName?>
539heightmap linewidth <width> <?dataSetName?>
540heightmap numcontours <n> <?dataSetName?>
541heightmap opacity <value> <?dataSetName?>
542heightmap orient <qw> <qx> <qy> <qz> <?dataSetName?>
543heightmap pos <x> <y> <z> <?dataSetName?>
544heightmap preinterp <bool> <?dataSetName?>
545          Controls if VTK's InterpolateScalarsBeforeMapping option is set.
546          Setting this on will give more correct colors, as the interpolation
547          is done on texture coordinates that lookup into a 1D texture instead
548          of using color interpolation from triangle vertices.
549heightmap scale <sx> <sy> <sz> <?dataSetName?>
550heightmap slice <axis> <ratio> <?dataSetName?>
551          For 3D data, select a slice along a principle axis of the volume. The
552          ratio is [0,1]
553heightmap surface <bool> <?dataSetName?>
554          Toggle rendering of colormapped surface (mountain plot or cutplane)
555heightmap visible <bool> <?dataSetName?>
556heightmap wireframe <bool> <?datasetName?>
557
558lic add <?datasetName?>
559lic colormap <colormapName> <?datasetName?>
560lic delete <?datasetName?>
561lic edges <bool> <?datasetName?>
562lic lighting <bool> <?datasetName?>
563lic linecolor <r> <g> <b> <?datasetName?>
564lic linewidth <val> <?datasetName?>
565lic opacity <val> <?datasetName?>
566lic orient <qw> <qx> <qy> <qz> <?dataSetName?>
567lic pos <x> <y> <z> <?dataSetName?>
568lic preinterp <bool> <?dataSetName?>
569    Controls if VTK's InterpolateScalarsBeforeMapping option is set.
570    Setting this on will give more correct colors, as the interpolation
571    is done on texture coordinates that lookup into a 1D texture instead
572    of using color interpolation from triangle vertices.
573lic scale <sx> <sy> <sz> <?dataSetName?>
574lic slice <axis> <ratio> <?datasetName?>
575    For 3D data, select a slice along a principle axis of the volume. The
576    ratio is [0,1]
577lic visible <bool> <?datasetName?>
578
579line add <pt1X> <pt1Y> <pt1Z> <pt2X> <pt2Y> <pt2Z> <name>
580line color <r> <g> <b> <?name?>
581line delete <?name?>
582line linecolor <r> <g> <b> <?name?>
583     Synonym for color
584line linewidth <val> <?name?>
585line opacity <val> <?name?>
586line orient <qw> <qx> <qy> <qz> <?name?>
587line origin <x> <y> <z> <?name?>
588line pos <x> <y> <z> <?name?>
589line scale <sx> <sy> <sz> <?name?>
590line visible <bool> <?name?>
591
592molecule add <?datasetName?>
593molecule aquality <val> <?datasetName?>
594         Set atom sphere resolution quality val=[0,10], 1 is default
595molecule ascale <val> <?datasetName?>
596         Set atom scale factor
597molecule atoms <bool> <?datasetName?>
598         Toggle rendering of atoms
599molecule bcmode <by_elements|constant> <?datasetName?>
600         Set bond color mode
601molecule bcolor <r> <g> <b> <?datasetName?>
602         Set constant bond color
603molecule bonds <bool> <?datasetName?>
604         Toggle rendering of bonds
605molecule bquality <val> <?datasetName?>
606         Set bond cylinder resolution quality val=[0,10], 1 is default
607molecule bscale <val> <?datasetName?>
608         Set bond scale factor
609molecule bstyle <cylinder|line> <?datasetName?>
610         Set bond render style
611molecule ccolor r g b <?datasetName?>
612molecule colormap <colormapName> <?datasetName?>
613molecule colormode <by_elements|scalar|vmag|vx|vy|vz|ccolor> <fieldName> <?datasetName?>
614         Set the field used to color the object.  'ccolor' means to use
615         the constant color defined by the ccolor subcommand.  'scalar' uses
616         the active scalar field.  'vmag' uses the magnitude of the current
617         vector field, and 'vx','vy','vz' use the corresponding component of
618         the active vector field.
619molecule delete <?datasetName?>
620molecule edges <bool> <?datasetName?>
621molecule labels <bool> <?datasetName?>
622         Toggle display of atom labels
623molecule lfield <fieldName> <?datasetName?>
624         Set the field used for atom labels
625molecule lighting <bool> <?datasetName?>
626molecule linecolor <r> <g> <b> <?datasetName?>
627molecule linewidth <val> <?datasetName?>
628molecule opacity <val> <?datasetName?>
629molecule orient <qw> <qx> <qy> <qz> <?dataSetName?>
630molecule pos <x> <y> <z> <?dataSetName?>
631molecule rscale <val> <?dataSetName?>
632         Atom radius scaling
633         val = van_der_waals|covalent|atomic|none
634molecule scale <sx> <sy> <sz> <?dataSetName?>
635molecule visible <bool> <?datasetName?>
636molecule wireframe <bool> <?datasetName?>
637
638outline add <?datasetName?>
639outline color <r> <g> <b> <?datasetName?>
640outline delete <?datasetName?>
641outline linecolor <r> <g> <b> <?datasetName?>
642        Synonym for color
643outline linewidth <val> <?datasetName?>
644outline opacity <val> <?datasetName?>
645outline orient <qw> <qx> <qy> <qz> <?datasetName?>
646outline pos <x> <y> <z> <?datasetName?>
647outline scale <sx> <sy> <sz> <?datasetName?>
648outline visible <bool> <?datasetName?>
649
650polydata add <?datasetName?>
651polydata cloudstyle <style> <?datasetName?>
652         <style> = mesh | points
653polydata color <r> <g> <b> <?datasetName?>
654polydata culling <bool> <?name?>
655polydata delete <?datasetName?>
656polydata edges <bool> <?datasetName?>
657polydata lighting <bool> <?datasetName?>
658polydata linecolor <r> <g> <b> <?datasetName?>
659polydata linewidth <val> <?datasetName?>
660polydata material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp>
661polydata opacity <val> <?datasetName?>
662polydata orient <qw> <qx> <qy> <qz> <?dataSetName?>
663polydata origin <x> <y> <z> <?name?>
664polydata pos <x> <y> <z> <?dataSetName?>
665polydata ptsize <size> <?dataSetName?>
666polydata scale <sx> <sy> <sz> <?dataSetName?>
667polydata shading <val> <?name?>
668         val = flat|smooth
669polydata visible <bool> <?datasetName?>
670polydata wireframe <bool> <?datasetName?>
671
672polygon add <numSides> <centerX> <centerY> <centerZ> <normX> <normY> <normZ> <radius> <name>
673polygon color <r> <g> <b> <?name?>
674polygon culling <bool> <?name?>
675polygon delete <?name?>
676polygon edges <bool> <?name?>
677polygon flipnorm <bool> <?name?>
678polygon lighting <bool> <?name?>
679polygon linecolor <r> <g> <b> <?name?>
680polygon linewidth <val> <?name?>
681polygon material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
682polygon opacity <val> <?name?>
683polygon orient <qw> <qx> <qy> <qz> <?name?>
684polygon origin <x> <y> <z> <?name?>
685polygon pos <x> <y> <z> <?name?>
686polygon scale <sx> <sy> <sz> <?name?>
687polygon shading <val> <?name?>
688        val = flat|smooth
689polygon visible <bool> <?name?>
690polygon wireframe <bool> <?name?>
691
692pseudocolor add <?datasetName?>
693pseudocolor ccolor <r> <g> <b> <?datasetName?>
694pseudocolor cloudstyle <style> <?datasetName?>
695            <style> = mesh | points | splat
696pseudocolor colormap <colormapName> <?datasetName?>
697pseudocolor colormode <scalar|vmag|vx|vy|vz|ccolor> <fieldName> <?datasetName?>
698            Set the field used to color the object.  'ccolor' means to use
699            the constant color defined by the ccolor subcommand.  'scalar' uses
700            the active scalar field.  'vmag' uses the magnitude of the current
701            vector field, and 'vx','vy','vz' use the corresponding component of
702            the active vector field.
703pseudocolor delete <?datasetName?>
704pseudocolor edges <bool> <?datasetName?>
705pseudocolor lighting <bool> <?datasetName?>
706pseudocolor linecolor <r> <g> <b> <?datasetName?>
707pseudocolor linewidth <val> <?datasetName?>
708pseudocolor opacity <val> <?datasetName?>
709pseudocolor orient <qw> <qx> <qy> <qz> <?dataSetName?>
710pseudocolor pos <x> <y> <z> <?dataSetName?>
711pseudocolor preinterp <bool> <?dataSetName?>
712            Controls if VTK's InterpolateScalarsBeforeMapping option is set.
713            Setting this on will give more correct colors, as the interpolation
714            is done on texture coordinates that lookup into a 1D texture instead
715            of using color interpolation from triangle vertices.
716pseudocolor ptsize <size> <?dataSetName?>
717pseudocolor scale <sx> <sy> <sz> <?dataSetName?>
718pseudocolor visible <bool> <?datasetName?>
719pseudocolor wireframe <bool> <?datasetName?>
720
721sphere add <centerX> <centerY> <centerZ> <radius> <name>
722sphere color <r> <g> <b> <?name?>
723sphere culling <bool> <?name?>
724sphere delete <?name?>
725sphere edges <bool> <?name?>
726sphere flipnorm <bool> <?name?>
727sphere lighting <bool> <?name?>
728sphere linecolor <r> <g> <b> <?name?>
729sphere linewidth <val> <?name?>
730sphere material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
731sphere opacity <val> <?name?>
732sphere orient <qw> <qx> <qy> <qz> <?name?>
733sphere origin <x> <y> <z> <?name?>
734sphere pos <x> <y> <z> <?name?>
735sphere resolution <thetaRes> <phiRes> <?name?>
736sphere scale <sx> <sy> <sz> <?name?>
737sphere section <thetaStart> <thetaEnd> <phiStart> <phiEnd> <?name?>
738       Angles are in degrees
739sphere shading <val> <?name?>
740       val = flat|smooth
741sphere visible <bool> <?name?>
742sphere wireframe <bool> <?name?>
743
744streamlines add <?datasetName?>
745streamlines ccolor <r> <g> <b> <?datasetName?>
746            Set the constant color of streamlines used for color mode 'ccolor'
747streamlines colormap <colormapName> <?datasetName?>
748            Colormap used to color streamlines/tubes/ribbons by vector magnitude
749streamlines colormode <scalar|vmag|vx|vy|vz|ccolor> <fieldName> <?datasetName?>
750            Set the field used to color the streamlines.  'ccolor' means to use
751            the constant color defined by the ccolor subcommand.  'scalar' uses
752            the active scalar field.  'vmag' uses the magnitude of the current
753            vector field, and 'vx','vy','vz' use the corresponding component of
754            the active vector field.
755streamlines delete <?datasetName?>
756streamlines edges <bool> <?datasetName?>
757            Turn on/off edges for tubes, ribbons
758streamlines length <?datasetName?>
759            Set maximum length in world coordinates of streamlines
760streamlines lighting <bool> <?datasetName?>
761streamlines linecolor <r> <g> <b> <?datasetName?>
762            Set color of edges for tubes, ribbons (lines are colored by
763            colormap)
764streamlines lines <?datasetName?>
765            Set rendering type to polylines
766streamlines linewidth <val> <?datasetName?>
767streamlines opacity <val> <?datasetName?>
768streamlines orient <qw> <qx> <qy> <qz> <?dataSetName?>
769streamlines pos <x> <y> <z> <?dataSetName?>
770streamlines ribbons <width> <angle> <?datasetName?>
771            Set rendering type to ribbons, width is minimum half-width, angle is
772            degrees offset from normal orientation
773streamlines scale <sx> <sy> <sz> <?dataSetName?>
774streamlines seed color <r> <g> <b> <?datasetName?>
775streamlines seed disk <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <radius> <innerRadius> <numPoints> <?dataSetName?>
776            Create a disk seed area with optional hole, filled with randomly
777            placed points
778streamlines seed fmesh <numPoints> data follows <nbytes> <?datasetName?>
779            Fill a mesh supplied as a VTK data file with randomly placed points
780streamlines seed fpoly <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <angle> <radius> <numSides> <numPoints> <?dataSetName?>
781            Create a regular n-sided polygonal seed area filled with randomly
782            placed points
783streamlines seed mesh data follows <nbytes> <?datasetName?>
784            Use points of a mesh supplied as a VTK data file
785streamlines seed numpts <?datasetName?>
786            If seeds have been created using 'seed random', 'seed fmesh',
787            'seed mesh' or 'seed points' this command can be used to change the
788            number of randomly distributed seeds.  In the case of 'seed mesh'
789            or 'seed points', the number is the maximum number of points of the
790            mesh to be used -- the actual number may be fewer if the mesh
791            contains fewer points.  Set to a number less than 0 to use all the
792            points of the mesh.
793streamlines seed points <?datasetName?>
794            Use points of the streamlines' dataset mesh
795streamlines seed polygon <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <angle> <radius> <numSides> <?dataSetName?>
796            Create seed points from vertices of a regular n-sided polygon
797streamlines seed ptsize <size> <?datasetName?>
798            Set the point size for rendering seed points
799streamlines seed rake <startX> <startY> <startZ> <endX> <endY> <endZ> <numPoints> <?datasetName?>
800streamlines seed random <numPoints> <?datasetName?>
801            Fill the streamlines' dataset mesh with randomly placed points
802streamlines seed visible <bool> <?datasetName?>
803streamlines tubes <numSides> <radius> <?datasetName?>
804            Set rendering type to tubes, numSides is number of sides of tubes,
805            radius is minimum tube radius
806streamlines visible <bool> <?datasetName?>
807
808volume add <?datasetName?>
809volume colormap <colorMapName> <?datasetName?>
810volume delete <?datasetName?>
811volume lighting <bool> <?datasetName?>
812volume orient <qw> <qx> <qy> <qz> <?dataSetName?>
813volume pos <x> <y> <z> <?dataSetName?>
814volume quality <val> <?datasetName?>
815       val = [0,1]
816volume scale <sx> <sy> <sz> <?dataSetName?>
817volume shading ambient <coeff> <?datasetName?>
818volume shading diffuse <coeff> <?datasetName?>
819volume shading specular <coeff> <power> <?datasetName?>
820volume visible <bool> <?datasetName?>
821
822warp add <?dataSetName?>
823warp ccolor <r> <g> <b> <?datasetName?>
824warp cloudstyle <style> <?datasetName?>
825     <style> = mesh | points
826warp colormap <colormapName> <?datasetName?>
827warp colormode <scalar|vmag|vx|vy|vz|ccolor> <fieldName> <?datasetName?>
828     Set the field used to color the object.  'ccolor' means to use
829     the constant color defined by the ccolor subcommand.  'scalar' uses
830     the active scalar field.  'vmag' uses the magnitude of the current
831     vector field, and 'vx','vy','vz' use the corresponding component of
832     the active vector field.
833warp delete <?dataSetName?>
834warp edges <bool> <?dataSetName?>
835warp lighting <bool> <?dataSetName?>
836warp linecolor <r> <g> <b> <?dataSetName?>
837warp linewidth <width> <?dataSetName?>
838warp opacity <value> <?dataSetName?>
839warp orient <qw> <qx> <qy> <qz> <?dataSetName?>
840warp ptsize <size> <?dataSetName?>
841warp pos <x> <y> <z> <?dataSetName?>
842warp preinterp <bool> <?dataSetName?>
843     Controls if VTK's InterpolateScalarsBeforeMapping option is set.
844     Setting this on will give more correct colors, as the interpolation
845     is done on texture coordinates that lookup into a 1D texture instead
846     of using color interpolation from triangle vertices.
847warp scale <sx> <sy> <sz> <?dataSetName?>
848warp visible <bool> <?dataSetName?>
849warp warpscale <value> <?dataSetName?>
850     Specify amount to scale vector magnitudes when warping
851warp wireframe <bool> <?datasetName?>
852
853================================================================================
854Replies:
855================================================================================
856nv>camera set <posX> <posY> <posZ> <focalPtX> <focalPtY> <focalPtZ> <viewUpX> <viewUpY> <viewUpZ>
857   Reply to "camera get"
858nv>image -type image -bytes <nbytes>
859  <binary RGB data>
860nv>image -type image -bbox {x y w h} -bytes <nbytes>
861  <binary RGB data>
862  The bounding box of the 2D image camera zoom region is supplied
863  Note: The bbox coordinates are in the form used by 'camera ortho world ...':
864  x,y - world coord. of lower left corner, w,h - width height in world coords
865  This form is currently used only if the camera mode is set to 'image'.
866nv>legend <colormapName> <title> <rmin> <rmax> <nbytes>
867  <binary RGB data>
868nv>dataset names <Tcl list of names>
869nv>dataset scalar world <x> <y> <z> <value> <dataSetName>
870nv>dataset scalar pixel <x> <y> <value> <dataSetName>
871nv>dataset vector world <x> <y> <z> <valueX> <valueY> <valueZ> <dataSetName>
872nv>dataset vector pixel <x> <y> <valueX> <valueY> <valueZ> <dataSetName>
873nv>ok -token <seqnum>
874   Reply indicated commands through <seqnum> (numbered beginning at 1) have been
875   processed, but no new image was rendered
876================================================================================
877Error Replies:
878================================================================================
879nv>viserror -bytes <nbytes>
880   <multi-line error string of nbytes>
881================================================================================
Note: See TracBrowser for help on using the repository browser.