1 .. _occ_3d_viewer_page:
10 The functionalities of OCC viewer are available via its Viewer
11 Toolbar. Buttons marked with small downward triangles have extended
12 functionality which can be accessed by locking on them with left mouse
15 .. image:: ../images/occviewer_toolbar.png
20 .. image:: ../../../../src/OCCViewer/resources/occ_view_camera_dump.png
23 **Dump View** - exports an object from the viewer in bmp, png, jpeg or another image format.
27 .. image:: ../../../../src/OCCViewer/resources/occ_view_style_switch.png
30 **Interaction style switch** - allows to switch between standard
31 and "keyboard free" interaction styles. "Keyboard free" style allows
32 to process all view transformations without using keyboard (only by
33 mouse). By default, rotation in this mode is performed by left mouse
34 button, panning - by middle mouse button, zooming - by right mouse
35 button. Selection in view by pressing "s" key works in both
40 .. image:: ../../../../src/OCCViewer/resources/occ_view_zooming_style_switch.png
43 **Zooming style switch** - allows to switch between standard
44 (zooming at the center of the view) and advanced (zooming at the
45 current cursor position) zooming styles.
49 .. image:: ../../../../src/OCCViewer/resources/occ_view_triedre.png
52 **Show/Hide Trihedron** - shows or hides coordinate axes.
56 .. image:: ../../../../src/OCCViewer/resources/occ_view_preselection.png
59 **Enable/Disable preselection** - enables or disables preselection (highlighting) in the view.
63 .. image:: ../../../../src/OCCViewer/resources/occ_view_selection.png
66 **Enable/Disable selection** - enables or disables selection in the view.
70 .. image:: ../../../../src/OCCViewer/resources/occ_view_rect_style.png
73 **Advanced selection by polygon** - enables advanced selection by polygon.
77 .. image:: ../../../../src/OCCViewer/resources/occ_view_circle_style.png
80 **Advanced selection by circle** - enables advanced selection by circle.
84 .. image:: ../../../../src/OCCViewer/resources/occ_view_fitall.png
87 **Fit all** - represents all displayed objects in the
92 .. image:: ../../../../src/OCCViewer/resources/occ_view_fitarea.png
95 **Fit area** - resizes the view to place in the visible area only
96 the contents of a frame drawn with pressed left mouse button.
100 .. image:: ../../../../src/OCCViewer/resources/occ_view_fitselection.png
103 **Fit selection** - fits view contents to the current selection.
107 .. image:: ../../../../src/OCCViewer/resources/occ_view_zoom.png
110 **Zoom** - allows to zoom in and out.
114 .. image:: ../../../../src/OCCViewer/resources/occ_view_pan.png
117 **Panning** - if the represented objects are greater that the
118 visible area and you don't wish to use **Fit all** functionality,
119 click on this button and you'll be able to drag the scene to see its
124 .. image:: ../../../../src/OCCViewer/resources/occ_view_glpan.png
127 **Global panning** - allows to select a point to be the center of a scene
128 representing all displayed objects in the visible area.
132 .. image:: ../../../../src/OCCViewer/resources/occ_view_rotation_point.png
135 **Change rotation point** - allows to choose the point around
136 which the rotation is performed.
138 .. image:: ../images/set_rotation_point_dialog1.png
141 By default the rotation point is located in the Center of the bounding
142 box of represented objects.
144 .. image:: ../images/set_rotation_point_dialog2.png
147 Unchecking **Use Bounding Box Center** check-box allows you to
148 change rotation point:
150 - **Set to Origin** button sets the rotation point to origin of coordinates: (0, 0, 0).
151 - **Gravity Center of Selected Object** button allows using the gravity center of the object selected in the viewer as the center of the rotation point. 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.
152 - Also you can define the coordinates of the rotation point manually.
156 .. image:: ../../../../src/OCCViewer/resources/occ_view_rotate.png
159 **Rotation** - allows to rotate the scene using the mouse.
163 .. image:: ../../../../src/OCCViewer/resources/occ_view_front.png
166 .. image:: ../../../../src/OCCViewer/resources/occ_view_back.png
169 .. image:: ../../../../src/OCCViewer/resources/occ_view_top.png
172 .. image:: ../../../../src/OCCViewer/resources/occ_view_bottom.png
175 .. image:: ../../../../src/OCCViewer/resources/occ_view_left.png
178 .. image:: ../../../../src/OCCViewer/resources/occ_view_right.png
181 These buttons orientate the scene strictly about coordinate axes:
182 **Front**, **Back**, **Top**, **Bottom**, **Left** or **Right** side.
186 .. image:: ../../../../src/OCCViewer/resources/occ_view_anticlockwise.png
189 **Rotate counterclockwise** - rotates view 90 @htmlonly ° @endhtmlonly counterclockwise.
193 .. image:: ../../../../src/OCCViewer/resources/occ_view_clockwise.png
196 **Rotate clockwise** - rotates view 90 @htmlonly ° @endhtmlonly clockwise.
200 .. image:: ../../../../src/OCCViewer/resources/occ_view_orthographic.png
203 **Ortographic projection** - default OCC viewer projection mode.
207 .. image:: ../../../../src/OCCViewer/resources/occ_view_perspective.png
210 **Perspective projection** - perspective OCC viewer projection mode.
214 .. image:: ../../../../src/OCCViewer/resources/occ_view_stereo.png
217 **Stereo projection** - stereoscopic rendering of the view.
218 .. note:: Activation of this mode also switches the view to perpective projection in case if the orthographic one has been active.
219 .. note:: By default, quad-buffered stereo is activated, if it is supported by the graphic card. If no stereo capabilities are available, an error message is shown.
220 .. note:: The stereoscopic view settings can be defined in :ref:`occ_preferences` preferences.
224 .. image:: ../../../../src/OCCViewer/resources/occ_view_reset.png
227 **Reset** - restores the default position (isometric) of objects in
232 .. image:: ../../../../src/OCCViewer/resources/occ_view_shoot.png
235 **Memorize view** - saves the current position of objects in the
240 .. image:: ../../../../src/OCCViewer/resources/occ_view_presets.png
243 **Restore view** - restores the saved position of objects in the
248 .. image:: ../../../../src/OCCViewer/resources/occ_view_clone.png
251 **Clone view** - opens a new duplicate scene.
260 **Clipping** allows creating cross-section views (clipping planes)
263 To create a clipping plane, click on the **New** button in the dialog and choose how it will be defined by **Absolute** or **Relative** coordinates.
265 **Absolute Coordinates**
267 .. image:: ../images/Clipping_Absolute.png
270 - **Base point** - allows defining the coordinates of the base point for the clipping plane.
272 - **Reset** - returns the base point to coordinate origin.
274 - **Direction** - allows defining the orientation of the clipping plane.
276 - **Invert** - allows selecting, which part of the object will be removed and which will remain after clipping.
281 .. image:: ../images/Clipping_Relative.png
284 - **Orientation** ( ||X-Y, ||X-Z or ||Y-Z).
286 - **Distance** between the opposite extremities of the boundary box of represented objects, if it is set to 0.5 the boundary box is split in two halves.
288 - **Rotation** (in angle degrees) **around X** (Y to Z) and **around Y** (X to Z) (depending on the chosen Orientation)
290 The other parameters are available in both modes :
292 - **Active** checkbox is used to apply/erase current plane and it's affect to/from view.
293 - **Delete** removes the active clipping plane and discards it's view changes.
294 - **Disable all** deactivates all created clipping planes and clears **Auto Apply** checkbox.
295 - **Preview** check-box shows the clipping plane in the **3D Viewer**.
296 - **Auto Apply** check-box allows you to see the result of clipping in the **3D Viewer** immediately. Be careful, it is not a preview 2and Close button could not cancel the applied modifications.
298 It is also possible to interact with the clipping plane directly in 3D
299 view using the mouse.
303 .. image:: ../../../../src/OCCViewer/resources/occ_view_scaling.png
306 **Scaling** - represents objects deformed (stretched or stuffed)
307 along the axes of coordinates.
311 .. image:: ../../../../src/OCCViewer/resources/occ_view_graduated_axes.png
314 **Graduated axes** - allows to define axes parameters and graduate
317 .. image:: ../images/graduatedaxes2.png
320 - **Axis name** - if checked the axis name is displayed in the viewer.
322 - **Name** - allows to redefine the axis name.
324 - **Font** - allows to define the font color of the axis name.
326 - **Labels** - if checked the labels are displayed in the viewer.
328 - **Number** - allows to define the number of labels.
330 - **Offset** - allows to define the distance between axis and labels.
332 - **Font** - allows to define the font color of labels names.
334 - **Tick marks** - if checked the tick marks are displayed in the viewer.
336 - **Length** - allows to define the length of tick marks.
338 - **Is visible** - if checked the graduated axes are displayed in the viewer.
342 .. image:: ../../../../src/OCCViewer/resources/occ_view_ambient.png
345 **Toggle ambient light** - toggle "keep only ambient light" flag
350 .. image:: ../../../../src/OCCViewer/resources/occ_view_minimized.png
355 .. image:: ../../../../src/OCCViewer/resources/occ_view_maximized.png
358 **Minimize/Maximize** - these buttons allow switching the current
359 view area to the minimized / maximized state.
363 .. image:: ../../../../src/OCCViewer/resources/occ_view_return_3d_view.png
366 **Return to 3D** - this button switches from 2D view projection back to the 3D view mode.
370 .. image:: ../images/occ_view_sync.png
373 **Synchronize view** - allows to synchronize 3d view
374 parameters. This button has two states - checked and
375 unchecked. Clicking on this button opens a drop-down menu listing the
376 compatible 3d views. As soon as the user selects any view from the
377 list, the parameters (view point, position, zoom coefficient, etc.) of
378 the current view are synchronized with the selected view (static
381 In addition, when this button is in the "checked" state, the dynamic
382 synchronization of the views is performed, i.e. any zoom, pan, rotate
383 or other view operation done in one view is automatically applied to
388 .. image:: ../../../../src/OCCViewer/resources/occ_view_ray_tracing.png
396 **Ray tracing** - allows to switch between rendering methods in run-time
397 in the current OCCT 3D view. It can be used to produce images with photorealistic quality.
399 .. image:: ../images/doc_ray_tracing.png
402 - **Ray tracing** - specifies rendering mode: OpenGL rasterization (by default) or GPU ray-tracing.
404 - **Depth** - defines maximum ray-tracing depth.
406 - **Specular reflections** - enables/disables specular reflections.
408 - **Adaptive anti-aliasing** - enables/disables adaptive anti-aliasing.
410 - **Shadows rendering** - enables/disables shadows rendering.
412 - **Transparent shadow** - enables/disables light propagation through transparent media.
416 .. image:: ../../../../src/OCCViewer/resources/occ_view_env_texture.png
424 **Environment texture** - allows to set parameters for environment texture.
425 This is a special mode of texture mapping when specular reflection of environment texture
426 is simulated by OpenGL using a special texture coordinates generation algorithm (a sphere map).
428 .. image:: ../images/doc_env_texture.png
431 - **Environment texture** - enables/disables environment texture in the current OCCT 3D view.
433 User can select one of 7 predefined environment texture from the list or define its texture from file by
434 choosing item **"Custom..."** in a combo box.
437 Environment texture file should normally satisfy the following requirements in order to produce good visual result:
438 * The image file should have 2:1 width-to-height ratio.
439 * It should constitute a 360-degrees panoramic image created using a fish-eye lens.
443 .. image:: ../../../../src/OCCViewer/resources/occ_view_light_source.png
451 **Light source** - allows to set parameters for light source.
453 It's possible to choose a type of light source between directional and positional light.
455 .. image:: ../images/doc_dir_light_source.png
458 **Directional** light - creates a directional light source in the viewer.
459 It is defined by direction coordinates, color and headlight parameter.
461 .. image:: ../images/doc_pos_light_source.png
464 **Positional** light - creates an isolated light source X,Y,Z in the viewer.
465 It is also defined by the color and headlight parameter.
469 - **Apply and Close** to apply defined light source to the OCC 3D Viewer.
471 - **Default** to restore default values of light source.
473 - **Close** to return parameters of light source on initial values.