Salome HOME
Join modifications from branch BR_DEBUG_3_2_0b1
[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 img_whs1 { border:none; width:24px; height:22px; border-style:none; }\r
18 p.whs2 { font-size:12pt; }\r
19 p.whs3 { font-size:12pt; font-weight:bold; margin-left:40px; }\r
20 img_whs4 { border:none; border-style:none; width:312px; height:379px; float:none; }\r
21 p.whs5 { font-size:12pt; margin-left:0px; font-weight:normal; }\r
22 ul.whs6 { list-style:disc; }\r
23 img_whs7 { border:none; width:50px; height:31px; border-style:none; }\r
24 p.whs8 { font-size:12pt; margin-left:48px; }\r
25 p.whs9 { font-size:12pt; margin-left:0px; }\r
26 p.whs10 { font-size:12pt; font-weight:bold; }\r
27 p.whs11 { font-size:12pt; margin-left:40px; }\r
28 img_whs12 { border:none; width:250px; height:307px; border-style:none; }\r
29 img_whs13 { border:none; width:22px; height:22px; border-style:none; }\r
30 p.whs14 { font-size:12pt; margin-left:40px; font-weight:bold; }\r
31 img_whs15 { border:none; width:312px; height:379px; float:none; border-style:none; }\r
32 -->\r
33 </style><script type="text/javascript" language="JavaScript">\r
34 <!--\r
35 if ((navigator.appName == "Netscape") && (parseInt(navigator.appVersion) == 4))\r
36 {\r
37   var strNSS = "<style type='text/css'>";\r
38   strNSS += "p.whs5 {margin-left:1pt; }";\r
39   strNSS += "p.whs9 {margin-left:1pt; }";\r
40   strNSS +="</style>";\r
41   document.write(strNSS);\r
42 }\r
43 //-->\r
44 </script>\r
45 <script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">\r
46 <!--\r
47 function reDo() {\r
48   if (innerWidth != origWidth || innerHeight != origHeight)\r
49      location.reload();\r
50 }\r
51 if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {\r
52         origWidth = innerWidth;\r
53         origHeight = innerHeight;\r
54         onresize = reDo;\r
55 }\r
56 onerror = null; \r
57 //-->\r
58 </script>\r
59 <style type="text/css">\r
60 <!--\r
61 div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
62 p.WebHelpNavBar { text-align:right; }\r
63 -->\r
64 </style><script type="text/javascript" language="javascript1.2" src="whmsg.js"></script>\r
65 <script type="text/javascript" language="javascript" src="whver.js"></script>\r
66 <script type="text/javascript" language="javascript1.2" src="whproxy.js"></script>\r
67 <script type="text/javascript" language="javascript1.2" src="whutils.js"></script>\r
68 <script type="text/javascript" language="javascript1.2" src="whtopic.js"></script>\r
69 <script type="text/javascript" language="javascript1.2">\r
70 <!--\r
71 if (window.gbWhTopic)\r
72 {\r
73         if (window.setRelStartPage)\r
74         {\r
75         addTocInfo("Geometry module\nCreating geometrical objects\nWorking with groups");\r
76 addButton("show",BTN_IMG,"Show","","","","",0,0,"whd_show0.gif","whd_show2.gif","whd_show1.gif");\r
77 addButton("hide",BTN_IMG,"Hide","","","","",0,0,"whd_hide0.gif","whd_hide2.gif","whd_hide1.gif");\r
78 \r
79         }\r
80 \r
81 \r
82         if (window.setRelStartPage)\r
83         {\r
84         setRelStartPage("index.htm");\r
85 \r
86                 autoSync(1);\r
87                 sendSyncInfo();\r
88                 sendAveInfoOut();\r
89         }\r
90 \r
91 }\r
92 else\r
93         if (window.gbIE4)\r
94                 document.location.reload();\r
95 //-->\r
96 </script>\r
97 </head>\r
98 <body><script type="text/javascript" language="javascript1.2">\r
99 <!--\r
100 if (window.writeIntopicBar)\r
101         writeIntopicBar(4);\r
102 //-->\r
103 </script>\r
104 <h1>Working with groups</h1>\r
105 \r
106 <p>Creation and editing groups of subshapes of a geometrical object makes \r
107  handling subshapes much easier. This functionality is available in OCC \r
108  viewer only.</p>\r
109 \r
110 <p>&nbsp;</p>\r
111 \r
112 <p><img src="image56.gif" width="24px" height="22px" border="0" class="img_whs1"> <span style="font-weight: bold; font-size: 14pt;"><font size=4 style="font-size:14pt;"><B>Create \r
113  a group</B></font></span></p>\r
114 \r
115 <p>&nbsp;</p>\r
116 \r
117 <p class="whs2">To create a group of subshapes of a geometrical \r
118  object in the main menu select <span style="font-weight: bold;"><B>New entity \r
119  &gt; Group &gt; Create</B></span>. </p>\r
120 \r
121 <p class="whs2">The following menu will appear. </p>\r
122 \r
123 <p class="whs2">&nbsp;</p>\r
124 \r
125 <p class="whs3"><b style="font-weight: bold;"><img src="pics/geomcreategroup.png" x-maintain-ratio="TRUE" width="312px" height="379px" border="0" class="img_whs4"></b></p>\r
126 \r
127 <p class="whs3">&nbsp;</p>\r
128 \r
129 <p class="whs5">In this Menu: </p>\r
130 \r
131 <p class="whs5">&nbsp;</p>\r
132 \r
133 <ul type="disc" class="whs6">\r
134         \r
135         <li class=kadov-p><p class="whs5"><span style="font-weight: bold;"><B>Shape \r
136  Type</B></span> radio button define the type of elements for the group (points, \r
137  lines, planes or shapes). </p></li>\r
138         \r
139         <li class=kadov-p><p class="whs5"><span style="font-weight: bold;"><B>Group \r
140  Name</B></span> - here you can enter the name of the group, by default, it \r
141  is Group_n.</p></li>\r
142         \r
143         <li class=kadov-p><p class="whs5">Then, using the <img src="image28.gif" width="50px" height="31px" border="0" class="img_whs7"> button, select the <span style="font-weight: bold;"><B>Main \r
144  Shape</B></span> (a geometrical object on which the group will be created). \r
145  You can select the elements of your group in two ways:</p></li>\r
146         \r
147         <li class=kadov-p><p class="whs8">Clicking \r
148  <span style="font-weight: bold;"><B>Select Sub-Shapes</B></span> button you can \r
149  select them manually in the 3D Viewer, and add to the group by clicking \r
150  the <span style="font-weight: bold;"><B>Add</B></span> button (keep down the \r
151  Shift button on the keyboard to select several elements and add all them \r
152  together). The indexes of the selected elements will be displayed in the \r
153  list. To delete elements from the list, select them and click <span style="font-weight: bold;"><B>Remove</B></span> \r
154  button. &nbsp;</p></li>\r
155         \r
156         <li class=kadov-p><p class="whs8">Clicking \r
157  <span style="font-weight: bold;"><B>Select All</B></span> button you can add \r
158  all object's elements of a certain type in the list of the elements of \r
159  the group. To delete elements from the list, select them and click <span \r
160  style="font-weight: bold;"><B>Remove</B></span> button. &nbsp;</p></li>\r
161         \r
162         <li class=kadov-p><p class="whs9">Finally, \r
163  confirm your selection by clicking <span style="font-weight: bold;"><B>OK \r
164  </B></span>(also closes the Menu) or <span style="font-weight: bold;"><B>Apply</B></span> \r
165  (leaves the Menu open for creation of other groups), or skip it by clicking \r
166  <span style="font-weight: bold;"><B>Close</B></span> button. </p></li>\r
167 </ul>\r
168 \r
169 <p class="whs2">&nbsp;</p>\r
170 \r
171 <p class="whs2"><b style="font-weight: bold;"><span style="font-weight: normal;">The</span> \r
172  Result <span style="font-weight: normal;">of the operation will be a</span></b><b> \r
173  GEOM_Object<span style="font-weight: normal;">.</span></b></p>\r
174 \r
175 <p class="whs2">&nbsp;</p>\r
176 \r
177 <p class="whs2"><b style="font-weight: bold;">TUI Command:</b><i> \r
178  </i><span style="font-style: italic;"><I>geompy.CreateGroup(MainShape, ShapeType)</I></span>, \r
179  where MainShape is a shape for which the group is created, ShapeType is \r
180  a type of shapes in the created group.</p>\r
181 \r
182 <p class="whs2">&nbsp;</p>\r
183 \r
184 <p class="whs2"><b style="font-weight: bold;">Arguments:</b> \r
185  1 Shape + Type of subshape.</p>\r
186 \r
187 <p class="whs2">&nbsp;</p>\r
188 \r
189 <p class="whs10">Example:</p>\r
190 \r
191 <p class="whs10">&nbsp;</p>\r
192 \r
193 <p class="whs11"><img src="image193.jpg" width="250px" height="307px" border="0" class="img_whs12"></p>\r
194 \r
195 <p class="whs2">&nbsp;</p>\r
196 \r
197 <p class="whs2">&nbsp;</p>\r
198 \r
199 <p class="whs2">&nbsp;</p>\r
200 \r
201 <p class="whs2"><img src="image57.gif" width="22px" height="22px" border="0" class="img_whs13"> <span style="font-weight: bold; font-size: 14pt;"><font size=4 style="font-size:14pt;"><B>Edit \r
202  a group</B></font></span></p>\r
203 \r
204 <p class="whs2">&nbsp;</p>\r
205 \r
206 <p class="whs2">To<span style="font-weight: bold;"><B> Edit </B></span>an \r
207  existing group in the main menu select <span style="font-weight: bold;"><B>New \r
208  entity &gt; Group &gt; Edit</B></span>. This menu is designed in the same \r
209  way as the <span style="font-weight: bold;"><B>Create a group</B></span> menu. \r
210  </p>\r
211 \r
212 <p class="whs2">&nbsp;</p>\r
213 \r
214 <p class="whs2"><b style="font-weight: bold;"><span style="font-weight: normal;">The</span> \r
215  Result <span style="font-weight: normal;">of the operation will be a</span></b><b> \r
216  GEOM_Object<span style="font-weight: normal;">.</span></b></p>\r
217 \r
218 <p>&nbsp;</p>\r
219 \r
220 <p class="whs2"><b style="font-weight: bold;">TUI Command:</b><i> \r
221  </i></p>\r
222 \r
223 <ul type="disc" class="whs6">\r
224         \r
225         <li class=kadov-p><p class="whs2"><i><span style="font-style: italic;"><I>g</i>eompy.AddObject(Group, \r
226  SubShapeID)</I></span>, where Group is a group to which a sub shape has to \r
227  be added, SubShapeID is an ID of the sub shape to be added to the group</p></li>\r
228         \r
229         <li class=kadov-p><p class="whs2"><span style="font-style: italic;"><I>geompy.RemoveObject(Group, \r
230  SubShapeID)</I></span>, where Group is a group from which a sub shape has \r
231  to be removed, SubShapeID is an ID of the sub shape to be removed from \r
232  the group</p></li>\r
233         \r
234         <li class=kadov-p><p class="whs2"><span style="font-style: italic;"><I>geompy.GetObjectIDs(Group)</I></span>, \r
235  where Group is a group for which its object ID\92s are returned. </p></li>\r
236 </ul>\r
237 \r
238 <p class="whs11"><span style="font-size: 12pt;"><font size=3 style="font-size:12pt;">Returns: \r
239  List of IDs.</font></span></p>\r
240 \r
241 <p class="whs2">&nbsp;</p>\r
242 \r
243 <p class="whs2"><b style="font-weight: bold;">Arguments:</b> \r
244  1 Shape + its subshapes.</p>\r
245 \r
246 <p class="whs2">&nbsp;</p>\r
247 \r
248 <p class="whs2"><b style="font-weight: bold;">Dialog Box:</b></p>\r
249 \r
250 <p class="whs2">&nbsp;</p>\r
251 \r
252 <p class="whs14"><b style="font-weight: bold;"><img src="pics/editgroup.png" x-maintain-ratio="TRUE" width="312px" height="379px" border="0" class="img_whs15"></b></p>\r
253 \r
254 <p class="whs14">&nbsp;</p>\r
255 \r
256 <p class="whs2">Our <span style="font-weight: bold;"><B>TUI Scripts</B></span> \r
257  provide you with useful examples of <a href="working_with_groups.htm">Working \r
258  with Groups</a>. </p>\r
259 \r
260 <p>&nbsp;</p>\r
261 \r
262 <script type="text/javascript" language="javascript1.2">\r
263 <!--\r
264 if (window.writeIntopicBar)\r
265         writeIntopicBar(0);\r
266 //-->\r
267 </script>\r
268 </body>\r
269 </html>\r