Salome HOME
4017290818481d50c6ffdfbf3064614fc7bd2e6a
[modules/geom.git] / doc / salome / gui / GEOM / working_with_groups.htm
1 <!doctype HTML public "-//W3C//DTD HTML 4.0 Frameset//EN">\r
2 \r
3 <html>\r
4 \r
5 <head>\r
6 <title>Working with groups</title>\r
7 <meta http-equiv="content-type" content="text/html; charset=windows-1252">\r
8 <meta name="generator" content="RoboHelp by eHelp Corporation www.ehelp.com">\r
9 <link rel="stylesheet" href="default_ns.css"><script type="text/javascript" language="JavaScript" title="WebHelpSplitCss">\r
10 <!--\r
11 if (navigator.appName !="Netscape")\r
12 {   document.write("<link rel='stylesheet' href='default.css'>");}\r
13 //-->\r
14 </script>\r
15 <style type="text/css">\r
16 <!--\r
17 p.whs1 { margin-left:40px; }\r
18 img_whs2 { border:none; width:24px; height:22px; border-style:none; }\r
19 p.whs3 { font-size:12pt; }\r
20 p.whs4 { font-size:12pt; margin-left:40px; font-weight:bold; }\r
21 img_whs5 { border:none; border-style:none; width:312px; height:379px; float:none; }\r
22 p.whs6 { font-size:12pt; font-weight:bold; }\r
23 p.whs7 { font-size:12pt; margin-left:40px; }\r
24 img_whs8 { border:none; width:250px; height:307px; border-style:none; }\r
25 img_whs9 { border:none; width:22px; height:22px; border-style:none; }\r
26 ul.whs10 { list-style:disc; }\r
27 -->\r
28 </style><script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">\r
29 <!--\r
30 function reDo() {\r
31   if (innerWidth != origWidth || innerHeight != origHeight)\r
32      location.reload();\r
33 }\r
34 if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {\r
35         origWidth = innerWidth;\r
36         origHeight = innerHeight;\r
37         onresize = reDo;\r
38 }\r
39 onerror = null; \r
40 //-->\r
41 </script>\r
42 <style type="text/css">\r
43 <!--\r
44 div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
45 -->\r
46 </style><script type="text/javascript" language="javascript1.2" src="whmsg.js"></script>\r
47 <script type="text/javascript" language="javascript" src="whver.js"></script>\r
48 <script type="text/javascript" language="javascript1.2" src="whproxy.js"></script>\r
49 <script type="text/javascript" language="javascript1.2" src="whutils.js"></script>\r
50 <script type="text/javascript" language="javascript1.2" src="whtopic.js"></script>\r
51 </head>\r
52 <body><script type="text/javascript" language="javascript1.2">\r
53 <!--\r
54 if (window.gbWhTopic)\r
55 {\r
56         if (window.addTocInfo)\r
57         {\r
58         addTocInfo("GEOM module\nCreating geometrical objects\nWorking with groups");\r
59 addButton("show",BTN_TEXT,"Show","","","","",0,0,"","","");\r
60 \r
61         }\r
62         if (window.writeBtnStyle)\r
63                 writeBtnStyle();\r
64 \r
65         if (window.writeIntopicBar)\r
66                 writeIntopicBar(1);\r
67 \r
68         if (window.setRelStartPage)\r
69         {\r
70         setRelStartPage("geom.htm");\r
71 \r
72                 autoSync(1);\r
73                 sendSyncInfo();\r
74                 sendAveInfoOut();\r
75         }\r
76 }\r
77 else\r
78         if (window.gbIE4)\r
79                 document.location.reload();\r
80 //-->\r
81 </script>\r
82 <h1>Working with groups</h1>\r
83 \r
84 <p>The <span style="font-style: italic;"><I>Salome</I></span> platform offers \r
85  such a useful functionality as creation and editing groups of subshapes \r
86  of a geometrical object which makes handling subshapes much easier. However \r
87  the functionality is available in the OCC viewer only. If other viewer \r
88  is used in your project by default, you can toggle the OCC viewer via \r
89  Preferences / Viewer background / OCC viewer. &nbsp;</p>\r
90 \r
91 <p>&nbsp;</p>\r
92 \r
93 <p class=TODO>To perform operations with groups:</p>\r
94 \r
95 <p class=TODO>&nbsp;</p>\r
96 \r
97 <p class="whs1">In the main menu select <span style="font-weight: bold;"><B>New \r
98  entity &gt; Group</B></span>.</p>\r
99 \r
100 <p>&nbsp;</p>\r
101 \r
102 <p><img src="image56.gif" width="24px" height="22px" border="0" class="img_whs2"> <span style="font-weight: bold; font-size: 14pt;"><font size=4 style="font-size:14pt;"><B>Create \r
103  a group</B></font></span></p>\r
104 \r
105 <p>&nbsp;</p>\r
106 \r
107 <p class="whs3"><span style="font-size: 12pt;"><font size=3 style="font-size:12pt;"><b style="font-weight: bold;">Description:</b> \r
108  Creates a group of subshapes of a geometrical object.</font></span></p>\r
109 \r
110 <p class="whs3">&nbsp;</p>\r
111 \r
112 <p class="whs3"><b style="font-weight: bold;">Result:</b> GEOM_Object.</p>\r
113 \r
114 <p class="whs3">&nbsp;</p>\r
115 \r
116 <p class="whs3"><b style="font-weight: bold;">TUI Command:</b><i> \r
117  </i><span style="font-style: italic;"><I>geompy.CreateGroup(MainShape, ShapeType)</I></span>, \r
118  where MainShape is a shape for which the group is created, ShapeType is \r
119  a type of shapes in the created group.</p>\r
120 \r
121 <p class="whs3">&nbsp;</p>\r
122 \r
123 <p class="whs3"><b style="font-weight: bold;">Arguments:</b> \r
124  1 Shape + Type of subshape.</p>\r
125 \r
126 <p class="whs3">&nbsp;</p>\r
127 \r
128 <p class="whs3"><b style="font-weight: bold;">Dialog Box:</b></p>\r
129 \r
130 <p class="whs3">&nbsp;</p>\r
131 \r
132 <p class="whs4"><b style="font-weight: bold;"><img src="pics/creategroup.png" x-maintain-ratio="TRUE" width="312px" height="379px" border="0" class="img_whs5"></b></p>\r
133 \r
134 <p class="whs3">&nbsp;</p>\r
135 \r
136 <p class="whs6">Example:</p>\r
137 \r
138 <p class="whs6">&nbsp;</p>\r
139 \r
140 <p class="whs7"><img src="image193.jpg" width="250px" height="307px" border="0" class="img_whs8"></p>\r
141 \r
142 <p class="whs3">&nbsp;</p>\r
143 \r
144 <p class="whs3">&nbsp;</p>\r
145 \r
146 <p class="whs3">&nbsp;</p>\r
147 \r
148 <p class="whs3"><img src="image57.gif" width="22px" height="22px" border="0" class="img_whs9"> <span style="font-weight: bold; font-size: 14pt;"><font size=4 style="font-size:14pt;"><B>Edit \r
149  a group</B></font></span></p>\r
150 \r
151 <p class="whs3">&nbsp;</p>\r
152 \r
153 <p class="whs3"><span style="font-size: 12pt;"><font size=3 style="font-size:12pt;"><b style="font-weight: bold;">Description:</b> \r
154  Allows to edit the existing group.</font></span></p>\r
155 \r
156 <p class="whs3">&nbsp;</p>\r
157 \r
158 <p class="whs3"><b style="font-weight: bold;">Result:</b> GEOM_Object.</p>\r
159 \r
160 <p class="whs3">&nbsp;</p>\r
161 \r
162 <p class="whs3"><b style="font-weight: bold;">TUI Command:</b><i> \r
163  </i></p>\r
164 \r
165 <ul type="disc" class="whs10">\r
166         \r
167         <li class=kadov-p><p class="whs3"><i><span style="font-style: italic;"><I>g</i>eompy.AddObject(Group, \r
168  SubShapeID)</I></span>, where Group is a group to which a sub shape has to \r
169  be added, SubShapeID is an ID of the sub shape to be added to the group</p></li>\r
170         \r
171         <li class=kadov-p><p class="whs3"><span style="font-style: italic;"><I>geompy.RemoveObject(Group, \r
172  SubShapeID)</I></span>, where Group is a group from which a sub shape has \r
173  to be removed, SubShapeID is an ID of the sub shape to be removed from \r
174  the group</p></li>\r
175         \r
176         <li class=kadov-p><p class="whs3"><span style="font-style: italic;"><I>geompy.GetObjectIDs(Group)</I></span>, \r
177  where Group is a group for which its object ID\92s are returned. </p></li>\r
178 </ul>\r
179 \r
180 <p class="whs7"><span style="font-size: 12pt;"><font size=3 style="font-size:12pt;">Returns: \r
181  List of IDs.</font></span></p>\r
182 \r
183 <p class="whs3">&nbsp;</p>\r
184 \r
185 <p class="whs3"><b style="font-weight: bold;">Arguments:</b> \r
186  1 Shape + its subshapes.</p>\r
187 \r
188 <p class="whs3">&nbsp;</p>\r
189 \r
190 <p class="whs3"><b style="font-weight: bold;">Dialog Box:</b></p>\r
191 \r
192 <p class="whs3">&nbsp;</p>\r
193 \r
194 <p class="whs4"><b><img src="pics/editgroup.png" x-maintain-ratio="TRUE" width="312px" height="379px" border="0" class="img_whs5"></b></p>\r
195 \r
196 <p class="whs4">&nbsp;</p>\r
197 \r
198 <p class="whs3">Our <span style="font-weight: bold;"><B>TUI Scripts</B></span> \r
199  provide you with useful examples of <a href="working_with_groups.htm">Working \r
200  with Groups</a>. </p>\r
201 \r
202 <p>&nbsp;</p>\r
203 \r
204 <script type="text/javascript" language="javascript1.2">\r
205 <!--\r
206 if (window.writeIntopicBar)\r
207         writeIntopicBar(0);\r
208 //-->\r
209 </script>\r
210 </body>\r
211 </html>\r