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