doc/salome/gui/input/occ_3d_viewer.doc

   1 /*!
   2
   3 \page occ_3d_viewer_page OCC 3D Viewer
   4
   5 <h2>Operations</h2>
   6
   7 The functionalities of OCC viewer are available via its Viewer
   8 Toolbar. Buttons marked with small downward triangles have extended
   9 functionality which can be accessed by locking on them with left mouse
  10 button.
  11
  12 \image html occviewer_toolbar.png
  13 <hr>
  14
  15 \image html occ_view_camera_dump.png
  16
  17 <b>Dump View</b> - exports an object from the viewer in bmp, png or
  18 jpeg image format.
  19 <hr>
  20
  21 \image html occ_view_style_switch.png
  22
  23 <b>Interaction style switch</b> - allows to switch between "Salome
  24 standard controls" and "Keyboard free" \ref viewer_navigation_modes "interaction styles".
  25
  26 <hr>
  27
  28 \image html occ_view_zooming_style_switch.png
  29
  30 <b>Zooming style switch</b> - allows to switch between standard
  31 (zooming at the center of the view) and advanced (zooming at the
  32 current cursor position) zooming styles.
  33 <hr>
  34
  35 \image html occ_view_triedre.png
  36
  37 <b>Show/Hide Trihedron</b> - shows or hides coordinate axes.
  38 <hr>
  39
  40 \image html occ_view_fitall.png
  41
  42 <b>Fit all</b> - allows to select a point to be the center of a scene
  43 representing all displayed objects in the visible area.
  44 <hr>
  45
  46 \image html occ_view_fitarea.png
  47
  48 <b>Fit area</b> - resizes the view to place in the visible area only
  49 the contents of a frame drawn with pressed left mouse button.
  50 <hr>
  51
  52 \image html occ_view_zoom.png
  53
  54 <b>Zoom</b> - allows to zoom in and out.
  55 <hr>
  56
  57 \image html occ_view_pan.png
  58
  59 <b>Panning</b> - if the represented objects are greater that the
  60 visible area and you don't wish to use <b>Fit all</b> functionality,
  61 click on this button and you'll be able to drag the scene to see its
  62 remote parts.
  63 <hr>
  64
  65 \image html occ_view_glpan.png
  66
  67 <b>Global panning</b> - represents all displayed objects in the
  68 visible area.
  69 <hr>
  70
  71 \image html occ_view_rotation_point.png
  72
  73 <b>Change rotation point</b> - allows to to choose the point around
  74 which the rotation is performed.
  75
  76 \image html set_rotation_point_dialog1.png
  77
  78 By default the rotation point is located in the Center of the bounding
  79 box of an object.
  80
  81 \image html set_rotation_point_dialog2.png
  82
  83 Unchecking <b>Use Bounding Box Center</b> checkbox allows you to
  84 define the coordinates of the rotation point manually.
  85
  86 - <b>Set to Origin</b> button restores the default rotation point
  87   coordinates.
  88
  89 - <b>Select Point from View</b> button allows to select the rotation
  90   point in the 3D Viewer.
  91
  92 <hr>
  93
  94 \image html occ_view_rotate.png
  95
  96 <b>Rotation</b> - allows to rotate the selected object using the
  97 mouse.
  98 <hr>
  99
 100 \image html occ_view_front.png
 101 \image html occ_view_back.png
 102 \image html occ_view_top.png
 103 \image html occ_view_bottom.png
 104 \image html occ_view_left.png
 105 \image html occ_view_right.png
 106
 107 These buttons orientate the scene strictly about coordinate axes:
 108 \b Front, \b Back, \b Top, \b Bottom, \b Left or \b Right side.
 109 <hr>
 110
 111 \image html occ_view_anticlockwise.png
 112
 113 <b>Rotate counterclockwise</b> - rotates view 90 @htmlonly &deg; @endhtmlonly counterclockwise.
 114 <hr>
 115
 116 \image html occ_view_clockwise.png
 117
 118 <b>Rotate clockwise</b> - rotates view 90 @htmlonly &deg; @endhtmlonly clockwise.
 119 <hr>
 120
 121 \image html occ_view_reset.png
 122
 123 <b>Reset</b> - restores the default position (isometric) of objects in
 124 the scene.
 125 <hr>
 126
 127 \image html occ_view_shoot.png
 128
 129 <b>Memorise view</b> - saves the current position of objects in the
 130 scene.
 131 <hr>
 132
 133 \image html occ_view_presets.png
 134
 135 <b>Restore view</b> - restores the saved position of objects in the
 136 scene.
 137 <hr>
 138
 139 \image html occ_view_clone.png
 140
 141 <b>Clone view</b> - opens a new duplicate scene.
 142 <hr>
 143
 144 \image html occ_view_clipping.png
 145
 146 <b>Clipping</b> - allows to create cross-section views (clipping
 147 planes) of geometrical objects.
 148
 149 \image html clipping.png
 150
 151 - <b>Base point</b> - allows to define the coordinates of the base
 152   point for the clipping plane.
 153
 154   - <b>Reset</b> - returns the base point to coordinate origin.
 155
 156 - <b>Direction</b> - allows to define the orientation of the
 157   clipping plane.
 158
 159   - <b>Invert</b> - allows to select which part of the object will be
 160     removed and which will remain after clipping.
 161
 162 - <b>Preview</b> - allows to see the results of clipping in the
 163   viewer.
 164
 165 <hr>
 166
 167 \image html occ_view_scaling.png
 168
 169 <b>Scaling</b> - represents objects deformed (stretched or stuffed)
 170 along the axes of coordinates.
 171 <hr>
 172
 173 \image html occ_view_graduated_axes.png
 174
 175 <b>Graduated axes</b> - allows to define axes parameters and graduate
 176 them.
 177
 178 \image html graduatedaxes2.png
 179
 180 - <b>Axis name</b> - if checked the axis name is displayed in the viewer.
 181
 182   - <b>Name</b> - allows to redefine the axis name.
 183
 184   - <b>Font</b> - allows to define the font color of the axis name.
 185
 186 - <b>Labels</b> - if checked the labels are displayed in the viewer.
 187
 188   - <b>Number</b> - allows to define the number of labels.
 189
 190   - <b>Offset</b> - allows to define the distance between labels.
 191
 192   - <b>Font</b> - allows to define the font color of labels names.
 193
 194 - <b>Tick marks</b> - if checked the tick marks are displayed in the viewer.
 195
 196   - <b>Length</b> - allows to define the length of tick marks.
 197
 198 - <b>Is visible</b> - if checked the axis is displayed in the viewer.
 199
 200 <hr>
 201
 202 \image html occ_view_ambient.png
 203
 204 <b>Toggle ambient light</b> - toggle "keep only ambient light" flag
 205 on/off.
 206 <hr>
 207
 208 \image html occ_view_minimized.png
 209 \image html occ_view_maximized.png
 210
 211 <b>Minimize/Maximize</b> - these buttons allow switching the current
 212 view area to the minimized / maximized state.
 213 <hr>
 214
 215 \image html occ_view_sync.png
 216
 217 <b>Synchronize view</b> - allows to synchronize 3d view
 218 parameters. This button has two states - checked and
 219 unchecked. Clicking on this button opens a drop-down menu listing the
 220 compatible 3d views. As soon as the user selects any view from the
 221 list, the parameters (view point, position, zoom coefficient, etc.) of
 222 the current view are synchronized with the selected view (static
 223 synchronization).
 224
 225 In addition, when this button is in the "checked" state, the dynamic
 226 synchronization of the views is performed, i.e. any zoom, pan, rotate
 227 or other view operation done in one view is automatically applied to
 228 the other view.
 229
 230 */