doc/salome/gui/input/vtk_3d_viewer.doc

   1 /*!
   2
   3 \page vtk_3d_viewer_page VTK 3D Viewer
   4
   5 The functionalities of VTK viewer are available via its Viewer
   6 Toolbar. Buttons marked with small downward triangles have extended
   7 functionality which can be accessed by locking on them with left mouse
   8 button.
   9
  10 \image html image157.gif "Viewer Toolbar"
  11
  12 <hr>
  13 \image html image77.png
  14 \n <center><b>Dump View</b> - exports an object from the viewer in bmp, png, jpg
  15 or jpeg image format.</center>
  16 <hr>
  17
  18 \image html image88.gif
  19 \n <center><b>Show/Hide Trihedron</b> - shows or hides coordinate axes.</center>
  20 <hr>
  21
  22 \image html image96.png
  23 \n <center><b>Fit all</b> - scales the presentation so that it could
  24 fit within the Viewer boundaries. </center>
  25 <hr>
  26
  27 \image html image97.png
  28 \n <center><b>Fit area</b> - resizes the view to place in the visible area
  29 only the contents of a frame drawn with pressed left mouse button.</center>
  30 <hr>
  31
  32 \image html image98.png
  33 \n <center><b>Zoom</b> - allows to zoom in and out.</center>
  34 <hr>
  35
  36 \image html image99.png
  37 \n <center><b>Panning</b> - if the represented objects are greater that the
  38 visible area and you don't wish to use <b>Fit all</b> functionality, click on
  39 this button and you'll be able to drag the scene to see its remote
  40 parts.</center>
  41 <hr>
  42
  43 \image html image100.png
  44 \n <center><b>Global panning</b> - allows to select a point to be the
  45 center of the presentation showing all displayeed objects in the
  46 visible ares <center>
  47 <hr>
  48
  49 \image html view_rotation_point.png
  50 \n <center><b>Change rotation point</b> - allows to to choose the point around
  51 which the rotation is performed.</center>
  52
  53 \image html set_rotation_point_dialog1.png
  54
  55 <center>By default the rotation point is located in the Center of the bounding
  56 box of an object.</center>
  57
  58 \image html set_rotation_point_dialog2.png
  59
  60 <center>Unchecking <b>Use Bounding Box Center</b> checkbox allows you to
  61 define the coordinates of the rotation point manually.</center>
  62
  63 <b>Set to Origin</b> button restores the default rotation point
  64 coordinates.\n
  65 <b>Select Point from View</b> button allows to select the rotation
  66 point in the 3D Viewer.
  67 <hr>
  68
  69 \image html image89.png
  70 \n <center><b>Rotation</b> - allows to rotate the selected object using the
  71 mouse.</center>
  72
  73 \image html image102.gif
  74
  75 <center>These buttons orientate the scene strictly about coordinate axes.</center>
  76 <hr>
  77
  78 \image html image91.png
  79 \n <center><b>Reset</b> - restores the default position (isometric) of
  80 objects in the scene.</center>
  81 <hr>
  82
  83 \image html urbutton.png
  84 \n <center><b>Update Rate</b> - allows to define the Update Rate for
  85 the presentations displayed in the viewer</center>
  86
  87 \image html updaterate.png
  88
  89 <ul>
  90 <li><b>Desired Update Rate, FPS</b> - allows to set the target Update
  91 Rate</li>
  92 <li><b>Still Update Rate, FPS</b> - allows to set the Update Rate for
  93 the periods when both the user and the application do not perform any
  94 actions in the viewer</li>
  95 <li><b>Current Update Rate, FPS</b> - shows the Update Rate currently
  96 available on your configuration</li>
  97 <li><b>Number of Cells</b> - shows the number of cells currently in
  98 display</li>
  99 </ul>
 100
 101 \image html image108.png
 102 \n <center><b>Scaling</b> - represents objects deformed (stretched or
 103 stuffed) along the axes of coordinates.</center>
 104 <hr>
 105
 106 \image html image109.gif
 107 \n <center><b>Graduated axes</b> - allows to define parameters of axes
 108 and graduate them.</center>
 109
 110 \image html graduatedaxes1.png
 111
 112 <ul>
 113 <li><b>Axis name</b></li>
 114 <ul>
 115 <li><b>Is visible</b> - if checked the axis name is displayed in the
 116 viewer.</li>
 117 <li><b>Name</b> - allows to redefine the name of the axis.</li>
 118 <li><b>Font</b> - allows to define color and properties of the font of
 119 axis name.</li>
 120 </ul>
 121 <li><b>Labels</b></li>
 122 <ul>
 123 <li><b>Is visible</b> - if checked the labels are displayed in the
 124 viewer.</li>
 125 <li><b>Number</b> - allows to define the number of labels.</li>
 126 <li><b>Offset</b> - allows to define the distance between labels.</li>
 127 <li><b>Font</b> - allows to define color and properties of the font of
 128 labels names.</li>
 129 </ul>
 130 <li><b>Tick marks</b></li>
 131 <ul>
 132 <li><b>Is visible</b> - if checked the tick marks are displayed in the
 133 viewer.</li>
 134 <li><b>Length</b> - allows to define the length of tick marks.</li>
 135 </ul>
 136 <li><b>Is visible</b> - if checked the axis is displayed in the
 137 viewer. </li>
 138 </ul>
 139
 140 */