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_fitall.png
  45
  46 <b>Fit all</b> - allows to select a point to be the center of a scene
  47 representing all displayed objects in the visible area.
  48 <hr>
  49
  50 \image html occ_view_fitarea.png
  51
  52 <b>Fit area</b> - resizes the view to place in the visible area only
  53 the contents of a frame drawn with pressed left mouse button.
  54 <hr>
  55
  56 \image html occ_view_zoom.png
  57
  58 <b>Zoom</b> - allows to zoom in and out.
  59 <hr>
  60
  61 \image html occ_view_pan.png
  62
  63 <b>Panning</b> - if the represented objects are greater that the
  64 visible area and you don't wish to use <b>Fit all</b> functionality,
  65 click on this button and you'll be able to drag the scene to see its
  66 remote parts.
  67 <hr>
  68
  69 \image html occ_view_glpan.png
  70
  71 <b>Global panning</b> - represents all displayed objects in the
  72 visible area.
  73 <hr>
  74
  75 \image html occ_view_rotation_point.png
  76
  77 <b>Change rotation point</b> - allows to to choose the point around
  78 which the rotation is performed.
  79
  80 \image html set_rotation_point_dialog1.png
  81
  82 By default the rotation point is located in the Center of the bounding
  83 box of an object.
  84
  85 \image html set_rotation_point_dialog2.png
  86
  87 Unchecking <b>Use Bounding Box Center</b> checkbox allows you to
  88 define the coordinates of the rotation point manually.
  89
  90 - <b>Set to Origin</b> button restores the default rotation point
  91   coordinates.
  92
  93 - <b>Select Point from View</b> button allows to select the rotation
  94   point in the 3D Viewer.
  95
  96 <hr>
  97
  98 \image html occ_view_rotate.png
  99
 100 <b>Rotation</b> - allows to rotate the selected object using the
 101 mouse.
 102 <hr>
 103
 104 \image html occ_view_front.png
 105 \image html occ_view_back.png
 106 \image html occ_view_top.png
 107 \image html occ_view_bottom.png
 108 \image html occ_view_left.png
 109 \image html occ_view_right.png
 110
 111 These buttons orientate the scene strictly about coordinate axes:
 112 \b Front, \b Back, \b Top, \b Bottom, \b Left or \b Right side.
 113 <hr>
 114
 115 \image html occ_view_anticlockwise.png
 116
 117 <b>Rotate counterclockwise</b> - rotates view 90 @htmlonly &deg; @endhtmlonly counterclockwise.
 118 <hr>
 119
 120 \image html occ_view_clockwise.png
 121
 122 <b>Rotate clockwise</b> - rotates view 90 @htmlonly &deg; @endhtmlonly clockwise.
 123 <hr>
 124
 125 \image html occ_view_reset.png
 126
 127 <b>Reset</b> - restores the default position (isometric) of objects in
 128 the scene.
 129 <hr>
 130
 131 \image html occ_view_shoot.png
 132
 133 <b>Memorise view</b> - saves the current position of objects in the
 134 scene.
 135 <hr>
 136
 137 \image html occ_view_presets.png
 138
 139 <b>Restore view</b> - restores the saved position of objects in the
 140 scene.
 141 <hr>
 142
 143 \image html occ_view_clone.png
 144
 145 <b>Clone view</b> - opens a new duplicate scene.
 146 <hr>
 147
 148 \image html occ_view_clipping.png
 149
 150 <b>Clipping</b> - allows to create cross-section views (clipping
 151 planes) of geometrical objects.
 152
 153 \image html clipping.png
 154
 155 - <b>Base point</b> - allows to define the coordinates of the base
 156   point for the clipping plane.
 157
 158   - <b>Reset</b> - returns the base point to coordinate origin.
 159
 160 - <b>Direction</b> - allows to define the orientation of the
 161   clipping plane.
 162
 163   - <b>Invert</b> - allows to select which part of the object will be
 164     removed and which will remain after clipping.
 165
 166 - <b>Preview</b> - allows to see the results of clipping in the
 167   viewer.
 168
 169 <hr>
 170
 171 \image html occ_view_scaling.png
 172
 173 <b>Scaling</b> - represents objects deformed (stretched or stuffed)
 174 along the axes of coordinates.
 175 <hr>
 176
 177 \image html occ_view_graduated_axes.png
 178
 179 <b>Graduated axes</b> - allows to define axes parameters and graduate
 180 them.
 181
 182 \image html graduatedaxes2.png
 183
 184 - <b>Axis name</b> - if checked the axis name is displayed in the viewer.
 185
 186   - <b>Name</b> - allows to redefine the axis name.
 187
 188   - <b>Font</b> - allows to define the font color of the axis name.
 189
 190 - <b>Labels</b> - if checked the labels are displayed in the viewer.
 191
 192   - <b>Number</b> - allows to define the number of labels.
 193
 194   - <b>Offset</b> - allows to define the distance between labels.
 195
 196   - <b>Font</b> - allows to define the font color of labels names.
 197
 198 - <b>Tick marks</b> - if checked the tick marks are displayed in the viewer.
 199
 200   - <b>Length</b> - allows to define the length of tick marks.
 201
 202 - <b>Is visible</b> - if checked the axis is displayed in the viewer.
 203
 204 <hr>
 205
 206 \image html occ_view_ambient.png
 207
 208 <b>Toggle ambient light</b> - toggle "keep only ambient light" flag
 209 on/off.
 210 <hr>
 211
 212 \image html occ_view_minimized.png
 213 \image html occ_view_maximized.png
 214
 215 <b>Minimize/Maximize</b> - these buttons allow switching the current
 216 view area to the minimized / maximized state.
 217 <hr>
 218
 219 \image html occ_view_sync.png
 220
 221 <b>Synchronize view</b> - allows to synchronize 3d view
 222 parameters. This button has two states - checked and
 223 unchecked. Clicking on this button opens a drop-down menu listing the
 224 compatible 3d views. As soon as the user selects any view from the
 225 list, the parameters (view point, position, zoom coefficient, etc.) of
 226 the current view are synchronized with the selected view (static
 227 synchronization).
 228
 229 In addition, when this button is in the "checked" state, the dynamic
 230 synchronization of the views is performed, i.e. any zoom, pan, rotate
 231 or other view operation done in one view is automatically applied to
 232 the other view.
 233 <hr>
 234
 235 \anchor occ_background
 236 <h2>Background</h2>
 237
 238 OCC Viewer background can be customized using the "Change background"
 239 popup menu command that opens the following dialog box:
 240
 241 \image html change_background_dlg.png
 242
 243 The following types of the background are supported:
 244
 245 - Single color: the background is colored with the solid color
 246   specified by the user in the dialog box.
 247
 248 - Gradient background: the background is gradiently colored according
 249   to two colors and the gradient type specified in the dialog box. The
 250   following types of background are supported:
 251
 252   - Horizontal
 253
 254   - Vertical
 255
 256   - First diagonal
 257
 258   - Second diagonal
 259
 260   - First corner
 261
 262   - Second corner
 263
 264   - Third corner
 265
 266   - Fourth corner
 267
 268 - Image: allows to set image as viewer background and define filling type:
 269
 270   - Center: the image is located at the center of the viewer backgound
 271
 272   - Tile: the image fills the entire viewer backgound one by one
 273
 274   - Stretch: the image is stretched to the entire viewer backgound.
 275
 276 Default background for the viewer is specified via the
 277 \ref occ_preferences "application preferences".
 278
 279 <h2>Polyline selection</h2>
 280
 281 OCC Viewer features a special <b>Polyline Selection</b> mechanism,
 282 which allows selecting an arbitraty part of the graphic area using a
 283 polygon frame (rubber band), instead of the usual selection with a
 284 rectangular frame.
 285
 286 To produce a Polyline Selection, lock the right mouse button and draw
 287 the first side of the polygon, then change the direction by clicking
 288 the left mouse button add draw another side, etc. The whole selection
 289 frame is drawn with the locked right mouse button.
 290
 291 \image html polyselection1.png
 292
 293 As a result, only the nodes within the frame are selected.
 294
 295 \image html polyselection2.png
 296
 297 */