X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FGEOM%2Finput%2Fworking_with_groups.doc;h=d1eac3994c018e6efdb3729809da5fa45a4ac578;hb=a0e22ed86a0df64143edb095e07295a014b32c88;hp=ed0909498f4cfa75195a532a8f25948ba3c3ccce;hpb=239f8109c64fa0c5a2e1d87a420bad5529b57f48;p=modules%2Fgeom.git
diff --git a/doc/salome/gui/GEOM/input/working_with_groups.doc b/doc/salome/gui/GEOM/input/working_with_groups.doc
index ed0909498..d1eac3994 100644
--- a/doc/salome/gui/GEOM/input/working_with_groups.doc
+++ b/doc/salome/gui/GEOM/input/working_with_groups.doc
@@ -2,15 +2,27 @@
\page work_with_groups_page Working with groups
-Creation and editing groups of subshapes of a geometrical object makes
-handling subshapes much easier. This functionality is available in OCC
-viewer only.
+Creation and editing groups of sub-shapes of a geometrical object makes
+handling sub-shapes much easier. Boolean operations on
+groups are also available.
-
Create a group
+
+- \ref create_groups_anchor "Create a Group"
+- \ref edit_groups_anchor "Edit a Group"
+- \ref union_groups_anchor "Union Groups"
+- \ref intersect_groups_anchor "Intersect Groups"
+- \ref cut_groups_anchor "Cut Groups"
+
+
+
+\anchor create_groups_anchor
+Create a group
-\image html image56.gif
+\image html image56.png
-To create a group of subshapes of a geometrical object in the main
+This functionality is available in OCC viewer only.
+
+To create a group of sub-shapes of a geometrical object in the main
menu select New entity > Group > Create
\n The following menu will appear:
@@ -19,71 +31,180 @@ menu select New entity > Group > Create
In this Menu:
-- Shape Type radio button define the type of elements for the
+
- Shape Type radio button defines the type of elements for the
group (points, wires, faces, shells or solids).
-- Group Name - here you can enter the name of the group, by
+
- Group Name - allows defining the name of the group, by
default, it is Group_n.
- Then, using the "Select" button, select the Main Shape (a
-geometrical object on which the group will be created). You can select
-the elements of your group in two ways:
+geometrical object on which the group will be created).
+- Main Shape Selection restriction button group allows limiting the range
+of available group elements,
+
- No restriction button enables all sub-shapes of the Main
+Shape.
+- Geometrical parts of the Second Shape restricts the range of accessible
+elements to the sub-shapes of the Main Shape that geometrically
+coincide with the Second Shape.
+- Only Sub-shapes of the Second Shape restricts the range of
+accessible elements to the sub-shapes of the Main Shape that
+are sub-shapes of the Second Shape. This is useful because
+sometimes purely geometrical coincidence is not enough and it
+is necessary to work with shapes, which actually belong both
+to the main and the second shape.
+
+ - You can selectively display the selected elements using the following buttons:
-- Clicking Select Sub-Shapes button you can select them
-manually in the 3D Viewer, and add to the group by clicking the \b Add
-button (keep down the Shift button on the keyboard to select several
-elements and add all them together). The indexes of the selected
-elements will be displayed in the list. To delete elements from the
-list, select them and click \b Remove button.
+- Show only selected - displays only the sub-shapes selected in the list box.
+- Hide selected - hides the sub-shapes selected in the list box.
+- Show all sub-shapes - displays only the sub-shapes of the Main Shape.
+
+- You can select the elements of your group in two ways:
+
+- You can select them manually in the 3D Viewer, and add to the
+group by clicking the \b Add button (keep down the Shift button on the
+keyboard to select several elements and add all them together). The
+indexes of the selected elements will be displayed in the list. To
+delete elements from the list, select them and click \b Remove
+button.
- Clicking Select All button you can add all object's
elements of a certain type in the list of the elements of the
-group. To delete elements from the list, select them and click \b
-Remove button.
-
- - Finally, confirm your selection by clicking \b OK (also closes the
-Menu) or \b Apply (leaves the Menu open for creation of other groups),
-or skip it by clicking \b Close button.
-
+group. If the Second Shape is used, the elements are added
+according to Main Shape Selection restriction settings. To delete elements
+from the list, select them and click \b Remove button.
+
+
+Finally, confirm your selection by clicking Apply and Close
+ (also closes the Menu) or \b Apply (leaves the Menu open for
+creation of other groups), or skip it by clicking \b Close button.
+
\n The Result of the operation will be a \b GEOM_Object.
\n TUI Command: geompy.CreateGroup(MainShape,
ShapeType), where MainShape is a shape for which the group is
created, ShapeType is a type of shapes in the created group.
-\n Arguments: 1 Shape + Type of subshape.
+\n Arguments: 1 Shape + Type of sub-shape.
+
+Our TUI Scripts provide you with useful examples of
+\ref tui_create_groups_anchor "Create a Group" operation.
Example:
-\image html image193.jpg
+\image html image193.png "Groups on a cylinder"
+
+\anchor edit_groups_anchor
+Edit a group
-
Edit a group
+\image html image57.png
-\image html image57.gif
+This functionality is available in OCC viewer only.
To \b Edit an existing group in the main menu select New entity >
Group > Edit. This menu is designed in the same way as the
Create a group menu.
+\n When a GEOM group is edited, the main shape appears in the 3D viewer in the same mode
+as it is displayed in the viewer. If the main shape was not displayed in the viewer, then
+the default mode defined in the preferences will be used.
+
+\n Working with Dialog Box:
+
+\image html editgroup.png
+
+\n The subshapes already in the group are displayed in the 3D viewer with a specific color,
+defined via preferences. The IDs of the subshapes already in the group are also displayed in
+a specific color in the dialog box. When the user adds some subshapes, the new IDs are
+displayed in the other color.
+
\n The \b Result of the operation will be a \b GEOM_Object.
\n TUI Command:
- geompy.AddObject(Group, SubShapeID), where Group is a
-group to which a sub shape has to be added, SubShapeID is an ID of the
-sub shape to be added to the group.
+group to which a sub-shape has to be added, SubShapeID is an ID of the
+sub-shape to be added to the group.
- geompy.RemoveObject(Group, SubShapeID), where Group is a
-group from which a sub shape has to be removed, SubShapeID is an ID of
-the sub shape to be removed from the group.
+group from which a sub-shape has to be removed, SubShapeID is an ID of
+the sub-shape to be removed from the group.
- geompy.GetObjectIDs(Group), where Group is a group for which its object's are returned.
\n Returns: List of IDs.
-\n Arguments: 1 Shape + its subshapes.
+\n Arguments: 1 Shape + its sub-shapes.
+
+Our TUI Scripts provide you with useful examples of
+\ref tui_edit_groups_anchor "Edit a Group" operation.
-\n Dialog Box:
+
+\anchor union_groups_anchor
+Union of groups
-\image html editgroup.png
+This operation allows to create a new group in such a way that all
+sub-shapes that are present in the initial groups will be added to
+the new one.
+
+To union groups:
+
+- In the New Entity menu select the \b Group - Union Groups item.
+The following dialog box will appear:
+
+\image html groups_union_dlg.png
+
+In this dialog box you should specify the name of the resulting group
+and select the groups, which will be united.
+
+- Click the \b Apply or Apply and Close button to confirm creation of the group.
+
+
+See Also a sample TUI Script of a
+\ref tui_union_groups_anchor "Union of Groups" operation.
+
+
+\anchor intersect_groups_anchor
+Intersection of groups
+
+This operation allows to create a new group in such a way that only
+the sub-shapes that are present in all initial groups are added to the
+new one.
+
+To intersect groups:
+
+- In the New Entity menu select the \b Group - Intersect Groups item.
+The following dialog box will appear:
+
+\image html groups_intersect_dlg.png
+
+In this dialog box you should specify the name of the resulting group
+and select the groups, which will be intersected.
+
+- Click the \b Apply or Apply and Close button to confirm creation of the group.
+
+
+See Also a sample TUI Script of an
+\ref tui_intersect_groups_anchor "Intersection of Groups" operation.
+
+
+\anchor cut_groups_anchor
+Cut of groups
+
+This operation allows to create a new group in such a way that all
+sub-shapes that are present in the main groups but are absent in the
+tool groups are added to the new one.
+
+To cut groups:
+
+- In the New Entity menu select the \b Group - Cut Groups item.
+The following dialog box will appear:
+
+\image html groups_cut_dlg.png
+
+In this dialog box you should specify the name of the resulting group
+and the groups which will be cut.
+
+- Click the \b Apply or Apply and Close button to confirm creation of the group.
+
Our TUI Scripts provide you with useful examples of
-\ref tui_working_with_groups_page "Working with Groups".
+\ref tui_cut_groups_anchor "Cut of Groups" operation.
*/