Salome HOME
Merge remote branch 'origin/akl/22379'
[modules/geom.git] / doc / salome / gui / GEOM / input / tui_working_with_groups.doc
index 37813417c41ad96f5432df931976de9a0fc40326..e21cb55884a678eb0f970f97232e037472862b39 100644 (file)
 <br>
 \anchor tui_create_groups_anchor
 <h2>Creation of a group</h2>
-
-\code
-import geompy
-import salome
-gg = salome.ImportComponentGUI("GEOM")
-
-# create two vertices
-p0 = geompy.MakeVertex(0.  , 0.  , 0.  )
-p200 = geompy.MakeVertex(200., 200., 200.)
-
-# create a box from two points
-Box = geompy.MakeBoxTwoPnt(p0, p200)
-
-# create a group from the faces of the box
-group = geompy.CreateGroup(Box, geompy.ShapeType["FACE"])
-
-# add objects to the group
-SubFaceList = geompy.SubShapeAllSortedCentres(Box, geompy.ShapeType["FACE"])
-for i in [0, 3, 5] :
-    FaceID = geompy.GetSubShapeID(Box, SubFaceList[i])
-    geompy.AddObject(group, FaceID)
-
-# add all selected shapes from the list to the group
-# (the program doesn't raise error, if some shapes are already included)
-geompy.UnionList(group, [SubFaceList[0], SubFaceList[2], SubFaceList[5]])
-
-# remove an object from the group
-geompy.RemoveObject(group, FaceID)
-
-# remove all selected shapes from the group
-# (the program doesn't raise error, if some shapes are not included)
-geompy.DifferenceList(group, [SubFaceList[2], SubFaceList[3], SubFaceList[4]])
-id_group1 = geompy.addToStudy(group, "Group1")
-
-# display the contents of the group
-gg.createAndDisplayGO(id_group1)
-salome.sg.updateObjBrowser(1)
-\endcode
+\tui_script{working_with_groups_ex01.py}
 
 \anchor tui_edit_groups_anchor
 
 <br><h2>Adding an object to the group</h2>
-
-\code
-import geompy
-import salome
-gg = salome.ImportComponentGUI("GEOM")
-
-# create two vertices
-p0 = geompy.MakeVertex(0.  , 0.  , 0.  )
-p200 = geompy.MakeVertex(200., 200., 200.)
-
-# create a box from two points
-Box = geompy.MakeBoxTwoPnt(p0, p200)
-
-# create a group from the faces of the box
-group = geompy.CreateGroup(Box, geompy.ShapeType["FACE"])
-
-# add objects to the group
-SubFaceList = geompy.SubShapeAllSortedCentres(Box, geompy.ShapeType["FACE"])
-for i in [0, 3, 5] :
-    FaceID = geompy.GetSubShapeID(Box, SubFaceList[i])
-    geompy.AddObject(group, FaceID)
-id_group1 = geompy.addToStudy(group, "Group1")
-
-# display the contents of the group
-gg.createAndDisplayGO(id_group1)
-salome.sg.updateObjBrowser(1) 
-\endcode
+\tui_script{working_with_groups_ex02.py}
 
 <br><h2>Removing an object from the group</h2>
-
-\code
-import geompy
-import salome
-gg = salome.ImportComponentGUI("GEOM")
-
-# create two vertices
-p0 = geompy.MakeVertex(0.  , 0.  , 0.  )
-p200 = geompy.MakeVertex(200., 200., 200.)
-
-# create a box from two points
-Box = geompy.MakeBoxTwoPnt(p0, p200)
-
-# create a group from the faces of the box
-group = geompy.CreateGroup(Box, geompy.ShapeType["FACE"])
-
-# add objects to the group
-SubFaceList = geompy.SubShapeAllSortedCentres(Box, geompy.ShapeType["FACE"])
-for i in [0, 3, 5] :
-    FaceID = geompy.GetSubShapeID(Box, SubFaceList[i])
-    geompy.AddObject(group, FaceID)
-
-# add all selected shapes from the list to the group
-# (the program doesn't raise errors, if some shapes are already included)
-geompy.UnionList(group, [SubFaceList[0], SubFaceList[2], SubFaceList[5]])
-
-# remove an object from the group
-geompy.RemoveObject(group, FaceID)
-id_group1 = geompy.addToStudy(group, "Group1")
-
-# display the contents of the group
-gg.createAndDisplayGO(id_group1)
-salome.sg.updateObjBrowser(1) 
-\endcode
+\tui_script{working_with_groups_ex03.py}
 
 <br>
 \anchor tui_union_groups_anchor
 <h2>Union Groups</h2>
-
-\code
-import geompy
-import salome
-
-# create a box and some groups of faces on it
-Box_1 = geompy.MakeBoxDXDYDZ(200, 200, 200)
-Group_1 = geompy.CreateGroup(Box_1, geompy.ShapeType["FACE"])
-geompy.UnionIDs(Group_1, [13, 23])
-Group_2 = geompy.CreateGroup(Box_1, geompy.ShapeType["FACE"])
-geompy.UnionIDs(Group_2, [3, 27])
-Group_3 = geompy.CreateGroup(Box_1, geompy.ShapeType["FACE"])
-geompy.UnionIDs(Group_3, [33, 23])
-Group_4 = geompy.CreateGroup(Box_1, geompy.ShapeType["FACE"])
-geompy.UnionIDs(Group_4, [31, 27])
-
-# union groups
-Group_U_1_2 = geompy.UnionGroups(Group_1, Group_2)
-Group_UL_3_4 = geompy.UnionListOfGroups([Group_3, Group_4])
-
-# publish shapes
-geompy.addToStudy(Box_1, 'Box_1')
-geompy.addToStudyInFather(Box_1, Group_1, 'Group_1')
-geompy.addToStudyInFather(Box_1, Group_2, 'Group_2')
-geompy.addToStudyInFather(Box_1, Group_3, 'Group_3')
-geompy.addToStudyInFather(Box_1, Group_4, 'Group_4')
-geompy.addToStudyInFather(Box_1, Group_U_1_2, 'Group_U_1_2')
-geompy.addToStudyInFather(Box_1, Group_UL_3_4, 'Group_UL_3_4')
-salome.sg.updateObjBrowser(1) 
-\endcode
+\tui_script{working_with_groups_ex04.py}
 
 <br>
 \anchor tui_intersect_groups_anchor
 <h2>Intersect Groups</h2>
-
-\code
-import geompy
-import salome
-
-# create a box and some groups of faces on it
-Box_1 = geompy.MakeBoxDXDYDZ(200, 200, 200)
-Group_1 = geompy.CreateGroup(Box_1, geompy.ShapeType["FACE"])
-geompy.UnionIDs(Group_1, [13, 23])
-Group_2 = geompy.CreateGroup(Box_1, geompy.ShapeType["FACE"])
-geompy.UnionIDs(Group_2, [3, 27])
-Group_3 = geompy.CreateGroup(Box_1, geompy.ShapeType["FACE"])
-geompy.UnionIDs(Group_3, [33, 23])
-Group_4 = geompy.CreateGroup(Box_1, geompy.ShapeType["FACE"])
-geompy.UnionIDs(Group_4, [31, 27])
-
-# intersect groups
-Group_I_1_3 = geompy.IntersectGroups(Group_1, Group_3)
-Group_IL_1_3 = geompy.IntersectListOfGroups([Group_1, Group_3])
-
-# publish shapes
-geompy.addToStudy(Box_1, 'Box_1')
-geompy.addToStudyInFather(Box_1, Group_1, 'Group_1')
-geompy.addToStudyInFather(Box_1, Group_2, 'Group_2')
-geompy.addToStudyInFather(Box_1, Group_3, 'Group_3')
-geompy.addToStudyInFather(Box_1, Group_4, 'Group_4')
-geompy.addToStudyInFather(Box_1, Group_I_1_3, 'Group_I_1_3')
-geompy.addToStudyInFather(Box_1, Group_IL_1_3, 'Group_IL_1_3')
-salome.sg.updateObjBrowser(1) 
-
-\endcode
+\tui_script{working_with_groups_ex05.py}
 
 <br>
 \anchor tui_cut_groups_anchor
 <h2>Cut Groups</h2>
-
-\code
-import geompy
-import salome
-
-# create a box and some groups of faces on it
-Box_1 = geompy.MakeBoxDXDYDZ(200, 200, 200)
-Group_1 = geompy.CreateGroup(Box_1, geompy.ShapeType["FACE"])
-geompy.UnionIDs(Group_1, [13, 23])
-Group_2 = geompy.CreateGroup(Box_1, geompy.ShapeType["FACE"])
-geompy.UnionIDs(Group_2, [3, 27])
-Group_3 = geompy.CreateGroup(Box_1, geompy.ShapeType["FACE"])
-geompy.UnionIDs(Group_3, [33, 23])
-Group_4 = geompy.CreateGroup(Box_1, geompy.ShapeType["FACE"])
-geompy.UnionIDs(Group_4, [31, 27])
-
-# cut groups
-Group_C_2_4 = geompy.CutGroups(Group_2, Group_4)
-Group_CL_2_4 = geompy.CutListOfGroups([Group_2], [Group_4])
-
-# publish shapes
-geompy.addToStudy(Box_1, 'Box_1')
-geompy.addToStudyInFather(Box_1, Group_1, 'Group_1')
-geompy.addToStudyInFather(Box_1, Group_2, 'Group_2')
-geompy.addToStudyInFather(Box_1, Group_3, 'Group_3')
-geompy.addToStudyInFather(Box_1, Group_4, 'Group_4')
-geompy.addToStudyInFather(Box_1, Group_C_2_4, 'Group_C_2_4')
-geompy.addToStudyInFather(Box_1, Group_CL_2_4, 'Group_CL_2_4')
-salome.sg.updateObjBrowser(1) 
-
-\endcode
+\tui_script{working_with_groups_ex06.py}
 
 */