source: branches/blt4/packages/vizservers/vtkvis/protocol.txt @ 2542

Last change on this file since 2542 was 2542, checked in by gah, 13 years ago

update from trunk
File size: 15.9 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
146glyphs add <?dataSetName?>
147glyphs ccolor r g b <?datasetName?>
148glyphs colormap <colorMapName> <?dataSetName?>
149glyphs colormode <scalar|vmag|ccolor> <?dataSetName?>
150       Set the color mode: color by scalar field or
151       vector magnitude -- uses the current color map,
152       or ccolor for constant color
153glyphs delete <?dataSetName?>
154glyphs edges <bool> <?datasetName?>
155glyphs gscale <scaleFactor> <?datasetName?>
156       Set glyph scaling factor
157glyphs lighting <bool> <?datasetName?>
158glyphs linecolor <r> <g> <b> <?datasetName?>
159glyphs linewidth <val> <?datasetName?>
160glyphs normscale <bool> <?datasetName?>
161       Control if data values are normalized to [0,1] range before applying
162       glyph scaling factor (gscale)
163glyphs opacity <val> <?datasetName?>
164glyphs orient <qw> <qx> <qy> <qz> <?dataSetName?>
165glyphs pos <x> <y> <z> <?dataSetName?>
166glyphs scale <sx> <sy> <sz> <?dataSetName?>
167glyphs shape <arrow|cone|cube|cylinder|dodecahedron|icosahedron|line|octahedron|sphere|tetrahedron> <?datasetName?>
168glyphs smode <scalar|vmag|vcomp|off> <?dataSetName?>
169       Set the scaling mode: use the scalar field, vector magnitude
170       (uniform scale), vector components, or disable scaling
171glyphs visible <bool> <?datasetName?>
172glyphs wireframe <bool> <?datasetName?>
173
174heightmap add numcontours <n> <heightScale> <?dataSetName?>
175          Generate evenly spaced contours including range endpoints.  See also
176          'dataset maprange' command.
177heightmap add contourlist <list> <heightScale> <?dataSetName?>
178          list = {isoval1 isoval2 isoval3...}
179heightmap colormap <colorMapName> <?dataSetName?>
180heightmap contourlist <list> <?dataSetName?>
181heightmap delete <?dataSetName?>
182heightmap edges <bool> <?dataSetName?>
183heightmap heightscale <value> <?dataSetName?>
184heightmap isolinecolor <r> <g> <b> <?dataSetName?>
185heightmap isolines <bool> <?dataSetName?>
186heightmap isolinewidth <width> <?dataSetName?>
187heightmap lighting <bool> <?dataSetName?>
188heightmap linecolor <r> <g> <b> <?dataSetName?>
189heightmap linewidth <width> <?dataSetName?>
190heightmap numcontours <n> <?dataSetName?>
191heightmap opacity <value> <?dataSetName?>
192heightmap orient <qw> <qx> <qy> <qz> <?dataSetName?>
193heightmap pos <x> <y> <z> <?dataSetName?>
194heightmap scale <sx> <sy> <sz> <?dataSetName?>
195heightmap surface <bool> <?dataSetName?>
196          Toggle rendering of colormapped surface (mountain plot or cutplane)
197heightmap visible <bool> <?dataSetName?>
198heightmap volumeslice axis ratio <?dataSetName?>
199          For 3D data, select a slice along a principle axis of the volume. The
200          ratio is [0,1]
201heightmap wireframe <bool> <?datasetName?>
202
203lic add <?datasetName?>
204lic colormap <colormapName> <?datasetName?>
205lic delete <?datasetName?>
206lic edges <bool> <?datasetName?>
207lic lighting <bool> <?datasetName?>
208lic linecolor <r> <g> <b> <?datasetName?>
209lic linewidth <val> <?datasetName?>
210lic opacity <val> <?datasetName?>
211lic orient <qw> <qx> <qy> <qz> <?dataSetName?>
212lic pos <x> <y> <z> <?dataSetName?>
213lic scale <sx> <sy> <sz> <?dataSetName?>
214lic visible <bool> <?datasetName?>
215lic volumeslice <axis> <ratio> <?datasetName?>
216
217molecule add <?datasetName?>
218molecule atoms <bool> <?datasetName?>
219         Toggle rendering of atoms
220molecule bonds <bool> <?datasetName?>
221         Toggle rendering of bonds
222molecule colormap <colormapName> <?datasetName?>
223molecule delete <?datasetName?>
224molecule edges <bool> <?datasetName?>
225molecule lighting <bool> <?datasetName?>
226molecule linecolor <r> <g> <b> <?datasetName?>
227molecule linewidth <val> <?datasetName?>
228molecule opacity <val> <?datasetName?>
229molecule orient <qw> <qx> <qy> <qz> <?dataSetName?>
230molecule pos <x> <y> <z> <?dataSetName?>
231molecule rscale <val> <?dataSetName?>
232         Atom radius scaling
233         val = van_der_walls|covalent|atomic|none
234molecule scale <sx> <sy> <sz> <?dataSetName?>
235molecule visible <bool> <?datasetName?>
236molecule wireframe <bool> <?datasetName?>
237
238polydata add <?datasetName?>
239polydata color <r> <g> <b> <?datasetName?>
240polydata delete <?datasetName?>
241polydata edges <bool> <?datasetName?>
242polydata lighting <bool> <?datasetName?>
243polydata linecolor <r> <g> <b> <?datasetName?>
244polydata linewidth <val> <?datasetName?>
245polydata opacity <val> <?datasetName?>
246polydata orient <qw> <qx> <qy> <qz> <?dataSetName?>
247polydata pos <x> <y> <z> <?dataSetName?>
248polydata ptsize <size> <?dataSetName?>
249polydata scale <sx> <sy> <sz> <?dataSetName?>
250polydata visible <bool> <?datasetName?>
251polydata wireframe <bool> <?datasetName?>
252
253pseudocolor add <?datasetName?>
254pseudocolor ccolor r g b <?datasetName?>
255pseudocolor colormap <colormapName> <?datasetName?>
256pseudocolor colormode <scalar|vmag|vx|vy|vz|ccolor> <?datasetName?>
257            Set the field used to color the object.  'ccolor' means to use
258            the constant color defined by the ccolor subcommand.  'scalar' uses
259            the active scalar field.  'vmag' uses the magnitude of the current
260            vector field, and 'vx','vy','vz' use the corresponding component of
261            the active vector field.
262pseudocolor delete <?datasetName?>
263pseudocolor edges <bool> <?datasetName?>
264pseudocolor lighting <bool> <?datasetName?>
265pseudocolor linecolor <r> <g> <b> <?datasetName?>
266pseudocolor linewidth <val> <?datasetName?>
267pseudocolor opacity <val> <?datasetName?>
268pseudocolor orient <qw> <qx> <qy> <qz> <?dataSetName?>
269pseudocolor pos <x> <y> <z> <?dataSetName?>
270pseudocolor scale <sx> <sy> <sz> <?dataSetName?>
271pseudocolor visible <bool> <?datasetName?>
272pseudocolor wireframe <bool> <?datasetName?>
273
274streamlines add <?datasetName?>
275streamlines ccolor <r> <g> <b> <?datasetName?>
276            Set the constant color of streamlines used for color mode 'ccolor'
277streamlines colormap <colormapName> <?datasetName?>
278            Colormap used to color streamlines/tubes/ribbons by vector magnitude
279streamlines colormode <scalar|vmag|vx|vy|vz|ccolor> <?datasetName?>
280            Set the field used to color the streamlines.  'ccolor' means to use
281            the constant color defined by the ccolor subcommand.  'scalar' uses
282            the active scalar field.  'vmag' uses the magnitude of the current
283            vector field, and 'vx','vy','vz' use the corresponding component of
284            the active vector field.
285streamlines delete <?datasetName?>
286streamlines edges <bool> <?datasetName?>
287            Turn on/off edges for tubes, ribbons
288streamlines length <?datasetName?>
289            Set maximum length in world coordinates of streamlines
290streamlines lighting <bool> <?datasetName?>
291streamlines linecolor <r> <g> <b> <?datasetName?>
292            Set color of edges for tubes, ribbons (lines are colored by colormap)
293streamlines lines <?datasetName?>
294            Set rendering type to polylines
295streamlines linewidth <val> <?datasetName?>
296streamlines opacity <val> <?datasetName?>
297streamlines orient <qw> <qx> <qy> <qz> <?dataSetName?>
298streamlines pos <x> <y> <z> <?dataSetName?>
299streamlines ribbons <width> <angle> <?datasetName?>
300            Set rendering type to ribbons, width is minimum half-width, angle is
301            degrees offset from normal orientation
302streamlines scale <sx> <sy> <sz> <?dataSetName?>
303streamlines seed color <r> <g> <b> <?datasetName?>
304streamlines seed disk <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <radius> <innerRadius> <numPoints> <?dataSetName?>
305            Create a disk seed area with optional hole, filled with randomly
306            placed points
307streamlines seed fpoly <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <angle> <radius> <numSides> <numPoints> <?dataSetName?>
308            Create a regular n-sided polygonal seed area filled with randomly
309            placed points
310streamlines seed polygon <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <angle> <radius> <numSides> <?dataSetName?>
311            Create seed points from vertices of a regular n-sided polygon
312streamlines seed rake <startX> <startY> <startZ> <endX> <endY> <endZ> <numPoints> <?datasetName?>
313streamlines seed random <numPoints> <?datasetName?>
314streamlines seed visible <bool> <?datasetName?>
315streamlines tubes <numSides> <radius> <?datasetName?>
316            Set rendering type to tubes, numSides is number of sides of tubes,
317            radius is minimum tube radius
318streamlines visible <bool> <?datasetName?>
319
320volume add <?datasetName?>
321volume colormap <colorMapName> <?datasetName?>
322volume delete <?datasetName?>
323volume lighting <bool> <?datasetName?>
324volume orient <qw> <qx> <qy> <qz> <?dataSetName?>
325volume pos <x> <y> <z> <?dataSetName?>
326volume scale <sx> <sy> <sz> <?dataSetName?>
327volume shading ambient <coeff> <?datasetName?>
328volume shading diffuse <coeff> <?datasetName?>
329volume shading specular <coeff> <power> <?datasetName?>
330volume visible <bool> <?datasetName?>
331
332================================================================================
333Replies:
334
335nv>camera set <posX> <posY> <posZ> <focalPtX> <focalPtY> <focalPtZ> <viewUpX> <viewUpY> <viewUpZ>
336   Reply to "camera get"
337nv>image -type image -bytes <nbytes>
338  <binary RGB data>
339nv>image -type image -bbox {x y w h} -bytes <nbytes>
340  <binary RGB data>
341  The bounding box of the 2D image camera zoom region is supplied
342  Note: The bbox coordinates are in the form used by 'camera ortho world ...':
343  x,y - world coordinate of lower left corner, w,h - width height in world coords
344  This form is currently used only if the camera mode is set to 'image'.
345nv>legend <colormapName> <title> <rmin> <rmax> <nbytes>
346  <binary RGB data>
347nv>dataset scalar world <x> <y> <z> <value> <dataSetName>
348nv>dataset scalar pixel <x> <y> <value> <dataSetName>
349nv>dataset vector world <x> <y> <z> <valueX> <valueY> <valueZ> <dataSetName>
350nv>dataset vector pixel <x> <y> <valueX> <valueY> <valueZ> <dataSetName>
351
352================================================================================
353Errors:
354
355Prefixed with "VtkVis Server Error: "
356Currently not guaranteed to be on a single line
Note: See TracBrowser for help on using the repository browser.