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