Salome HOME
PAL12557: Documentation for scripts is not up to date.
[modules/geom.git] / doc / salome / gui / GEOM / blocks_operations.htm
index dd9f31a7e1fdc2636e1c3544812f1a6fbe1b45a0..7498a7ae4181e9c35753956ec77834c924071dcd 100755 (executable)
@@ -15,6 +15,7 @@ if (navigator.appName !="Netscape")
 <style type="text/css">\r
 <!--\r
 p.whs1 { font-family:'Lucida Console' , monospace; }\r
+p.whs2 { font-family:'Times New Roman' , serif; }\r
 -->\r
 </style><script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">\r
 <!--\r
@@ -33,56 +34,64 @@ onerror = null;
 <style type="text/css">\r
 <!--\r
 div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
+p.WebHelpNavBar { text-align:right; }\r
 -->\r
 </style><script type="text/javascript" language="javascript1.2" src="whmsg.js"></script>\r
 <script type="text/javascript" language="javascript" src="whver.js"></script>\r
 <script type="text/javascript" language="javascript1.2" src="whproxy.js"></script>\r
 <script type="text/javascript" language="javascript1.2" src="whutils.js"></script>\r
 <script type="text/javascript" language="javascript1.2" src="whtopic.js"></script>\r
-</head>\r
-<body><script type="text/javascript" language="javascript1.2">\r
+<script type="text/javascript" language="javascript1.2">\r
 <!--\r
 if (window.gbWhTopic)\r
 {\r
-       if (window.addTocInfo)\r
+       if (window.setRelStartPage)\r
        {\r
        addTocInfo("Geometry module\nTUI Scripts\nTransformation\nBlocks Operations");\r
-addButton("show",BTN_TEXT,"Show","","","","",0,0,"","","");\r
+addButton("show",BTN_IMG,"Show","","","","",0,0,"whd_show0.gif","whd_show2.gif","whd_show1.gif");\r
+addButton("hide",BTN_IMG,"Hide","","","","",0,0,"whd_hide0.gif","whd_hide2.gif","whd_hide1.gif");\r
 \r
        }\r
-       if (window.writeBtnStyle)\r
-               writeBtnStyle();\r
 \r
-       if (window.writeIntopicBar)\r
-               writeIntopicBar(1);\r
 \r
        if (window.setRelStartPage)\r
        {\r
-       setRelStartPage("geom.htm");\r
+       setRelStartPage("index.htm");\r
 \r
                autoSync(1);\r
                sendSyncInfo();\r
                sendAveInfoOut();\r
        }\r
+\r
 }\r
 else\r
        if (window.gbIE4)\r
                document.location.reload();\r
 //-->\r
 </script>\r
+</head>\r
+<body><script type="text/javascript" language="javascript1.2">\r
+<!--\r
+if (window.writeIntopicBar)\r
+       writeIntopicBar(4);\r
+//-->\r
+</script>\r
 <h1>Blocks Operations</h1>\r
 \r
 <h3><a name=bookmark4>Multi Transformation</a></h3>\r
 \r
-<p class="whs1">import geompy</p>\r
+<p class="whs1"><span style="font-family: 'Lucida Console', monospace;">import \r
+ geompy</span></p>\r
 \r
 <p class="whs1">import salome</p>\r
 \r
+<p class="whs1">&nbsp;</p>\r
+\r
 <p class="whs1">gg = salome.ImportComponentGUI(&quot;GEOM&quot;)</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p># create vertices</p>\r
+<p class="whs2"># create vertices</p>\r
 \r
 <p class="whs1">p_25_25_50 = geompy.MakeVertex(25., \r
  25., 50.)</p>\r
@@ -93,9 +102,13 @@ else
 <p class="whs1">p_25_50_25 = geompy.MakeVertex(25., \r
  50., 25.)</p>\r
 \r
+<p class="whs1">&nbsp;</p>\r
+\r
 <p class="whs1">box = geompy.MakeBoxDXDYDZ(50, \r
  50, 50)</p>\r
 \r
+<p class="whs1">&nbsp;</p>\r
+\r
 <p class="whs1">top_face = geompy.GetFaceNearPoint(box, \r
  p_25_25_50)</p>\r
 \r
@@ -105,18 +118,21 @@ else
 <p class="whs1">xz_face = geompy.GetFaceNearPoint(box, \r
  p_25_50_25)</p>\r
 \r
-<p class="whs1">top_face_ind = geompy.LocalOp.GetSubShapeIndex(box, \r
+<p class="whs1">&nbsp;</p>\r
+\r
+<p class="whs1">top_face_ind = geompy.GetSubShapeID(box, \r
  top_face)</p>\r
 \r
-<p class="whs1">yz_face_ind = geompy.LocalOp.GetSubShapeIndex(box, \r
+<p class="whs1">yz_face_ind = geompy.GetSubShapeID(box, \r
  yz_face)</p>\r
 \r
-<p class="whs1">xz_face_ind = geompy.LocalOp.GetSubShapeIndex(box, \r
+<p class="whs1">xz_face_ind = geompy.GetSubShapeID(box, \r
  xz_face)</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p># Multi-transformate block and glue the result</p>\r
+<p class="whs2"># Multi-transformate \r
+ block and glue the result</p>\r
 \r
 <p class="whs1">box_tr1 = geompy.MakeMultiTransformation1D(box, \r
  yz_face_ind, top_face_ind, 3)</p>\r
@@ -124,9 +140,10 @@ else
 <p class="whs1">box_tr2 = geompy.MakeMultiTransformation2D(box, \r
  xz_face_ind, yz_face_ind, 3, top_face_ind, 0, 2)</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p># add objects in the study</p>\r
+<p class="whs2"># add objects in the \r
+ study</p>\r
 \r
 <p class="whs1">id_box = geompy.addToStudy(box, \r
  &quot;Box&quot;)</p>\r
@@ -137,9 +154,9 @@ else
 <p class="whs1">id_box_tr2 = geompy.addToStudy(box_tr2, \r
  &quot;Multi-transformed Block 2D&quot;)</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p># display the results</p>\r
+<p class="whs2"># display the results</p>\r
 \r
 <p class="whs1">gg.createAndDisplayGO(id_box)</p>\r
 \r
@@ -147,10 +164,10 @@ else
 \r
 <p class="whs1">gg.createAndDisplayGO(id_box_tr1)</p>\r
 \r
-<p><span style="font-family: 'Lucida Console', monospace;">gg.createAndDisplayGO(id_box_tr2)</span> \r
+<p class="whs1">gg.createAndDisplayGO(id_box_tr2) \r
  </p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
 <h3><a name=bookmark5>Explode on Blocks</a></h3>\r
 \r
@@ -158,11 +175,14 @@ else
 \r
 <p class="whs1">import salome</p>\r
 \r
+<p class="whs1">&nbsp;</p>\r
+\r
 <p class="whs1">gg = salome.ImportComponentGUI(&quot;GEOM&quot;)</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p># create a box and a sphere</p>\r
+<p class="whs2"># create a box and a \r
+ sphere</p>\r
 \r
 <p class="whs1">box = geompy.MakeBoxDXDYDZ(200, \r
  200, 200)</p>\r
@@ -171,31 +191,38 @@ else
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p># make a compound</p>\r
+<p class="whs2"># make a compound</p>\r
 \r
 <p class="whs1">compound = geompy.MakeCompound([box, \r
  sphere])</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs2">&nbsp;</p>\r
+\r
+<p class="whs2"># get all the blocks \r
+ of the given compound, by criteria: min_nb_faces &lt;= nb. of faces &lt;= \r
+ max_nb_faces</p>\r
 \r
-<p># get all the blocks, contained in the given compound</p>\r
+<p class="whs1">min_nb_faces = 6</p>\r
+\r
+<p class="whs1">max_nb_faces = 6</p>\r
 \r
 <p class="whs1">make_block_explode \r
- = geompy.MakeBlockExplode(compound, 1, 1)</p>\r
+ = geompy.MakeBlockExplode(compound, min_nb_faces, max_nb_faces)</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p># add objects in the study</p>\r
+<p class="whs2"># add objects in the \r
+ study</p>\r
 \r
 <p class="whs1">id_compound = geompy.addToStudy(compound, \r
  &quot;Compound&quot;)</p>\r
 \r
 <p class="whs1">id_make_block_explode \r
- = geompy.addToStudy(make_block_explode[0], &quot;MakeBlockExplode&quot;)</p>\r
+ = geompy.addToStudyInFather(compound, make_block_explode[0], &quot;MakeBlockExplode&quot;)</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p># display the results</p>\r
+<p class="whs2"># display the results</p>\r
 \r
 <p class="whs1">gg.createAndDisplayGO(id_compound)</p>\r
 \r
@@ -212,42 +239,45 @@ else
 \r
 <p class="whs1">import salome</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p># create a box and a sphere</p>\r
+<p class="whs2"># create a box</p>\r
 \r
 <p class="whs1">box = geompy.MakeBoxDXDYDZ(200, \r
  200, 200)</p>\r
 \r
-<p>&nbsp;</p>\r
-\r
-<p># check and improve</p>\r
-\r
-<p class="whs1">check_box = geompy.CheckAndImprove(box)</p>\r
-\r
-<p>&nbsp;&nbsp;</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p># build all possible propagation groups</p>\r
+<p class="whs2"># build all possible \r
+ propagation groups</p>\r
 \r
 <p class="whs1">listChains = geompy.Propagate(check_box)</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p># add objects in the study</p>\r
+<p class="whs2"># add objects in the \r
+ study</p>\r
 \r
 <p class="whs1">geompy.addToStudy(check_box, \r
  &quot;Box&quot;)</p>\r
 \r
+<p class="whs1">ii = 1</p>\r
+\r
 <p class="whs1">for chain in listChains:</p>\r
 \r
 <p class="whs1">&nbsp;&nbsp;&nbsp;&nbsp;geompy.addToStudyInFather(check_box, \r
- chain, &quot;propagation chain&quot;)</p>\r
+ chain, &quot;propagation chain &quot; + `ii`)</p>\r
 \r
-<p><span style="font-family: 'Lucida Console', monospace;">salome.sg.updateObjBrowser(1)</span> \r
- </p>\r
+<p class="whs1">&nbsp;&nbsp;&nbsp;&nbsp;ii \r
+ = ii + 1</p>\r
+\r
+<p class="whs1">&nbsp;&nbsp;&nbsp;&nbsp;pass</p>\r
 \r
 <p>&nbsp;</p>\r
 \r
+<p><span style="font-family: 'Lucida Console', monospace;">salome.sg.updateObjBrowser(1)</span> \r
+ </p>\r
+\r
 <script type="text/javascript" language="javascript1.2">\r
 <!--\r
 if (window.writeIntopicBar)\r