Salome HOME
PAL12557: Documentation for scripts is not up to date.
[modules/geom.git] / doc / salome / gui / GEOM / primitives.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>Primitives</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 p.whs1 { font-family:'Lucida Console' , monospace; }\r
18 -->\r
19 </style><script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">\r
20 <!--\r
21 function reDo() {\r
22   if (innerWidth != origWidth || innerHeight != origHeight)\r
23      location.reload();\r
24 }\r
25 if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {\r
26         origWidth = innerWidth;\r
27         origHeight = innerHeight;\r
28         onresize = reDo;\r
29 }\r
30 onerror = null; \r
31 //-->\r
32 </script>\r
33 <style type="text/css">\r
34 <!--\r
35 div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
36 p.WebHelpNavBar { text-align:right; }\r
37 -->\r
38 </style><script type="text/javascript" language="javascript1.2" src="whmsg.js"></script>\r
39 <script type="text/javascript" language="javascript" src="whver.js"></script>\r
40 <script type="text/javascript" language="javascript1.2" src="whproxy.js"></script>\r
41 <script type="text/javascript" language="javascript1.2" src="whutils.js"></script>\r
42 <script type="text/javascript" language="javascript1.2" src="whtopic.js"></script>\r
43 <script type="text/javascript" language="javascript1.2">\r
44 <!--\r
45 if (window.gbWhTopic)\r
46 {\r
47         if (window.setRelStartPage)\r
48         {\r
49         addTocInfo("Geometry module\nTUI Scripts\nCreating Geometric Objects\nPrimitives");\r
50 addButton("show",BTN_IMG,"Show","","","","",0,0,"whd_show0.gif","whd_show2.gif","whd_show1.gif");\r
51 addButton("hide",BTN_IMG,"Hide","","","","",0,0,"whd_hide0.gif","whd_hide2.gif","whd_hide1.gif");\r
52 \r
53         }\r
54 \r
55 \r
56         if (window.setRelStartPage)\r
57         {\r
58         setRelStartPage("index.htm");\r
59 \r
60                 autoSync(1);\r
61                 sendSyncInfo();\r
62                 sendAveInfoOut();\r
63         }\r
64 \r
65 }\r
66 else\r
67         if (window.gbIE4)\r
68                 document.location.reload();\r
69 //-->\r
70 </script>\r
71 </head>\r
72 <body><script type="text/javascript" language="javascript1.2">\r
73 <!--\r
74 if (window.writeIntopicBar)\r
75         writeIntopicBar(4);\r
76 //-->\r
77 </script>\r
78 <h1>Primitives</h1>\r
79 \r
80 <h3><a name=bookmark>Creation of a Box</a></h3>\r
81 \r
82 <p>i<span style="font-family: 'Lucida Console', monospace;">mport geompy</span></p>\r
83 \r
84 <p class="whs1">import salome</p>\r
85 \r
86 <p class="whs1">gg = salome.ImportComponentGUI(&quot;GEOM&quot;)</p>\r
87 \r
88 <p class="whs1">&nbsp;</p>\r
89 \r
90 <p># create vertices</p>\r
91 \r
92 <p class="whs1">p0 = geompy.MakeVertex(15, \r
93  25, 35)</p>\r
94 \r
95 <p class="whs1">p70 = geompy.MakeVertex(70, \r
96  70, 70)</p>\r
97 \r
98 <p>&nbsp;</p>\r
99 \r
100 <p># create boxes</p>\r
101 \r
102 <p class="whs1">box1 = geompy.MakeBoxDXDYDZ(10, \r
103  20, 30)</p>\r
104 \r
105 <p class="whs1">box2 = geompy.MakeBox(10,20,30, \r
106  15,25,35)</p>\r
107 \r
108 <p class="whs1">box3 = geompy.MakeBoxTwoPnt(p0, \r
109  p70)</p>\r
110 \r
111 <p>&nbsp;</p>\r
112 \r
113 <p># add objects in the study</p>\r
114 \r
115 <p class="whs1">id_box1 = geompy.addToStudy(box1,&quot;Box1&quot;)</p>\r
116 \r
117 <p class="whs1">id_box2 = geompy.addToStudy(box2,&quot;Box2&quot;)</p>\r
118 \r
119 <p class="whs1">id_box3 = geompy.addToStudy(box3,&quot;Box3&quot;)</p>\r
120 \r
121 <p>&nbsp;</p>\r
122 \r
123 <p># display the boxes</p>\r
124 \r
125 <p class="whs1">gg.createAndDisplayGO(id_box1)</p>\r
126 \r
127 <p class="whs1">gg.setDisplayMode(id_box1,1)</p>\r
128 \r
129 <p class="whs1">gg.createAndDisplayGO(id_box2)</p>\r
130 \r
131 <p class="whs1">gg.setDisplayMode(id_box2,1)</p>\r
132 \r
133 <p class="whs1">gg.createAndDisplayGO(id_box3)</p>\r
134 \r
135 <p><span style="font-family: 'Lucida Console', monospace;">gg.setDisplayMode(id_box3,1)</span> \r
136  </p>\r
137 \r
138 <p>&nbsp;</p>\r
139 \r
140 <h3><a name=bookmark1>Creation of a Cylinder</a></h3>\r
141 \r
142 <p class="whs1">import geompy</p>\r
143 \r
144 <p class="whs1">import salome</p>\r
145 \r
146 <p class="whs1">&nbsp;</p>\r
147 \r
148 <p class="whs1">gg = salome.ImportComponentGUI(&quot;GEOM&quot;)</p>\r
149 \r
150 <p class="whs1">&nbsp;</p>\r
151 \r
152 <p># create a vertex and a vector</p>\r
153 \r
154 <p class="whs1">p1 = geompy.MakeVertex(25, \r
155  35, 45)</p>\r
156 \r
157 <p class="whs1">p2 = geompy.MakeVertex(70, \r
158  70, 70)</p>\r
159 \r
160 <p class="whs1">v = geompy.MakeVector(p1, \r
161  p2)</p>\r
162 \r
163 <p>&nbsp;</p>\r
164 \r
165 <p># create cylinders</p>\r
166 \r
167 <p class="whs1">height = 40</p>\r
168 \r
169 <p class="whs1">&nbsp;</p>\r
170 \r
171 <p class="whs1">radius1 = 15</p>\r
172 \r
173 <p class="whs1">cylinder1 = geompy.MakeCylinder(p1, \r
174  v, radius1, height)</p>\r
175 \r
176 <p class="whs1">&nbsp;</p>\r
177 \r
178 <p class="whs1">radius2 = 30</p>\r
179 \r
180 <p class="whs1">cylinder2 = geompy.MakeCylinderRH(radius2, \r
181  height)</p>\r
182 \r
183 <p class="whs1">&nbsp;</p>\r
184 \r
185 <p># add objects in the study</p>\r
186 \r
187 <p class="whs1">id_cylinder1 = geompy.addToStudy(cylinder1,&quot;Cylinder1&quot;)</p>\r
188 \r
189 <p class="whs1">id_cylinder2 = geompy.addToStudy(cylinder2,&quot;Cylinder2&quot;)</p>\r
190 \r
191 <p>&nbsp;</p>\r
192 \r
193 <p># display the cylinders</p>\r
194 \r
195 <p class="whs1">gg.createAndDisplayGO(id_cylinder1)</p>\r
196 \r
197 <p class="whs1">gg.setDisplayMode(id_cylinder1,1)</p>\r
198 \r
199 <p class="whs1">gg.createAndDisplayGO(id_cylinder2)</p>\r
200 \r
201 <p><span style="font-family: 'Lucida Console', monospace;">gg.setDisplayMode(id_cylinder2,1)</span> \r
202  </p>\r
203 \r
204 <p>&nbsp;</p>\r
205 \r
206 <h3><a name=bookmark2>Creation of a Sphere</a></h3>\r
207 \r
208 <p class="whs1">import geompy</p>\r
209 \r
210 <p class="whs1">import salome</p>\r
211 \r
212 <p class="whs1">gg = salome.ImportComponentGUI(&quot;GEOM&quot;)</p>\r
213 \r
214 <p>&nbsp;</p>\r
215 \r
216 <p># create a vertex</p>\r
217 \r
218 <p class="whs1">p = geompy.MakeVertex(55, \r
219  45, 25)</p>\r
220 \r
221 <p>&nbsp;</p>\r
222 \r
223 <p># create spheres</p>\r
224 \r
225 <p class="whs1">radius1 = 20</p>\r
226 \r
227 <p class="whs1">sphere1 = geompy.MakeSpherePntR(p, \r
228  radius1)</p>\r
229 \r
230 <p class="whs1">radius2 = 15</p>\r
231 \r
232 <p class="whs1">sphere2 = geompy.MakeSphere(0, \r
233  0, 45, radius2)</p>\r
234 \r
235 <p class="whs1">radius3 = 30</p>\r
236 \r
237 <p class="whs1">sphere3 = geompy.MakeSphereR(radius3)</p>\r
238 \r
239 <p>&nbsp;</p>\r
240 \r
241 <p># add objects in the study</p>\r
242 \r
243 <p class="whs1">id_sphere1 = geompy.addToStudy(sphere1,&quot;Sphere1&quot;)</p>\r
244 \r
245 <p class="whs1">id_sphere2 = geompy.addToStudy(sphere2,&quot;Sphere2&quot;)</p>\r
246 \r
247 <p class="whs1">id_sphere3 = geompy.addToStudy(sphere3,&quot;Sphere3&quot;)</p>\r
248 \r
249 <p>&nbsp;</p>\r
250 \r
251 <p># display spheres</p>\r
252 \r
253 <p class="whs1">gg.createAndDisplayGO(id_sphere1)</p>\r
254 \r
255 <p class="whs1">gg.setDisplayMode(id_sphere1,1)</p>\r
256 \r
257 <p class="whs1">gg.createAndDisplayGO(id_sphere2)</p>\r
258 \r
259 <p class="whs1">gg.setDisplayMode(id_sphere2,1)</p>\r
260 \r
261 <p class="whs1">gg.createAndDisplayGO(id_sphere3)</p>\r
262 \r
263 <p><span style="font-family: 'Lucida Console', monospace;">gg.setDisplayMode(id_sphere3,1)</span> \r
264  </p>\r
265 \r
266 <p>&nbsp;</p>\r
267 \r
268 <h3><a name=bookmark3>Creation of a Torus</a></h3>\r
269 \r
270 <p class="whs1">import geompy</p>\r
271 \r
272 <p class="whs1">import salome</p>\r
273 \r
274 <p class="whs1">gg = salome.ImportComponentGUI(&quot;GEOM&quot;)</p>\r
275 \r
276 <p>&nbsp;</p>\r
277 \r
278 <p># create a vertex and a vector</p>\r
279 \r
280 <p class="whs1">p1 = geompy.MakeVertex(35, \r
281  40, 45)</p>\r
282 \r
283 <p class="whs1">p2 = geompy.MakeVertex(35, \r
284  45, 70)</p>\r
285 \r
286 <p class="whs1">v = geompy.MakeVector(p1, \r
287  p2)</p>\r
288 \r
289 <p>&nbsp;</p>\r
290 \r
291 <p># create toruses</p>\r
292 \r
293 <p class="whs1">torus1 = geompy.MakeTorus(p1, \r
294  v, 20, 10)</p>\r
295 \r
296 <p class="whs1">torus2 = geompy.MakeTorusRR(30, \r
297  15)</p>\r
298 \r
299 <p>&nbsp;</p>\r
300 \r
301 <p># add objects in the study</p>\r
302 \r
303 <p class="whs1">id_torus1 = geompy.addToStudy(torus1,&quot;Torus1&quot;)</p>\r
304 \r
305 <p class="whs1">id_torus2 = geompy.addToStudy(torus2,&quot;Torus2&quot;)</p>\r
306 \r
307 <p>&nbsp;</p>\r
308 \r
309 <p># display toruses</p>\r
310 \r
311 <p class="whs1">gg.createAndDisplayGO(id_torus1)</p>\r
312 \r
313 <p class="whs1">gg.setDisplayMode(id_torus1,1)</p>\r
314 \r
315 <p class="whs1">gg.createAndDisplayGO(id_torus2)</p>\r
316 \r
317 <p><span style="font-family: 'Lucida Console', monospace;">gg.setDisplayMode(id_torus2,1)</span> \r
318  </p>\r
319 \r
320 <h3><a name=bookmark4>Creation of a Cone</a></h3>\r
321 \r
322 <p class="whs1">import geompy</p>\r
323 \r
324 <p class="whs1">import salome</p>\r
325 \r
326 <p class="whs1">gg = salome.ImportComponentGUI(&quot;GEOM&quot;)</p>\r
327 \r
328 <p>&nbsp;</p>\r
329 \r
330 <p># create a vertex and a vector</p>\r
331 \r
332 <p class="whs1">p1 = geompy.MakeVertex(35, \r
333  35, 0)</p>\r
334 \r
335 <p class="whs1">p2 = geompy.MakeVertex(35, \r
336  35, 70)</p>\r
337 \r
338 <p class="whs1">v = geompy.MakeVector(p1, \r
339  p2)</p>\r
340 \r
341 <p>&nbsp;</p>\r
342 \r
343 <p># create cones</p>\r
344 \r
345 <p class="whs1">cone1 = geompy.MakeCone(p1, \r
346  v, 17, 1, 20)</p>\r
347 \r
348 <p class="whs1">cone2 = geompy.MakeConeR1R2H(30, \r
349  10, 30)</p>\r
350 \r
351 <p>&nbsp;</p>\r
352 \r
353 <p># add objects in the study</p>\r
354 \r
355 <p class="whs1">id_cone1 = geompy.addToStudy(cone1,&quot;Cone1&quot;)</p>\r
356 \r
357 <p class="whs1">id_cone2 = geompy.addToStudy(cone2,&quot;Cone2&quot;)</p>\r
358 \r
359 <p>&nbsp;</p>\r
360 \r
361 <p># display cones</p>\r
362 \r
363 <p class="whs1">gg.createAndDisplayGO(id_cone1)</p>\r
364 \r
365 <p class="whs1">gg.setDisplayMode(id_cone1,1)</p>\r
366 \r
367 <p class="whs1">gg.createAndDisplayGO(id_cone2)</p>\r
368 \r
369 <p><span style="font-family: 'Lucida Console', monospace;">gg.setDisplayMode(id_cone2,1)</span> \r
370  </p>\r
371 \r
372 <script type="text/javascript" language="javascript1.2">\r
373 <!--\r
374 if (window.writeIntopicBar)\r
375         writeIntopicBar(0);\r
376 //-->\r
377 </script>\r
378 </body>\r
379 </html>\r