From: vsr Date: Thu, 12 Dec 2013 14:08:47 +0000 (+0000) Subject: Update documentation X-Git-Tag: V7_3_0~4 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=1318dd83ec4fbb78f13c636b1ba0412c8dd564f3;hp=469aa593ccb983bed7b8c7525e9be0a14e63a446;p=modules%2Fgui.git Update documentation --- diff --git a/doc/salome/gui/images/arranging1.png b/doc/salome/gui/images/arranging1.png new file mode 100644 index 000000000..5a50eda36 Binary files /dev/null and b/doc/salome/gui/images/arranging1.png differ diff --git a/doc/salome/gui/images/arranging3.png b/doc/salome/gui/images/arranging3.png new file mode 100644 index 000000000..04cc29ad6 Binary files /dev/null and b/doc/salome/gui/images/arranging3.png differ diff --git a/doc/salome/gui/images/objectbrowser2.png b/doc/salome/gui/images/objectbrowser2.png index e010ef2b0..67b2b9fe9 100755 Binary files a/doc/salome/gui/images/objectbrowser2.png and b/doc/salome/gui/images/objectbrowser2.png differ diff --git a/doc/salome/gui/images/polyselectionvtk11.png b/doc/salome/gui/images/polyselectionvtk11.png new file mode 100644 index 000000000..77563dbf3 Binary files /dev/null and b/doc/salome/gui/images/polyselectionvtk11.png differ diff --git a/doc/salome/gui/images/polyselectionvtk21.png b/doc/salome/gui/images/polyselectionvtk21.png new file mode 100644 index 000000000..03daf3f4b Binary files /dev/null and b/doc/salome/gui/images/polyselectionvtk21.png differ diff --git a/doc/salome/gui/images/rectselectionvtk.png b/doc/salome/gui/images/rectselectionvtk.png new file mode 100644 index 000000000..8f544372d Binary files /dev/null and b/doc/salome/gui/images/rectselectionvtk.png differ diff --git a/doc/salome/gui/images/rectselectionvtk2.png b/doc/salome/gui/images/rectselectionvtk2.png new file mode 100644 index 000000000..0d46c33da Binary files /dev/null and b/doc/salome/gui/images/rectselectionvtk2.png differ diff --git a/doc/salome/gui/input/common_functionality.doc b/doc/salome/gui/input/common_functionality.doc index 7e4e2d73b..6b0e9b536 100644 --- a/doc/salome/gui/input/common_functionality.doc +++ b/doc/salome/gui/input/common_functionality.doc @@ -1,6 +1,6 @@ /*! -\page common_functionality_page Common functionality +\page common_functionality_page Functionality common for OCC and VTK viewers \anchor viewer_background

Background

@@ -12,10 +12,10 @@ popup menu command that opens the following dialog box: The following types of the background are supported: -- Single color: the background is colored with the solid color +- 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 +- 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: @@ -35,13 +35,13 @@ The following types of the background are supported: - Fourth corner -- Image: allows to set image as viewer background and define filling type: +- \b Image: allows to set image as viewer background and define filling type: - - Center: the image is located at the center of the viewer backgound + - \b Center: the image is located at the center of the viewer backgound - - Tile: the image fills the entire viewer backgound one by one + - \b Tile: the image fills the entire viewer backgound one by one - - Stretch: the image is stretched to the entire viewer backgound. + - \b Stretch: the image is stretched to the entire viewer backgound. Default background for the OCC viewer is specified via the \ref occ_preferences "OCC 3D Viewer Preferences" and for the @@ -51,48 +51,49 @@ VTK viewer via the \ref vtk_preferences "VTK 3D Viewer Preferences".

Selection

-For selecting it is necessary to click by left mouse button on the required -element. Thus, this element will be selected. +An element can be selected by clicking on it with the left mouse button. +Selecting objects with locked Shift key produces a multi selection. -Also, holding down the Shift key while selecting objects will -produce multi selection. - -In the viewers there are two mechanism for selecting: rectangle and +In the viewers there are two selection mechanisms: rectangle and polyline selection.

Rectangle selection

-The Rectangle Selection tool is designed to select rectangular regions: -it is the most basic of the selection tools and very commonly used. +Rectangle Selection is the basic and commonly used selection tool. -For selecting area by rectangle press left mouse button and draw it on -the viewer holding down the left mouse button. - -To add an area to the existing selection it is necessary to hold down -Shift key while selecting. +To select a rectangle area press and hold the left mouse button while drawing the diagonal of the selection rectangle in the viewer. \image html rectselectionvtk.png -As a result, only a rectangle is selected. + +As a result, the objects within the rectangle are selected. + \image html rectselectionvtk2.png + +\note It is possible to add an area to the existing selection by holding down +Shift key while selecting. + +

Polyline selection

-OCC and VTK Viewers features a special Polyline Selection mechanism, -which allows selecting an arbitraty part of the graphic area using a +OCC and VTK Viewers feature a special Polyline Selection mechanism, +which allows selecting an arbitrary 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 -frame is drawn with the locked right mouse button. +To produce a Polyline Selection, press and hold the right mouse button and draw +the first side of the selection polygon, then change the direction by clicking +the left mouse button add draw another side, etc. + +\image html polyselectionvtk11.png + +As a result, the objects within the polygon are selected. + +\image html polyselectionvtk21.png To add an area to the existing selection it is necessary to hold down Shift key while selecting. -\image html polyselectionvtk11.png -As a result, only the faces within the frame are selected. -\image html polyselectionvtk21.png
@@ -103,28 +104,26 @@ OCC and VTK 3D viewers support two different navigation modes: - Salome standard controls - Rectangle selection in this mode is performed by left mouse button, - polyline selection is done by right mouse button; + Rectangle selection in this mode is performed by the left mouse button + and polyline selection by the right mouse button; multiple selection is available when \b Shift button is pressed. - Also, holding \b Ctrl key pressed in conjunction with - mouse buttons performs view transformations: + Also, holding \b Ctrl key with pressed mouse buttons performs the following view transformations: - \b Ctrl + left mouse button - zooming; - \b Ctrl + middle mouse button - panning; - \b Ctrl + right mouse button - rotation. - Keyboard free style - This mode allows to process all view transformations without using - keyboard (only by mouse): + This mode allows performing all view transformations without using the + keyboard (only by the mouse): - \b Left mouse button performs view rotation; - \b Middle mouse button performs panning; - \b Right mouse button makes zooming. - . - - In this style selection of objects in view is performed by pressing - "S" key or by left mouse button click. Rectangle selection is done - by left mouse button when holding \b Ctrl key; polyline selection - is done by right mouse button with \b Ctrl key pressed. + . + In this style selection of objects in the viewer is performed by pressing + "S" key or by the left mouse button click. Rectangle selection is done + by the left mouse button with \b Ctrl key pressed; polyline selection + is done by the right mouse button with \b Ctrl key pressed. */ diff --git a/doc/salome/gui/input/occ_3d_viewer.doc b/doc/salome/gui/input/occ_3d_viewer.doc index bb4818e14..7ab47b2ca 100644 --- a/doc/salome/gui/input/occ_3d_viewer.doc +++ b/doc/salome/gui/input/occ_3d_viewer.doc @@ -43,7 +43,7 @@ current cursor position) zooming styles. \image html occ_view_preselection.png -Enable/Disable preselection - enables or disables preselection in the view. +Enable/Disable preselection - enables or disables preselection (highlighting) in the view.
\image html occ_view_selection.png @@ -156,29 +156,25 @@ scene.
\anchor clipping_planes -\image html occ_view_clipping.png -Clipping - allows to create cross-section views (clipping -planes) of geometrical objects. +\b Clipping allows creating cross-section views (clipping planes) +of your mesh. -To start, click on the \em New button. +To create a clipping plane, click on the \b New button in the dialog and choose how it is definition by \b Absolute or \b Relative coordinates. -Now you must specify what mode of creating plane you want to choose: -absolute or relative. - -Absolute mode +Absolute Coordinates \image html Clipping_Absolute.png -- Base point - allows to define the coordinates of the base +- Base point - allows defining the coordinates of the base point for the clipping plane. - Reset - returns the base point to coordinate origin. -- Direction - allows to define the orientation of the +- Direction - allows defining the orientation of the clipping plane. - - Invert - allows to select which part of the object will be + - Invert - allows selecting, which part of the object will be removed and which will remain after clipping. Relative mode @@ -186,17 +182,20 @@ absolute or relative. \image html Clipping_Relative.png - \b Orientation ( ||X-Y, ||X-Z or ||Y-Z). + - \b Distance between the opposite extremities of the boundary box of selected objects, if it is set to 0.5 the boundary box is split in two halves. + - \b Rotation (in angle degrees) around X (Y to Z) and around Y (X to Z) (depending on the chosen Orientation) +The other parameters are available in both modes : +- Preview check-box shows the clipping plane in the 3D Viewer. +- Auto Apply check-box shows button is on, you can preview the +cross-section in the 3D Viewer. -If the Show preview button is on, you can see the clipping plane -in the viewer. - -If the Auto Apply button is on, you can preview the -cross-section in the viewer. +It is also possible to interact with the clipping plane directly in 3D +view using the mouse.
@@ -269,66 +268,5 @@ or other view operation done in one view is automatically applied to the other view.
-\anchor occ_background -

Background

- -OCC Viewer background can be customized using the "Change background" -popup menu command that opens the following dialog box: - -\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 - - - Stretch: the image is stretched to the entire viewer backgound. - -Default background for the viewer is specified via the -\ref occ_preferences "application preferences". - -

Polyline selection

- -OCC Viewer features a special Polyline Selection 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 -frame is drawn with the locked right mouse button. - -\image html polyselection1.png - -As a result, only the nodes within the frame are selected. - -\image html polyselection2.png */ diff --git a/doc/salome/gui/input/salome_architecture.doc b/doc/salome/gui/input/salome_architecture.doc index 387c201a1..c91983ef4 100644 --- a/doc/salome/gui/input/salome_architecture.doc +++ b/doc/salome/gui/input/salome_architecture.doc @@ -21,7 +21,7 @@ cooperate dynamically and be configurable. etc. Third party modules optionally can have GUI, but in any case they always connected with KERNEL.
  • \b Geometry : facilitates construction and optimization of geometrical models using a wide range of CAD functions.
  • \b Mesh : generates meshes on geometrical models previously created or imported by the Geometry component. -
  • \b Post-Pro : performs data visualization and post-processing. +
  • \b ParaVis : performs data visualization and post-processing.
  • \b MED : allows to work with MED files. @@ -46,7 +46,7 @@ other components.          -All software components (Post-Pro, Geometry, Mesh...) integrated into +All software components (Geometry, Mesh...) integrated into \b SALOME platform implement predefined interfaces. Each component provides data for the \b SALOME study in a form of links (stored in the Study) to the specific data created and stored in the diff --git a/doc/salome/gui/input/salome_desktop.doc b/doc/salome/gui/input/salome_desktop.doc index 03704ae0b..2c60c00e3 100644 --- a/doc/salome/gui/input/salome_desktop.doc +++ b/doc/salome/gui/input/salome_desktop.doc @@ -3,14 +3,13 @@ \page salome_desktop_page SALOME desktop Multi-Desktop Approach used in Salome means that there is a separate Desktop -for each Study and all windows connected to one Study (viewers, dockable -windows etc) are placed in one container. +for each Study and all windows connected to the same Study (viewers, dockable +windows, etc.) are placed in one container. This approach positively differs from the classic multi document interface if many windows are used, i.e. when one document contains a lot of viewers, dialogs, etc. Each desktop also has its own menu and toolbar. -The main SALOME Desktop consists of the following sections and -toolbars: +The main SALOME Desktop consists of the following sections and toolbars: \image html desktop.png @@ -19,31 +18,24 @@ toolbars: -        All toolbars in the -\b SALOME Platform are context-sensitive. Loading of a definite component -(Geometry, Post-Pro, Mesh etc.) will automatically add some additional -toolbars specific to this component. To display/hide a definite -toolbar, in the main menu choose View > Toolbars, and from this -submenu check or uncheck the toolbar, you would like to display/hide. +All toolbars in the \b SALOME Platform are context-sensitive. Loading of a definite component +(Geometry, Mesh etc.) will automatically add some additional +toolbars specific to this component. To display/hide a toolbar, in the main menu choose View > Toolbars, and from this submenu check or uncheck the toolbar that you would like to display/hide. -        By default all -toolbars are located on the top of the SALOME desktop. But you can -relocate toolbars by dragging with the mouse and dropping it in any -place of the window. +By default all toolbars are located on top of the SALOME desktop, but you can relocate a toolbar by dragging it with the mouse and dropping in any place of the window. Parts of the study window: -        Object Browser, Python -Console, MenuBar, etc are, in fact, separate dockable windows. +Object Browser, Python Console, MenuBar, etc are, in fact, separate dockable windows. Dockable windows can be placed in special areas, on the borders of desktop like toolbars. You can change the size and the position of dockable windows, hide them or even place outside desktop. SALOME @@ -70,8 +61,7 @@ activated). Also each module can indicate which common windows are necessary for working, and only they will be displayed when this module is active. -All parts of Salome desktop and study window can be managed through \b -View menu. +All parts of Salome desktop and study window can be managed through \b View menu. \image html viewmenu.png @@ -80,53 +70,31 @@ View menu.
  • \b Windows - allows to show and hide dockable windows, such as Object Browser and Python Console
  • Status Bar allows showing and hiding the Status Bar.
    • -
  • \ref themes_page "Theme" - allows to select and edit the style (colors and fonts) for -Salome session.
    • +
  • \ref themes_page "Theme" - allows to select and edit the style (colors and fonts) for Salome session.
    • -If there are several viewer windows in your current study and -you want to display more then one at the same time, you can use the -functionalities provided by the \b Window menu. +If there are several viewer windows in your current study and you want to display more then one at the same time, you can use the functionalities provided by the \b Window menu. \image html windowmenu.png diff --git a/doc/salome/gui/input/using_object_browser.doc b/doc/salome/gui/input/using_object_browser.doc index 6511e7995..d147ad329 100644 --- a/doc/salome/gui/input/using_object_browser.doc +++ b/doc/salome/gui/input/using_object_browser.doc @@ -32,25 +32,19 @@ attributes. \image html objectbrowser2.png - +- \b Name; +- \b Entry - Identification index of the object in the structure of the study; +- \b IOR - Interoperable Object Reference; +- Reference entry - Identification index of the references to the objects; +- \b Value - Displays the value of the first object attribute. \note Entry, IOR and Reference entry attributes are displayed for debugging purposes only. -

    Enable sorting

    +

    Sorting

    By default the objects in the object browser are sorted in the creation order. \n -However, it is possible to enable sorting -in the alphabetical order (or the reverse alphabetical order) by right -clicking in the header of the tree (near the "Name" field) and -checking "enable sorting" in the popup menu. +However, it is possible to enable sorting in the alphabetical order (or the reverse alphabetical order) by right clicking in the header of the tree (near the \b Name field) and checking "enable sorting" in the context menu. \n It is possible to use the arrow near "Name" to reverse the order. If "enable sorting" is unchecked, the objects are sorted in the default order again. diff --git a/doc/salome/gui/input/viewers_chapter.doc b/doc/salome/gui/input/viewers_chapter.doc index fd493caab..17eadb87d 100644 --- a/doc/salome/gui/input/viewers_chapter.doc +++ b/doc/salome/gui/input/viewers_chapter.doc @@ -2,25 +2,26 @@ \page viewers_page Viewers -SALOME provides a set of viewers for data representation. SALOME GUI -module includes several 2D and 3D viewers, that are used for + + +SALOME GUI module includes several 2D and 3D viewers, that are used for different purposes within the platform: - \subpage occ_3d_viewer_page 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 +This is the default viewer for SALOME Geometry module, it provides good representation of construction and transformation of geometrical objects. - \subpage vtk_3d_viewer_page 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. +for visualization of meshes. + +OCC and VTK 3d viewers share some \subpage common_functionality_page "common functionality". - \subpage plot2d_viewer_page 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. +It can be used, for example, for the representation of 2D plots and graphs. - \subpage gl_2d_viewer_page is a general purpose OpenGL-based viewer, which can be used for visualization of 2D @@ -31,6 +32,6 @@ directly, but can be used in custom modules for 2D visualization purposes. developed on the basis of Qt QGraphicsView scene. This viewer is used in SALOME YACS module for visualization of computation schemes. -- \subpage common_functionality_page used in OCC and VTK 3d viewers. + */ diff --git a/doc/salome/gui/input/vtk_3d_viewer.doc b/doc/salome/gui/input/vtk_3d_viewer.doc index e3838531e..d09134121 100644 --- a/doc/salome/gui/input/vtk_3d_viewer.doc +++ b/doc/salome/gui/input/vtk_3d_viewer.doc @@ -6,7 +6,7 @@ The functionalities of VTK 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 +functionality, which can be accessed by locking on them with left mouse button. \image html vtkviewer_toolbar.png @@ -14,8 +14,7 @@ button. \image html vtk_view_camera_dump.png -Dump View - exports an object from the viewer in bmp, png or -jpeg image format. +Dump View - exports an object from the viewer in bmp, png or jpeg image format.
    \image html vtk_view_style_switch.png @@ -35,14 +34,10 @@ only for parallel (non-perspective) view's mode. \image html vtk_view_highlight.png -These buttons allow to switch between three pre-selection modes. -Possible choices: -- Standard preselection mode - pre-selection is enabled in a standard mode; -- Dynamic preselection mode - when the dynamic pre-selection is chosen, -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); -- Disable preselection - pre-selection is disabled. +These buttons allow switching between three pre-selection (highlighting) modes: +- Static pre-selection mode - pre-selection is done in terms of bounding boxes; +- Dynamic pre-selection mode - pre-selection is done in terms of cells, i.e. an object can be selected by clicking the point/cell belonging to this object. This mode causes some performance loss. It is advisable to switch dynamic pre-selection off to have a good performance on big objects (for example, huge meshes); +- Disable pre-selection - pre-selection is disabled.
    @@ -76,15 +71,14 @@ the contents of a frame drawn with pressed left mouse button. \image html vtk_view_pan.png 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. +visible area and you do not wish to use Fit all functionality, +click on this button to drag the scene to see its remote parts.
    \image html vtk_view_glpan.png Global panning - allows to select a point to be the center of -the presentation showing all displayed objects in the visible ares. +the presentation showing all displayed objects in the visible area.
    \image html vtk_view_rotation_point.png @@ -99,7 +93,7 @@ box of an object. \image html set_rotation_point_dialog2.png -Unchecking Use Bounding Box Center checkbox allows you to +Unchecking Use Bounding Box Center check-box allows you to define the coordinates of the rotation point manually. - Set to Origin button restores the default rotation point @@ -129,7 +123,7 @@ These buttons orientate the scene strictly about coordinate axes: \image html vtk_view_anticlockwise.png -Rotate counterclockwise - rotates view 90° counterclockwise. +Rotate counter-clockwise - rotates view 90° counter-clockwise.
    \image html vtk_view_clockwise.png @@ -202,46 +196,39 @@ graduate them. \image html vtk_view_parameters.png -Change View Parameters - this button provides access to the -dialog box allowing customization different parameters of the view. +Change View Parameters - this button gives access to the +dialog for customization of various view parameters. \image html vtk_view_parameters_dlg.png -- Projection Mode - switchs to the Orthogonal / Perspective - projection mode +- Projection Mode - switches between the \b Orthogonal and \b Perspective projection modes. - Focal Point - allows to specify the focal point of the view - Set to Bounding Box Center - 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; - Set to Origin - chooses the global coordinates system origin as - the focal point - + the focal point; - Select Point from View - 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; - X, Y, Z - allows to input the coordinates of the focal - point directly + point directly. - Camera Position - allows to specify the position of the view camera: - - - Absolute Coordinates - either in absolute coordinates, - - - Relative to Focal Point - or as a offset to the focal point; - + - Absolute Coordinates - in absolute coordinates; + - Relative to Focal Point - as a offset to the focal point; - Projection Direction - allows specify the direction of the projection vector; + - Focal Distance - the focal distance value. - - Focal Distance - the focal distance value; - - - View Up Direction - direction of the "view up" vector. +- View Up Direction - direction of the "view up" vector. -- Zooming - the current zoom factor (available in the Orthogonal - mode only) +- Zooming -- View Angle - the current view angle (available in the Perspective - mode only) + - \b Scale - the current zoom factor (available in the Orthogonal + mode only); + - View Angle - the current view angle (available in the Perspective + mode only).
    @@ -249,16 +236,13 @@ dialog box allowing customization different parameters of the view. Synchronize view - 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 +unchecked. Clicking on this button opens a drop-down menu listing +compatible 3d views. When a view is selected in 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. +In addition, when this button is "checked", the +views are synchronized dynamically, i.e. any zoom, pan, rotate +or other view operation done in one view is automatically applied to the other view.
    \image html vtk_view_parallel.png