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

Last change on this file since 2575 was 2575, checked in by ldelgass, 13 years ago

cutplane now controls 3 axis aligned cutplanes. Add some comments to new
classes.
  • Property svn:eol-style set to native
File size: 17.6 KB
Line 
1================================================================================
2On connection, send 32-bit little endian int indicating memory requirements
3(comsumed by nanoscale server before exec-ing vtkvis)
4================================================================================
5Requests:
6
7screen bgcolor <r> <g> <b>
8screen size <width> <height>
9
10renderer clipplane <axis> <ratio> <direction>
11         Set a user clipping plane, ratio is [0,1] and is always interpreted as
12         0 = min_bound, 1 = max_bound, regardless of direction.  Sign of
13         direction determines normal of clipping plane.  User clip planes do not
14         apply if camera mode is image.
15renderer depthpeel <bool>
16         Set use of depth peeling algorithm for transparency
17renderer light2side <bool>
18         Toggle use of two-sided lighting (controls if backfaces are lit with a
19         flipped normal)
20renderer render
21         Force a new image to be rendered - use for advancing animation
22
23axis color <r> <g> <b>
24     Set color of axis lines, labels, titles, ticks
25axis flymode <mode>
26     <mode> = static_edges|static_triad|outer_edges|furthest_triad|closest_triad
27axis grid <bool>
28axis labels <axis> <bool>
29     Toggle visibility of axis labels
30     <axis> = x|y|z|all
31axis name <axis> <title>
32axis tickpos <position>
33     Set position of ticks on 3D axes (not implemented for 2D axes)
34     <position> = inside|outside|both
35axis ticks <axis> <bool>
36     Toggle visibility of axis tick marks
37     <axis> = x|y|z|all
38axis units <axis> <units>
39     Currently only supported when camera mode is not image mode
40axis visible <axis> <bool>
41     <axis> = x|y|z|all
42     Note: 'all' means all enabled axes.  To force all axes on, set each axis on
43     individually -- however, it is best to let the server determine which of
44     the individual axes are enabled based on the dataset bounds.
45
46camera get
47       Request current camera parameters
48camera mode <mode>
49       <mode> = persp|ortho|image
50camera orient <quatW> <quatX> <quatY> <quatZ>
51       Set scene orientation using a quaternion
52camera ortho <coordMode> <x> <y> <width> <height>
53       <coordMode> = pixel|world
54       Supply bounds of plot area for image camera mode
55camera pan <x> <y>
56       <x,y> viewport coordinates (window center at 0,0).  Positive x pan
57       means pan object to right (camera to left).  Positive y pan means
58       pan object down (camera up).  For example a pan of 0.5, 0.5 would
59       move the object center to the lower right corner of the window
60camera reset <?all?>
61       Option all resets orientation/rotation as well as pan/zoom/clip range
62camera rotate <yaw> <pitch> <roll>
63       Specify relative rotation in Euler angles
64camera set <posX> <posY> <posZ> <focalPtX> <focalPtY> <focalPtZ> <viewUpX> <viewUpY> <viewUpZ>
65       Set camera parameters: camera position, focal point and view up vector
66camera zoom <z>
67       Specify zoom ratio.  z > 1 is a zoom in, z < 1 is zoom out. z = 1
68       resets to default.
69
70colormap add <colorMapName> <colorMap> <opacityMap>
71         colorMap = Tcl list of {value r g b} control points
72         opacityMap = Tcl list of {value alpha} control points
73colormap delete <?colorMapName?>
74
75legend <colormapName> <legendType> <legendTitle> <width> <height> <numLabels> <?datasetName?>
76       Causes legend to be rendered and written back with labels and title
77       (title may be left blank)
78       <legendType> = scalar|vmag|vx|vy|vz
79       <numLabels> Can be zero or more 'tick' value labels
80       If datasetName is omitted, the cumulative data range of all data sets
81       will be used to label the legend -- otherwise, the current setting of
82       'dataset maprange' will be used to determine if the individual dataset
83       range or cumulative range will be used.
84
85dataset add <datasetName> data follows <nbytes>
86dataset color <r> <g> <b> <?datasetName?>
87        Set color of outline bounding box
88dataset delete <?datasetName?>
89dataset getscalar world <x> <y> <z> <datasetName>
90dataset getscalar pixel <x> <y> <datasetName>
91dataset getvector world <x> <y> <z> <datasetName>
92dataset getvector pixel <x> <y> <datasetName>
93        Use pixel for image camera mode
94dataset maprange <val>
95        <val> = all|visible|separate
96        Controls if data range for colormapping and contours is based on
97        cumulative range of all datasets ("all"), only visible datasets
98        ("visible") or each individual dataset ("separate").  Defaults to
99        "all"
100dataset opacity <val> <?datasetName?>
101dataset outline <bool> <?datasetName?>
102        Toggle wireframe outline of dataset's bounding box
103dataset scalar <scalarName> <?datasetName?>
104        Set the active scalar field to plot
105dataset vector <vectorName> <?datasetName?>
106        Set the active vector field to plot
107dataset visible <bool> <?datasetName?>
108
109contour2d add numcontours <n> <?datasetName?>
110          Generate evenly spaced contours including range endpoints.  See also
111          'dataset maprange' command.
112contour2d add contourlist <list> <?datasetName?>
113          list = {isoval1 isoval2 isoval3...}
114contour2d color <r> <g> <b> <?datasetName?>
115          synonym for linecolor
116contour2d delete <?datasetName?>
117contour2d lighting <bool> <?datasetName?>
118contour2d linecolor <r> <g> <b> <?datasetName?>
119          synonym for color
120contour2d linewidth <val> <?datasetName?>
121contour2d opacity <val> <?datasetName?>
122contour2d orient <qw> <qx> <qy> <qz> <?dataSetName?>
123contour2d pos <x> <y> <z> <?dataSetName?>
124contour2d scale <sx> <sy> <sz> <?dataSetName?>
125contour2d visible <bool> <?datasetName?>
126
127contour3d add numcontours <n> <?datasetName?>
128          Generate evenly spaced contours including range endpoints.  See also
129          'dataset maprange' command.
130contour3d add contourlist <list> <?datasetName?>
131          list = {isoval1 isoval2 isoval3...}
132contour3d ccolor r g b <?datasetName?>
133contour3d colormap <colorMapName> <?dataSetName?>
134contour3d delete <?datasetName?>
135contour3d edges <bool> <?datasetName?>
136contour3d lighting <bool> <?datasetName?>
137contour3d linecolor <r> <g> <b> <?datasetName?>
138contour3d linewidth <val> <?datasetName?>
139contour3d opacity <val> <?datasetName?>
140contour3d orient <qw> <qx> <qy> <qz> <?dataSetName?>
141contour3d pos <x> <y> <z> <?dataSetName?>
142contour3d scale <sx> <sy> <sz> <?dataSetName?>
143contour3d visible <bool> <?datasetName?>
144contour3d wireframe <bool> <?datasetName?>
145
146cutplane add <?dataSetName?>
147cutplane axis <axis> <bool> <?dataSetName?>
148         Toggle visibility of the 3 principal axis cutplanes
149cutplane colormap <colorMapName> <?dataSetName?>
150cutplane colormode <scalar|vmag|vx|vy|vz> <?datasetName?>
151         Set the field used to color the object.  'scalar' uses
152         the active scalar field.  'vmag' uses the magnitude of the current
153         vector field, and 'vx','vy','vz' use the corresponding component of
154         the active vector field.
155cutplane delete <?dataSetName?>
156cutplane edges <bool> <?dataSetName?>
157cutplane lighting <bool> <?dataSetName?>
158cutplane linecolor <r> <g> <b> <?dataSetName?>
159cutplane linewidth <width> <?dataSetName?>
160cutplane opacity <value> <?dataSetName?>
161cutplane orient <qw> <qx> <qy> <qz> <?dataSetName?>
162cutplane pos <x> <y> <z> <?dataSetName?>
163cutplane scale <sx> <sy> <sz> <?dataSetName?>
164cutplane slice axis ratio <?dataSetName?>
165         For 3D data, select a slice along a principle axis of the volume. The
166         ratio is [0,1]
167cutplane visible <bool> <?dataSetName?>
168cutplane wireframe <bool> <?datasetName?>
169
170glyphs add <shape> <?dataSetName?>
171       See 'glyphs shape' for list of shapes
172glyphs ccolor r g b <?datasetName?>
173glyphs colormap <colorMapName> <?dataSetName?>
174glyphs colormode <scalar|vmag|ccolor> <?dataSetName?>
175       Set the color mode: color by scalar field or
176       vector magnitude -- uses the current color map,
177       or ccolor for constant color
178glyphs delete <?dataSetName?>
179glyphs edges <bool> <?datasetName?>
180glyphs gscale <scaleFactor> <?datasetName?>
181       Set glyph scaling factor
182glyphs lighting <bool> <?datasetName?>
183glyphs linecolor <r> <g> <b> <?datasetName?>
184glyphs linewidth <val> <?datasetName?>
185glyphs normscale <bool> <?datasetName?>
186       Control if data values are normalized to [0,1] range before applying
187       glyph scaling factor (gscale)
188glyphs opacity <val> <?datasetName?>
189glyphs orient <qw> <qx> <qy> <qz> <?dataSetName?>
190glyphs pos <x> <y> <z> <?dataSetName?>
191glyphs scale <sx> <sy> <sz> <?dataSetName?>
192glyphs shape <arrow|cone|cube|cylinder|dodecahedron|icosahedron|line|octahedron|sphere|tetrahedron> <?datasetName?>
193glyphs smode <scalar|vmag|vcomp|off> <?dataSetName?>
194       Set the scaling mode: use the scalar field, vector magnitude
195       (uniform scale), vector components, or disable scaling
196glyphs visible <bool> <?datasetName?>
197glyphs wireframe <bool> <?datasetName?>
198
199heightmap add numcontours <n> <heightScale> <?dataSetName?>
200          Generate evenly spaced contours including range endpoints.  See also
201          'dataset maprange' command.
202heightmap add contourlist <list> <heightScale> <?dataSetName?>
203          list = {isoval1 isoval2 isoval3...}
204heightmap colormap <colorMapName> <?dataSetName?>
205heightmap contourlist <list> <?dataSetName?>
206heightmap delete <?dataSetName?>
207heightmap edges <bool> <?dataSetName?>
208heightmap heightscale <value> <?dataSetName?>
209heightmap isolinecolor <r> <g> <b> <?dataSetName?>
210heightmap isolines <bool> <?dataSetName?>
211heightmap isolinewidth <width> <?dataSetName?>
212heightmap lighting <bool> <?dataSetName?>
213heightmap linecolor <r> <g> <b> <?dataSetName?>
214heightmap linewidth <width> <?dataSetName?>
215heightmap numcontours <n> <?dataSetName?>
216heightmap opacity <value> <?dataSetName?>
217heightmap orient <qw> <qx> <qy> <qz> <?dataSetName?>
218heightmap pos <x> <y> <z> <?dataSetName?>
219heightmap scale <sx> <sy> <sz> <?dataSetName?>
220heightmap slice axis ratio <?dataSetName?>
221          For 3D data, select a slice along a principle axis of the volume. The
222          ratio is [0,1]
223heightmap surface <bool> <?dataSetName?>
224          Toggle rendering of colormapped surface (mountain plot or cutplane)
225heightmap visible <bool> <?dataSetName?>
226heightmap wireframe <bool> <?datasetName?>
227
228lic add <?datasetName?>
229lic colormap <colormapName> <?datasetName?>
230lic delete <?datasetName?>
231lic edges <bool> <?datasetName?>
232lic lighting <bool> <?datasetName?>
233lic linecolor <r> <g> <b> <?datasetName?>
234lic linewidth <val> <?datasetName?>
235lic opacity <val> <?datasetName?>
236lic orient <qw> <qx> <qy> <qz> <?dataSetName?>
237lic pos <x> <y> <z> <?dataSetName?>
238lic scale <sx> <sy> <sz> <?dataSetName?>
239lic slice <axis> <ratio> <?datasetName?>
240    For 3D data, select a slice along a principle axis of the volume. The
241    ratio is [0,1]
242lic visible <bool> <?datasetName?>
243
244molecule add <?datasetName?>
245molecule atoms <bool> <?datasetName?>
246         Toggle rendering of atoms
247molecule bonds <bool> <?datasetName?>
248         Toggle rendering of bonds
249molecule colormap <colormapName> <?datasetName?>
250molecule delete <?datasetName?>
251molecule edges <bool> <?datasetName?>
252molecule lighting <bool> <?datasetName?>
253molecule linecolor <r> <g> <b> <?datasetName?>
254molecule linewidth <val> <?datasetName?>
255molecule opacity <val> <?datasetName?>
256molecule orient <qw> <qx> <qy> <qz> <?dataSetName?>
257molecule pos <x> <y> <z> <?dataSetName?>
258molecule rscale <val> <?dataSetName?>
259         Atom radius scaling
260         val = van_der_walls|covalent|atomic|none
261molecule scale <sx> <sy> <sz> <?dataSetName?>
262molecule visible <bool> <?datasetName?>
263molecule wireframe <bool> <?datasetName?>
264
265polydata add <?datasetName?>
266polydata color <r> <g> <b> <?datasetName?>
267polydata delete <?datasetName?>
268polydata edges <bool> <?datasetName?>
269polydata lighting <bool> <?datasetName?>
270polydata linecolor <r> <g> <b> <?datasetName?>
271polydata linewidth <val> <?datasetName?>
272polydata opacity <val> <?datasetName?>
273polydata orient <qw> <qx> <qy> <qz> <?dataSetName?>
274polydata pos <x> <y> <z> <?dataSetName?>
275polydata ptsize <size> <?dataSetName?>
276polydata scale <sx> <sy> <sz> <?dataSetName?>
277polydata visible <bool> <?datasetName?>
278polydata wireframe <bool> <?datasetName?>
279
280pseudocolor add <?datasetName?>
281pseudocolor ccolor r g b <?datasetName?>
282pseudocolor colormap <colormapName> <?datasetName?>
283pseudocolor colormode <scalar|vmag|vx|vy|vz|ccolor> <?datasetName?>
284            Set the field used to color the object.  'ccolor' means to use
285            the constant color defined by the ccolor subcommand.  'scalar' uses
286            the active scalar field.  'vmag' uses the magnitude of the current
287            vector field, and 'vx','vy','vz' use the corresponding component of
288            the active vector field.
289pseudocolor delete <?datasetName?>
290pseudocolor edges <bool> <?datasetName?>
291pseudocolor lighting <bool> <?datasetName?>
292pseudocolor linecolor <r> <g> <b> <?datasetName?>
293pseudocolor linewidth <val> <?datasetName?>
294pseudocolor opacity <val> <?datasetName?>
295pseudocolor orient <qw> <qx> <qy> <qz> <?dataSetName?>
296pseudocolor pos <x> <y> <z> <?dataSetName?>
297pseudocolor scale <sx> <sy> <sz> <?dataSetName?>
298pseudocolor visible <bool> <?datasetName?>
299pseudocolor wireframe <bool> <?datasetName?>
300
301streamlines add <?datasetName?>
302streamlines ccolor <r> <g> <b> <?datasetName?>
303            Set the constant color of streamlines used for color mode 'ccolor'
304streamlines colormap <colormapName> <?datasetName?>
305            Colormap used to color streamlines/tubes/ribbons by vector magnitude
306streamlines colormode <scalar|vmag|vx|vy|vz|ccolor> <?datasetName?>
307            Set the field used to color the streamlines.  'ccolor' means to use
308            the constant color defined by the ccolor subcommand.  'scalar' uses
309            the active scalar field.  'vmag' uses the magnitude of the current
310            vector field, and 'vx','vy','vz' use the corresponding component of
311            the active vector field.
312streamlines delete <?datasetName?>
313streamlines edges <bool> <?datasetName?>
314            Turn on/off edges for tubes, ribbons
315streamlines length <?datasetName?>
316            Set maximum length in world coordinates of streamlines
317streamlines lighting <bool> <?datasetName?>
318streamlines linecolor <r> <g> <b> <?datasetName?>
319            Set color of edges for tubes, ribbons (lines are colored by colormap)
320streamlines lines <?datasetName?>
321            Set rendering type to polylines
322streamlines linewidth <val> <?datasetName?>
323streamlines opacity <val> <?datasetName?>
324streamlines orient <qw> <qx> <qy> <qz> <?dataSetName?>
325streamlines pos <x> <y> <z> <?dataSetName?>
326streamlines ribbons <width> <angle> <?datasetName?>
327            Set rendering type to ribbons, width is minimum half-width, angle is
328            degrees offset from normal orientation
329streamlines scale <sx> <sy> <sz> <?dataSetName?>
330streamlines seed color <r> <g> <b> <?datasetName?>
331streamlines seed disk <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <radius> <innerRadius> <numPoints> <?dataSetName?>
332            Create a disk seed area with optional hole, filled with randomly
333            placed points
334streamlines seed fmesh <numPoints> data follows <nbytes> <?datasetName?>
335            Fill a mesh supplied as a VTK data file with randomly placed points
336streamlines seed fpoly <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <angle> <radius> <numSides> <numPoints> <?dataSetName?>
337            Create a regular n-sided polygonal seed area filled with randomly
338            placed points
339streamlines seed mesh data follows <nbytes> <?datasetName?>
340            Use points of a mesh supplied as a VTK data file
341streamlines seed points <?datasetName?>
342            Use points of the streamlines' dataset mesh
343streamlines seed polygon <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <angle> <radius> <numSides> <?dataSetName?>
344            Create seed points from vertices of a regular n-sided polygon
345streamlines seed rake <startX> <startY> <startZ> <endX> <endY> <endZ> <numPoints> <?datasetName?>
346streamlines seed random <numPoints> <?datasetName?>
347            Fill the streamlines' dataset mesh with randomly placed points
348streamlines seed visible <bool> <?datasetName?>
349streamlines tubes <numSides> <radius> <?datasetName?>
350            Set rendering type to tubes, numSides is number of sides of tubes,
351            radius is minimum tube radius
352streamlines visible <bool> <?datasetName?>
353
354volume add <?datasetName?>
355volume colormap <colorMapName> <?datasetName?>
356volume delete <?datasetName?>
357volume lighting <bool> <?datasetName?>
358volume orient <qw> <qx> <qy> <qz> <?dataSetName?>
359volume pos <x> <y> <z> <?dataSetName?>
360volume scale <sx> <sy> <sz> <?dataSetName?>
361volume shading ambient <coeff> <?datasetName?>
362volume shading diffuse <coeff> <?datasetName?>
363volume shading specular <coeff> <power> <?datasetName?>
364volume visible <bool> <?datasetName?>
365
366================================================================================
367Replies:
368
369nv>camera set <posX> <posY> <posZ> <focalPtX> <focalPtY> <focalPtZ> <viewUpX> <viewUpY> <viewUpZ>
370   Reply to "camera get"
371nv>image -type image -bytes <nbytes>
372  <binary RGB data>
373nv>image -type image -bbox {x y w h} -bytes <nbytes>
374  <binary RGB data>
375  The bounding box of the 2D image camera zoom region is supplied
376  Note: The bbox coordinates are in the form used by 'camera ortho world ...':
377  x,y - world coordinate of lower left corner, w,h - width height in world coords
378  This form is currently used only if the camera mode is set to 'image'.
379nv>legend <colormapName> <title> <rmin> <rmax> <nbytes>
380  <binary RGB data>
381nv>dataset scalar world <x> <y> <z> <value> <dataSetName>
382nv>dataset scalar pixel <x> <y> <value> <dataSetName>
383nv>dataset vector world <x> <y> <z> <valueX> <valueY> <valueZ> <dataSetName>
384nv>dataset vector pixel <x> <y> <valueX> <valueY> <valueZ> <dataSetName>
385
386================================================================================
387Errors:
388
389Prefixed with "VtkVis Server Error: "
390Currently not guaranteed to be on a single line
Note: See TracBrowser for help on using the repository browser.