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 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>Select Point from View</b> button allows to select the rotation
 104   point in the 3D Viewer.
 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 \image html occ_view_clipping.png
 160
 161 <b>Clipping</b> - allows to create cross-section views (clipping
 162 planes) of geometrical objects.
 163
 164 To start, click on the \em New button.
 165
 166 Now you must specify what mode of creating plane you want to choose:
 167 absolute or relative.
 168
 169 <b>Absolute mode</b>
 170
 171 \image html Clipping_Absolute.png
 172
 173 - <b>Base point</b> - allows to define the coordinates of the base
 174   point for the clipping plane.
 175
 176   - <b>Reset</b> - returns the base point to coordinate origin.
 177
 178 - <b>Direction</b> - allows to define the orientation of the
 179   clipping plane.
 180
 181   - <b>Invert</b> - allows to select which part of the object will be
 182     removed and which will remain after clipping.
 183
 184 <b>Relative mode</b>
 185
 186 \image html Clipping_Relative.png
 187
 188 - \b Orientation ( ||X-Y, ||X-Z or ||Y-Z).
 189 - \b Distance between the opposite extremities of the boundary box of
 190 selected objects, if it is set to 0.5 the boundary box is split in two halves.
 191 - \b Rotation (in angle degrees) <b>around X</b> (Y to Z) and <b>around
 192 Y</b> (X to Z) (depending on the chosen Orientation)
 193
 194
 195 If the <b>Show preview</b> button is on, you can see the clipping plane
 196 in the viewer.
 197
 198 If the <b>Auto Apply</b> button is on, you can preview the
 199 cross-section in the viewer.
 200
 201 <hr>
 202
 203 \image html occ_view_scaling.png
 204
 205 <b>Scaling</b> - represents objects deformed (stretched or stuffed)
 206 along the axes of coordinates.
 207 <hr>
 208
 209 \image html occ_view_graduated_axes.png
 210
 211 <b>Graduated axes</b> - allows to define axes parameters and graduate
 212 them.
 213
 214 \image html graduatedaxes2.png
 215
 216 - <b>Axis name</b> - if checked the axis name is displayed in the viewer.
 217
 218   - <b>Name</b> - allows to redefine the axis name.
 219
 220   - <b>Font</b> - allows to define the font color of the axis name.
 221
 222 - <b>Labels</b> - if checked the labels are displayed in the viewer.
 223
 224   - <b>Number</b> - allows to define the number of labels.
 225
 226   - <b>Offset</b> - allows to define the distance between labels.
 227
 228   - <b>Font</b> - allows to define the font color of labels names.
 229
 230 - <b>Tick marks</b> - if checked the tick marks are displayed in the viewer.
 231
 232   - <b>Length</b> - allows to define the length of tick marks.
 233
 234 - <b>Is visible</b> - if checked the axis is displayed in the viewer.
 235
 236 <hr>
 237
 238 \image html occ_view_ambient.png
 239
 240 <b>Toggle ambient light</b> - toggle "keep only ambient light" flag
 241 on/off.
 242 <hr>
 243
 244 \image html occ_view_minimized.png
 245 \image html occ_view_maximized.png
 246
 247 <b>Minimize/Maximize</b> - these buttons allow switching the current
 248 view area to the minimized / maximized state.
 249 <hr>
 250
 251 \image html occ_view_return_3d_view.png
 252
 253 <b>Return to 3D</b> - this button switches from 2D view projection back to the 3D view mode.
 254 <hr>
 255
 256 \image html occ_view_sync.png
 257
 258 <b>Synchronize view</b> - allows to synchronize 3d view
 259 parameters. This button has two states - checked and
 260 unchecked. Clicking on this button opens a drop-down menu listing the
 261 compatible 3d views. As soon as the user selects any view from the
 262 list, the parameters (view point, position, zoom coefficient, etc.) of
 263 the current view are synchronized with the selected view (static
 264 synchronization).
 265
 266 In addition, when this button is in the "checked" state, the dynamic
 267 synchronization of the views is performed, i.e. any zoom, pan, rotate
 268 or other view operation done in one view is automatically applied to
 269 the other view.
 270 <hr>
 271
 272 \anchor occ_background
 273 <h2>Background</h2>
 274
 275 OCC Viewer background can be customized using the "Change background"
 276 popup menu command that opens the following dialog box:
 277
 278 \image html change_background_dlg.png
 279
 280 The following types of the background are supported:
 281
 282 - Single color: the background is colored with the solid color
 283   specified by the user in the dialog box.
 284
 285 - Gradient background: the background is gradiently colored according
 286   to two colors and the gradient type specified in the dialog box. The
 287   following types of background are supported:
 288
 289   - Horizontal
 290
 291   - Vertical
 292
 293   - First diagonal
 294
 295   - Second diagonal
 296
 297   - First corner
 298
 299   - Second corner
 300
 301   - Third corner
 302
 303   - Fourth corner
 304
 305 - Image: allows to set image as viewer background and define filling type:
 306
 307   - Center: the image is located at the center of the viewer backgound
 308
 309   - Tile: the image fills the entire viewer backgound one by one
 310
 311   - Stretch: the image is stretched to the entire viewer backgound.
 312
 313 Default background for the viewer is specified via the
 314 \ref occ_preferences "application preferences".
 315
 316 <h2>Polyline selection</h2>
 317
 318 OCC Viewer features a special <b>Polyline Selection</b> mechanism,
 319 which allows selecting an arbitraty part of the graphic area using a
 320 polygon frame (rubber band), instead of the usual selection with a
 321 rectangular frame.
 322
 323 To produce a Polyline Selection, lock the right mouse button and draw
 324 the first side of the polygon, then change the direction by clicking
 325 the left mouse button add draw another side, etc. The whole selection
 326 frame is drawn with the locked right mouse button.
 327
 328 \image html polyselection1.png
 329
 330 As a result, only the nodes within the frame are selected.
 331
 332 \image html polyselection2.png
 333
 334 */