Salome HOME
PAL12557: Documentation for scripts is not up to date.
[modules/geom.git] / doc / salome / gui / GEOM / building_by_blocks.htm
index 246c6f4366ed77d089d6947e8c1d93d2a2b3a0a7..e2cb299ad8b0242d076c1e9317660297c51fed6d 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,43 +34,48 @@ 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("GEOM module\nTUI Scripts\nCreation of Geometric Objects\nBuilding by Blocks");\r
-addButton("show",BTN_TEXT,"Show","","","","",0,0,"","","");\r
+       addTocInfo("Geometry module\nTUI Scripts\nCreating Geometric Objects\nBuilding by Blocks");\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>Building by Blocks</h1>\r
 \r
 <h3>Quadrangle Face</h3>\r
@@ -117,28 +123,28 @@ else
 \r
 <p>&nbsp;</p>\r
 \r
-<p># create quadrangle face from four edges</p>\r
+<p># create quadrangle face from four edges</p>\r
 \r
 <p class="whs1">qface1 = geompy.MakeQuad(edge1, \r
  edge2, edge3, edge4)</p>\r
 \r
 <p>&nbsp;</p>\r
 \r
-<p># create quadrangle face on two edges</p>\r
+<p># create a quadrangle face from two edges</p>\r
 \r
 <p class="whs1">qface2 = geompy.MakeQuad2Edges(edge1, \r
  edge3)</p>\r
 \r
 <p>&nbsp;</p>\r
 \r
-<p># create quadrangle with specified corners</p>\r
+<p># create a quadrangle from four points in its corners</p>\r
 \r
 <p class="whs1">qface3 = geompy.MakeQuad4Vertices(p1, \r
  p2, p3, p4)</p>\r
 \r
 <p>&nbsp;</p>\r
 \r
-<p># add objects in study</p>\r
+<p># add objects in the study</p>\r
 \r
 <p class="whs1">id_p1 = geompy.addToStudy(p1,&quot;Point1&quot;)</p>\r
 \r
@@ -164,7 +170,7 @@ else
 \r
 <p>&nbsp;</p>\r
 \r
-<p># display vertices, edges and quadrangle faces</p>\r
+<p># display the vertices, the edges and the quadrangle faces</p>\r
 \r
 <p class="whs1">gg.createAndDisplayGO(id_p1)</p>\r
 \r
@@ -195,8 +201,6 @@ else
 <p><span style="font-family: 'Lucida Console', monospace;">gg.setDisplayMode(id_qface3,1)</span> \r
  </p>\r
 \r
-<h3>&nbsp;</h3>\r
-\r
 <h3>Hexagonal Solid</h3>\r
 \r
 <p class="whs1">import geompy</p>\r
@@ -205,120 +209,141 @@ else
 \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">p1 = geompy.MakeVertex( \r
- &nbsp;0., &nbsp;&nbsp;0., \r
+<p class="whs1">p0 &nbsp;= \r
+ geompy.MakeVertex( &nbsp;0., \r
+ &nbsp;&nbsp;0., \r
  &nbsp;&nbsp;0.)</p>\r
 \r
-<p class="whs1">p2 = geompy.MakeVertex(150., \r
- &nbsp;30., &nbsp;&nbsp;0.)</p>\r
+<p class="whs1">p1 &nbsp;= \r
+ geompy.MakeVertex( &nbsp;0., \r
+ &nbsp;&nbsp;0., \r
+ &nbsp;40.)</p>\r
 \r
-<p class="whs1">p3 = geompy.MakeVertex( \r
- &nbsp;0., 120., \r
- &nbsp;50.)</p>\r
+<p class="whs1">p2 &nbsp;= \r
+ geompy.MakeVertex( 70., -15., &nbsp;&nbsp;0.)</p>\r
 \r
-<p class="whs1">p4 = geompy.MakeVertex( \r
- &nbsp;0., &nbsp;40., \r
- &nbsp;70.)</p>\r
+<p class="whs1">p3 &nbsp;= \r
+ geompy.MakeVertex( 70., -15., &nbsp;70.)</p>\r
 \r
-<p class="whs1">p5 = geompy.MakeVertex(100., \r
- &nbsp;20., &nbsp;45.)</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs1">p6 = geompy.MakeVertex( \r
&nbsp;0., 70., \r
- &nbsp;40.)</p>\r
+<p class="whs1">p4 &nbsp;= \r
geompy.MakeVertex( &nbsp;0., \r
+ &nbsp;70., &nbsp;&nbsp;0.)</p>\r
 \r
-<p class="whs1">p7 = geompy.MakeVertex( \r
- 70., 70., &nbsp;70.)</p>\r
+<p class="whs1">p5 &nbsp;= \r
+ geompy.MakeVertex( &nbsp;0., \r
+ &nbsp;70., &nbsp;40.)</p>\r
 \r
-<p class="whs1">p8 = geompy.MakeVertex( \r
- 70.,-15., &nbsp;70.)</p>\r
+<p class="whs1">p6 &nbsp;= \r
+ geompy.MakeVertex( 70., &nbsp;70., \r
+ &nbsp;&nbsp;0.)</p>\r
 \r
-<p class="whs1">p9 = geompy.MakeVertex( \r
- &nbsp;0., &nbsp;0., \r
- &nbsp;40.)</p>\r
+<p class="whs1">p7 &nbsp;= \r
+ geompy.MakeVertex( 70., &nbsp;70., \r
+ &nbsp;70.)</p>\r
+\r
+<p class="whs1">&nbsp;</p>\r
+\r
+<p class="whs1">p8 &nbsp;= \r
+ geompy.MakeVertex( &nbsp;0., \r
+ -50., &nbsp;&nbsp;0.)</p>\r
+\r
+<p class="whs1">p9 &nbsp;= \r
+ geompy.MakeVertex( &nbsp;0., \r
+ -50., &nbsp;40.)</p>\r
 \r
 <p class="whs1">p10 = geompy.MakeVertex( \r
- &nbsp;0., 70., \r
- &nbsp;&nbsp;0.)</p>\r
+ 70., -35., &nbsp;&nbsp;0.)</p>\r
 \r
 <p class="whs1">p11 = geompy.MakeVertex( \r
- 70., 70., &nbsp;&nbsp;0.)</p>\r
+ 70., -35., &nbsp;70.)</p>\r
 \r
-<p class="whs1">p12 = geompy.MakeVertex( \r
- 70., -15., &nbsp;&nbsp;0.)</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs1">p13 = geompy.MakeVertex( \r
- &nbsp;0., &nbsp;0., \r
- &nbsp;&nbsp;0.)</p>\r
+<p class="whs2"># create faces</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">qface1 = geompy.MakeQuad4Vertices(p0, \r
+ p1, p2, p3)</p>\r
 \r
-<p># create faces</p>\r
+<p class="whs1">qface2 = geompy.MakeQuad4Vertices(p4, \r
+ p5, p6, p7)</p>\r
 \r
-<p class="whs1">qface1 = geompy.MakeQuad4Vertices(p1\r
- p2, p3, p4)</p>\r
+<p class="whs1">qface3 = geompy.MakeQuad4Vertices(p0\r
+ p1, p4, p5)</p>\r
 \r
-<p class="whs1">qface2 = geompy.MakeQuad4Vertices(p1\r
- p2, p5, p4)</p>\r
+<p class="whs1">qface4 = geompy.MakeQuad4Vertices(p2\r
+ p3, p6, p7)</p>\r
 \r
-<p class="whs1">qface3 = geompy.MakeQuad4Vertices(p13\r
- p12, p11, p10)</p>\r
+<p class="whs1">qface5 = geompy.MakeQuad4Vertices(p0\r
+ p2, p4, p6)</p>\r
 \r
-<p class="whs1">qface4 = geompy.MakeQuad4Vertices(p9\r
- p8, p7, p6)</p>\r
+<p class="whs1">qface6 = geompy.MakeQuad4Vertices(p1\r
+ p3, p5, p7)</p>\r
 \r
-<p class="whs1">qface5 = geompy.MakeQuad4Vertices(p13, \r
- p9, p6, p10)</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs1">qface6 = geompy.MakeQuad4Vertices(p13\r
- p9, p8, p12)</p>\r
+<p class="whs1">qface7 = geompy.MakeQuad4Vertices(p8\r
+ p9, p10, p11)</p>\r
 \r
-<p class="whs1">qface7 = geompy.MakeQuad4Vertices(p12, \r
- p8, p7, p11)</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs1">qface8 = geompy.MakeQuad4Vertices(p11, \r
p7, p6, p10)</p>\r
+<p class="whs2"># create a hexahedral \r
solid between two given faces</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">solid1 = geompy.MakeHexa2Faces(qface1, \r
+ qface7)</p>\r
 \r
-<p># create hexahedral solid between two given faces</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs1">solid1 = geompy.MakeHexa2Faces(qface1, \r
qface2)</p>\r
+<p class="whs2"># create a hexahedral \r
solid, bounded by six given faces</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">solid2 = geompy.MakeHexa(qface1, \r
+ qface2, qface3, qface4, qface5, qface6)</p>\r
 \r
-<p># create hexahedral solids, bounded by the six given faces</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs1">solid2 = geompy.MakeHexa(qface3, \r
qface4, qface5, qface6, qface7, qface8)</p>\r
+<p class="whs2"># add objects in the \r
study</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">geompy.addToStudy(qface1,&quot;qface1&quot;)</p>\r
+\r
+<p class="whs1">geompy.addToStudy(qface2,&quot;qface2&quot;)</p>\r
+\r
+<p class="whs1">geompy.addToStudy(qface3,&quot;qface3&quot;)</p>\r
+\r
+<p class="whs1">geompy.addToStudy(qface4,&quot;qface4&quot;)</p>\r
+\r
+<p class="whs1">geompy.addToStudy(qface5,&quot;qface5&quot;)</p>\r
 \r
-<p># add objects in study</p>\r
+<p class="whs1">geompy.addToStudy(qface6,&quot;qface6&quot;)</p>\r
+\r
+<p class="whs1">geompy.addToStudy(qface7,&quot;qface7&quot;)</p>\r
+\r
+<p class="whs1">&nbsp;</p>\r
 \r
 <p class="whs1">id_solid1 = geompy.addToStudy(solid1,&quot;Solid1&quot;)</p>\r
 \r
 <p class="whs1">id_solid2 = geompy.addToStudy(solid2,&quot;Solid2&quot;)</p>\r
 \r
-<p>&nbsp;</p>\r
+<p class="whs1">&nbsp;</p>\r
 \r
-<p># display solids</p>\r
+<p class="whs2"># display solids</p>\r
 \r
 <p class="whs1">gg.createAndDisplayGO(id_solid1)</p>\r
 \r
-<p class="whs1">gg.setDisplayMode(id_solid1,1)</p>\r
+<p class="whs1">gg.setDisplayMode(id_solid1, \r
+ 1)</p>\r
 \r
 <p class="whs1">gg.createAndDisplayGO(id_solid2)</p>\r
 \r
-<p><span style="font-family: 'Lucida Console', monospace;">gg.setDisplayMode(id_solid2,1)</span> \r
- </p>\r
-\r
-<p>&nbsp;</p>\r
+<p><span style="font-family: 'Lucida Console', monospace;">gg.setDisplayMode(id_solid2, \r
+ 1)</span> </p>\r
 \r
 <script type="text/javascript" language="javascript1.2">\r
 <!--\r