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

Last change on this file since 2217 was 2213, checked in by ldelgass, 14 years ago

vtkvis - rename camera orient command to camera set, new camera orient command
takes a quaternion to orient the scene.

  • Property svn:eol-style set to native
File size: 4.4 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
10axis color <r> <g> <b>
11     Set color of axis lines, labels, titles, ticks
12axis grid <bool>
13axis name <axis> <title>
14axis units <axis> <units>
15     Currently only supported when camera mode is not image mode
16axis visible <axis> <bool>
17     <axis> = x|y|z|all
18
19camera get
20       Request current camera orientation
21camera mode <mode>
22       <mode> = persp|ortho|image
23camera orient <quatX> <quatY> <quatZ> <quatW>
24       Set scene orientation using a quaternion
25camera ortho <x> <y> <width> <height>
26       Supply world coordinate bounds of plot area for image camera mode
27       Data is assumed to lie in XY plane (z = 0)
28camera pan <x> <y>
29       <x,y> world coordinates
30camera reset <?all?>
31       Option all resets orientation/rotation as well as pan/zoom/clip range
32camera rotate <yaw> <pitch> <roll>
33       Specify relative rotation in Euler angles (FIXME)
34camera set <posX> <posY> <posZ> <focalPtX> <focalPtY> <focalPtZ> <viewUpX> <viewUpY> <viewUpZ>
35       Set camera orientation using camera position, focal point and view up
36       vector
37camera zoom <z>
38       Specify zoom ratio
39
40colormap add <colorMapName> <colorMap> <opacityMap>
41         colorMap = Tcl list of {value r g b} control points
42         opacityMap = Tcl list of {value alpha} control points
43colormap delete <?colorMapName?>
44
45legend <colormapName> <legendTitle> <width> <height> <?datasetName?>
46       Causes legend to be rendered and written back with labels and title
47
48dataset add <datasetName> data follows <nbytes>
49dataset delete <?datasetName?>
50dataset getvalue world <x> <y> <z> <datasetName>
51dataset getvalue pixel <x> <y> <datasetName>
52        Use pixel for image camera mode
53dataset maprange <val>
54        <val> = all|visible|separate
55        Controls if data range for colormapping and contours is based on
56        cumulative range of all datasets ("all"), only visible datasets
57        ("visible") or each individual dataset ("separate").  Defaults to
58        "all"
59dataset opacity <val> <?datasetName?>
60dataset visible <bool> <?datasetName?>
61
62pseudocolor add <?datasetName?>
63pseudocolor colormap <colormapName> <?datasetName?>
64pseudocolor delete <?datasetName?>
65pseudocolor edges <bool> <?datasetName?>
66pseudocolor lighting <bool> <?datasetName?>
67pseudocolor linecolor <r> <g> <b> <?datasetName?>
68pseudocolor linewidth <val> <?datasetName?>
69pseudocolor opacity <val> <?datasetName?>
70pseudocolor visible <bool> <?datasetName?>
71
72contour2d add numcontours <n> <?datasetName?>
73          Generate evenly spaced contours including range endpoints.  See also
74          'dataset maprange' command.
75contour2d add contourlist <list> <?datasetName?>
76          list = {isoval1 isoval2 isoval3...}
77contour2d delete <?datasetName?>
78contour2d lighting <bool> <?datasetName?>
79contour2d linecolor <r> <g> <b> <?datasetName?>
80contour2d linewidth <val> <?datasetName?>
81contour2d opacity <val> <?datasetName?>
82contour2d visible <bool> <?datasetName?>
83
84polydata add <?datasetName?>
85polydata color <r> <g> <b> <?datasetName?>
86polydata delete <?datasetName?>
87polydata edges <bool> <?datasetName?>
88polydata lighting <bool> <?datasetName?>
89polydata linecolor <r> <g> <b> <?datasetName?>
90polydata linewidth <val> <?datasetName?>
91polydata opacity <val> <?datasetName?>
92polydata visible <bool> <?datasetName?>
93polydata wireframe <bool> <?datasetName?>
94
95================================================================================
96Replies:
97
98nv>camera orient <posX> <posY> <posZ> <focalPtX> <focalPtY> <focalPtZ> <viewUpX> <viewUpY> <viewUpZ>
99   Reply to "camera get"
100nv>image -type image -bytes <nbytes>
101  <binary RGB data>
102nv>image -type image -bbox {x1 y1 x2 y2} -bytes <nbytes>
103  <binary RGB data>
104  Note: in this form, the bbox is the upper left and lower right screen corners
105  in world coordinates.  This form is currently used only if the camera mode is
106  set to 'image'.
107nv>legend <colormapName> <nbytes>
108  <binary RGB data>
109nv>dataset value world <x> <y> <z> <value>
110nv>dataset value pixel <x> <y> <value>
111
112================================================================================
113Errors:
114
115Prefixed with "VtkVis Server Error: "
116Currently not guaranteed to be on a single line
Note: See TracBrowser for help on using the repository browser.