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_preselection.png
  41
  42 <b>Enable/Disable preselection</b> - enables or disables preselection in the view.
  43 <hr>
  44
  45 \image html occ_view_selection.png
  46
  47 <b>Enable/Disable selection</b> - enables or disables selection in the view.
  48 <hr>
  49
  50 \image html occ_view_fitall.png
  51
  52 <b>Fit all</b> - allows to select a point to be the center of a scene
  53 representing all displayed objects in the visible area.
  54 <hr>
  55
  56 \image html occ_view_fitarea.png
  57
  58 <b>Fit area</b> - resizes the view to place in the visible area only
  59 the contents of a frame drawn with pressed left mouse button.
  60 <hr>
  61
  62 \image html occ_view_zoom.png
  63
  64 <b>Zoom</b> - allows to zoom in and out.
  65 <hr>
  66
  67 \image html occ_view_pan.png
  68
  69 <b>Panning</b> - if the represented objects are greater that the
  70 visible area and you don't wish to use <b>Fit all</b> functionality,
  71 click on this button and you'll be able to drag the scene to see its
  72 remote parts.
  73 <hr>
  74
  75 \image html occ_view_glpan.png
  76
  77 <b>Global panning</b> - represents all displayed objects in the
  78 visible area.
  79 <hr>
  80
  81 \image html occ_view_rotation_point.png
  82
  83 <b>Change rotation point</b> - allows to to choose the point around
  84 which the rotation is performed.
  85
  86 \image html set_rotation_point_dialog1.png
  87
  88 By default the rotation point is located in the Center of the bounding
  89 box of an object.
  90
  91 \image html set_rotation_point_dialog2.png
  92
  93 Unchecking <b>Use Bounding Box Center</b> checkbox allows you to
  94 define the coordinates of the rotation point manually.
  95
  96 - <b>Set to Origin</b> button restores the default rotation point
  97   coordinates.
  98
  99 - <b>Select Point from View</b> button allows to select the rotation
 100   point in the 3D Viewer.
 101
 102 <hr>
 103
 104 \image html occ_view_rotate.png
 105
 106 <b>Rotation</b> - allows to rotate the selected object using the
 107 mouse.
 108 <hr>
 109
 110 \image html occ_view_front.png
 111 \image html occ_view_back.png
 112 \image html occ_view_top.png
 113 \image html occ_view_bottom.png
 114 \image html occ_view_left.png
 115 \image html occ_view_right.png
 116
 117 These buttons orientate the scene strictly about coordinate axes:
 118 \b Front, \b Back, \b Top, \b Bottom, \b Left or \b Right side.
 119 <hr>
 120
 121 \image html occ_view_anticlockwise.png
 122
 123 <b>Rotate counterclockwise</b> - rotates view 90 @htmlonly &deg; @endhtmlonly counterclockwise.
 124 <hr>
 125
 126 \image html occ_view_clockwise.png
 127
 128 <b>Rotate clockwise</b> - rotates view 90 @htmlonly &deg; @endhtmlonly clockwise.
 129 <hr>
 130
 131 \image html occ_view_reset.png
 132
 133 <b>Reset</b> - restores the default position (isometric) of objects in
 134 the scene.
 135 <hr>
 136
 137 \image html occ_view_shoot.png
 138
 139 <b>Memorise view</b> - saves the current position of objects in the
 140 scene.
 141 <hr>
 142
 143 \image html occ_view_presets.png
 144
 145 <b>Restore view</b> - restores the saved position of objects in the
 146 scene.
 147 <hr>
 148
 149 \image html occ_view_clone.png
 150
 151 <b>Clone view</b> - opens a new duplicate scene.
 152 <hr>
 153
 154 \image html occ_view_clipping.png
 155
 156 <b>Clipping</b> - allows to create cross-section views (clipping
 157 planes) of geometrical objects.
 158
 159 \image html clipping.png
 160
 161 - <b>Base point</b> - allows to define the coordinates of the base
 162   point for the clipping plane.
 163
 164   - <b>Reset</b> - returns the base point to coordinate origin.
 165
 166 - <b>Direction</b> - allows to define the orientation of the
 167   clipping plane.
 168
 169   - <b>Invert</b> - allows to select which part of the object will be
 170     removed and which will remain after clipping.
 171
 172 - <b>Preview</b> - allows to see the results of clipping in the
 173   viewer.
 174
 175 <hr>
 176
 177 \image html occ_view_scaling.png
 178
 179 <b>Scaling</b> - represents objects deformed (stretched or stuffed)
 180 along the axes of coordinates.
 181 <hr>
 182
 183 \image html occ_view_graduated_axes.png
 184
 185 <b>Graduated axes</b> - allows to define axes parameters and graduate
 186 them.
 187
 188 \image html graduatedaxes2.png
 189
 190 - <b>Axis name</b> - if checked the axis name is displayed in the viewer.
 191
 192   - <b>Name</b> - allows to redefine the axis name.
 193
 194   - <b>Font</b> - allows to define the font color of the axis name.
 195
 196 - <b>Labels</b> - if checked the labels are displayed in the viewer.
 197
 198   - <b>Number</b> - allows to define the number of labels.
 199
 200   - <b>Offset</b> - allows to define the distance between labels.
 201
 202   - <b>Font</b> - allows to define the font color of labels names.
 203
 204 - <b>Tick marks</b> - if checked the tick marks are displayed in the viewer.
 205
 206   - <b>Length</b> - allows to define the length of tick marks.
 207
 208 - <b>Is visible</b> - if checked the axis is displayed in the viewer.
 209
 210 <hr>
 211
 212 \image html occ_view_ambient.png
 213
 214 <b>Toggle ambient light</b> - toggle "keep only ambient light" flag
 215 on/off.
 216 <hr>
 217
 218 \image html occ_view_minimized.png
 219 \image html occ_view_maximized.png
 220
 221 <b>Create sub-views/Maximize</b> - these buttons allow switching the current
 222 view area to the minimized / maximized state.
 223
 224 <b>Create sub-views</b> - user can select the layout and types of child sub-views:
 225
 226 \image html create_sub-views_dlg.png
 227
 228 - <b>Sub-views Layout</b>
 229
 230   - Three radio-buttons to specify numbers of the views to arrange (2, 3 or 4).
 231
 232   - Buttons (depending on the chosen number of views) with images to specify
 233     view layout.
 234
 235   - Buttons "Previous" and "Next" for possibility to change split schemas.
 236
 237 - <b>Sub-views Properties</b>
 238
 239   - Type of each sub-view: XZ, YZ, XY or XYZ.
 240
 241 <b>Maximize</b> - the current view area will be converted to maximized state.
 242
 243 <hr>
 244
 245 \image html occ_view_sync.png
 246
 247 <b>Synchronize view</b> - allows to synchronize 3d view
 248 parameters. This button has two states - checked and
 249 unchecked. Clicking on this button opens a drop-down menu listing the
 250 compatible 3d views. As soon as the user selects any view from the
 251 list, the parameters (view point, position, zoom coefficient, etc.) of
 252 the current view are synchronized with the selected view (static
 253 synchronization).
 254
 255 In addition, when this button is in the "checked" state, the dynamic
 256 synchronization of the views is performed, i.e. any zoom, pan, rotate
 257 or other view operation done in one view is automatically applied to
 258 the other view.
 259
 260 */