From 533603e5ce391f9f16255aa89ebfec961e2b9399 Mon Sep 17 00:00:00 2001 From: ysn Date: Mon, 27 Oct 2014 14:05:11 +0400 Subject: [PATCH] A revison of documentation for the new Salome version. --- .../input/arranging_study_objects_page.doc | 7 +- .../gui/GEOM/input/creating_cylinder.doc | 8 +- .../gui/GEOM/input/creating_explode.doc | 4 +- .../gui/GEOM/input/creating_polyline.doc | 85 +++++-------- .../GEOM/input/creating_smoothingsurface.doc | 8 +- doc/salome/gui/GEOM/input/dependency_tree.doc | 117 +++++++----------- .../gui/GEOM/input/geometry_preferences.doc | 35 +++--- doc/salome/gui/GEOM/input/reduce_study.doc | 45 ++++--- .../gui/GEOM/input/tui_basic_geom_objs.doc | 3 + doc/salome/gui/GEOM/input/tui_polyline.doc | 6 - .../gui/GEOM/input/viewing_geom_obj.doc | 7 +- 11 files changed, 128 insertions(+), 197 deletions(-) delete mode 100644 doc/salome/gui/GEOM/input/tui_polyline.doc diff --git a/doc/salome/gui/GEOM/input/arranging_study_objects_page.doc b/doc/salome/gui/GEOM/input/arranging_study_objects_page.doc index 88aea81d4..e496e02f2 100644 --- a/doc/salome/gui/GEOM/input/arranging_study_objects_page.doc +++ b/doc/salome/gui/GEOM/input/arranging_study_objects_page.doc @@ -36,11 +36,10 @@ and then displays only the children of the selected object(s). to change the order (ascending / descending) by clicking the corresponding title bar of the objects list. -
  • \ref dependency_tree_page "Show dependency tree" - shows dependency tree of selected objects -in new 2D View Window.
    • +
  • \ref dependency_tree_page "Show dependency tree" - shows the dependency tree with parents and children of the selected object +in a new 2D View Window.
    • -
  • \ref reduce_study_page "Reduce study" - allows to reduce study -by automatic removing objects according to user's options.
    • +
  • \ref reduce_study_page "Reduce study" - allows reducing the study by removing objects from it.

    • Folders

    diff --git a/doc/salome/gui/GEOM/input/creating_cylinder.doc b/doc/salome/gui/GEOM/input/creating_cylinder.doc index d2c9f78e3..8b81f7982 100644 --- a/doc/salome/gui/GEOM/input/creating_cylinder.doc +++ b/doc/salome/gui/GEOM/input/creating_cylinder.doc @@ -10,8 +10,8 @@ Entity - > Primitives - > Cylinder \n Firstly, you can define a \b Cylinder by the Base Point (the central point of the cylinder base), the \b Vector (the axis of the cylinder), -and its dimensions: the \b Radius and the \b Height. Also, you can optionally specify -the \b Angle in order to create a portion of cylinder. +and its dimensions: the \b Radius and the \b Height. You can optionally specify +the \b Angle to create a portion of cylinder. \n TUI Command: geompy.MakeCylinder(Point, Axis, Radius, Height) \n Arguments: Name + 1 vertex + 1 vector + 2 values @@ -26,8 +26,8 @@ the \b Angle in order to create a portion of cylinder. \n Secondly, you can define a \b Cylinder by the given \b Radius and \b Height at the origin of coordinate system. The axis of the cylinder will be collinear to the OZ axis of the coordinate system. -Similarly to first constructor, you can optionally specify the \b Angle -in order to create a portion of cylinder. +Similarly to the first constructor, you can optionally specify the \b Angle +to create a portion of cylinder. \n TUI Command: geompy.MakeCylinderRH(Radius, Height) \n Arguments: Name + 2 values (Dimensions at origin: radius and diff --git a/doc/salome/gui/GEOM/input/creating_explode.doc b/doc/salome/gui/GEOM/input/creating_explode.doc index 1de29847a..65a813eb2 100644 --- a/doc/salome/gui/GEOM/input/creating_explode.doc +++ b/doc/salome/gui/GEOM/input/creating_explode.doc @@ -26,11 +26,11 @@ sub-shapes of a given Type and returns a List of IDs of sub-shapes.
  • geompy.SubShapeAllSortedCentres(Shape, Type) explodes a shape on sub-shapes of a given type and sorts them taking into account -their gravity centers, to provide stable order of sub-shapes. +their gravity centers, to provide a stable order of sub-shapes. It returns a list of sub-shapes.
  • geompy.SubShapeAllSortedCentresIDs(Shape, Type) explodes a shape on sub-shapes of a given type and sorts them taking into -account their gravity centers, to provide stable order of sub-shapes. +account their gravity centers, to provide a stable order of sub-shapes. It returns a List of IDs of sub-shapes.
  • geompy.SubShape(Shape, Type, ListOfInd) allows to obtain a compound of sub-shapes of the Shape, selected by they indices in a diff --git a/doc/salome/gui/GEOM/input/creating_polyline.doc b/doc/salome/gui/GEOM/input/creating_polyline.doc index 7ec36434d..f7fa7c9a1 100644 --- a/doc/salome/gui/GEOM/input/creating_polyline.doc +++ b/doc/salome/gui/GEOM/input/creating_polyline.doc @@ -9,93 +9,68 @@ To create a 2D Polyline select in the main menu New Entity -> Basic - \image html polyline_dlg.png A polyline represents a section or a set of sections. Each section is constructed from a sequence of 2D points -connected either by linear setgments or an interpolation curve. Every section has its own attributes: +connected by either linear segments or an interpolation curve. Every section has its own attributes: - \b Name, - \b Type (Polyline or Spline), - \b Closed flag. -A Polyline created represents a shape that lies on the XOY plane. It can have the following types: +A created Polyline represents a shape that lies on the XOY plane. Its type can be one of the following: - \b Vertex for a single section with only 1 point. -- \b Wire for a single section with 2 or more points. A Wire can have multiple edges for more then 2 points if the section type is Polyline. -A single edge in the result wire is obtained for a Spline or Polyline with 2 points. +- \b Wire for a single section with 2 or more points. A Wire can have multiple edges for more then 2 points if the section type is Polyline. A single edge in the resulting wire is obtained for a Spline or Polyline with 2 points. - \b Compound of Wires and/or Vertices if there are several sections. -For the moment only one reference coordinate system for polyline creation is supported. The XOY plane of the Global coordinate system -is suggested. Implementation of another reference coordinate system is a subject of further development of this functionality. -Restore button orientates the viewer correspondingly to the chosen working plane and fits the scene to show all objects. +For the moment only one reference coordinate system for polyline creation is supported, which is the XOY plane of the Global coordinate system. +\b Restore button orientates the viewer correspondingly to the chosen working plane and fits the scene to show all objects. For the moment this button works with only one plane. -It is possible to import a shape in this dialog using Import polyline selection button. To do it an imported object should satisfy conditions -for polyline shapes mentioned above. If a valid shape is selected, when dialog is opened, it is initialized by this shape. -Though the shape can be on any plane, an imported polyline will be defined on XOY plane only due to the limitation. +It is possible to import a shape in this dialog using Import polyline selection button. An imported object should meet the conditions for polyline shapes mentioned above. If a valid shape is selected, when the dialog is opened, it is initialized by this shape. +Though the shape can be on any plane, the imported polyline will be defined on XOY plane only due to the limitation. -The group \b Sections in this dialog represents the Polyline construction framework. Its toolbar has the following operations: -- \b Undo -- \b Redo -- Insert new section -- Addition mode -- Modification mode - not implemented -- Detection mode - not implemented -- \b Remove -- Join selected sections +The group \b Sections in this dialog represents the Polyline construction framework. -Undo/Redo buttons allows to undo/redo changes of the polyline. +The buttons Undo and Redo allows to undo or redo the changes of the polyline. -Insert new section button opens a dialog that allows to add a new section: +Insert new section button opens the corresponding dialog: \image html polyline_dlg_add_section.png In this dialog it is possible to choose: -- \b Name of section -- \b Type of section -- \b Closed flag +- \b Name of section; +- \b Type of section; +- Set \b Closed flag. -To create a new section \b Add button should be clicked. \b Cancel button is used to cancel this operation. -After clicking \b Add button a new section is appeared on the list. Its name supplemented by its type and closedness -information (see icon) and the number of points (equal to 0 after creation). +To create a new section, click \b Add button. \b Cancel button is used to cancel this operation. +After clicking \b Add button a new section appears in the list. Its name is generated automatically depending on its type, closed or opened state and the number of points (equal to 0 after creation). -To modify section parameters it is possible to double-click on a section in the list. In this case the following dialog appears: +To modify section parameters, double-click on a section in the list. In this case the following dialog appears: \image html polyline_dlg_edit_section.png -To apply modifications the button \b Ok should be clicked. +To apply the modifications, click \b Ok button. -Addition mode allows to add points to a section. It is necessary to select a particular section in a list of sections -and make some mouse clicks in the viewer. A section preview is recomputed after each click. +Addition mode allows adding points to a section. Select a particular section in the list of sections +and left-click in the viewer to add new nodes to the section. A section preview is recomputed after each click. Modification mode and Detection mode are not implemented for the moment. -\b Remove button allows to remove a section. It is available if all modes are deactivated and one section is selected. +\b Remove button allows removing a section. It is available if all modes are deactivated and one section is selected. Join selected sections button is available in modification mode if two or more sections are selected. It is used to -merge several sections into the first one from selection list. Joined section has parameters of the first selected one. Points of -the other sections are appended at the end of the list of the first section points. +merge several sections into the first one from the selection list. The points of the merged sections are appended at the end of the list of points of the first section. -Some actions are available via popup menu by right mouse button click. +Some actions are available via the context menu activated by right mouse button click. +- Join all sections - joins all defined sections into the first one. +- \b Join - joins two or more selected sections. +- Clear all - removes all selected sections. +- Set closed - sets \b Closed flag for all selected section. +- Set open - unset \b Closed flag for all selected sections. +- Set polyline - sets the type of all selected sections to Polyline. +- Set spline - set the type of all selected sections to Splineall. -If all modes are deactivated: -- Join all sections - join all defined sections into the first one. -- \b Join - join sections. Available if two or more sections are selected. - -In Addition mode: -- Join all sections - join all defined sections into the first one. - -In Modification mode: -- Join all sections - join all defined sections into the first one. -- \b Join - join sections. Available if two or more sections are selected. -- Clear all - remove all sections. Available if at least one section is selected. -- Set closed - set all selected section's Closed flag. Available if at least one section is selected. -- Set open - reset all selected section's Closed flag. Available if at least one section is selected. -- Set polyline - set all selected section's type to Polyline. Available if at least one section is selected. -- Set spline - set all selected section's type to Spline. Available if at least one section is selected. - -In Detection mode: -- Join all sections - join all defined sections into the first one. -- \b Join - join sections. Available if two or more sections are selected. +Different actions are available depending on the mode and selection.

    TUI Commands

    - To create the 2D polyline in TUI Polyline2D interface is used. pl = geompy.Polyline2D() - returns an instance of Polyline2D interface pl. diff --git a/doc/salome/gui/GEOM/input/creating_smoothingsurface.doc b/doc/salome/gui/GEOM/input/creating_smoothingsurface.doc index a4d3fb647..e59f403b1 100644 --- a/doc/salome/gui/GEOM/input/creating_smoothingsurface.doc +++ b/doc/salome/gui/GEOM/input/creating_smoothingsurface.doc @@ -14,11 +14,11 @@ In this dialog you can specify the following parameters: - Max BSpline surface degree of the resulting BSpline surface; - 3D tolerance of initial approximation -\note 3D tolerance of initial approximation represents a tolerance of +\note 3D tolerance of the initial approximation represents the tolerance of initial plate surface approximation. If this parameter is equal to 0 (default), its value is automatically computed as max(0.0001, 10*error), -where error is a 3D tolerance of the surface representing a maximal -distance between computed plate surface and given points. +where error is the 3D tolerance of the surface representing the maximal +distance between the computed plate surface and given points. Advanced options: \ref preview_anchor "Preview" @@ -28,7 +28,7 @@ Press "Apply" or "Apply & Close" button to get the resulting GEOM_Object(Sur - \em thelPoints is a list of points or compounds of points; - \em theNbMax maximum number of Bezier pieces in the resulting surface; - \em theDegMax maximum degree; -- \em theDMax specifies 3D tolerance of initial approximation +- \em theDMax specifies 3D tolerance of the initial approximation. Example: diff --git a/doc/salome/gui/GEOM/input/dependency_tree.doc b/doc/salome/gui/GEOM/input/dependency_tree.doc index e44dba400..62bd3bbe8 100644 --- a/doc/salome/gui/GEOM/input/dependency_tree.doc +++ b/doc/salome/gui/GEOM/input/dependency_tree.doc @@ -13,23 +13,20 @@ \anchor dependency_tree_general_description_anchor

    General description

    -In order to better understand the relations between the %GEOM -objects in a study the user has a possibility to display the -ascendants and descendant of the object(s) in a family tree. +You can display the ascendants and descendants of object(s) in a tree structure to better understand the relations between the %GEOM +objects in a study . -User can build the dependency tree by selecting desirable object -in Object Browser or OCC Viewer and calling "Show dependency tree" -popup item. It will open a new or clear the existing "Dependency -Tree" view window (only one view is supported) and display a -dependency tree for the selected object or objects (multiple -selection is supported). Also user can rebuild the tree if to select -some object(s) right in the "Dependency Tree" view and call -"Rebuild the tree" popup menu item. +To build the dependency tree, select the necessary object or objects (multiple +selection is supported) in the Object Browser or OCC Viewer and call "Show dependency tree" context menu item. \image html tree_example.png -User can change all necessary parameters of Dependency Tree Viewer -in \ref pref_dependency_tree "Preferences". + +"Dependency Tree" view window will display the dependency tree for the selected object. +It is also possible to select an object(s) directly in the "Dependency Tree" view and to rebuild the tree by selecting +"Rebuild the tree" context menu item. + +All necessary parameters of Dependency Tree Viewer can be edited in the \ref pref_dependency_tree "Preferences".
    \anchor dependency_tree_nodes_anchor

    Nodes

    @@ -37,54 +34,41 @@ in \ref pref_dependency_tree "Preferences". Tree nodes in the Dependency Viewer are named according to the study names of the corresponding objects. -Non-published objects are shown in the tree as "unpublished" and -colored in special color. - -All nodes have the fixed size, so the long names are cut and shown -with ellipsis; full name of the object can be seen in the tooltip -if to keep the cursor over the node. +All nodes have fixed size, so long names are cut; the full object name can be seen in the tooltip +when the cursor is hovered over the node. "Dependency Tree" view supports the following states of nodes: -
    • Main node - node of main object(s), which were selected in Object -Browser, OCC Viewer or Dependency Tree Viewer in order to build the -dependency tree;
    +
    • Main node - corresponds to the main object(s) selected in Object +Browser, OCC Viewer or Dependency Tree Viewer;
    \image html tree_main_node.png -
    • Default node - node of published in study object, which participate in building of -dependency tree as ascendant or descendant;
    +
    • Default node - ascendant or descendant node of the dependency tree corresponding to an object published in the study;
    \image html tree_default_node.png -
    • Unpublished node - the same as "Default node", but -corresponding object was not published in study;
    +
    • Unpublished node - corresponds to an object that was not published in the study;
    \image html tree_unpublished_node.png -
    • Highlighted node - the state of node when mouse -cursor is over it;
    +
    • Highlighted node - the state of a node when the mouse cursor is hovered over it;
    \image html tree_highlighted_node.png -
    • Selected node - the state of node when user -clicks the left mouse button on node.
    +
    • Selected node - the state of node when the user clicks the left mouse button it.
    \image html tree_selected_node.png
    \anchor dependency_tree_links_anchor

    Links

    Dependency Tree Viewer shows oriented links between nodes to -represent dependency direction. Viewer supports the following states -of links: +represent the dependency direction. The viewer supports the following states of links: -
    • Unidirectional link - shows that A object depends on -B object;
    +
    • Unidirectional link - shows that object A depends on object B;
    \image html tree_unidir_link.png -
    • Bidirectional link - shows that A object depends on -B object and, at the same time, B object depends on -A object;
    +
    • Bidirectional link - shows that object A depends on +object B and, at the same time, object B depends on object A;
    \image html tree_bidir_link.png -
    • Self-dependency link - shows that object depends on -itself;
    +
    • Self-dependency link - shows that an object depends on itself;
    \image html tree_selfdep_link.png
    • Cyclic dependency links - shows cyclic dependency of @@ -92,7 +76,7 @@ some nodes.
    \image html tree_cycldep_link.png
    -\anchor dependency_tree_operations_anchor

    Operations

    +\anchor dependency_tree_operations_anchor

    Viewer Operations

    The dependency tree of a chosen %GEOM object is displayed in the dedicated 2D view window. @@ -105,8 +89,7 @@ mouse button. \image tree_tool_bar -Dump View - exports an object from the viewer in bmp, png or -jpeg image format. +Dump View - exports the current scene in bmp, png or jpeg image format. \image html tree_view_dump.png Fit all - scales the presentation so that it could fit within @@ -140,38 +123,32 @@ levels to be shown in the dependency tree.
    • Level 1 corresponds to the parents and children of the selected object(s);
      • -
    • Level 2 is Level 1 plus the grand-parents and grand-children +
    • Level 2 adds the grand-parents and grand-children of the selected object(s);
    • etc...
    -Display ascendants - allows user to control the displaying -of ascendants. +Display ascendants - allows showing/hiding the ascendants. \image html tree_disp_ascendants.png -Display descendants - allows user to control the displaying -of descendants. +Display descendants - allows showing/hiding the descendants. \image html tree_disp_descendants.png -Move nodes - enables/disables of moving the nodes. +Move nodes -if checked, it is possible to move nodes in the viewer. \image html tree_move_nodes.png -Update - allows user to update a dependency tree model and the view. +Update - updates the dependency tree view, reflecting changes introduced in the hierarchy. \image html tree_button_update.png
    -\anchor dependency_tree_navigation_anchor

    Navigation

    - -Dependency Tree 2D Viewer supports the following navigation mode: +\anchor dependency_tree_navigation_anchor

    Selection and Shortcuts

      -
    • rectangle selection in this mode is performed by the left mouse -button
      • ; -
    • multiple selection is available when \b Shift button +
    • It is possible to select multiple nodes in the view by rectangle selection or by clicking nodes when \b Shift button is pressed.
    -Also, holding \b Ctrl key with pressed mouse buttons performs +Holding \b Ctrl key with pressed mouse buttons performs the following view transformations:
    • Ctrl + left mouse button - zooming;
      • @@ -179,33 +156,23 @@ the following view transformations:
    -\anchor dependency_tree_popup_menu_anchor

    Popup Menu

    +\anchor dependency_tree_popup_menu_anchor

    Context Menu

    -After the object has appeared in the Dependency Tree 2D Viewer, -user can select it with left mouse click to change its presentation -parameters and get access to other useful options by right-clicking on -the selected object. +The following operations are available from the context menu of the selected object. \image html tree_popup_menu1.png
      -
    • \b Show - allows to show selected object(s) in OCC 3D Viewer;
      • -
    • Show Only - allows to show only selected object(s) -in OCC 3D Viewer;
      • -
    • Rebuild the tree - allows to rebuild the dependency tree +
    • \b Show - shows the selected object(s) in OCC 3D Viewer;
      • +
    • Show Only - shows only the selected object(s) in OCC 3D Viewer;
      • +
    • Rebuild the tree - rebuilds the dependency tree for selected object(s);
      • -
    • \ref reduce_study_page "Reduce study" - allows to reduce study.
      • -
    - -Some functionalities are available through right-clicking on -the viewer background: +
  • \ref reduce_study_page "Reduce study" - allows reducing the study.
    • \image html tree_popup_menu2.png -Dependency Tree 2D Viewer background can be customized using the -"Change background" popup menu command that opens standard -"Select Color" dialog box: - -\image html selectcolor.png +
  • It is also possible to customize the background of Dependency Tree 2D Viewer using the +corresponding context menu command.
    • + */ diff --git a/doc/salome/gui/GEOM/input/geometry_preferences.doc b/doc/salome/gui/GEOM/input/geometry_preferences.doc index 5e9e94e7d..ea011b8bf 100644 --- a/doc/salome/gui/GEOM/input/geometry_preferences.doc +++ b/doc/salome/gui/GEOM/input/geometry_preferences.doc @@ -4,10 +4,9 @@ \anchor pref_settings

    Settings

    -In the \b Geometry module you can set preferences for visualisation of +In the \b Geometry module you can set preferences for visualization of geometrical figures, which can be used in later sessions with this module. -There is also a special group of preferences controlling input -precision for floating-point data. + \image html pref15.png @@ -67,7 +66,7 @@ of values set in spin boxes.
      -
    • Dimensions (Measurements)
      • +
    • Dimensions (Measurements) - a group of preferences controlling the presentation of dimensions.
      • Color - allows to define color for persistent dimension presentations.
      • Line width - allows to define pixel width of dimension lines.
        • @@ -91,7 +90,8 @@ By default Along U and Along V are null and isolines are not drawn
        -
      • Input fields precision
        • +
      • Input fields precision - a group of preferences controlling input +precision for floating-point data.
        • Length precision - allows to adjust input precision of coordinates and dimensions.
        • Angular precision - allows to adjust input precision of angles.
          • @@ -147,32 +147,29 @@ system immediately after the module activation. \anchor pref_dependency_tree

          Dependency Tree

          -Also user can set preferences for visualisation of Dependency Tree in 2D Viewer. +This tab groups preferences for visualization of Dependency Tree in the 2D Viewer. \image html pref_dep_tree.png
          • General
              • -
            • Hierarchy type - allows to choose default displaying mode of dependency tree.
              • -
            • Possibility to move nodes - enable/disable the possibility of moving nodes by default.
              • +
            • Hierarchy type - allows to choose the default display mode of the dependency tree.
              • +
            • Possibility to move nodes - enables/disables the possibility of moving nodes by default.
          • Color
              • -
            • Background color - allows to select default background color.
              • -
            • Default node color - allows to select default node color.
              • -
            • Main node color - allows to select default main node color.
              • -
            • Unpublished node color - allows to select default node color -for unpublished objects.
              • -
            • Selected node color - allows to select default selected node color.
              • -
            • Default arrow color - allows to select default arrow color.
              • -
            • Highlighted arrow color - allows to select default highlighted -arrow color.
              • -
            • Selected arrow color - allows to select default selected -arrow color.
              • +
            • Background color - allows to select the default background color.
              • +
            • Default node color - allows to select the default node color.
              • +
            • Main node color - allows to select the default main node color.
              • +
            • Unpublished node color - allows to select the default node color for unpublished objects.
              • +
            • Selected node color - allows to select the default selected node color.
              • +
            • Default arrow color - allows to select the default arrow color.
              • +
            • Highlighted arrow color - allows to select the default highlighted arrow color.
              • +
            • Selected arrow color - allows to select the default selected arrow color.
          diff --git a/doc/salome/gui/GEOM/input/reduce_study.doc b/doc/salome/gui/GEOM/input/reduce_study.doc index 8a3c7e766..6757c5a1a 100644 --- a/doc/salome/gui/GEOM/input/reduce_study.doc +++ b/doc/salome/gui/GEOM/input/reduce_study.doc @@ -2,55 +2,52 @@ \page reduce_study_page Reduce Study -The user sometimes needs to keep in the study only some objects that +It can be sometimes necessary to keep in the study only the objects that present the final result(s) of the design operations and to delete all -other objects which do not contribute to these results. +other objects, which do not contribute to these results. -The feature is especially useful when the user designs the whole model -through the GUI and wants to generate simplified "clean" Python dump only -at the end of the model construction with no "useless" objects in the -%GEOM module. +This is especially useful when the model is designed using the GUI +and it is necessary to generate a simplified "clean" Python dump without "useless" objects +at the end of the model construction. -User can open dialog box by selecting desirable object(s) in Object -Browser or OCC Viewer and calling "Reduce study" popup item. +This feature can be activated by selecting the desirable object(s) in Object +Browser or OCC Viewer and calling "Reduce study" context item. \image html reduce_study_dialog.png
          • Objects to be kept - objects that will be kept in the study after -applying operation of reduce study. The list of objects being selected by +applying reduce study operation. The objects selected by the user are highlighted in bold font.
          • Objects to be removed - objects that will be deleted.
            • -\note Mentioned views provide possibility to show/hide object(s) in -current Viewer using "eye" icon near each item of tree. Also user can -show/hide ALL objects in tree by clicking "eye" icon in the head of tree view. +\note It is possible to show/hide object(s) in the +current Viewer using "eye" icon next to each tree item. +ALL objects in the tree can be shown/hidden by clicking the "eye" icon in the head of the tree view. + +
          • Intermediate objects group box allows choosing what should be done with the objects that are used to produce the selected object(s): +
          • Sub-objects group box allows choosing the same operations for +sub-objects of the selected object(s).
            • -
          • Intermediate objects group box allows to choose an action -that will be performed with the objects that took part in the operations -chain to produce the selected object(s):
            • Keep - object(s) will be kept in the study;
            • Unpublish - object(s) will be unpublished (hidden) from the study;
            • Remove - object(s) will be removed from the study. \note Since use of -this option can lead to the broken Dump Python script, the warning message -will be shown at the operation commiting to confirm/reject removing -intermediate objects.
              • +this option can cause a broken Dump Python script, the warning message +is shown confirm/reject removing intermediate objects.
            • -
          • Sub-objects group box allows to choose the same operations for -sub-objects of selected item(s): keep, unpublish or remove.
            • -
          • Remove empty folders - if this option is checked, then all folders, +
          • Remove empty folders - if this option is checked, all folders, which will become empty after removing unused objects from the study, will be also removed; otherwise, empty folders will be kept.
            • -
          • Soft removal - if this option is checked, operation will just -unpublish the redundant objects from the study instead of their hard delete. -\n Soft removal would keep all the data in the study to give the user a +
          • Soft removal - if this option is checked, the operation will +unpublish the redundant objects from the study instead of deleting them. +\n So, soft removal keeps all data in the study to give the user a chance to revert this operation using \ref publish_hidden_objects "Publish Objects" dialog box.
            • diff --git a/doc/salome/gui/GEOM/input/tui_basic_geom_objs.doc b/doc/salome/gui/GEOM/input/tui_basic_geom_objs.doc index 89be6f64b..7266034d7 100644 --- a/doc/salome/gui/GEOM/input/tui_basic_geom_objs.doc +++ b/doc/salome/gui/GEOM/input/tui_basic_geom_objs.doc @@ -38,4 +38,7 @@

            Creation of a Local Coordinate System

            \tui_script{basic_geom_objs_ex09.py} +\page tui_polyline_page 2D Polyline +\tui_script{polyline.py} + */ diff --git a/doc/salome/gui/GEOM/input/tui_polyline.doc b/doc/salome/gui/GEOM/input/tui_polyline.doc deleted file mode 100644 index ff83b9053..000000000 --- a/doc/salome/gui/GEOM/input/tui_polyline.doc +++ /dev/null @@ -1,6 +0,0 @@ -/*! - -\page tui_polyline_page 2D Polyline -\tui_script{polyline.py} - -*/ diff --git a/doc/salome/gui/GEOM/input/viewing_geom_obj.doc b/doc/salome/gui/GEOM/input/viewing_geom_obj.doc index 29a43cfbf..430624deb 100644 --- a/doc/salome/gui/GEOM/input/viewing_geom_obj.doc +++ b/doc/salome/gui/GEOM/input/viewing_geom_obj.doc @@ -64,10 +64,9 @@ geometrical object. TUI Command: sg.DisplayOnly(ID)
          • Show all dimensions - shows all of the persistent dimensions created for the selected geometrical object.
          • Hide all dimensions - hides all of the persistent dimensions created for the selected geometrical object.
            • -
          • \subpage dependency_tree_page "Show dependency tree" - shows dependency tree of selected objects -in new 2D View Window.
            • -
          • \subpage reduce_study_page "Reduce study" - allows to reduce study -by automatic removing objects according to user's options.
            • +
          • \subpage dependency_tree_page "Show dependency tree" - shows the dependency tree with parents and children of the selected object +in a new 2D View Window.
            • +
          • \subpage reduce_study_page "Reduce study" - allows reducing the study by removing objects from it.
          • Dump view - exports an object from the viewer in bmp, png, jpg or jpeg image format.
          • Change background - allows to redefine the background