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