--- /dev/null
+/*!
+
+\page gl_2d_viewer_page GL 2D Viewer
+
+<h2>Operations</h2>
+
+The functionalities of GL viewer are available via its Viewer
+Toolbar. Buttons marked with small downward triangles have extended
+functionality which can be accessed by locking on them with left mouse
+button.
+
+\image html glviewer_toolbar.png
+<hr>
+
+\image html gl_view_dump.png
+
+<b>Dump View</b> - exports an object from the viewer in bmp, png or
+jpeg image format.
+<hr>
+
+\image html gl_view_fitall.png
+
+<b>Fit all</b> - scales the presentation so that it could fit within
+the Viewer boundaries.
+<hr>
+
+\image html gl_view_fitarea.png
+
+<b>Fit area</b> - resizes the view to place in the visible area only
+the contents of a frame drawn with pressed left mouse button.
+<hr>
+
+\image html gl_view_fitselect.png
+
+<b>Fit selection</b> - resizes the view to fit in the visible area
+only currently selected objects.
+<hr>
+
+\image html gl_view_zoom.png
+
+<b>Zoom</b> - allows to zoom in and out.
+<hr>
+
+\image html gl_view_pan.png
+
+<b>Panning</b> - if the represented objects are greater that the
+visible area and you don't wish to use <b>Fit all</b> functionality,
+click on this button and you'll be able to drag the scene to see its
+remote parts.
+<hr>
+
+\image html gl_view_glpan.png
+
+<b>Global panning</b> - allows to select a point to be the center of
+the presentation showing all displayed objects in the visible ares.
+<hr>
+
+\image html gl_view_reset.png
+
+<b>Reset</b> - restores the default position the scene.
+<hr>
+
+\anchor gl_background
+<h2>Background</h2>
+
+GL Viewer background can be customized using the "Change background"
+popup menu command that opens standard "Select Color" dialog box:
+
+\image html selectcolor.png
+
+*/
functionality which can be accessed by locking on them with left mouse
button.
-\image html occviewer_toolbar.png "Viewer Toolbar"
+\image html occviewer_toolbar.png
<hr>
\image html occ_view_camera_dump.png
-<br><center><b>Dump View</b> - exports an object from the viewer in bmp, png, jpg
-or jpeg image format.</center>
+
+<b>Dump View</b> - exports an object from the viewer in bmp, png or
+jpeg image format.
<hr>
\image html occ_view_style_switch.png
-<br><center><b>Interaction style switch</b> - allows to switch between standard and
-"keyboard free" interaction styles. "Keyboard free" style allows to process all
-view transformations without using keyboard (only by mouse) and perform selection
-in view by pressing "S" key. By default, rotation in this mode is performed by
-left mouse button, panning - by middle mouse button, zooming - by left and middle
-mouse buttons pressed simultaneously.</center>
+
+<b>Interaction style switch</b> - allows to switch between standard
+and "keyboard free" interaction styles. "Keyboard free" style allows
+to process all view transformations without using keyboard (only by
+mouse) and perform selection in view by pressing "S" key. By default,
+rotation in this mode is performed by left mouse button, panning - by
+middle mouse button, zooming - by left and middle mouse buttons
+pressed simultaneously.
<hr>
\image html occ_view_zooming_style_switch.png
-<br><center><b>Zooming style switch</b> - allows to switch between standard
-(zooming at the center of the view) and advanced (zooming at the current cursor
-position) zooming styles.</center>
+
+<b>Zooming style switch</b> - allows to switch between standard
+(zooming at the center of the view) and advanced (zooming at the
+current cursor position) zooming styles.
<hr>
\image html occ_view_triedre.png
-<br><center><b>Show/Hide Trihedron</b> - shows or hides coordinate axes.</center>
+
+<b>Show/Hide Trihedron</b> - shows or hides coordinate axes.
<hr>
\image html occ_view_fitall.png
-<br><center><b>Fit all</b> - allows to select a point to be the center of a
-scene representing all displayed objects in the visible area.</center>
+
+<b>Fit all</b> - allows to select a point to be the center of a scene
+representing all displayed objects in the visible area.
<hr>
\image html occ_view_fitarea.png
-<br><center><b>Fit area</b> - resizes the view to place in the visible area
-only the contents of a frame drawn with pressed left mouse button.</center>
+
+<b>Fit area</b> - resizes the view to place in the visible area only
+the contents of a frame drawn with pressed left mouse button.
<hr>
\image html occ_view_zoom.png
-<br><center><b>Zoom</b> - allows to zoom in and out.</center>
+
+<b>Zoom</b> - allows to zoom in and out.
<hr>
\image html occ_view_pan.png
-<br><center><b>Panning</b> - if the represented objects are greater that the
-visible area and you don't wish to use <b>Fit all</b> functionality, click on
-this button and you'll be able to drag the scene to see its remote
-parts.</center>
+
+<b>Panning</b> - if the represented objects are greater that the
+visible area and you don't wish to use <b>Fit all</b> functionality,
+click on this button and you'll be able to drag the scene to see its
+remote parts.
<hr>
\image html occ_view_glpan.png
-<br><center><b>Global panning</b> - represents all displayed objects in
-the visible area.</center>
+
+<b>Global panning</b> - represents all displayed objects in the
+visible area.
<hr>
\image html occ_view_rotation_point.png
-<br><center><b>Change rotation point</b> - allows to to choose the point around
-which the rotation is performed.</center><br>
+
+<b>Change rotation point</b> - allows to to choose the point around
+which the rotation is performed.
\image html set_rotation_point_dialog1.png
-<br><center>By default the rotation point is located in the Center of the bounding
-box of an object.</center><br>
+By default the rotation point is located in the Center of the bounding
+box of an object.
\image html set_rotation_point_dialog2.png
-<br><center>Unchecking <b>Use Bounding Box Center</b> checkbox allows you to
-define the coordinates of the rotation point manually.</center><br>
+Unchecking <b>Use Bounding Box Center</b> checkbox allows you to
+define the coordinates of the rotation point manually.
- <b>Set to Origin</b> button restores the default rotation point
-coordinates.
+ coordinates.
+
- <b>Select Point from View</b> button allows to select the rotation
-point in the 3D Viewer.
+ point in the 3D Viewer.
+
<hr>
\image html occ_view_rotate.png
-<br> <center><b>Rotation</b> - allows to rotate the selected object using the
-mouse.</center>
+
+<b>Rotation</b> - allows to rotate the selected object using the
+mouse.
<hr>
\image html occ_view_front.png
\image html occ_view_bottom.png
\image html occ_view_left.png
\image html occ_view_right.png
-<br><center>These buttons orientate the scene strictly about coordinate axes.</center>
+
+These buttons orientate the scene strictly about coordinate axes:
+\b Front, \b Back, \b Top, \b Bottom, \b Left or \b Right side.
<hr>
\image html occ_view_anticlockwise.png
-<br><center><b>Rotate counterclockwise</b> - rotates view 90°
-counterclockwise.</center>
+
+<b>Rotate counterclockwise</b> - rotates view 90° counterclockwise.
<hr>
\image html occ_view_clockwise.png
-<br><center><b>Rotate clockwise</b> - rotates view 90°
-clockwise.</center>
+
+<b>Rotate clockwise</b> - rotates view 90° clockwise.
<hr>
\image html occ_view_reset.png
-<br><center><b>Reset</b> - restores the default position (isometric) of
-objects in the scene.</center>
+
+<b>Reset</b> - restores the default position (isometric) of objects in
+the scene.
<hr>
\image html occ_view_shoot.png
-<br><center><b>Memorise view</b> - saves the current position of
-objects in the scene.</center>
+
+<b>Memorise view</b> - saves the current position of objects in the
+scene.
<hr>
\image html occ_view_presets.png
-<br><center><b>Restore view</b> - restores the saved position of
-objects in the scene.</center>
+
+<b>Restore view</b> - restores the saved position of objects in the
+scene.
<hr>
\image html occ_view_clone.png
-<br><center><b>Clone view</b> - opens a new duplicate scene.</center>
+
+<b>Clone view</b> - opens a new duplicate scene.
<hr>
\image html occ_view_clipping.png
-<br><center><b>Clipping</b> - allows to create cross-section views
-(clipping planes) of geometrical objects.</center><br>
+
+<b>Clipping</b> - allows to create cross-section views (clipping
+planes) of geometrical objects.
\image html clipping.png
-<br>
- <b>Base point</b> - allows to define the coordinates of the base
-point for the clipping plane.
+ point for the clipping plane.
+
- <b>Reset</b> - returns the base point to coordinate origin.
+
- <b>Direction</b> - allows to define the orientation of the
-clipping plane.
- - <b>Invert</b> - allows to select which part of the object will be removed
-and which will remain after clipping.
+ clipping plane.
+
+ - <b>Invert</b> - allows to select which part of the object will be
+ removed and which will remain after clipping.
+
- <b>Preview</b> - allows to see the results of clipping in the
-viewer.
+ viewer.
+
<hr>
\image html occ_view_scaling.png
-<br><center><b>Scaling</b> - represents objects deformed (stretched or
-stuffed) along the axes of coordinates.</center>
+
+<b>Scaling</b> - represents objects deformed (stretched or stuffed)
+along the axes of coordinates.
<hr>
\image html occ_view_graduated_axes.png
-<br><center><b>Graduated axes</b> - allows to define axes parameters
-and graduate them.</center><br>
+
+<b>Graduated axes</b> - allows to define axes parameters and graduate
+them.
\image html graduatedaxes2.png
-<br>
- <b>Axis name</b> - if checked the axis name is displayed in the viewer.
+
- <b>Name</b> - allows to redefine the axis name.
+
- <b>Font</b> - allows to define the font color of the axis name.
+
- <b>Labels</b> - if checked the labels are displayed in the viewer.
+
- <b>Number</b> - allows to define the number of labels.
+
- <b>Offset</b> - allows to define the distance between labels.
+
- <b>Font</b> - allows to define the font color of labels names.
+
- <b>Tick marks</b> - if checked the tick marks are displayed in the viewer.
+
- <b>Length</b> - allows to define the length of tick marks.
+
- <b>Is visible</b> - if checked the axis is displayed in the viewer.
+
<hr>
\image html occ_view_ambient.png
-<br><center><b>Toggle ambient light</b> - toggle "keep only ambient
-light" flag on/off</center>
+
+<b>Toggle ambient light</b> - toggle "keep only ambient light" flag
+on/off.
<hr>
\image html occ_view_minimized.png
-<br>
\image html occ_view_maximized.png
-<br><center><b>Minimize/Maximize</b> - these buttons allow switching
-the current view area to the minimized / maximized state.</center>
+
+<b>Minimize/Maximize</b> - these buttons allow switching the current
+view area to the minimized / maximized state.
<hr>
\image html occ_view_sync.png
-<br><center><b>Synchronize view</b> - allows to synchronize 3d view parameters.</center>
-This button has two states - checked and unchecked. Clicking on this
-button opens a drop-down menu listing the compatible 3d views. As soon
-as the user selects any view from the list, the parameters (view point,
-position, zoom coefficient, etc.) of the current view are synchronized
-with the selected view (static synchronization).
+
+<b>Synchronize view</b> - allows to synchronize 3d view
+parameters. This button has two states - checked and
+unchecked. Clicking on this button opens a drop-down menu listing the
+compatible 3d views. As soon as the user selects any view from the
+list, the parameters (view point, position, zoom coefficient, etc.) of
+the current view are synchronized with the selected view (static
+synchronization).
In addition, when this button is in the "checked" state, the dynamic
synchronization of the views is performed, i.e. any zoom, pan, rotate
-or other view operation done in one view is automatically applied
-to the other view.
+or other view operation done in one view is automatically applied to
+the other view.
<hr>
\anchor occ_background
\image html change_background_dlg.png
The following types of the background are supported:
+
- Single color: the background is colored with the solid color
specified by the user in the dialog box.
+
- Gradient background: the background is gradiently colored according
to two colors and the gradient type specified in the dialog box. The
following types of background are supported:
+
- Horizontal
+
- Vertical
+
- First diagonal
+
- Second diagonal
+
- First corner
+
- Second corner
+
- Third corner
+
- Fourth corner
- Image: allows to set image as viewer background and define filling type:
+
- Center: the image is located at the center of the viewer backgound
+
- Tile: the image fills the entire viewer backgound one by one
- - Strech: the image is stretched to the entire viewer backgound.
+
+ - Stretch: the image is stretched to the entire viewer backgound.
Default background for the viewer is specified via the
\ref occ_preferences "application preferences".
<h2>Polyline selection</h2>
-OCC Viewer features a special <b>Polyline Selection</b>
-mechanism, which allows selecting an arbitraty part of the graphic
-area using a polygon frame (rubber band), instead of the usual
-selection with a rectangular frame.
+OCC Viewer features a special <b>Polyline Selection</b> mechanism,
+which allows selecting an arbitraty part of the graphic area using a
+polygon frame (rubber band), instead of the usual selection with a
+rectangular frame.
+
To produce a Polyline Selection, lock the right mouse button and draw
the first side of the polygon, then change the direction by clicking
the left mouse button add draw another side, etc. The whole selection
functionality which can be accessed by locking on them with left mouse
button.
-\image html plot2dviewer_toolbar.png "Viewer Toolbar"
+\image html plot2dviewer_toolbar.png
<hr>
\image html plot2d_camera_dump.png
-<br><center><b>Dump View</b> - exports an object from the viewer in bmp,
-png, jpg or jpeg image format.</center>
+
+<b>Dump View</b> - exports an object from the viewer in
+bmp, png or jpeg image format.
<hr>
\image html plot2d_fitall.png
-<br><center><b>Fit all</b> - scales the display to show the entire
-scene. Use this to resize the scene so that it could fit within the
-Viewer boundary.</center>
+<b>Fit all</b> - scales the display to show the entire scene. Use this
+to resize the scene so that it could fit within the Viewer boundary.
<hr>
\image html plot2d_fitarea.png
-<br><center><b>Fit area</b> - resizes the view to place in the visible
-area only the contents of a frame drawn with pressed left mouse
-button.</center>
+
+<b>Fit area</b> - resizes the view to place in the visible area only
+the contents of a frame drawn with pressed left mouse button.
<hr>
\image html plot2d_zoom.png
-<br><center><b>Zoom</b> - allows to zoom in and out.</center>
+
+<b>Zoom</b> - allows to zoom in and out.
<hr>
\image html plot2d_pan.png
-<br><center>\b Panning - if the represented objects are greater that the
-visible area and you don't wish to use Fit all functionality, click on
-this button and you'll be able to drag the scene to see its remote
-parts.</center>
+
+\b Panning - if the represented objects are greater that the visible
+area and you don't wish to use Fit all functionality, click on this
+button and you'll be able to drag the scene to see its remote parts.
<hr>
\image html plot2d_glpan.png
-<br><center><b>Global panning</b> - allows to define the center of the
-scene presenting all displayed objects in the visible area.</center>
+
+<b>Global panning</b> - allows to define the center of the scene
+presenting all displayed objects in the visible area.
<hr>
\image html plot2d_points.png
-<br><center><b>Draw Points</b> - switch display mode to the
-<b>Points</b> mode. In this mode, each curve is displayed as a set of
-points.</center>
+
+<b>Draw Points</b> - switch display mode to the \em Points mode. In
+this mode, each curve is displayed as a set of points.
<hr>
\image html plot2d_lines.png
-<br><center><b>Draw Lines</b> - switch display mode to the
-<b>Lines</b> mode. In this mode, each curve is represented as a set of
-the plain line segments.</center>
+
+<b>Draw Lines</b> - switch display mode to the \em Lines mode. In this
+mode, each curve is represented as a set of the plain line segments.
+<hr>
\image html plot2d_splines.png
-<br><center><b>Draw Splines</b> - switch display mode to the
-<b>Splines</b> mode. In this mode, each curve is represented as a
-spline.</center>
+
+<b>Draw Splines</b> - switch display mode to the \em Splines mode. In
+this mode, each curve is represented as a spline.
<hr>
\image html plot2d_lmin_normalization.png
-<br><center><b>Normalization to global minimum by left Y axis</b> - switch normalization mode to the
-<b>Left Y Axis: Minimum normalization</b> mode. In this mode, all curves are normalized
-to the global minimum by left Y axis.</center>
+
+<b>Normalization to global minimum by left Y axis</b> - switch
+normalization mode to the <b>Left Y Axis: Minimum normalization</b>
+mode. In this mode, all curves are normalized to the global minimum by
+left Y axis.
\image html plot2d_lmax_normalization.png
-<br><center><b>Normalization to global maximum by left Y axis</b> - switch normalization mode to the
-<b>Left Y Axis: Maximum normalization</b> mode. In this mode, all curves are normalized
-to the global maximum by left Y axis.</center>
+
+<b>Normalization to global maximum by left Y axis</b> - switch
+normalization mode to the <b>Left Y Axis: Maximum normalization</b>
+mode. In this mode, all curves are normalized to the global maximum by
+left Y axis.
<hr>
\image html plot2d_rmin_normalization.png
-<br><center><b>Normalization to global minimum by right Y axis</b> - switch normalization mode to the
-<b>Right Y Axis: Minimum normalization</b> mode. In this mode, all curves are normalized
-to the global minimum by right Y axis.</center>
+
+<b>Normalization to global minimum by right Y axis</b> - switch
+normalization mode to the <b>Right Y Axis: Minimum normalization</b>
+mode. In this mode, all curves are normalized to the global minimum by
+right Y axis.
\image html plot2d_rmax_normalization.png
-<br><center><b>Normalization to global maximum by right Y axis</b> - switch normalization mode to the
-<b>Right Y Axis: Maximum normalization</b> mode. In this mode, all curves are normalized
-to the global maximum by right Y axis.</center>
+
+<b>Normalization to global maximum by right Y axis</b> - switch
+normalization mode to the <b>Right Y Axis: Maximum normalization</b>
+mode. In this mode, all curves are normalized to the global maximum by
+right Y axis.
<hr>
\image html plot2d_linear.png
-<br>
\image html plot2d_log.png
-<br><center>These buttons allow to switch horizontal axis scale to the
-linear or logarithmic mode.<br>Note that the logarithmic mode of the
-horizontal axis scale is allowed only if the minimum value of abscissa
-component of displayed points is greater than zero.</center>
+
+These buttons allow to switch horizontal axis scale to the linear or
+logarithmic mode.
+
+\note The logarithmic mode of the horizontal
+axis scale is allowed only if the minimum value of abscissa component
+of displayed points is greater than zero.
+
<hr>
\image html plot2d_linear_y.png
-<br>
\image html plot2d_log_y.png
-<br><center>These buttons allow to switch vertical axis scale to the
-linear or logarithmic mode.<br>Note that the logarithmic mode of the
-vertical axis scale is allowed only if the minimum value of ordinate
-component of displayed points is greater than zero.</center>
+
+These buttons allow to switch vertical axis scale to the linear or
+logarithmic mode.
+
+\note The logarithmic mode of the vertical
+axis scale is allowed only if the minimum value of ordinate component
+of displayed points is greater than zero.
+
<hr>
\image html plot2d_legend.png
-<br><center><b>Show Legend</b> - Shows / hides information about the
-displayed objects in a legend.</center>
+
+<b>Show Legend</b> - Shows / hides information about the displayed
+objects in a legend.
<hr>
\image html plot2d_settings.png
-<br><center>\b Settings - provides an access to the settings dialog
-box, that allows to specify advanced parameters for the Plot 2d
-Viewer.</center>
-<br>
+
+\b Settings - provides an access to the settings dialog box, that
+allows to specify advanced parameters for the Plot 2d Viewer.
\anchor settings
\image html plot2d_view_settings.png
-<br>
The options are as follows:
+
- <b>Main title</b> the title of the XY plot. By default, it will
-consist of the names of the tables, on the basis of which the curve
-lines have been constructed.
-- <b>Curve type</b> you can select from \b Points, \b Lines and \b Spline.
+ consist of the names of the tables, on the basis of which the curve
+ lines have been constructed.
+
+- <b>Curve type</b> you can select from \em Points, \em Lines or
+ \em Spline.
+
- <b>Show legend</b> here you can define the position of the
-description table on the XY plot (to the \b Left, to the \b Right, on
-\b Top or on \b Bottom).
+ description table on the XY plot (to the \em Left, to the \em Right,
+ on \em Top or on \em Bottom).
+
- <b>Legend font</b> here you can set type, face and color for the
-font of Legend item.
+ font of Legend item.
+
- <b>Marker size</b> - size of the points (markers) forming curve lines.
+
- <b>Background color</b> of the XY plot.
-- <b>Deviation marker</b> here you can specify the properties of the marker, which used for the drawing
-deviations data.
- - <b>Line width</b> line width of the marker.
- - <b>Tick size</b> size of the upper and lower horizontal lines of the marker.
- - <b>Color</b> color of the marker.
-
-- <b>Normalization</b> here you can select the type of normalization(\b
-minimum or/and \b maximum) for the displayed presentations of the 2d curves in the view.
-- <b>Scale mode</b> here you can select the type of scaling (\b
-Linear or \b Logarithmic) for <b>X (Horizontal)</b> or <b>Y
-(Vertical)</b> axes separately. Note that the \b Logarithmic scale can
-be used only if the minimum value of corresponding component (abscissa
-or ordinate) of all points displayed in the viewer is greater than zero.
-- <b>Axis ...</b> options group allows to specify additional settings for each axis separately:
+
+- <b>Deviation marker</b> here you can specify the properties of the
+ marker, which used for the drawing deviations data.
+
+ - <b>Line width</b> line width of the marker.
+
+ - <b>Tick size</b> size of the upper and lower horizontal lines of
+ the marker.
+
+ - <b>Color</b> color of the marker.
+
+- <b>Normalization</b> here you can select the type of
+ normalization(\em minimum or/and \em maximum) for the displayed
+ presentations of the 2d curves in the view.
+
+- <b>Scale mode</b> here you can select the type of scaling (\em Linear
+ or \em Logarithmic) for <b>X (Horizontal)</b> or <b>Y (Vertical)</b>
+ axes separately. Note that the \em Logarithmic scale can be used
+ only if the minimum value of corresponding component (abscissa or
+ ordinate) of all points displayed in the viewer is greater than
+ zero.
+
+- <b>Axis ...</b> options group allows to specify additional settings
+ for each axis separately:
+
- <b>Axis title</b> - an axis title
- - <b>Grid / Axes marks</b> here you can define the maximum number of major
- and minor scale divisions for a specified axis. The real number of
- intervals fits to {1,2,5}*10^N, where N is a natural number, and
- doesn't exceed the maximum.
-- <b>Save settings as default</b> If this check box is marked, all
-XY plots will be displayed with these defined properties.
+
+ - <b>Grid / Axes marks</b> here you can define the maximum number
+ of major and minor scale divisions for a specified axis. The real
+ number of intervals fits to {1,2,5}*10^N, where N is a natural
+ number, and doesn't exceed the maximum.
+
+- <b>Save settings as default</b> If this check box is marked, all XY
+ plots will be displayed with these defined properties.
+
<hr>
\anchor analytical_curve
\image html plot2d_analytical_curve.png
-<br><center><b>Analytical curves</b> - provides an access to the analytical curves dialog box,
-that allows to add, remove and modify analytical curves for the Plot 2d Viewer.</center>
-<br>
+<b>Analytical curves</b> - provides an access to the analytical curves
+dialog box, that allows to add, remove and modify analytical curves
+for the Plot 2d Viewer.
\image html analytical_curves_dlg.png
-The options are as follows:<br>
-Curve parameters:
-<ul>
-<li><b>y(x)=</b> allows to specify python expression, which used to calculate coordinates of the points of the curve.</li>
-<li><b>Nb. itervals</b> allows to specify number of the points of the curve.</li>
-</ul>
-Curve properties:
-<ul>
-<li><b>Auto assign</b> if it is checked, properties of the curves (Line type, Line width, Marker type and Color)
-assigned automatically.To define the properties of the curve manually remove the checkmark from this control.</li>
-<li><b>Line type</b> allows to choose curve's line type from (None, Solid, Dash, Dot, Dash - Dot, Dash - Dot - Dot).</li>
-<li><b>Line width</b> allows to specify line width of the curve.</li>
-<li><b>Marker type</b> allows to choose curve's marker type from (Circle, Rectangle, Diamond, Rightward,
-Leftward, Downward & Upward Triangle, Cross or Diagonal Cross).</li>
-<li><b>Color</b> allows to specify color of the curve.</li>
-</ul>
+The options are as follows:
+
+- Curve parameters:
+
+ - <b>y(x)=</b> allows to specify python expression, which used to
+ calculate coordinates of the points of the curve.
+ - <b>Nb. itervals</b> allows to specify number of the points of the
+ curve.
+
+- Curve properties:
+
+ - <b>Auto assign</b> if it is checked, properties of the curves
+ (Line type, Line width, Marker type and Color) assigned
+ automatically.To define the properties of the curve manually
+ remove the checkmark from this control.
+
+ - <b>Line type</b> allows to choose curve's line type from (None,
+ Solid, Dash, Dot, Dash - Dot, Dash - Dot - Dot).
+
+ - <b>Line width</b> allows to specify line width of the curve.
+
+ - <b>Marker type</b> allows to choose curve's marker type from
+ (Circle, Rectangle, Diamond, Rightward, Leftward, Downward &
+ Upward Triangle, Cross or Diagonal Cross).
+
+ - <b>Color</b> allows to specify color of the curve.
<hr>
\image html plot2d_clone.png
-<br><center><b>Clone view</b> - opens a new duplicate scene.</center>
+<b>Clone view</b> - opens a new duplicate scene.
<hr>
\image html plot2d_print.png
-<br><center><b>Print view</b> - print view scene.</center>
-<hr>
+
+<b>Print view</b> - print view scene.
*/
--- /dev/null
+/*!
+
+\page qxscene_2d_viewer_page QxScene 2D Viewer
+
+<h2>Operations</h2>
+
+The functionalities of QxScene viewer are available via its Viewer
+Toolbar. Buttons marked with small downward triangles have extended
+functionality which can be accessed by locking on them with left mouse
+button.
+
+\image html qxviewer_toolbar.png
+<hr>
+
+\image html qx_view_fitall.png
+
+<b>Fit all</b> - scales the presentation so that it could fit within
+the Viewer boundaries.
+<hr>
+
+\image html qx_view_fitarea.png
+
+<b>Fit area</b> - resizes the view to place in the visible area only
+the contents of a frame drawn with pressed left mouse button.
+<hr>
+
+\image html qx_view_zoom.png
+
+<b>Zoom</b> - allows to zoom in and out.
+<hr>
+
+\image html qx_view_pan.png
+
+<b>Panning</b> - if the represented objects are greater that the
+visible area and you don't wish to use <b>Fit all</b> functionality,
+click on this button and you'll be able to drag the scene to see its
+remote parts.
+<hr>
+
+\image html qx_view_glpan.png
+
+<b>Global panning</b> - allows to select a point to be the center of
+the presentation showing all displayed objects in the visible ares.
+<hr>
+
+\image html qx_view_reset.png
+
+<b>Reset</b> - restores the default position the scene.
+<hr>
+
+For more details about QxScene viewer, refer to the SALOME YACS module
+User's guide.
+
+*/
\page viewers_page Viewers
-Salome provides a selection of viewers for data representation. Some
-of them are used in several modules, others are used only in one
-module or in some particular cases.
-
-
-<ul>
-<li>\subpage occ_3d_viewer_page "OCC (Open CasCade) 3D viewer" has been developed on the basis of Open
-CASCADE Technology. This is the default viewer for Geometry Module,
-providing good representation of construction and transformation of
-geometrical objects. Only this viewer allows to work with groups and
-sub-shapes. This viewer can also work in Mesh module, however, it
-doesn't allow to visualize meshes. </li>
-<li>\subpage vtk_3d_viewer_page "VTK 3D viewer" has been developed
-basing on Visualization ToolKit library by Kitware, Inc. This is the default viewer for Mesh Module, allowing to
-visualize meshes. It is also used in Post-Pro module for all 3D presentations.</li>
-<li>\subpage plot2d_viewer_page "Plot 2D viewer" has been developed
-basing on open-source Qwt library. It is destined for the representation of 2d
-plots and graphs in Post-Pro module.</li>
-<li>GL 2D viewer - general purpose OpenGL-based viewer, which can be
-used for visualization of 2D scenes.</li>
-<li>QxScene 2D viewer - has been developed on the basis of Qt's
-QGraphicsView scene. This viewer is used in YACS module
-for visualization of computation schemes.</li>
-</ul>
+SALOME provides a set of viewers for data representation. SALOME GUI
+module includes several types of 2D and 3D viewers, that are used for
+different purposes within the platform:
+
+- \subpage occ_3d_viewer_page "OCC 3D viewer" has been developed on
+the basis of Open CASCADE Technology (http://www.opencascade.org).
+This is the default viewer for SALOME Geometry module, it provids good
+representation of construction and transformation of geometrical objects.
+
+- \subpage vtk_3d_viewer_page "VTK 3D viewer" has been developed
+basing on Kitware Visualization ToolKit library (http://www.vtk.org).
+This is the default viewer for SALOME Mesh module, where it is used
+for visualization of meshes. It is also used in SALOME Post-Pro module
+for all 3D presentations.
+
+- \subpage plot2d_viewer_page "Plot 2D viewer" has been developed
+basing on the open-source Qwt library (http://qwt.sourceforge.net).
+It is used, for example, for the representation of 2D plots and graphs
+in the SALOME Post-Pro module.
+
+- \subpage gl_2d_viewer_page GL 2D viewer - general purpose
+OpenGL-based viewer, which can be used for visualization of 2D
+scenes. This type of viewer is not currently used in SALOME platform
+directly, but can be used in the custom modules for the 2D
+visualization purposes.
+
+- \subpage qxscene_2d_viewer_page QxScene 2D viewer - it has been
+developed on the basis of Qt QGraphicsView scene. This viewer is used
+in SALOME YACS module for visualization of computation schemes.
*/
functionality which can be accessed by locking on them with left mouse
button.
-\image html vtkviewer_toolbar.png "Viewer Toolbar"
+\image html vtkviewer_toolbar.png
<hr>
\image html vtk_view_camera_dump.png
-<br><center><b>Dump View</b> - exports an object from the viewer in bmp, png, jpg
-or jpeg image format.</center>
+
+<b>Dump View</b> - exports an object from the viewer in bmp, png or
+jpeg image format.
<hr>
\image html vtk_view_style_switch.png
-<br><center><b>Interaction style switch</b> - allows to switch between standard and
-"keyboard free" interaction styles. "Keyboard free" style allows to process all
-view transformations without using keyboard (only by mouse) and perform selection
-in view by pressing "S" key. By default, rotation in this mode is performed by
-left mouse button, panning - by middle mouse button, zooming - by left and middle
-mouse buttons pressed simultaneously.</center>
+
+<b>Interaction style switch</b> - allows to switch between standard
+and "keyboard free" interaction styles. "Keyboard free" style allows
+to process all view transformations without using keyboard (only by
+mouse) and perform selection in view by pressing "S" key. By default,
+rotation in this mode is performed by left mouse button, panning - by
+middle mouse button, zooming - by left and middle mouse buttons
+pressed simultaneously.
<hr>
\image html vtk_view_zooming_style_switch.png
-<br><center><b>Zooming style switch</b> - allows to switch between standard
-(zooming at the center of the view) and advanced (zooming at the current cursor
-position) zooming styles. The second mode is available only for parallel
-(non-perspective) view's mode.</center>
+
+<b>Zooming style switch</b> - allows to switch between standard
+(zooming at the center of the view) and advanced (zooming at the
+current cursor position) zooming styles. The second mode is available
+only for parallel (non-perspective) view's mode.
<hr>
\image html vtk_view_highlight.png
-<br><center><b>Dynamic pre-selection switch</b> - allows to switch
-on/off dynamic pre-selection of objects. When the dynamic
-pre-selection is switched on, an objects can be selected by clicking
-the point/cell belonging to this object, with some performance
-loss. Switch dynamic pre-selection off to have a good performance on
-big objects (for example, huge meshes).</center>
+
+<b>Dynamic pre-selection switch</b> - allows to switch on/off dynamic
+pre-selection of objects. When the dynamic pre-selection is switched
+on, an objects can be selected by clicking the point/cell belonging to
+this object, with some performance loss. Switch dynamic pre-selection
+off to have a good performance on big objects (for example, huge
+meshes).
<hr>
\image html vtk_view_triedre.png
-<br><center><b>Show/Hide Trihedron</b> - shows or hides coordinate axes.</center>
+
+<b>Show/Hide Trihedron</b> - shows or hides coordinate axes.
<hr>
\image html vtk_view_fitall.png
-<br><center><b>Fit all</b> - scales the presentation so that it could
-fit within the Viewer boundaries.</center>
+
+<b>Fit all</b> - scales the presentation so that it could fit within
+the Viewer boundaries.
<hr>
\image html vtk_view_fitarea.png
-<br><center><b>Fit area</b> - resizes the view to place in the visible area
-only the contents of a frame drawn with pressed left mouse button.</center>
+
+<b>Fit area</b> - resizes the view to place in the visible area only
+the contents of a frame drawn with pressed left mouse button.
<hr>
\image html vtk_view_zoom.png
-<br><center><b>Zoom</b> - allows to zoom in and out.</center>
+
+<b>Zoom</b> - allows to zoom in and out.
<hr>
\image html vtk_view_pan.png
-<br><center><b>Panning</b> - if the represented objects are greater that the
-visible area and you don't wish to use <b>Fit all</b> functionality, click on
-this button and you'll be able to drag the scene to see its remote
-parts.</center>
+
+<b>Panning</b> - if the represented objects are greater that the
+visible area and you don't wish to use <b>Fit all</b> functionality,
+click on this button and you'll be able to drag the scene to see its
+remote parts.
<hr>
\image html vtk_view_glpan.png
-<br><center><b>Global panning</b> - allows to select a point to be the
-center of the presentation showing all displayeed objects in the
-visible ares.</center>
+
+<b>Global panning</b> - allows to select a point to be the center of
+the presentation showing all displayed objects in the visible ares.
<hr>
\image html vtk_view_rotation_point.png
-<br><center><b>Change rotation point</b> - allows to to choose the point around
-which the rotation is performed.</center><br>
+
+<b>Change rotation point</b> - allows to to choose the point around
+which the rotation is performed.
\image html set_rotation_point_dialog1.png
-<br><center>By default the rotation point is located in the Center of the bounding
-box of an object.</center><br>
+By default the rotation point is located in the Center of the bounding
+box of an object.
\image html set_rotation_point_dialog2.png
-<br><center>Unchecking <b>Use Bounding Box Center</b> checkbox allows you to
-define the coordinates of the rotation point manually.</center><br>
+Unchecking <b>Use Bounding Box Center</b> checkbox allows you to
+define the coordinates of the rotation point manually.
- <b>Set to Origin</b> button restores the default rotation point
-coordinates.<br>
+ coordinates.
+
- <b>Select Point from View</b> button allows to select the rotation
-point in the 3D Viewer.
+ point in the 3D Viewer.
+
<hr>
\image html vtk_view_rotate.png
-<br><center><b>Rotation</b> - allows to rotate the selected object using the
-mouse.</center>
+
+<b>Rotation</b> - allows to rotate the selected object using the
+mouse.
<hr>
\image html vtk_view_front.png
\image html vtk_view_left.png
\image html vtk_view_right.png
-<br><center>These buttons orientate the scene strictly about coordinate axes.</center>
+These buttons orientate the scene strictly about coordinate axes:
+\b Front, \b Back, \b Top, \b Bottom, \b Left or \b Right side.
<hr>
\image html vtk_view_anticlockwise.png
-<br><center><b>Rotate counterclockwise</b> - rotates view 90°
-counterclockwise.</center>
+
+<b>Rotate counterclockwise</b> - rotates view 90° counterclockwise.
<hr>
\image html vtk_view_clockwise.png
-<br><center><b>Rotate clockwise</b> - rotates view 90°
-clockwise.</center>
+
+<b>Rotate clockwise</b> - rotates view 90° clockwise.
<hr>
\image html vtk_view_reset.png
-<br><center><b>Reset</b> - restores the default position (isometric) of
-objects in the scene.</center>
+
+<b>Reset</b> - restores the default position (isometric) of objects in
+the scene.
<hr>
\image html vtk_view_update_rate.png
-<br><center><b>Update Rate</b> - allows to define the Update Rate for
-the presentations displayed in the viewer.</center><br>
+
+<b>Update Rate</b> - allows to define the Update Rate for the
+presentations displayed in the viewer.
\image html updaterate.png
-<br>
- <b>Desired Update Rate, FPS</b> - allows to set the target Update
-Rate
+ Rate
+
- <b>Still Update Rate, FPS</b> - allows to set the Update Rate for
-the periods when both the user and the application do not perform any
-actions in the viewer
+ the periods when both the user and the application do not perform
+ any actions in the viewer
+
- <b>Current Update Rate, FPS</b> - shows the Update Rate currently
-available on your configuration
+ available on your configuration
+
- <b>Number of Cells</b> - shows the number of cells currently in
-display
+ display
+
<hr>
\image html vtk_view_scaling.png
-<br><center><b>Scaling</b> - represents objects deformed (stretched or
-stuffed) along the axes of coordinates.</center>
+
+<b>Scaling</b> - represents objects deformed (stretched or stuffed)
+along the axes of coordinates.
<hr>
\image html vtk_view_graduated_axes.png
-<br><center><b>Graduated axes</b> - allows to define parameters of axes
-and graduate them.</center><br>
+
+<b>Graduated axes</b> - allows to define parameters of axes and
+graduate them.
\image html graduatedaxes1.png
-<br>
- <b>Axis name</b> - if checked the axis name is displayed in the viewer.
+
- <b>Name</b> - allows to redefine the name of the axis.
+
- <b>Font</b> - allows to define color and properties of the font of axis name.
+
- <b>Labels</b> - if checked the labels are displayed in the viewer.<
+
- <b>Number</b> - allows to define the number of labels.
+
- <b>Offset</b> - allows to define the distance between labels.
+
- <b>Font</b> - allows to define color and properties of the font of labels names.
+
- <b>Tick marks</b> - if checked the tick marks are displayed in the viewer.
+
- <b>Length</b> - allows to define the length of tick marks.
+
- <b>Is visible</b> - if checked the axis is displayed in the viewer.
+
<hr>
\image html vtk_view_parameters.png
-<br><center><b>Change View Parameters</b> - this button provides
-access to the dialog box allowing customization different parameters
-of the view:</center><br>
+
+<b>Change View Parameters</b> - this button provides access to the
+dialog box allowing customization different parameters of the view.
\image html vtk_view_parameters_dlg.png
-<br>
- <b>Projection Mode</b> - switchs to the Orthogonal / Perspective
projection mode
+
- <b>Focal Point</b> - allows to specify the focal point of the view
+
- <b>Set to Bounding Box Center</b> - chooses the center of the
- bounding box of the current scene as the focal point.
+ bounding box of the current scene as the focal point.
+
- <b>Set to Origin</b> - chooses the global coordinates system origin as
- the focal point
+ the focal point
+
- <b>Select Point from View</b> - allows to specify the focal point by the
- direct selection of a point in the view window
+ direct selection of a point in the view window
+
- <b>X</b>, <b>Y</b>, <b>Z</b> - allows to input the coordinates of the focal
- point directly
+ point directly
+
- <b>Camera Position</b> - allows to specify the position of the view camera:
+
- <b>Absolute Coordinates</b> - either in absolute coordinates,
+
- <b>Relative to Focal Point</b> - or as a offset to the focal point;
+
- <b>Projection Direction</b> - allows specify the direction of the
- projection vector;
+ projection vector;
+
- <b>Focal Distance</b> - the focal distance value;
+
- <b>View Up Direction</b> - direction of the "view up" vector.
+
- <b>Zooming</b> - the current zoom factor (available in the <b>Orthogonal
mode</b> only)
+
- <b>View Angle</b> - the current view angle (available in the <b>Perspective
mode</b> only)
+
<hr>
\image html vtk_view_sync.png
-<br><center><b>Synchronize view</b> - allows to synchronize 3d view parameters.</center>
-This button has two states - checked and unchecked. Clicking on this
-button opens a drop-down menu listing the compatible 3d views. As soon
-as the user selects any view from the list, the parameters (view point,
-position, zoom coefficient, etc.) of the current view are synchronized
-with the selected view (static synchronization).
+
+<b>Synchronize view</b> - allows to synchronize 3d view
+parameters. This button has two states - checked and
+unchecked. Clicking on this button opens a drop-down menu listing the
+compatible 3d views. As soon as the user selects any view from the
+list, the parameters (view point, position, zoom coefficient, etc.) of
+the current view are synchronized with the selected view (static
+synchronization).
In addition, when this button is in the "checked" state, the dynamic
synchronization of the views is performed, i.e. any zoom, pan, rotate
-or other view operation done in one view is automatically applied
-to the other view.
+or other view operation done in one view is automatically applied to
+the other view.
<hr>
\image html vtk_view_parallel.png
-<br><center><b>Orthogonal mode</b> - Switches the view to the orthogonal mode.</center>
+
+<b>Orthogonal mode</b> - Switches the view to the orthogonal mode.
<hr>
\image html vtk_view_perspective.png
-<br><center><b>Perspective mode</b> - Switches the view to the perspective mode.</center>
+
+<b>Perspective mode</b> - Switches the view to the perspective mode.
<hr>
\image html vtk_view_recording_start.png
\image html vtk_view_recording_play.png
\image html vtk_view_recording_pause.png
\image html vtk_view_recording_stop.png
-<br><center>These buttons allow recording viewing operations as a
-video file in the AVI format using external software (jpeg2yuv):</center>
+
+These buttons allow recording viewing operations as a video file in
+the AVI format using external software (jpeg2yuv):
+
- <b>Start recording</b> - specify parameters and start recording;
+
- <b>Pause recording</b> - suspend recording;
+
- <b>Continue recording</b> - resume recording;
+
- <b>Stop recording</b> - stop recording.
+<hr>
+
\anchor vtk_background
<h2>Background</h2>
\image html change_background_dlg.png
The following types of the background are supported:
+
- Single color: the background is colored with the solid color
specified by the user in the dialog box.
+
- Gradient background: the background is gradiently colored according
to two colors and the gradient type specified in the dialog
box. The following types of background are supported:
+
- Horizontal
+
- Vertical
+
- First diagonal
+
- Second diagonal
+
- First corner
+
- Second corner
+
- Third corner
+
- Fourth corner
- Image: allows to set image as viewer background and define filling type:
+
- Center: the image is located at the center of the viewer backgound
+
- Tile: the image fills the entire viewer backgound one by one
- - Strech: the image is stretched to the entire viewer backgound.
+
+ - Stretch: the image is stretched to the entire viewer backgound.
Default background for the viewer is specified via the
