Changeset 4239 for branches/1.3/packages/vizservers/vtkvis/protocol.txt

Timestamp:

Mar 11, 2014, 11:38:22 AM (11 years ago)

Author:

ldelgass

Message:

merge r4040 from trunk. Brings vtkvis up to date with installed version

Location:

branches/1.3

Files:

• . (modified) (1 prop)
• packages/vizservers/vtkvis/protocol.txt (modified) (3 diffs)

branches/1.3/packages/vizservers/vtkvis/protocol.txt

@@ -3 +3 @@
 Protocol for vtkvis render server.  
 
-Commands take the general form of command and arguments using Tcl syntax and are 
+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 
@@ -125 +125 @@
      <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.
+     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
@@ -247 +247 @@
          direction determines normal of clipping plane.  User clip planes do not
          apply if camera mode is image.
-renderer depthpeel <bool>
+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