Salome HOME
PAL12557: Documentation for scripts is not up to date.
[modules/geom.git] / doc / salome / gui / GEOM / 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>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 { font-family:'Lucida Console' , monospace; }\r
18 -->\r
19 </style><script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">\r
20 <!--\r
21 function reDo() {\r
22   if (innerWidth != origWidth || innerHeight != origHeight)\r
23      location.reload();\r
24 }\r
25 if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {\r
26         origWidth = innerWidth;\r
27         origHeight = innerHeight;\r
28         onresize = reDo;\r
29 }\r
30 onerror = null; \r
31 //-->\r
32 </script>\r
33 <style type="text/css">\r
34 <!--\r
35 div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
36 p.WebHelpNavBar { text-align:right; }\r
37 -->\r
38 </style><script type="text/javascript" language="javascript1.2" src="whmsg.js"></script>\r
39 <script type="text/javascript" language="javascript" src="whver.js"></script>\r
40 <script type="text/javascript" language="javascript1.2" src="whproxy.js"></script>\r
41 <script type="text/javascript" language="javascript1.2" src="whutils.js"></script>\r
42 <script type="text/javascript" language="javascript1.2" src="whtopic.js"></script>\r
43 <script type="text/javascript" language="javascript1.2">\r
44 <!--\r
45 if (window.gbWhTopic)\r
46 {\r
47         if (window.setRelStartPage)\r
48         {\r
49         addTocInfo("Geometry module\nTUI Scripts\nCreating Geometric Objects\nWorking with Groups");\r
50 addButton("show",BTN_IMG,"Show","","","","",0,0,"whd_show0.gif","whd_show2.gif","whd_show1.gif");\r
51 addButton("hide",BTN_IMG,"Hide","","","","",0,0,"whd_hide0.gif","whd_hide2.gif","whd_hide1.gif");\r
52 \r
53         }\r
54 \r
55 \r
56         if (window.setRelStartPage)\r
57         {\r
58         setRelStartPage("index.htm");\r
59 \r
60                 autoSync(1);\r
61                 sendSyncInfo();\r
62                 sendAveInfoOut();\r
63         }\r
64 \r
65 }\r
66 else\r
67         if (window.gbIE4)\r
68                 document.location.reload();\r
69 //-->\r
70 </script>\r
71 </head>\r
72 <body><script type="text/javascript" language="javascript1.2">\r
73 <!--\r
74 if (window.writeIntopicBar)\r
75         writeIntopicBar(4);\r
76 //-->\r
77 </script>\r
78 <h1>Groups</h1>\r
79 \r
80 <h3>Creation of a group</h3>\r
81 \r
82 <p class="whs1">import geompy</p>\r
83 \r
84 <p class="whs1">import salome</p>\r
85 \r
86 <p class="whs1">gg = salome.ImportComponentGUI(&quot;GEOM&quot;)</p>\r
87 \r
88 <p>&nbsp;</p>\r
89 \r
90 <p># create two vertices</p>\r
91 \r
92 <p class="whs1">p0 = geompy.MakeVertex(0. \r
93  &nbsp;, 0. &nbsp;, \r
94  0. &nbsp;)</p>\r
95 \r
96 <p class="whs1">p200 = geompy.MakeVertex(200., \r
97  200., 200.)</p>\r
98 \r
99 <p>&nbsp;</p>\r
100 \r
101 <p># create a box from two points</p>\r
102 \r
103 <p class="whs1">Box = geompy.MakeBoxTwoPnt(p0, \r
104  p200)</p>\r
105 \r
106 <p>&nbsp;</p>\r
107 \r
108 <p># create a group from the faces of the box</p>\r
109 \r
110 <p class="whs1">group = geompy.CreateGroup(Box, \r
111  geompy.ShapeType[&quot;FACE&quot;])</p>\r
112 \r
113 <p>&nbsp;</p>\r
114 \r
115 <p># add objects to the group</p>\r
116 \r
117 <p class="whs1">SubFaceList = geompy.SubShapeAllSorted(Box, \r
118  geompy.ShapeType[&quot;FACE&quot;])</p>\r
119 \r
120 <p class="whs1">for i in [0, 3, 5] \r
121  :</p>\r
122 \r
123 <p class="whs1">&nbsp;&nbsp;&nbsp;&nbsp;FaceID \r
124  = geompy.GetSubShapeID(Box, SubFaceList[i])</p>\r
125 \r
126 <p class="whs1">&nbsp;&nbsp;&nbsp;&nbsp;geompy.AddObject(group, \r
127  FaceID)</p>\r
128 \r
129 <p>&nbsp;</p>\r
130 \r
131 <p># add all selected shapes from the list to the group </p>\r
132 \r
133 <p># (the program doesn't raise error, if some shapes are already included)</p>\r
134 \r
135 <p class="whs1">geompy.UnionList(group, \r
136  [SubFaceList[0], SubFaceList[2], SubFaceList[5]])</p>\r
137 \r
138 <p>&nbsp;</p>\r
139 \r
140 <p># remove an object from the group</p>\r
141 \r
142 <p class="whs1">geompy.RemoveObject(group, \r
143  FaceID)</p>\r
144 \r
145 <p>&nbsp;</p>\r
146 \r
147 <p># remove all selected shapes from the group </p>\r
148 \r
149 <p># (the program doesn't raise error, if some shapes are not included)</p>\r
150 \r
151 <p class="whs1">geompy.DifferenceList(group, \r
152  [SubFaceList[2], SubFaceList[3], SubFaceList[4]])</p>\r
153 \r
154 <p class="whs1">id_group1 = geompy.addToStudy(group, \r
155  &quot;Group1&quot;)</p>\r
156 \r
157 <p>&nbsp;</p>\r
158 \r
159 <p># display the contents of the group</p>\r
160 \r
161 <p class="whs1">gg.createAndDisplayGO(id_group1)</p>\r
162 \r
163 <p><span style="font-family: 'Lucida Console', monospace;">salome.sg.updateObjBrowser(1)</span> \r
164  </p>\r
165 \r
166 <h3>Adding an object to the group.</h3>\r
167 \r
168 <p class="whs1">import geompy</p>\r
169 \r
170 <p class="whs1">import salome</p>\r
171 \r
172 <p class="whs1">gg = salome.ImportComponentGUI(&quot;GEOM&quot;)</p>\r
173 \r
174 <p>&nbsp;</p>\r
175 \r
176 <p># create two vertices</p>\r
177 \r
178 <p class="whs1">p0 = geompy.MakeVertex(0. \r
179  &nbsp;, 0. &nbsp;, \r
180  0. &nbsp;)</p>\r
181 \r
182 <p class="whs1">p200 = geompy.MakeVertex(200., \r
183  200., 200.)</p>\r
184 \r
185 <p>&nbsp;</p>\r
186 \r
187 <p># create a box from two points</p>\r
188 \r
189 <p class="whs1">Box = geompy.MakeBoxTwoPnt(p0, \r
190  p200)</p>\r
191 \r
192 <p>&nbsp;</p>\r
193 \r
194 <p># create a group from the faces of the box</p>\r
195 \r
196 <p class="whs1">group = geompy.CreateGroup(Box, \r
197  geompy.ShapeType[&quot;FACE&quot;])</p>\r
198 \r
199 <p>&nbsp;</p>\r
200 \r
201 <p># add objects to the group</p>\r
202 \r
203 <p class="whs1">SubFaceList = geompy.SubShapeAllSorted(Box, \r
204  geompy.ShapeType[&quot;FACE&quot;])</p>\r
205 \r
206 <p class="whs1">for i in [0, 3, 5] \r
207  :</p>\r
208 \r
209 <p class="whs1">&nbsp;&nbsp;&nbsp;&nbsp;FaceID \r
210  = geompy.GetSubShapeID(Box, SubFaceList[i])</p>\r
211 \r
212 <p class="whs1">&nbsp;&nbsp;&nbsp;&nbsp;geompy.AddObject(group, \r
213  FaceID)</p>\r
214 \r
215 <p class="whs1">id_group1 = geompy.addToStudy(group, \r
216  &quot;Group1&quot;)</p>\r
217 \r
218 <p>&nbsp;</p>\r
219 \r
220 <p># display the contents of the group</p>\r
221 \r
222 <p class="whs1">gg.createAndDisplayGO(id_group1)</p>\r
223 \r
224 <p><span style="font-family: 'Lucida Console', monospace;">salome.sg.updateObjBrowser(1)</span> \r
225  </p>\r
226 \r
227 <p>&nbsp;</p>\r
228 \r
229 <h3>Removing an object from the group</h3>\r
230 \r
231 <p class="whs1">import geompy</p>\r
232 \r
233 <p class="whs1">import salome</p>\r
234 \r
235 <p class="whs1">gg = salome.ImportComponentGUI(&quot;GEOM&quot;)</p>\r
236 \r
237 <p>&nbsp;</p>\r
238 \r
239 <p># create two vertices</p>\r
240 \r
241 <p class="whs1">p0 = geompy.MakeVertex(0. \r
242  &nbsp;, 0. &nbsp;, \r
243  0. &nbsp;)</p>\r
244 \r
245 <p class="whs1">p200 = geompy.MakeVertex(200., \r
246  200., 200.)</p>\r
247 \r
248 <p>&nbsp;</p>\r
249 \r
250 <p># create a box from two points</p>\r
251 \r
252 <p class="whs1">Box = geompy.MakeBoxTwoPnt(p0, \r
253  p200)</p>\r
254 \r
255 <p>&nbsp;</p>\r
256 \r
257 <p># create a group from the faces of the box</p>\r
258 \r
259 <p class="whs1">group = geompy.CreateGroup(Box, \r
260  geompy.ShapeType[&quot;FACE&quot;])</p>\r
261 \r
262 <p>&nbsp;</p>\r
263 \r
264 <p># add objects to the group</p>\r
265 \r
266 <p class="whs1">SubFaceList = geompy.SubShapeAllSorted(Box, \r
267  geompy.ShapeType[&quot;FACE&quot;])</p>\r
268 \r
269 <p class="whs1">for i in [0, 3, 5] \r
270  :</p>\r
271 \r
272 <p class="whs1">&nbsp;&nbsp;&nbsp;&nbsp;FaceID \r
273  = geompy.GetSubShapeID(Box, SubFaceList[i])</p>\r
274 \r
275 <p class="whs1">&nbsp;&nbsp;&nbsp;&nbsp;geompy.AddObject(group, \r
276  FaceID)</p>\r
277 \r
278 <p>&nbsp;</p>\r
279 \r
280 <p># add all selected shapes from the list to the group </p>\r
281 \r
282 <p># (the program doesn't raise errors, if some shapes are already included)</p>\r
283 \r
284 <p class="whs1">geompy.UnionList(group, \r
285  [SubFaceList[0], SubFaceList[2], SubFaceList[5]])</p>\r
286 \r
287 <p>&nbsp;</p>\r
288 \r
289 <p># remove an object from the group</p>\r
290 \r
291 <p class="whs1">geompy.RemoveObject(group, \r
292  FaceID)</p>\r
293 \r
294 <p class="whs1">id_group1 = geompy.addToStudy(group, \r
295  &quot;Group1&quot;)</p>\r
296 \r
297 <p>&nbsp;</p>\r
298 \r
299 <p># display the contents of the group</p>\r
300 \r
301 <p class="whs1">gg.createAndDisplayGO(id_group1)</p>\r
302 \r
303 <p><span style="font-family: 'Lucida Console', monospace;">salome.sg.updateObjBrowser(1)</span> \r
304  </p>\r
305 \r
306 <p>&nbsp;</p>\r
307 \r
308 <p>&nbsp;</p>\r
309 \r
310 <p>&nbsp;</p>\r
311 \r
312 <p>&nbsp;</p>\r
313 \r
314 <p>&nbsp;</p>\r
315 \r
316 <p>&nbsp;</p>\r
317 \r
318 <p>&nbsp;</p>\r
319 \r
320 <script type="text/javascript" language="javascript1.2">\r
321 <!--\r
322 if (window.writeIntopicBar)\r
323         writeIntopicBar(0);\r
324 //-->\r
325 </script>\r
326 </body>\r
327 </html>\r