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=ef9fe6f95bdefc44cefef7e676e67c95ec37e657;hpb=392885c1a8d50369708bbe5e6b44033ed8b8ba51;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 ef9fe6f95..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.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:
@@ -32,13 +44,19 @@ 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
+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:
+
+- 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
@@ -64,42 +82,129 @@ creation of other groups), or skip it by clicking \b Close button.
\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.
-Example:
+Our TUI Scripts provide you with useful examples of
+\ref tui_create_groups_anchor "Create a Group" operation.
-\image html image193.jpg "Groups on a cylinder"
+Example:
+\image html image193.png "Groups on a cylinder"
-
Edit a group
+
+\anchor edit_groups_anchor
+Edit a group
\image html image57.png
+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.
*/