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 standard
  24 and "keyboard free" interaction styles. "Keyboard free" style allows
  25 to process all view transformations without using keyboard (only by
  26 mouse) and perform selection in view by pressing "S" key. By default,
  27 rotation in this mode is performed by left mouse button, panning - by
  28 middle mouse button, zooming - by left and middle mouse buttons
  29 pressed simultaneously.
  30 <hr>
  31
  32 \image html occ_view_zooming_style_switch.png
  33
  34 <b>Zooming style switch</b> - allows to switch between standard
  35 (zooming at the center of the view) and advanced (zooming at the
  36 current cursor position) zooming styles.
  37 <hr>
  38
  39 \image html occ_view_triedre.png
  40
  41 <b>Show/Hide Trihedron</b> - shows or hides coordinate axes.
  42 <hr>
  43
  44 \image html occ_view_preselection.png
  45
  46 <b>Enable/Disable preselection</b> - enables or disables preselection (highlighting) in the view.
  47 <hr>
  48
  49 \image html occ_view_selection.png
  50
  51 <b>Enable/Disable selection</b> - enables or disables selection in the view.
  52 <hr>
  53
  54 \image html occ_view_fitall.png
  55
  56 <b>Fit all</b> - allows to select a point to be the center of a scene
  57 representing all displayed objects in the visible area.
  58 <hr>
  59
  60 \image html occ_view_fitarea.png
  61
  62 <b>Fit area</b> - resizes the view to place in the visible area only
  63 the contents of a frame drawn with pressed left mouse button.
  64 <hr>
  65
  66 \image html occ_view_fitselection.png
  67
  68 <b>Fit selection</b> - fits view contents to the current selection.
  69 <hr>
  70
  71 \image html occ_view_zoom.png
  72
  73 <b>Zoom</b> - allows to zoom in and out.
  74 <hr>
  75
  76 \image html occ_view_pan.png
  77
  78 <b>Panning</b> - if the represented objects are greater that the
  79 visible area and you don't wish to use <b>Fit all</b> functionality,
  80 click on this button and you'll be able to drag the scene to see its
  81 remote parts.
  82 <hr>
  83
  84 \image html occ_view_glpan.png
  85
  86 <b>Global panning</b> - represents all displayed objects in the
  87 visible area.
  88 <hr>
  89
  90 \image html occ_view_rotation_point.png
  91
  92 <b>Change rotation point</b> - allows to to choose the point around
  93 which the rotation is performed.
  94
  95 \image html set_rotation_point_dialog1.png
  96
  97 By default the rotation point is located in the Center of the bounding
  98 box of an object.
  99
 100 \image html set_rotation_point_dialog2.png
 101
 102 Disabling <b>Use Bounding Box Center</b> check-box allows you to
 103 define the coordinates of the rotation point manually.
 104
 105 - <b>Set to Origin</b> button restores the default rotation point
 106   coordinates.
 107
 108 - <b>Gravity Center of Selected Object</b> button allows using the gravity center of the object selected in the viewer as the center of the rotation point.
 109 When you click this button, you should first choose the type of selectable object: Point, Edge, Face or Solid and only then proceed with selection in the viewer.
 110
 111 <hr>
 112
 113 \image html occ_view_rotate.png
 114
 115 <b>Rotation</b> - allows to rotate the selected object using the
 116 mouse.
 117 <hr>
 118
 119 \image html occ_view_front.png
 120 \image html occ_view_back.png
 121 \image html occ_view_top.png
 122 \image html occ_view_bottom.png
 123 \image html occ_view_left.png
 124 \image html occ_view_right.png
 125
 126 These buttons orientate the scene strictly about coordinate axes:
 127 \b Front, \b Back, \b Top, \b Bottom, \b Left or \b Right side.
 128 <hr>
 129
 130 \image html occ_view_anticlockwise.png
 131
 132 <b>Rotate counterclockwise</b> - rotates view 90 @htmlonly &deg; @endhtmlonly counterclockwise.
 133 <hr>
 134
 135 \image html occ_view_clockwise.png
 136
 137 <b>Rotate clockwise</b> - rotates view 90 @htmlonly &deg; @endhtmlonly clockwise.
 138 <hr>
 139
 140 \image html occ_view_reset.png
 141
 142 <b>Reset</b> - restores the default position (isometric) of objects in
 143 the scene.
 144 <hr>
 145
 146 \image html occ_view_shoot.png
 147
 148 <b>Memorise view</b> - saves the current position of objects in the
 149 scene.
 150 <hr>
 151
 152 \image html occ_view_presets.png
 153
 154 <b>Restore view</b> - restores the saved position of objects in the
 155 scene.
 156 <hr>
 157
 158 \image html occ_view_clone.png
 159
 160 <b>Clone view</b> - opens a new duplicate scene.
 161 <hr>
 162
 163 \anchor clipping_planes
 164
 165 \b Clipping allows creating cross-section views (clipping planes)
 166 of your mesh.
 167
 168 To create a clipping plane, click on the \b New button in the dialog and choose how it is  definition by \b Absolute or \b Relative coordinates.
 169
 170 <b>Absolute Coordinates</b>
 171
 172 \image html Clipping_Absolute.png
 173
 174 - <b>Base point</b> - allows defining the coordinates of the base
 175   point for the clipping plane.
 176
 177   - <b>Reset</b> - returns the base point to coordinate origin.
 178
 179 - <b>Direction</b> - allows defining the orientation of the
 180   clipping plane.
 181
 182         - <b>Invert</b> - allows selecting, which part of the object will be
 183     removed and which will remain after clipping.
 184
 185 <b>Relative mode</b>
 186
 187 \image html Clipping_Relative.png
 188
 189 - \b Orientation ( ||X-Y, ||X-Z or ||Y-Z).
 190
 191 - \b Distance between the opposite extremities of the boundary box of
 192 selected objects, if it is set to 0.5 the boundary box is split in two halves.
 193
 194 - \b Rotation (in angle degrees) <b>around X</b> (Y to Z) and <b>around
 195 Y</b> (X to Z) (depending on the chosen Orientation)
 196
 197 The other parameters are available in both modes :
 198 - <b>Preview</b> check-box shows the clipping plane in the <b>3D Viewer</b>.
 199 - <b>Auto Apply</b> check-box shows button is on, you can preview the
 200 cross-section in the <b>3D Viewer</b>.
 201
 202 It is also possible to interact  with the clipping plane directly in 3D
 203 view using the mouse.
 204
 205 <hr>
 206
 207 \image html occ_view_scaling.png
 208
 209 <b>Scaling</b> - represents objects deformed (stretched or stuffed)
 210 along the axes of coordinates.
 211 <hr>
 212
 213 \image html occ_view_graduated_axes.png
 214
 215 <b>Graduated axes</b> - allows to define axes parameters and graduate
 216 them.
 217
 218 \image html graduatedaxes2.png
 219
 220 - <b>Axis name</b> - if checked the axis name is displayed in the viewer.
 221
 222   - <b>Name</b> - allows to redefine the axis name.
 223
 224   - <b>Font</b> - allows to define the font color of the axis name.
 225
 226 - <b>Labels</b> - if checked the labels are displayed in the viewer.
 227
 228   - <b>Number</b> - allows to define the number of labels.
 229
 230   - <b>Offset</b> - allows to define the distance between labels.
 231
 232   - <b>Font</b> - allows to define the font color of labels names.
 233
 234 - <b>Tick marks</b> - if checked the tick marks are displayed in the viewer.
 235
 236   - <b>Length</b> - allows to define the length of tick marks.
 237
 238 - <b>Is visible</b> - if checked the axis is displayed in the viewer.
 239
 240 <hr>
 241
 242 \image html occ_view_ambient.png
 243
 244 <b>Toggle ambient light</b> - toggle "keep only ambient light" flag
 245 on/off.
 246 <hr>
 247
 248 \image html occ_view_minimized.png
 249 \image html occ_view_maximized.png
 250
 251 <b>Minimize/Maximize</b> - these buttons allow switching the current
 252 view area to the minimized / maximized state.
 253 <hr>
 254
 255 \image html occ_view_return_3d_view.png
 256
 257 <b>Return to 3D</b> - this button switches from 2D view projection back to the 3D view mode.
 258 <hr>
 259
 260 \image html occ_view_sync.png
 261
 262 <b>Synchronize view</b> - allows to synchronize 3d view
 263 parameters. This button has two states - checked and
 264 unchecked. Clicking on this button opens a drop-down menu listing the
 265 compatible 3d views. As soon as the user selects any view from the
 266 list, the parameters (view point, position, zoom coefficient, etc.) of
 267 the current view are synchronized with the selected view (static
 268 synchronization).
 269
 270 In addition, when this button is in the "checked" state, the dynamic
 271 synchronization of the views is performed, i.e. any zoom, pan, rotate
 272 or other view operation done in one view is automatically applied to
 273 the other view.
 274 <hr>
 275
 276
 277 */