source: vtkvis/branches/1.7/protocol.txt @ 4777

================================================================================
================================================================================
Protocol for vtkvis render server.  

Commands take the general form of command and arguments using Tcl syntax and are
terminated by a newline.  Some command arguments expect a Tcl list which can be
sent by enclosing the list in curly braces to prevent the interpreter from 
splitting the list into multiple arguments.  Likewise, strings with spaces 
should be quoted or enclosed in curly braces.  In the documentation below,
arguments are indicated by angle brackets and optional arguments are surrounded
by question marks -- the brackets and question marks are not part of the
protocol and should not be included in argument strings.  The arguments shown 
in angle brackets should be replaced with a string (where there are fixed 
choices this document indicates valid values by separating them with pipe 
symbols), a list in Tcl syntax, or a numeric value.  Boolean arguments can take
the form of 0|1, true|false, or yes|no.  Since the protocol commands are 
executed in a Tcl interpreter, Tcl code such as math expressions in expr 
commands enclosed in square brackets are also allowed.  Since the interpreter
is a "safe" interpreter, some Tcl commands that could cause security issues may 
not be available for use.

When binary data is to be sent, it should follow the newline after a command 
that indicates incoming data including a byte count argument.
================================================================================
================================================================================
Requests:
================================================================================

== General dataset, scene and renderer commands ==

axis autobounds <axis> <bool>
     Toggle between automatic and explicit bounds settings.  To set an explicit
     range use the 'axis bounds...' command.
     <axis> = x|y|z|all
axis autorange <axis> <bool>
     Toggle between automatic and explicit range settings.  To set an explicit
     range use the 'axis range...' command.  For scaling based on axis bounds,
     see 'axis scale...'
     <axis> = x|y|z|all
axis bounds <axis> <min> <max>
     Explicitly specify bounds to use for an axis.
     <axis> = x|y|z|all
axis color <axis> <r> <g> <b> <?opacity?>
     Set color of axis lines, labels, titles, ticks
     <axis> = x|y|z|all
axis exp <xPower> <yPower> <zPower> <?useCustom?>
     Control power scaling of labels.  When an exponent is set, the labels
     are adjusted to show mantissa and the exponent is indicated in the title.
     <xPower> = Base 10 exponent for X axis
     <yPower> = Base 10 exponent for Y axis
     <zPower> = Base 10 exponent for Z axis
     <useCustom> = Flag to control if custom/manual powers are used.  Setting
     this to off will re-enable automatic power scaling.
axis flymode <mode>
     <mode> = static_edges|static_triad|outer_edges|furthest_triad|closest_triad
axis fontsz <fontPixelSize>
     Controls size of labels and text in 3D mode
axis gpcolor <axis> <r> <g> <b> <?opacity?>
     Set color/opacity of inner grid polygons
     <axis> = x|y|z|all
axis gpolys <axis> <bool>
     Turn on/off inner grid polygons/planes
     <axis> = x|y|z|all
axis grcolor <axis> <r> <g> <b> <?opacity?>
     Set color/opacity of gridlines
     <axis> = x|y|z|all
axis grid <axis> <bool>
     Turn on/off outer gridlines
     <axis> = x|y|z|all
axis igcolor <axis> <r> <g> <b> <?opacity?>
     Set color/opacity of inner gridlines
     <axis> = x|y|z|all
axis igrid <axis> <bool>
     Turn on/off inner gridlines
     <axis> = x|y|z|all
axis labels <axis> <bool>
     Toggle visibility of axis labels
     <axis> = x|y|z|all
axis lcolor <axis> <r> <g> <b> <?opacity?>
     Set color/opacity of tick labels
     <axis> = x|y|z|all
axis lfont <axis> <fontName>
     Set label font family
     <axis> = x|y|z|all
     <fontName> = Arial|Courier|Times
axis lformat <axis> <formatString>
     <axis> = x|y|z|all
     <formatString> = printf style format string
axis lfsize <axis> <fontSizePts>
     Set font size of labels in 2D mode - currently relies on patched VTK in 
     runtime
     <axis> = x|y|z|all
     <fontSizePts> = Font size in points
axis linecolor <axis> <r> <g> <b> <?opacity?>
     Set color/opacity of main axis lines
     <axis> = x|y|z|all
axis lrot <axis> <rotation>
     <axis> = x|y|z|all
     <rotation> = rotation angle in degrees
axis lscale <axis> <boolAuto> <xpow> <ypow> <zpow>
     Control (auto-)scaling of labels with powers of 10
     <axis> = x|y|z|all
     <boolAuto> = Enable/disable automatic scaling with powers of 10
     <xpow> = Explicitly set power on X axis
     <ypow> = Explicitly set power on Y axis
     <zpow> = Explicitly set power on Z axis
axis minticks <axis> <bool>
     Toggle visibility of axis minor tick marks
     <axis> = x|y|z|all
axis name <axis> <title>
     <axis> = x|y|z|all
     <title> = Title of axis
axis origin <x> <y> <z> <?useCustom?>
     <x>,<y>,<z> = point inside world coordinate bounds of axes box where axes 
     should intersect
     <useCustom> = Set to false to disable use of custom origin and re-enable 
     automatic origin
axis range <axis> <min> <max>
     Explicitly set min,max range of axis labels.  Note that the min and max 
     values themselves may not be given labels if they don't fall on tick 
     divisions -- the min/max determine the value of the axis endpoints.  This
     setting allows labeling axes independently of the world coordinate bounds.
     <axis> = x|y|z|all
     <min> = minimum value of axis for labels
     <max> = maximum value of axis for labels
axis scale <axis> <scale>
     Set axis range to be computed based on scaling the axis bounds by the given
     scale factor.
     <axis> = x|y|z|all
     <scale> = scale factor where range = bounds * scale
axis tcolor <axis> <r> <g> <b> <?opacity?>
     Set color/opacity of axis title
     <axis> = x|y|z|all
axis tickpos <position>
     Set position of ticks on 3D axes (not implemented for 2D axes)
     <position> = inside|outside|both
axis ticks <axis> <bool>
     Toggle visibility of axis tick marks
     <axis> = x|y|z|all
axis tfont <axis> <fontName>
     Set title font family
     <axis> = x|y|z|all
     <fontName> = Arial|Courier|Times
axis tfsize <axis> <fontSizePts>
     Set font size of title in 2D mode - currently relies on patched VTK in 
     runtime
     <axis> = x|y|z|all
     <fontSizePts> = Font size in points
axis trot <axis> <rotation>
     Currently a no-op -- needs a fix in vtkCubeAxesActor
     <axis> = x|y|z|all
     <rotation> = rotation angle in degrees
axis units <axis> <units>
     Currently only supported when camera mode is not image mode
axis visible <axis> <bool>
     <axis> = x|y|z|all
     Note: 'all' means all enabled axes.  To force all axes on, set each axis on
     individually -- however, it is best to let the server determine which of 
     the individual axes are enabled based on the dataset bounds.

camera aspect <aspectMode>
       Set 2D aspect ratio mode
       <aspectMode> = native|square|window
camera get
       Request current camera parameters
camera mode <mode>
       <mode> = persp|ortho|image
camera orient <quatW> <quatX> <quatY> <quatZ>
       Set scene orientation using a quaternion
camera ortho <coordMode> <x> <y> <width> <height>
       <coordMode> = pixel|world
       Supply bounds of plot area for image camera mode
camera pan <x> <y>
       <x,y> viewport coordinates (window center at 0,0).  Positive x pan
       means pan object to right (camera to left).  Positive y pan means
       pan object down (camera up).  For example a pan of 0.5, 0.5 would
       move the object center to the lower right corner of the window
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
camera set <posX> <posY> <posZ> <focalPtX> <focalPtY> <focalPtZ> <viewUpX> <viewUpY> <viewUpZ>
       Set camera parameters: camera position, focal point and view up vector
camera zoom <z>
       Specify zoom ratio.  z > 1 is a zoom in, z < 1 is zoom out. z = 1
       resets to default.

clientinfo <list>

colormap add <colorMapName> <colorMap> <opacityMap>
         (Re-)define a colormap.  If colorMapName doesn't exist, it is created,
         otherwise the colormap is redefined and all users will be updated.
         colorMap = Tcl list of {value r g b} control points
         opacityMap = Tcl list of {value alpha} control points
colormap define <colorMapName> <colorMap> <opacityMap>
         (Re-)define a colormap (same as 'add')
colormap delete <?colorMapName?>
colormap res <numberOfTableEntries>
         Set the "resolution" or number of lookup table entries in the colormap
         <numberOfTableEntries> = integer or "default"

dataset add <datasetName> data follows <nbytes>
dataset delete <?datasetName?>
dataset getscalar world <x> <y> <z> <datasetName>
dataset getscalar pixel <x> <y> <datasetName>
dataset getvector world <x> <y> <z> <datasetName>
dataset getvector pixel <x> <y> <datasetName>
        Use pixel for image camera mode
dataset maprange <val> <?min?> <?max?> <?fieldName?> <?fieldType?> <?numComp?> <?component?>
        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"
        <val> = all|explicit|visible|separate
        The following arguments are only used for 'explicit' mode:
        <min>,<max> = Required in explicit mode, specify the range to use
        <fieldName> = Required in explicit mode, specify the field to which the
        range should be applied
        <fieldType> = point_data|cell_data|field_data, optional (defaults to 
        point_data)
        <numComp> = Number of components (1 = scalar, 3 = vector), optional (1
        is default)
        <component> = Component index for vector fields, required if numComp is
        3, otherwise unused.
dataset names
        Returns a list of the loaded data sets
dataset opacity <val> <?datasetName?>
dataset scalar <scalarName> <?datasetName?>
        Set the active scalar field to plot
dataset vector <vectorName> <?datasetName?>
        Set the active vector field to plot
dataset visible <bool> <?datasetName?>

legend <colormapName> <legendType> <fieldName> <legendTitle> <width> <height> <numLabels> <?datasetName?>
       Causes legend to be rendered and written back with labels and title
       (title may be left blank)
       <legendType> = scalar|vmag|vx|vy|vz
       <numLabels> Can be zero or more 'tick' value labels
       If datasetName is omitted, the cumulative data range of all data sets 
       will be used to label the legend -- otherwise, the current setting of 
       'dataset maprange' will be used to determine if the individual dataset
       range or cumulative range will be used.

legend2 <colormapName> <width> <height>
        Simple legend command for rendering legend without labels or title

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> <?occlusionRatio?> <?maxPeels?>
         Set use of depth peeling algorithm for transparency
         <occlusionRatio> = [0,0.5] Value of 0 means exact rendering, higher
         values can speed rendering at the cost of some quality.  From VTK docs:
         "the threshold under which the algorithm stops to iterate over peel 
         layers. This is the ratio of the number of pixels that have been 
         touched by the last layer over the total number of pixels of the 
         viewport area."
         <maxPeels> = 0 means unlimited passes, positive value limits the number
         of rendering passes 
renderer light2side <bool>
         Toggle use of two-sided lighting (controls if backfaces are lit with a
         flipped normal)
renderer lights <lightNum> <bool>
         Toggle lights on/off.  Light 0 is the headlight, light 1 the skylight
renderer render
         Force a new image to be rendered - use for advancing animation

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

== Graphics objects ==

arc add <centerX> <centerY> <centerZ> <startX> <startY> <startZ> <normX> <normY> <normZ> <angle> <name>
    Creates a circular arc given a center and starting point, a normal and a 
    sweep angle.
arc color <r> <g> <b> <?name?>
arc delete <?name?>
arc linecolor <r> <g> <b> <?name?>
arc linewidth <val> <?name?>
arc opacity <val> <?name?>
arc orient <qw> <qx> <qy> <qz> <?name?>
arc origin <x> <y> <z> <?name?>
arc pos <x> <y> <z> <?name?>
arc resolution <res> <?name?>
arc scale <sx> <sy> <sz> <?name?>
arc visible <bool> <?name?>

arrow add <tipRadius> <shaftRadius> <tipLength> <name>
      Arrow will have base at 0,0,0 and tip at 1, 0, 0
arrow color <r> <g> <b> <?name?>
arrow culling <bool> <?name?>
arrow delete <?name?>
arrow edges <bool> <?name?>
arrow flipnorms <bool> <?name?>
arrow lighting <bool> <?name?>
arrow linecolor <r> <g> <b> <?name?>
arrow linewidth <val> <?name?>
arrow material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
arrow opacity <val> <?name?>
arrow orient <qw> <qx> <qy> <qz> <?name?>
arrow origin <x> <y> <z> <?name?>
arrow pos <x> <y> <z> <?name?>
arrow resolution <tipRes> <shaftRes> <?name?>
arrow scale <sx> <sy> <sz> <?name?>
arrow shading <val> <?name?>
      val = flat|smooth
arrow visible <bool> <?name?>
arrow wireframe <bool> <?name?>

box add <xLen> <yLen> <zLen> <name>
box color <r> <g> <b> <?name?>
box culling <bool> <?name?>
box delete <?name?>
box edges <bool> <?name?>
box flipnorms <bool> <?name?>
box lighting <bool> <?name?>
box linecolor <r> <g> <b> <?name?>
box linewidth <val> <?name?>
box material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
box opacity <val> <?name?>
box orient <qw> <qx> <qy> <qz> <?name?>
box origin <x> <y> <z> <?name?>
box pos <x> <y> <z> <?name?>
box scale <sx> <sy> <sz> <?name?>
box shading <val> <?name?>
    val = flat|smooth
box visible <bool> <?name?>
box wireframe <bool> <?name?>

cone add <radius> <height> <cap> <name>
     <cap> = boolean flag for cap disks
cone color <r> <g> <b> <?name?>
cone culling <bool> <?name?>
cone delete <?name?>
cone edges <bool> <?name?>
cone flipnorms <bool> <?name?>
cone lighting <bool> <?name?>
cone linecolor <r> <g> <b> <?name?>
cone linewidth <val> <?name?>
cone material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
cone opacity <val> <?name?>
cone orient <qw> <qx> <qy> <qz> <?name?>
cone origin <x> <y> <z> <?name?>
cone pos <x> <y> <z> <?name?>
cone resolution <res> <?name?>
cone scale <sx> <sy> <sz> <?name?>
cone shading <val> <?name?>
     val = flat|smooth
cone visible <bool> <?name?>
cone wireframe <bool> <?name?>

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 color <r> <g> <b> <?datasetName?>
          synonym for linecolor
contour2d colormap <colormapName> <?datasetName?>
contour2d colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
          Set the field used to color the object.  'constant' means to use
          the constant color defined by the color subcommand.  'scalar' uses
          the active scalar field.  'vmag' uses the magnitude of the current
          vector field, and 'vx','vy','vz' use the corresponding component of
          the active vector field.
contour2d contourlist <list> <?dataSetName?>
contour2d delete <?datasetName?>
contour2d lighting <bool> <?datasetName?>
contour2d linecolor <r> <g> <b> <?datasetName?>
          synonym for color
contour2d linewidth <val> <?datasetName?>
contour2d numcontours <n> <?dataSetName?>
contour2d opacity <val> <?datasetName?>
contour2d orient <qw> <qx> <qy> <qz> <?dataSetName?>
contour2d pos <x> <y> <z> <?dataSetName?>
contour2d scale <sx> <sy> <sz> <?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 colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
          Set the field used to color the object.  'constant' means to use
          the constant color defined by the color subcommand.  'scalar' uses
          the active scalar field.  'vmag' uses the magnitude of the current
          vector field, and 'vx','vy','vz' use the corresponding component of
          the active vector field.
contour3d contourlist <list> <?dataSetName?>
contour3d delete <?datasetName?>
contour3d edges <bool> <?datasetName?>
contour3d lighting <bool> <?datasetName?>
contour3d linecolor <r> <g> <b> <?datasetName?>
contour3d linewidth <val> <?datasetName?>
contour3d numcontours <n> <?dataSetName?>
contour3d opacity <val> <?datasetName?>
contour3d orient <qw> <qx> <qy> <qz> <?dataSetName?>
contour3d pos <x> <y> <z> <?dataSetName?>
contour3d scale <sx> <sy> <sz> <?dataSetName?>
contour3d visible <bool> <?datasetName?>
contour3d wireframe <bool> <?datasetName?>

cutplane add <?dataSetName?>
cutplane axis <axis> <bool> <?dataSetName?>
         Toggle visibility of the 3 principal axis cutplanes
cutplane cloudstyle <style> <?datasetName?>
         <style> = mesh | splat
cutplane color r g b <?datasetName?>
         Set color of outline bounding box
cutplane colormap <colorMapName> <?dataSetName?>
cutplane colormode <scalar|vmag|vx|vy|vz> <fieldName> <?datasetName?>
         Set the field used to color the object.  'scalar' uses
         the active scalar field.  'vmag' uses the magnitude of the current
         vector field, and 'vx','vy','vz' use the corresponding component of
         the active vector field.
cutplane delete <?dataSetName?>
cutplane edges <bool> <?dataSetName?>
cutplane lighting <bool> <?dataSetName?>
cutplane linecolor <r> <g> <b> <?dataSetName?>
cutplane linewidth <width> <?dataSetName?>
cutplane opacity <value> <?dataSetName?>
cutplane orient <qw> <qx> <qy> <qz> <?dataSetName?>
cutplane outline <bool> <?dataSetName?>
         Toggle rendering of cutplane outlines
cutplane pos <x> <y> <z> <?dataSetName?>
cutplane preinterp <bool> <?dataSetName?>
         Controls if VTK's InterpolateScalarsBeforeMapping option is set.
         Setting this on will give more correct colors, as the interpolation
         is done on texture coordinates that lookup into a 1D texture instead
         of using color interpolation from triangle vertices.
cutplane scale <sx> <sy> <sz> <?dataSetName?>
cutplane slice axis ratio <?dataSetName?>
         For 3D data, select a slice along a principle axis of the volume. The
         ratio is [0,1]
cutplane visible <bool> <?dataSetName?>
cutplane wireframe <bool> <?datasetName?>

cylinder add <radius> <height> <cap> <name>
         <cap> = boolean flag for cap disks
cylinder color <r> <g> <b> <?name?>
cylinder culling <bool> <?name?>
cylinder delete <?name?>
cylinder edges <bool> <?name?>
cylinder flipnorms <bool> <?name?>
cylinder lighting <bool> <?name?>
cylinder linecolor <r> <g> <b> <?name?>
cylinder linewidth <val> <?name?>
cylinder material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
cylinder opacity <val> <?name?>
cylinder orient <qw> <qx> <qy> <qz> <?name?>
cylinder origin <x> <y> <z> <?name?>
cylinder pos <x> <y> <z> <?name?>
cylinder resolution <res> <?name?>
cylinder scale <sx> <sy> <sz> <?name?>
cylinder shading <val> <?name?>
         val = flat|smooth
cylinder visible <bool> <?name?>
cylinder wireframe <bool> <?name?>

disk add <innerRadius> <outerRadius> <name>
disk color <r> <g> <b> <?name?>
disk culling <bool> <?name?>
disk delete <?name?>
disk edges <bool> <?name?>
disk flipnorms <bool> <?name?>
disk lighting <bool> <?name?>
disk linecolor <r> <g> <b> <?name?>
disk linewidth <val> <?name?>
disk material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
disk opacity <val> <?name?>
disk orient <qw> <qx> <qy> <qz> <?name?>
disk origin <x> <y> <z> <?name?>
disk pos <x> <y> <z> <?name?>
disk resolution <resRadial> <resCircum> <?name?>
disk scale <sx> <sy> <sz> <?name?>
disk shading <val> <?name?>
     val = flat|smooth
disk visible <bool> <?name?>
disk wireframe <bool> <?name?>

glyphs add <shape> <?dataSetName?>
       See 'glyphs shape' for list of shapes
glyphs color r g b <?datasetName?>
glyphs colormap <colorMapName> <?dataSetName?>
glyphs colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?dataSetName?>
       Set the color mode: color by scalar field or
       vector magnitude -- uses the current color map,
       or color for constant color
glyphs delete <?dataSetName?>
glyphs edges <bool> <?datasetName?>
glyphs gorient <bool> <fieldName> <?datasetName?>
       Set the glyph orientation mode: orient glyphs by
       a named vector field, or set to default orientation (off)
glyphs gscale <scaleFactor> <?datasetName?>
       Set glyph scaling factor
glyphs lighting <bool> <?datasetName?>
glyphs linecolor <r> <g> <b> <?datasetName?>
glyphs linewidth <val> <?datasetName?>
glyphs normscale <bool> <?datasetName?>
       Control if data values are normalized to [0,1] range before applying
       glyph scaling factor (gscale)
glyphs numglyphs <max> <random> <offset> <ratio> <?dataSetName?>
       Limit the maximum number of glyphs displayed.  Can use either a random
       sampling or every nth point sampling (useful for uniform grids)
       <max> = integer maximum number of glyphs
       <random> = bool indicating if random sampling should be used
       <offset> = offset point index from which to start sampling
       <ratio> = If random is false, use this to control every nth point sampling
glyphs opacity <val> <?datasetName?>
glyphs orient <qw> <qx> <qy> <qz> <?dataSetName?>
glyphs pos <x> <y> <z> <?dataSetName?>
glyphs ptsize <size> <?dataSetName?>
glyphs quality <val> <?dataSetName?>
       Set glyph shape resolution quality val=[0,10], 1 is default
glyphs scale <sx> <sy> <sz> <?dataSetName?>
glyphs shape <arrow|cone|cube|cylinder|dodecahedron|icosahedron|line|octahedron|point|sphere|tetrahedron> <?datasetName?>
glyphs smode <scalar|vmag|vcomp|off> <fieldName> <?dataSetName?>
       Set the scaling mode: use the scalar field, vector magnitude, 
       vector components, or disable scaling
glyphs visible <bool> <?datasetName?>
glyphs wireframe <bool> <?datasetName?>

group add <nodeList> <name>
      Add listed nodes to group named <name>.  Group will be created if
      it doesn't exist, but nodes may be added to existing groups.  The
      nodes will be removed from the virtual root scene.
group delete <?name?>
group orient <qw> <qx> <qy> <qz> <?name?>
group origin <x> <y> <z> <?name?>
group pos <x> <y> <z> <?name?>
group remove <nodeList> <name>
      Remove listed nodes from group.  Currently, nodes will be added back
      to the virtual root scene, and so nodes must be explicitly deleted to 
      remove them from the scene.
group scale <sx> <sy> <sz> <?name?>
group visible <bool> <?name?>

heightmap add numcontours <n> <heightScale> <?dataSetName?>
          Generate evenly spaced contours including range endpoints.  See also
          'dataset maprange' command.
heightmap add contourlist <list> <heightScale> <?dataSetName?>
          list = {isoval1 isoval2 isoval3...}
heightmap aspect <aspectRatio>
          Set scaling by aspect ratio
          <aspectRatio> = width/height or 0 for native aspect
heightmap cloudstyle <style> <?datasetName?>
          <style> = mesh | splat
heightmap colormap <colorMapName> <?dataSetName?>
heightmap colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
          Set the field used to color the object.  'constant' means to use
          the constant color defined by the color subcommand.  'scalar' uses
          the active scalar field.  'vmag' uses the magnitude of the current
          vector field, and 'vx','vy','vz' use the corresponding component of
          the active vector field.
heightmap colormode2 <scalar|vmag|vx|vy|vz|constant> <fieldName> <point_data|cell_data|field_data|any> <min> <max> <?datasetName?>
          Set the field used to color the object.  'constant' means to use
          the constant color defined by the color subcommand.  'scalar' uses
          the active scalar field.  'vmag' uses the magnitude of the current
          vector field, and 'vx','vy','vz' use the corresponding component of
          the active vector field.
heightmap contourlist <list> <?dataSetName?>
heightmap delete <?dataSetName?>
heightmap edges <bool> <?dataSetName?>
heightmap heightscale <value> <?dataSetName?>
heightmap isolinecmap <bool> <?dataSetName?>
          Toggle colormapping of isolines (false means to use constant color)
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 numcontours <n> <?dataSetName?>
heightmap opacity <value> <?dataSetName?>
heightmap orient <qw> <qx> <qy> <qz> <?dataSetName?>
heightmap pos <x> <y> <z> <?dataSetName?>
heightmap preinterp <bool> <?dataSetName?>
          Controls if VTK's InterpolateScalarsBeforeMapping option is set.
          Setting this on will give more correct colors, as the interpolation
          is done on texture coordinates that lookup into a 1D texture instead
          of using color interpolation from triangle vertices.
heightmap scale <sx> <sy> <sz> <?dataSetName?>
heightmap slice <axis> <ratio> <?dataSetName?>
          For 3D data, select a slice along a principle axis of the volume. The
          ratio is [0,1]
heightmap surface <bool> <?dataSetName?>
          Toggle rendering of colormapped surface (mountain plot or cutplane)
heightmap visible <bool> <?dataSetName?>
heightmap wireframe <bool> <?datasetName?>

image add <?dataSetName?>
      Create an image from a vtkImageData data set
image backing <bool> <?dataSetName?>
image bg <bool> <?dataSetName?>
image border <bool> <?dataSetName?>
image color <r> <g> <b> <?dataSetName?>
image colormap <colorMapName> <?dataSetName?>
image delete <?dataSetName?>
image extents <xmin> <xmax> <ymin> <ymax> <zmin> <zmax> <?dataSetName?>
image level <level> <?dataSetName?>
image opacity <opacity> <?dataSetName?>
image orient <qw> <qx> <qy> <qz> <?dataSetName?>
image pos <x> <y> <z> <?dataSetName?>
image scale <sx> <sy> <sz> <?dataSetName?>
image visible <bool> <?dataSetName?>
image window <windowWidth> <?dataSetName?>
image zslice <sliceNum> <?dataSetName?>

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 orient <qw> <qx> <qy> <qz> <?dataSetName?>
lic pos <x> <y> <z> <?dataSetName?>
lic preinterp <bool> <?dataSetName?>
    Controls if VTK's InterpolateScalarsBeforeMapping option is set.
    Setting this on will give more correct colors, as the interpolation
    is done on texture coordinates that lookup into a 1D texture instead
    of using color interpolation from triangle vertices.
lic scale <sx> <sy> <sz> <?dataSetName?>
lic slice <axis> <ratio> <?datasetName?>
    For 3D data, select a slice along a principle axis of the volume. The
    ratio is [0,1]
lic visible <bool> <?datasetName?>

line add <points> <name>
     Create a polyline from the list of point coordinates in <points>. The
     list size must be a multiple of 3 (each point's x,y,z coordinates)
line color <r> <g> <b> <?name?>
line delete <?name?>
line linecolor <r> <g> <b> <?name?>
     Synonym for color
line linewidth <val> <?name?>
line opacity <val> <?name?>
line orient <qw> <qx> <qy> <qz> <?name?>
line origin <x> <y> <z> <?name?>
line pos <x> <y> <z> <?name?>
line scale <sx> <sy> <sz> <?name?>
line visible <bool> <?name?>

molecule add <?datasetName?>
molecule aquality <val> <?datasetName?>
         Set atom sphere resolution quality val=[0,10], 1 is default
molecule ascale <val> <?datasetName?>
         Set atom scale factor
molecule atoms <bool> <?datasetName?>
         Toggle rendering of atoms
molecule bcmode <by_elements|constant> <?datasetName?>
         Set bond color mode
molecule bcolor <r> <g> <b> <?datasetName?>
         Set constant bond color
molecule bonds <bool> <?datasetName?>
         Toggle rendering of bonds
molecule bquality <val> <?datasetName?>
         Set bond cylinder resolution quality val=[0,10], 1 is default
molecule bscale <val> <?datasetName?>
         Set bond scale factor
molecule bstyle <cylinder|line> <?datasetName?>
         Set bond render style
molecule color r g b <?datasetName?>
molecule colormap <colormapName> <?datasetName?>
molecule colormode <by_elements|scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
         Set the field used to color the object.  'constant' means to use
         the constant color defined by the color subcommand.  'scalar' uses
         the active scalar field.  'vmag' uses the magnitude of the current
         vector field, and 'vx','vy','vz' use the corresponding component of
         the active vector field.
molecule delete <?datasetName?>
molecule edges <bool> <?datasetName?>
molecule labels <bool> <?datasetName?>
         Toggle display of atom labels
molecule lfield <fieldName> <?datasetName?>
         Set the field used for atom labels
molecule lighting <bool> <?datasetName?>
molecule linecolor <r> <g> <b> <?datasetName?>
molecule linewidth <val> <?datasetName?>
molecule material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?datasetName?>
molecule opacity <val> <?datasetName?>
molecule orient <qw> <qx> <qy> <qz> <?dataSetName?>
molecule pos <x> <y> <z> <?dataSetName?>
molecule rscale <val> <?dataSetName?>
         Atom radius scaling
         val = van_der_waals|covalent|atomic|none
molecule scale <sx> <sy> <sz> <?dataSetName?>
molecule visible <bool> <?datasetName?>
molecule wireframe <bool> <?datasetName?>

outline add <?datasetName?>
outline color <r> <g> <b> <?datasetName?>
outline delete <?datasetName?>
outline linecolor <r> <g> <b> <?datasetName?>
        Synonym for color
outline linewidth <val> <?datasetName?>
outline opacity <val> <?datasetName?>
outline orient <qw> <qx> <qy> <qz> <?datasetName?>
outline pos <x> <y> <z> <?datasetName?>
outline scale <sx> <sy> <sz> <?datasetName?>
outline visible <bool> <?datasetName?>

parallelepiped add <v0x> <v0y> <v0z> <v1x> <v1y> <v1z> <v2x> <v2y> <v2z> <name>
               Specify parallelepiped using 3 basis vectors.  The 3 vectors should
               be given in order to create a right-handed coordinate system, i.e.
               (v0 cross v1) dot v2 should be positive.
parallelepiped color <r> <g> <b> <?name?>
parallelepiped culling <bool> <?name?>
parallelepiped delete <?name?>
parallelepiped edges <bool> <?name?>
parallelepiped flipnorms <bool> <?name?>
parallelepiped lighting <bool> <?name?>
parallelepiped linecolor <r> <g> <b> <?name?>
parallelepiped linewidth <val> <?name?>
parallelepiped material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
parallelepiped opacity <val> <?name?>
parallelepiped orient <qw> <qx> <qy> <qz> <?name?>
parallelepiped origin <x> <y> <z> <?name?>
parallelepiped pos <x> <y> <z> <?name?>
parallelepiped scale <sx> <sy> <sz> <?name?>
parallelepiped shading <val> <?name?>
               val = flat|smooth
parallelepiped visible <bool> <?name?>
parallelepiped wireframe <bool> <?name?>

polydata add <?datasetName?>
polydata cloudstyle <style> <?datasetName?>
         <style> = mesh | points
polydata color <r> <g> <b> <?datasetName?>
polydata colormap <colormapName> <?datasetName?>
polydata colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
         Set the field used to color the object.  'constant' means to use
         the constant color defined by the color subcommand.  'scalar' uses
         the active scalar field.  'vmag' uses the magnitude of the current
         vector field, and 'vx','vy','vz' use the corresponding component of
         the active vector field.
polydata culling <bool> <?name?>
polydata delete <?datasetName?>
polydata edges <bool> <?datasetName?>
polydata lighting <bool> <?datasetName?>
polydata linecolor <r> <g> <b> <?datasetName?>
polydata linewidth <val> <?datasetName?>
polydata material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp>
polydata opacity <val> <?datasetName?>
polydata orient <qw> <qx> <qy> <qz> <?dataSetName?>
polydata origin <x> <y> <z> <?name?>
polydata pos <x> <y> <z> <?dataSetName?>
polydata preinterp <bool> <?dataSetName?>
         Controls if VTK's InterpolateScalarsBeforeMapping option is set.
         Setting this on will give more correct colors, as the interpolation
         is done on texture coordinates that lookup into a 1D texture instead
         of using color interpolation from triangle vertices.
polydata ptsize <size> <?dataSetName?>
polydata scale <sx> <sy> <sz> <?dataSetName?>
polydata shading <val> <?name?>
         val = flat|smooth
polydata visible <bool> <?datasetName?>
polydata wireframe <bool> <?datasetName?>

polygon add <numSides> <centerX> <centerY> <centerZ> <normX> <normY> <normZ> <radius> <name>
polygon color <r> <g> <b> <?name?>
polygon culling <bool> <?name?>
polygon delete <?name?>
polygon edges <bool> <?name?>
polygon flipnorms <bool> <?name?>
polygon lighting <bool> <?name?>
polygon linecolor <r> <g> <b> <?name?>
polygon linewidth <val> <?name?>
polygon material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
polygon opacity <val> <?name?>
polygon orient <qw> <qx> <qy> <qz> <?name?>
polygon origin <x> <y> <z> <?name?>
polygon pos <x> <y> <z> <?name?>
polygon scale <sx> <sy> <sz> <?name?>
polygon shading <val> <?name?>
        val = flat|smooth
polygon visible <bool> <?name?>
polygon wireframe <bool> <?name?>

pseudocolor add <?datasetName?>
pseudocolor cloudstyle <style> <?datasetName?>
            <style> = mesh | points | splat
pseudocolor color <r> <g> <b> <?datasetName?>
pseudocolor colormap <colormapName> <?datasetName?>
pseudocolor colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
            Set the field used to color the object.  'constant' means to use
            the constant color defined by the color subcommand.  'scalar' uses
            the active scalar field.  'vmag' uses the magnitude of the current
            vector field, and 'vx','vy','vz' use the corresponding component of
            the active vector field.
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 orient <qw> <qx> <qy> <qz> <?dataSetName?>
pseudocolor pos <x> <y> <z> <?dataSetName?>
pseudocolor preinterp <bool> <?dataSetName?>
            Controls if VTK's InterpolateScalarsBeforeMapping option is set.
            Setting this on will give more correct colors, as the interpolation
            is done on texture coordinates that lookup into a 1D texture instead
            of using color interpolation from triangle vertices.
pseudocolor ptsize <size> <?dataSetName?>
pseudocolor scale <sx> <sy> <sz> <?dataSetName?>
pseudocolor visible <bool> <?datasetName?>
pseudocolor wireframe <bool> <?datasetName?>

sphere add <centerX> <centerY> <centerZ> <radius> <name>
sphere color <r> <g> <b> <?name?>
sphere culling <bool> <?name?>
sphere delete <?name?>
sphere edges <bool> <?name?>
sphere flipnorms <bool> <?name?>
sphere lighting <bool> <?name?>
sphere linecolor <r> <g> <b> <?name?>
sphere linewidth <val> <?name?>
sphere material <ambientCoeff> <diffuseCoeff> <specularCoeff> <specularExp> <?name?>
sphere opacity <val> <?name?>
sphere orient <qw> <qx> <qy> <qz> <?name?>
sphere origin <x> <y> <z> <?name?>
sphere pos <x> <y> <z> <?name?>
sphere resolution <thetaRes> <phiRes> <?name?>
sphere scale <sx> <sy> <sz> <?name?>
sphere section <thetaStart> <thetaEnd> <phiStart> <phiEnd> <?name?>
       Angles are in degrees
sphere shading <val> <?name?>
       val = flat|smooth
sphere visible <bool> <?name?>
sphere wireframe <bool> <?name?>

streamlines add <?datasetName?>
streamlines color <r> <g> <b> <?datasetName?>
            Set the constant color of streamlines used for color mode 'constant'
streamlines colormap <colormapName> <?datasetName?>
            Colormap used to color streamlines/tubes/ribbons by vector magnitude
streamlines colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
            Set the field used to color the streamlines.  'constant' means to use
            the constant color defined by the color subcommand.  'scalar' uses
            the active scalar field.  'vmag' uses the magnitude of the current
            vector field, and 'vx','vy','vz' use the corresponding component of
            the active vector field.
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 orient <qw> <qx> <qy> <qz> <?dataSetName?>
streamlines pos <x> <y> <z> <?dataSetName?>
streamlines ribbons <width> <angle> <?datasetName?>
            Set rendering type to ribbons, width is minimum half-width, angle is
            degrees offset from normal orientation
streamlines scale <sx> <sy> <sz> <?dataSetName?>
streamlines seed color <r> <g> <b> <?datasetName?>
streamlines seed disk <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <radius> <innerRadius> <numPoints> <?dataSetName?>
            Create a disk seed area with optional hole, filled with randomly 
            placed points
streamlines seed fmesh <numPoints> data follows <nbytes> <?datasetName?>
            Fill a mesh supplied as a VTK data file with randomly placed points
streamlines seed fpoly <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <angle> <radius> <numSides> <numPoints> <?dataSetName?>
            Create a regular n-sided polygonal seed area filled with randomly 
            placed points
streamlines seed mesh data follows <nbytes> <?datasetName?>
            Use points of a mesh supplied as a VTK data file
streamlines seed numpts <?datasetName?>
            If seeds have been created using 'seed random', 'seed fmesh',
            'seed mesh' or 'seed points' this command can be used to change the 
            number of randomly distributed seeds.  In the case of 'seed mesh'
            or 'seed points', the number is the maximum number of points of the 
            mesh to be used -- the actual number may be fewer if the mesh
            contains fewer points.  Set to a number less than 0 to use all the
            points of the mesh.
streamlines seed points <?datasetName?>
            Use points of the streamlines' dataset mesh
streamlines seed polygon <centerX> <centerY> <centerZ> <normalX> <normalY> <normalZ> <angle> <radius> <numSides> <?dataSetName?>
            Create seed points from vertices of a regular n-sided polygon
streamlines seed ptsize <size> <?datasetName?>
            Set the point size for rendering seed points
streamlines seed rake <startX> <startY> <startZ> <endX> <endY> <endZ> <numPoints> <?datasetName?>
streamlines seed random <numPoints> <?datasetName?>
            Fill the streamlines' dataset mesh with randomly placed points
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?>

text3d add <textString> <name>
text3d bold <bool> <?name?>
text3d color <r> <g> <b> <?name?>
text3d delete <?name?>
text3d fntfamily <fontName> <?name?>
text3d fntsize <fontSize> <?name?>
text3d follow <bool> <?name?>
       Toggle text automatically aligning toward camera
text3d italic <bool> <?name?>
text3d opacity <opacity> <?name?>
text3d orient <qw> <qx> <qy> <qz> <?name?>
text3d origin <x> <y> <z> <?name?>
text3d pos <x> <y> <z> <?name?>
text3d scale <sx> <sy> <sz> <?name?>
text3d shadow <bool> <?name?>
text3d text <text> <?name?>
text3d visible <bool> <?name?>

volume add <?datasetName?>
volume blendmode <mode> <?dataSetName?>
       mode = composite|max_intensity|min_intensity|additive
volume colormap <colorMapName> <?datasetName?>
volume delete <?datasetName?>
volume lighting <bool> <?datasetName?>
volume opacity <opacity> <?datasetName?>
volume orient <qw> <qx> <qy> <qz> <?dataSetName?>
volume pos <x> <y> <z> <?dataSetName?>
volume quality <val> <?datasetName?>
       val = [0,1]
volume scale <sx> <sy> <sz> <?dataSetName?>
volume shading ambient <coeff> <?datasetName?>
volume shading diffuse <coeff> <?datasetName?>
volume shading specular <coeff> <power> <?datasetName?>
volume visible <bool> <?datasetName?>

warp add <?dataSetName?>
warp cloudstyle <style> <?datasetName?>
     <style> = mesh | points
warp color <r> <g> <b> <?datasetName?>
warp colormap <colormapName> <?datasetName?>
warp colormode <scalar|vmag|vx|vy|vz|constant> <fieldName> <?datasetName?>
     Set the field used to color the object.  'constant' means to use
     the constant color defined by the color subcommand.  'scalar' uses
     the active scalar field.  'vmag' uses the magnitude of the current
     vector field, and 'vx','vy','vz' use the corresponding component of
     the active vector field.
warp delete <?dataSetName?>
warp edges <bool> <?dataSetName?>
warp lighting <bool> <?dataSetName?>
warp linecolor <r> <g> <b> <?dataSetName?>
warp linewidth <width> <?dataSetName?>
warp opacity <value> <?dataSetName?>
warp orient <qw> <qx> <qy> <qz> <?dataSetName?>
warp pos <x> <y> <z> <?dataSetName?>
warp preinterp <bool> <?dataSetName?>
     Controls if VTK's InterpolateScalarsBeforeMapping option is set.
     Setting this on will give more correct colors, as the interpolation
     is done on texture coordinates that lookup into a 1D texture instead
     of using color interpolation from triangle vertices.
warp ptsize <size> <?dataSetName?>
warp scale <sx> <sy> <sz> <?dataSetName?>
warp visible <bool> <?dataSetName?>
warp warpscale <value> <?dataSetName?>
     Specify amount to scale vector magnitudes when warping
warp wireframe <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 {x y w h} -bytes <nbytes>
  <binary RGB data>
  The bounding box of the 2D image camera zoom region is supplied
  Note: The bbox coordinates are in the form used by 'camera ortho world ...':
  x,y - world coord. of lower left corner, w,h - width height in world coords
  This form is currently used only if the camera mode is set to 'image'.
nv>legend <colormapName> <title> <rmin> <rmax> <nbytes>
  <binary RGB data>
nv>dataset names <Tcl list of names>
nv>dataset scalar world <x> <y> <z> <value> <dataSetName>
nv>dataset scalar pixel <x> <y> <value> <dataSetName>
nv>dataset vector world <x> <y> <z> <valueX> <valueY> <valueZ> <dataSetName>
nv>dataset vector pixel <x> <y> <valueX> <valueY> <valueZ> <dataSetName>
nv>ok -token <seqnum>
   Reply indicated commands through <seqnum> (numbered beginning at 1) have been
   processed, but no new image was rendered
================================================================================
Error Replies:
================================================================================
nv>viserror -bytes <nbytes>
   <multi-line error string of nbytes>
================================================================================