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

================================================================================
On connection, send 32-bit little endian int indicating memory requirements
(comsumed by nanoscale server before exec-ing vtkvis)
================================================================================
Requests:

screen bgcolor <r> <g> <b>
screen size <width> <height>

renderer clipplane <axis> <ratio> <direction>
         Set a user clipping plane, ratio is [0,1] and is always interpreted as
         0 = min_bound, 1 = max_bound, regardless of direction.  Sign of 
         direction determines normal of clipping plane.  User clip planes do not
         apply if camera mode is image.
renderer depthpeel <bool>
         Set use of depth peeling algorithm for transparency

axis color <r> <g> <b>
     Set color of axis lines, labels, titles, ticks
axis flymode <mode>
     <mode> = static_edges|static_triad|outer_edges|furthest_triad|closest_triad
axis grid <bool>
axis name <axis> <title>
axis units <axis> <units>
     Currently only supported when camera mode is not image mode
axis visible <axis> <bool>
     <axis> = x|y|z|all

camera get
       Request current camera orientation
camera mode <mode>
       <mode> = persp|ortho|image
camera orient <quatW> <quatX> <quatY> <quatZ>
       Set scene orientation using a quaternion
camera ortho <x> <y> <width> <height>
       Supply world coordinate bounds of plot area for image camera mode
       Data is assumed to lie in XY plane (z = 0)
camera pan <x> <y>
       <x,y> world coordinates
camera reset <?all?>
       Option all resets orientation/rotation as well as pan/zoom/clip range
camera rotate <yaw> <pitch> <roll>
       Specify relative rotation in Euler angles (FIXME)
camera set <posX> <posY> <posZ> <focalPtX> <focalPtY> <focalPtZ> <viewUpX> <viewUpY> <viewUpZ>
       Set camera orientation using camera position, focal point and view up 
       vector
camera zoom <z>
       Specify zoom ratio

colormap add <colorMapName> <colorMap> <opacityMap>
         colorMap = Tcl list of {value r g b} control points
         opacityMap = Tcl list of {value alpha} control points
colormap delete <?colorMapName?>

legend <colormapName> <legendTitle> <width> <height> <?datasetName?>
       Causes legend to be rendered and written back with labels and title

dataset add <datasetName> data follows <nbytes>
dataset delete <?datasetName?>
dataset getvalue world <x> <y> <z> <datasetName>
dataset getvalue pixel <x> <y> <datasetName>
        Use pixel for image camera mode
dataset maprange <val>
        <val> = all|visible|separate
        Controls if data range for colormapping and contours is based on
        cumulative range of all datasets ("all"), only visible datasets
        ("visible") or each individual dataset ("separate").  Defaults to
        "all"
dataset opacity <val> <?datasetName?>
dataset visible <bool> <?datasetName?>

contour2d add numcontours <n> <?datasetName?>
          Generate evenly spaced contours including range endpoints.  See also
          'dataset maprange' command.
contour2d add contourlist <list> <?datasetName?>
          list = {isoval1 isoval2 isoval3...}
contour2d delete <?datasetName?>
contour2d lighting <bool> <?datasetName?>
contour2d linecolor <r> <g> <b> <?datasetName?>
contour2d linewidth <val> <?datasetName?>
contour2d opacity <val> <?datasetName?>
contour2d visible <bool> <?datasetName?>

contour3d add numcontours <n> <?datasetName?>
          Generate evenly spaced contours including range endpoints.  See also
          'dataset maprange' command.
contour3d add contourlist <list> <?datasetName?>
          list = {isoval1 isoval2 isoval3...}
contour3d color r g b <?datasetName?>
contour3d colormap <colorMapName> <?dataSetName?>
contour3d delete <?datasetName?>
contour3d edges <bool> <?datasetName?>
contour3d lighting <bool> <?datasetName?>
contour3d linecolor <r> <g> <b> <?datasetName?>
contour3d linewidth <val> <?datasetName?>
contour3d opacity <val> <?datasetName?>
contour3d visible <bool> <?datasetName?>
contour3d wireframe <bool> <?datasetName?>

glyphs add <?dataSetName?>
glyphs colormap <colorMapName> <?dataSetName?>
glyphs delete <?dataSetName?>
glyphs lighting <bool> <?datasetName?>
glyphs opacity <val> <?datasetName?>
glyphs scale <scaleFactor> <?datasetName?>
glyphs shape <arrow|cone|cube|cylinder|dodecahedron|icosahedron|octahedron|sphere|tetrahedron> <?datasetName?>
glyphs visible <bool> <?datasetName?>

heightmap add numcontours <n> <?dataSetName?>
          Generate evenly spaced contours including range endpoints.  See also
          'dataset maprange' command.
heightmap add contourlist <list> <?dataSetName?>
          list = {isoval1 isoval2 isoval3...}
heightmap colormap <colorMapName> <?dataSetName?>
heightmap delete <?dataSetName?>
heightmap edges <bool> <?dataSetName?>
heightmap heightscale <value> <?dataSetName?>
heightmap isolinecolor <r> <g> <b> <?dataSetName?>
heightmap isolines <bool> <?dataSetName?>
heightmap isolinewidth <width> <?dataSetName?>
heightmap lighting <bool> <?dataSetName?>
heightmap linecolor <r> <g> <b> <?dataSetName?>
heightmap linewidth <width> <?dataSetName?>
heightmap opacity <value> <?dataSetName?>
heightmap visible <bool> <?dataSetName?>
heightmap volumeslice axis ratio <?dataSetName?>
          For 3D data, select a slice along a principle axis of the volume. The
          ratio is [0,1]

lic add <?datasetName?>
lic colormap <colormapName> <?datasetName?>
lic delete <?datasetName?>
lic edges <bool> <?datasetName?>
lic lighting <bool> <?datasetName?>
lic linecolor <r> <g> <b> <?datasetName?>
lic linewidth <val> <?datasetName?>
lic opacity <val> <?datasetName?>
lic visible <bool> <?datasetName?>
lic volumeslice <axis> <ratio> <?datasetName?>

molecule add <?datasetName?>
molecule atoms <bool> <?datasetName?>
         Toggle rendering of atoms
molecule bonds <bool> <?datasetName?>
         Toggle rendering of bonds
molecule colormap <colormapName> <?datasetName?>
molecule delete <?datasetName?>
molecule edges <bool> <?datasetName?>
molecule lighting <bool> <?datasetName?>
molecule linecolor <r> <g> <b> <?datasetName?>
molecule linewidth <val> <?datasetName?>
molecule opacity <val> <?datasetName?>
molecule scaleatoms <val> <?dataSetName?>
         val = van_der_walls|covalent|atomic|none
molecule visible <bool> <?datasetName?>
molecule wireframe <bool> <?datasetName?>

polydata add <?datasetName?>
polydata color <r> <g> <b> <?datasetName?>
polydata delete <?datasetName?>
polydata edges <bool> <?datasetName?>
polydata lighting <bool> <?datasetName?>
polydata linecolor <r> <g> <b> <?datasetName?>
polydata linewidth <val> <?datasetName?>
polydata opacity <val> <?datasetName?>
polydata visible <bool> <?datasetName?>
polydata wireframe <bool> <?datasetName?>

pseudocolor add <?datasetName?>
pseudocolor colormap <colormapName> <?datasetName?>
pseudocolor delete <?datasetName?>
pseudocolor edges <bool> <?datasetName?>
pseudocolor lighting <bool> <?datasetName?>
pseudocolor linecolor <r> <g> <b> <?datasetName?>
pseudocolor linewidth <val> <?datasetName?>
pseudocolor opacity <val> <?datasetName?>
pseudocolor visible <bool> <?datasetName?>
pseudocolor wireframe <bool> <?datasetName?>

streamlines add <?datasetName?>
streamlines colormap <colormapName> <?datasetName?>
            Colormap used to color streamlines/tubes/ribbons by vector magnitude
streamlines delete <?datasetName?>
streamlines edges <bool> <?datasetName?>
            Turn on/off edges for tubes, ribbons
streamlines length <?datasetName?>
            Set maximum length in world coordinates of streamlines
streamlines lighting <bool> <?datasetName?>
streamlines linecolor <r> <g> <b> <?datasetName?>
            Set color of edges for tubes, ribbons (lines are colored by colormap)
streamlines lines <?datasetName?>
            Set rendering type to polylines
streamlines linewidth <val> <?datasetName?>
streamlines opacity <val> <?datasetName?>
streamlines ribbons <width> <angle> <?datasetName?>
            Set rendering type to ribbons, width is minimum half-width, angle is
            degrees offset from normal orientation
streamlines seed color <r> <g> <b> <?datasetName?>
streamlines seed polygon <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <radius> <numSides> <?dataSetName?>
streamlines seed rake <startX> <startY> <startZ> <endX> <endY> <endZ> <numPoints> <?datasetName?>
streamlines seed random <numPoints> <?datasetName?>
streamlines seed visible <bool> <?datasetName?>
streamlines tubes <numSides> <radius> <?datasetName?>
            Set rendering type to tubes, numSides is number of sides of tubes,
            radius is minimum tube radius
streamlines visible <bool> <?datasetName?>

volume add <?datasetName?>
volume colormap <colorMapName> <?datasetName?>
volume delete <?datasetName?>
volume lighting <bool> <?datasetName?>
volume shading ambient <coeff> <?datasetName?>
volume shading diffuse <coeff> <?datasetName?>
volume shading specular <coeff> <power> <?datasetName?>
volume visible <bool> <?datasetName?>

================================================================================
Replies:

nv>camera set <posX> <posY> <posZ> <focalPtX> <focalPtY> <focalPtZ> <viewUpX> <viewUpY> <viewUpZ>
   Reply to "camera get"
nv>image -type image -bytes <nbytes>
  <binary RGB data>
nv>image -type image -bbox {x1 y1 x2 y2} -bytes <nbytes>
  <binary RGB data>
  Note: in this form, the bbox is the upper left and lower right screen corners
  in world coordinates.  This form is currently used only if the camera mode is
  set to 'image'.
nv>legend <colormapName> <nbytes>
  <binary RGB data>
nv>dataset value world <x> <y> <z> <value>
nv>dataset value pixel <x> <y> <value>

================================================================================
Errors:

Prefixed with "VtkVis Server Error: "
Currently not guaranteed to be on a single line