Salome HOME
projects / modules / geom.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
PAL12557: Documentation for scripts is not up to date.
[modules/geom.git] / doc / salome / gui / GEOM / geometrical_objects.htm
diff --git a/doc/salome/gui/GEOM/geometrical_objects.htm b/doc/salome/gui/GEOM/geometrical_objects.htm
index 7008952e12096be9581bb4cbb263d728e1a56d9d..7e26114b9b385762b66e55774337f0bf70381d38 100755 (executable)
--- a/doc/salome/gui/GEOM/geometrical_objects.htm
+++ b/doc/salome/gui/GEOM/geometrical_objects.htm
@@ -34,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\nAdvanced Geometrical Objects");\r
-addButton("show",BTN_TEXT,"Show","","","","",0,0,"","","");\r
+       addTocInfo("Geometry module\nTUI Scripts\nCreating Geometric Objects\nAdvanced Geometrical Objects");\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>Advanced Geometrical Objects</h1>\r
 \r
 <h3><a name=bookmark>Creation of an Edge</a></h3>\r
@@ -95,20 +100,20 @@ else
 \r
 <p>&nbsp;</p>\r
 \r
-<p># create edge</p>\r
+<p># create an edge</p>\r
 \r
 <p class="whs1">edge = geompy.MakeEdge(p0, \r
  pxyz)</p>\r
 \r
 <p>&nbsp;</p>\r
 \r
-<p># add object in study</p>\r
+<p># add object in the study</p>\r
 \r
 <p class="whs1">id_edge = geompy.addToStudy(edge,&quot;Edge&quot;)</p>\r
 \r
 <p>&nbsp;</p>\r
 \r
-<p># display edge</p>\r
+<p># display an edge</p>\r
 \r
 <p class="whs1">gg.createAndDisplayGO(id_edge) \r
  </p>\r
@@ -142,36 +147,37 @@ else
 \r
 <p class="whs2">&nbsp;</p>\r
 \r
-<p class="whs2"># create vector on two \r
- points</p>\r
+<p class="whs2"># create a vector from \r
+ two points</p>\r
 \r
 <p class="whs1">vxy = geompy.MakeVector(px, \r
  py)</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># create arc with three \r
- points</p>\r
+<p class="whs2"># create an arc from \r
+ three points</p>\r
 \r
 <p class="whs1">arc = geompy.MakeArc(py, \r
  pz, px)</p>\r
 \r
 <p class="whs2">&nbsp;</p>\r
 \r
-<p class="whs2"># create wire</p>\r
+<p class="whs2"># create a wire</p>\r
 \r
 <p class="whs1">wire = geompy.MakeWire([vxy, \r
  arc])</p>\r
 \r
 <p class="whs2">&nbsp;</p>\r
 \r
-<p class="whs2"># add object in study</p>\r
+<p class="whs2"># add an object in the \r
+ study</p>\r
 \r
 <p class="whs1">id_wire = geompy.addToStudy(wire,&quot;Wire&quot;)</p>\r
 \r
 <p class="whs2">&nbsp;</p>\r
 \r
-<p class="whs2"># display wire</p>\r
+<p class="whs2"># display the wire</p>\r
 \r
 <p class="whs1">gg.createAndDisplayGO(id_wire) \r
  </p>\r
@@ -215,23 +221,23 @@ else
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># create vector on two \r
- points</p>\r
+<p class="whs2"># create a vector from \r
+ two points</p>\r
 \r
 <p class="whs1">vxy = geompy.MakeVector(px, \r
  py)</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># create arc with three \r
- points</p>\r
+<p class="whs2"># create an arc from \r
+ three points</p>\r
 \r
 <p class="whs1">arc = geompy.MakeArc(py, \r
  pz, px)</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># create wire</p>\r
+<p class="whs2"># create a wire</p>\r
 \r
 <p class="whs1">wire = geompy.MakeWire([vxy, \r
  arc])</p>\r
@@ -256,7 +262,8 @@ else
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># create face from wire</p>\r
+<p class="whs2"># create a face from \r
+ the wire</p>\r
 \r
 <p class="whs1">face1 = geompy.MakeFace(wire, \r
  isPlanarFace)</p>\r
@@ -274,7 +281,8 @@ else
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># add objects in study</p>\r
+<p class="whs2"># add objects in the \r
+ study</p>\r
 \r
 <p class="whs1">id_face1 = geompy.addToStudy(face1,&quot;Face1&quot;)</p>\r
 \r
@@ -284,7 +292,7 @@ else
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># display faces</p>\r
+<p class="whs2"># display the faces</p>\r
 \r
 <p class="whs1">gg.createAndDisplayGO(id_face1)</p>\r
 \r
@@ -342,30 +350,31 @@ else
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># create face from two \r
- wires</p>\r
+<p class="whs2"># create a face from \r
+ two wires</p>\r
 \r
 <p class="whs1">face = geompy.MakeFaces([sketcher1, \r
  sketcher2],isPlanarFace)</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># create prism</p>\r
+<p class="whs2"># create a prism</p>\r
 \r
 <p class="whs1">prism = geompy.MakePrism(face, \r
  p0, pxyz)</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># explode prism on faces</p>\r
+<p class="whs2"># explode the prism into \r
+ faces</p>\r
 \r
 <p class="whs1">prism_faces = geompy.SubShapeAllSorted(prism, \r
  geompy.ShapeType[&quot;FACE&quot;])</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># create shell from the \r
- set of faces</p>\r
+<p class="whs2"># create a shell from \r
+ a set of faces</p>\r
 \r
 <p class="whs1">shell = geompy.MakeShell([prism_faces[0], \r
  prism_faces[2], prism_faces[3],</p>\r
@@ -375,13 +384,14 @@ else
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># add objects in study</p>\r
+<p class="whs2"># add objects in the \r
+ study</p>\r
 \r
 <p class="whs1">id_shell = geompy.addToStudy(shell,&quot;Shell&quot;)</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># display shell</p>\r
+<p class="whs2"># display the shell</p>\r
 \r
 <p class="whs1">gg.createAndDisplayGO(id_shell)</p>\r
 \r
@@ -427,22 +437,23 @@ else
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># create prism</p>\r
+<p class="whs2"># create a prism</p>\r
 \r
 <p class="whs1">prism = geompy.MakePrism(face, \r
  p0, pz)</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># explode prism on faces</p>\r
+<p class="whs2"># explode the prism into \r
+ faces</p>\r
 \r
 <p class="whs1">prism_faces = geompy.SubShapeAllSorted(prism, \r
  geompy.ShapeType[&quot;FACE&quot;])</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># create shell from the \r
- set of faces</p>\r
+<p class="whs2"># create a shell from \r
+ a set of faces</p>\r
 \r
 <p class="whs1">shell = geompy.MakeShell([prism_faces[0], \r
  prism_faces[1],</p>\r
@@ -455,20 +466,21 @@ else
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># create solid, bounded \r
+<p class="whs2"># create a solid, bounded \r
  by the given shells</p>\r
 \r
 <p class="whs1">solid = geompy.MakeSolid([shell])</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># add objects in study</p>\r
+<p class="whs2"># add objects in the \r
+ study</p>\r
 \r
 <p class="whs1">id_solid = geompy.addToStudy(solid,&quot;Solid&quot;)</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># display solid</p>\r
+<p class="whs2"># display the solid</p>\r
 \r
 <p class="whs1">gg.createAndDisplayGO(id_solid)</p>\r
 \r
@@ -479,86 +491,73 @@ else
 \r
 <h3><a name=bookmark4>Creation of a Compound</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">gg = salome.ImportComponentGUI(&quot;GEOM&quot;)</p>\r
-\r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2">#create vertices</p>\r
-\r
-<p class="whs1">p0 = geompy.MakeVertex( \r
- 0., &nbsp;0., \r
- &nbsp;0.)</p>\r
-\r
-<p class="whs1">pz = geompy.MakeVertex( \r
- 0., &nbsp;0., \r
- 40.)</p>\r
+<p class="whs1">gg = salome.ImportComponentGUI(&quot;GEOM&quot;)</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># create sketchers</p>\r
+<p class="whs2"># create a vertex and \r
+ a vector</p>\r
 \r
-<p class="whs1">sketcher = geompy.MakeSketcher(&quot;Sketcher:F \r
- -50 -50:TT 100 -50:R 0:C 50 70:R 0:L 100:WW&quot;)</p>\r
+<p class="whs1">p1 = geompy.MakeVertex( \r
+ &nbsp;-30., &nbsp;-30., \r
+ &nbsp;50.)</p>\r
 \r
-<p class="whs1">&nbsp;</p>\r
+<p class="whs1">p2 = geompy.MakeVertex( \r
+ &nbsp;-60., &nbsp;-60., \r
+ &nbsp;30.)</p>\r
 \r
-<p class="whs2"># create faces from two \r
- wires</p>\r
-\r
-<p class="whs1">face = geompy.MakeFace(sketcher,1)</p>\r
+<p class="whs1">p3 = geompy.MakeVertex( \r
+ &nbsp;-30., &nbsp;-30., \r
+ &nbsp;10.)</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># create prism</p>\r
+<p class="whs2"># create an arc from \r
+ three points</p>\r
 \r
-<p class="whs1">prism = geompy.MakePrism(face, \r
- p0, pz)</p>\r
+<p class="whs1">arc = geompy.MakeArc(p1, \r
+ p2, p3)</p>\r
 \r
-<p class="whs1">&nbsp;</p>\r
+<p class="whs1">ShapeListCompound \r
+ = []</p>\r
 \r
-<p class="whs2"># explode prism on faces</p>\r
+<p class="whs1">i = 0</p>\r
 \r
-<p class="whs1">prism_faces = geompy.SubShapeAllSorted(prism, \r
- geompy.ShapeType[&quot;FACE&quot;])</p>\r
+<p class="whs1">while i &lt;= 3 :</p>\r
 \r
-<p class="whs1">&nbsp;</p>\r
+<p class="whs1">&nbsp;&nbsp;&nbsp;&nbsp;S \r
+ = geompy.MakeTranslation(arc, i * 50., 0., 0.)</p>\r
 \r
-<p class="whs2"># create shell from the \r
- set of faces</p>\r
+<p class="whs1">&nbsp;&nbsp;&nbsp;&nbsp;ShapeListCompound.append(S)</p>\r
 \r
-<p class="whs1">shell = geompy.MakeShell([prism_faces[0], \r
- prism_faces[1],</p>\r
-\r
-<p class="whs1">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;prism_faces[3], \r
- prism_faces[4],</p>\r
-\r
-<p class="whs1">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;prism_faces[5], \r
- prism_faces[2]])</p>\r
+<p class="whs1">&nbsp;&nbsp;&nbsp;&nbsp;i \r
+ = i + 1</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># create solid, bounded \r
- by the given shells</p>\r
+<p class="whs2"># create a compund of \r
+ the given shapes</p>\r
 \r
-<p class="whs1">solid = geompy.MakeSolid([shell])</p>\r
+<p class="whs1">compound = geompy.MakeCompound(ShapeListCompound)</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># add objects in study</p>\r
+<p class="whs2"># add object in the study</p>\r
 \r
-<p class="whs1">id_solid = geompy.addToStudy(solid,&quot;Solid&quot;)</p>\r
+<p class="whs1">id_compound = geompy.addToStudy(compound,&quot;Compound&quot;)</p>\r
 \r
 <p class="whs1">&nbsp;</p>\r
 \r
-<p class="whs2"># display solid</p>\r
+<p class="whs2"># display the compound</p>\r
 \r
-<p class="whs1">gg.createAndDisplayGO(id_solid)</p>\r
-\r
-<p class="whs1">gg.setDisplayMode(id_solid,1) \r
+<p class="whs1">gg.createAndDisplayGO(id_compound) \r
  </p>\r
 \r
 <script type="text/javascript" language="javascript1.2">\r
SALOME Geometry module

Copyright © 2005–2024 Open CASCADE.
All rights reserved.
Legal Information