Salome HOME
Merge with version on tag OCC-V2_1_0d
[modules/geom.git] / doc / salome / gui / GEOM / files / salome2_sp3_primitivegui_functions.htm
1 <!doctype HTML public "-//W3C//DTD HTML 4.0 Frameset//EN">\r
2 \r
3 <html>\r
4 \r
5 <!--(==============================================================)-->\r
6 <!--(Document created with RoboEditor. )============================-->\r
7 <!--(==============================================================)-->\r
8 \r
9 <head>\r
10 \r
11 <title>Titre</title>\r
12 \r
13 <!--(Meta)==========================================================-->\r
14 \r
15 <meta HTTP-EQUIV=Content-Type CONTENT="text/html; charset=windows-1252">\r
16 <meta NAME=subject CONTENT=Sujet>\r
17 <meta NAME=keywords CONTENT=Etude>\r
18 <meta NAME=Client CONTENT=Client>\r
19 <meta NAME=Department CONTENT="D&#1081;veloppements sp&#1081;cifiques open cascade">\r
20 <meta NAME=Division CONTENT="Une filiale EADS Matra Datavision">\r
21 <meta NAME=Owner CONTENT=OCC>\r
22 <meta NAME=Project CONTENT=ProjectRef>\r
23 <meta NAME=Folder CONTENT=FF>\r
24 <meta NAME=Study CONTENT=SSS>\r
25 <meta NAME=Reference CONTENT=Reference>\r
26 <meta name=generator content="RoboHELP by eHelp Corporation - www.ehelp.com">\r
27 <meta name=generator-major-version content=0.1>\r
28 <meta name=generator-minor-version content=1>\r
29 <meta name=filetype content=kadov>\r
30 <meta name=filetype-version content=1>\r
31 <meta name=page-count content=1>\r
32 <meta name=layout-height content=4081>\r
33 <meta name=layout-width content=491>\r
34 \r
35 \r
36 <!--(Links)=========================================================-->\r
37 \r
38  <link rel='stylesheet' href='../default_ns.css'>\r
39 <script type="text/javascript" language="JavaScript" title="WebHelpSplitCss">\r
40 <!--\r
41 if (navigator.appName !="Netscape")\r
42 {   document.write("<link rel='stylesheet' href='../default.css'>");}\r
43 //-->\r
44 </script>\r
45 <style type="text/css">\r
46 <!--\r
47 img_whs1 {border-style: none; border: none; float: none; width: 30px; height: 30px;}\r
48 ul.whs2 {list-style: disc;}\r
49 p.whs3 {margin-left: 40px;}\r
50 p.whs4 {font-size: 14pt;}\r
51 img_whs5 {border-style: none; width: 20px; height: 20px;}\r
52 img_whs6 {border-style: none; border: none; width: 200px; height: 175px;}\r
53 img_whs7 {border-style: none; border: none; width: 150px; height: 129px;}\r
54 p.whs8 {font-family: 'Times New Roman', serif; font-size: 14pt;}\r
55 img_whs9 {border-style: none; border: none; width: 200px; height: 211px;}\r
56 img_whs10 {border-style: none; border: none; width: 150px; height: 142px;}\r
57 img_whs11 {border-style: none; border: none; width: 200px; height: 166px;}\r
58 img_whs12 {border-style: none; border: none; width: 150px; height: 137px;}\r
59 p.whs13 {margin-left: 40px; font-weight: bold;}\r
60 img_whs14 {border-style: none; border: none; width: 150px; height: 96px;}\r
61 img_whs15 {border-style: none; border: none; width: 200px; height: 229px;}\r
62 p.whs16 {font-size: 12pt; margin-left: 40px;}\r
63 img_whs17 {border-style: none; border: none; width: 150px; height: 119px;}\r
64 -->\r
65 </style>\r
66 <script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">\r
67 <!--\r
68 function reDo() {\r
69   if (innerWidth != origWidth || innerHeight != origHeight)\r
70      location.reload();\r
71 }\r
72 if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {\r
73         origWidth = innerWidth;\r
74         origHeight = innerHeight;\r
75         onresize = reDo;\r
76 }\r
77 onerror = null; \r
78 //-->\r
79 </script>\r
80 <style type="text/css">\r
81 <!--\r
82   div.WebHelpPopupMenu {position:absolute; left:0px; top:0px; z-index:4; visibility:hidden;}\r
83 -->\r
84 </style>\r
85 <script type="text/javascript" language="javascript1.2" src="../whmsg.js"></script>\r
86 <script type="text/javascript" language="javascript" src="../whver.js"></script>\r
87 <script type="text/javascript" language="javascript1.2" src="../whproxy.js"></script>\r
88 <script type="text/javascript" language="javascript1.2" src="../whutils.js"></script>\r
89 <script type="text/javascript" language="javascript1.2" src="../whtopic.js"></script>\r
90 </head>\r
91 \r
92 <!--(Body)==========================================================-->\r
93 \r
94 \r
95 <body>\r
96 \r
97 <script type="text/javascript" language="javascript1.2">\r
98 <!--\r
99 if (window.gbWhTopic)\r
100 {\r
101         if (window.addTocInfo)\r
102         {\r
103         addTocInfo("GEOM module\nCreating geometrical objects\nConstructing primitives");\r
104 addButton("show",BTN_TEXT,"Show","","","","",0,0,"","","");\r
105 \r
106         }\r
107         if (window.writeBtnStyle)\r
108                 writeBtnStyle();\r
109 \r
110         if (window.writeIntopicBar)\r
111                 writeIntopicBar(1);\r
112 \r
113         if (window.setRelStartPage)\r
114         {\r
115         setRelStartPage("../geom.html");\r
116 \r
117                 autoSync(0);\r
118                 sendSyncInfo();\r
119                 sendAveInfoOut();\r
120         }\r
121 }\r
122 else\r
123         document.location.reload();\r
124 //-->\r
125 </script>\r
126 <h1>Constructing primitives</h1>\r
127 \r
128 <p><span style="font-size: 12pt;"><font size=3 style="font-size:12pt;"><b style="font-weight: bold;"><img src="../i_blue.jpg" x-maintain-ratio="TRUE" x-save-file="TRUE" x-save-method="compute-relative" width="30px" height="30px" border="0" class="img_whs1"> </font></span><span style="font-size: 12pt; font-weight: normal;"><font size=3 style="font-size:12pt;">In \r
129  GEOM you can create different types of primitive geometrical objects </font></span></b>(3D \r
130  elements):</p>\r
131 \r
132 <p>&nbsp;</p>\r
133 \r
134 <ul type="disc" class="whs2">\r
135         \r
136         <li class=kadov-p><p><a href="#box">Box</a></p></li>\r
137         \r
138         <li class=kadov-p><p><a href="#cylinder">Cylinder</a></p></li>\r
139         \r
140         <li class=kadov-p><p><a href="#sphere">Sphere</a></p></li>\r
141         \r
142         <li class=kadov-p><p><a href="#torus">Torus</a></p></li>\r
143         \r
144         <li class=kadov-p><p><a href="#cone">Cone</a></p></li>\r
145 </ul>\r
146 \r
147 <p>&nbsp;</p>\r
148 \r
149 <p class=TODO>To construct primitive geometrical objects:</p>\r
150 \r
151 <p class=TODO>&nbsp;</p>\r
152 \r
153 <p class="whs3">In the main menu select <span style="font-weight: bold;"><B>New \r
154  Entity &gt; Primitives</B></span><span>.</span></p>\r
155 \r
156 <p>&nbsp;</p>\r
157 \r
158 <p class="whs4"><b style="font-weight: bold;"><a NAME=box\r
159                                                                                                                         style="font-size: 14pt;"><img src="salome2_sp3_primitivegui_functions_salome2_sp3_primitivegui_functions_image99.gif" width="20px" height="20px" border="0" class="img_whs5"><font style="font-size: 14pt;"\r
160                                         size=4> Box</font></a></b></p>\r
161 \r
162 <p class="whs4">&nbsp;</p>\r
163 \r
164 <p><b style="font-weight: bold;">Description:</b> Creates a box.</p>\r
165 \r
166 <p>&nbsp;</p>\r
167 \r
168 <p><b style="font-weight: bold;">Result:</b> GEOM_Object (SOLID).</p>\r
169 \r
170 <p>&nbsp;</p>\r
171 \r
172 <p><b style="font-weight: bold;">TUI Command :</b> <span style="font-style: italic;"><I>geompy.MakeBox(X1, \r
173  Y1, Z1, X2, Y2, Z2)</I></span>, &nbsp;where \r
174  (X1, Y1, X2) and (X2, Y2, Z2) are coordinates of two points which define \r
175  a diagonal of the box.</p>\r
176 \r
177 <p>&nbsp;</p>\r
178 \r
179 <p><b style="font-weight: bold;">Arguments:</b></p>\r
180 \r
181 <ul type="disc" class="whs2">\r
182         \r
183         <li class=kadov-p><p><b style="font-weight: bold;"><span>1st Constructor \r
184  :</b> 2 vertices (opposite corners of the box).</span></p></li>\r
185         \r
186         <li class=kadov-p><p><b style="font-weight: bold;">2nd Constructor \r
187  :</b> 3 values (dimensions at origin).</p></li>\r
188 </ul>\r
189 \r
190 <p>&nbsp;</p>\r
191 \r
192 <p><b style="font-weight: bold;">Dialog Box:</b></p>\r
193 \r
194 <p>&nbsp;</p>\r
195 \r
196 <p class="whs3"><img src="../image99.jpg" width="200px" height="175px" border="0" class="img_whs6"> &nbsp;<img src="../image100.jpg" width="200px" height="175px" border="0" class="img_whs6"></p>\r
197 \r
198 <p>&nbsp;</p>\r
199 \r
200 <p><b style="font-weight: bold;">Example:</b></p>\r
201 \r
202 <p>&nbsp;</p>\r
203 \r
204 <p class="whs3"><img src="../image94.jpg" width="150px" height="129px" border="0" class="img_whs7"></p>\r
205 \r
206 <p>&nbsp;</p>\r
207 \r
208 <p>&nbsp;</p>\r
209 \r
210 <p class="whs8"><a NAME=cylinder\r
211         style="font-size: 14pt;"><img src="salome2_sp3_primitivegui_functions_salome2_sp3_primitivegui_functions_image100.gif" width="20px" height="20px" border="0" class="img_whs5"><b><font style="font-size: 14pt;"\r
212                                                                                                                 size=4> Cylinder</font></b></a></p>\r
213 \r
214 <p class="whs8">&nbsp;</p>\r
215 \r
216 <p><b style="font-weight: bold;">Description:</b> Creates a cylinder.</p>\r
217 \r
218 <p>&nbsp;</p>\r
219 \r
220 <p><b style="font-weight: bold;">Result:</b> GEOM_Object (solid).</p>\r
221 \r
222 <p>&nbsp;</p>\r
223 \r
224 <p><b style="font-weight: bold;">TUI Command:</b> <span style="font-style: italic;"><I>geompy.MakeCylinder(Point, \r
225  Axis, Radius, Height)</I></span>, where Point is a central point of the cylinder \r
226  base, Axis (vector value) is an axis of the cylinder, Radius and Height \r
227  are correspondingly a radius and a height of the cylinder.</p>\r
228 \r
229 <p>&nbsp;</p>\r
230 \r
231 <p><b style="font-weight: bold;">Arguments:</b></p>\r
232 \r
233 <ul type="disc" class="whs2">\r
234         \r
235         <li class=kadov-p><p><b style="font-weight: bold;"><span>1st Constructor:</b> \r
236  1 vertex + 1 edge + 2 values (Dimensions).</span></p></li>\r
237         \r
238         <li class=kadov-p><p><b style="font-weight: bold;"><span>2nd Constructor:</b> \r
239  2 values (Dimensions at origin).</span></p></li>\r
240 </ul>\r
241 \r
242 <p>&nbsp;</p>\r
243 \r
244 <p><b style="font-weight: bold;">Dialog Box:</b></p>\r
245 \r
246 <p>&nbsp;</p>\r
247 \r
248 <p class="whs3"><img src="../image101.jpg" width="200px" height="211px" border="0" class="img_whs9"> &nbsp;<img src="../image102.jpg" width="200px" height="211px" border="0" class="img_whs9"></p>\r
249 \r
250 <p>&nbsp;</p>\r
251 \r
252 <p><b style="font-weight: bold;">Example:</b></p>\r
253 \r
254 <p>&nbsp;</p>\r
255 \r
256 <p class="whs3"><img src="../image95.jpg" width="150px" height="142px" border="0" class="img_whs10"></p>\r
257 \r
258 <p class="whs3">&nbsp;</p>\r
259 \r
260 <p>&nbsp;</p>\r
261 \r
262 <p class="whs4"><a NAME=sphere\r
263                                                                 style="font-size: 14pt;"><img src="salome2_sp3_primitivegui_functions_salome2_sp3_primitivegui_functions_image101.gif" width="20px" height="20px" border="0" class="img_whs5"><b><font style="font-size: 14pt;"\r
264                                                 size=4> Sphere</font></b></a></p>\r
265 \r
266 <p class="whs4">&nbsp;</p>\r
267 \r
268 <p><b style="font-weight: bold;">Description:</b> Creates a sphere.</p>\r
269 \r
270 <p>&nbsp;</p>\r
271 \r
272 <p><b style="font-weight: bold;">Result:</b> GEOM_Object (solid).</p>\r
273 \r
274 <p>&nbsp;</p>\r
275 \r
276 <p><b style="font-weight: bold;">TUI Command:</b> <span style="font-style: italic;"><I>geompy.MakeSphere(Point, \r
277  Radius)</I></span>, where Point is a center of the sphere and Radius is a \r
278  radius of the sphere.</p>\r
279 \r
280 <p>&nbsp;</p>\r
281 \r
282 <p><b style="font-weight: bold;">Arguments:</b></p>\r
283 \r
284 <ul type="disc" class="whs2">\r
285         \r
286         <li class=kadov-p><p><b style="font-weight: bold;"><span>1st Constructor \r
287  :</b> 1 vertex + 1 value (Radius).</span></p></li>\r
288         \r
289         <li class=kadov-p><p><b style="font-weight: bold;"><span>2nd Constructor \r
290  :</b> 1 &nbsp;value \r
291  (Radius from the origin).</span></p></li>\r
292 </ul>\r
293 \r
294 <p>&nbsp;</p>\r
295 \r
296 <p><b style="font-weight: bold;">Dialog Box:</b></p>\r
297 \r
298 <p>&nbsp;</p>\r
299 \r
300 <p class="whs3"><img src="../image103.jpg" width="200px" height="166px" border="0" class="img_whs11"> &nbsp;<img src="../image104.jpg" width="200px" height="166px" border="0" class="img_whs11"></p>\r
301 \r
302 <p>&nbsp;</p>\r
303 \r
304 <p><b style="font-weight: bold;">Example:</b></p>\r
305 \r
306 <p>&nbsp;</p>\r
307 \r
308 <p class="whs3"><img src="../image96.jpg" width="150px" height="137px" border="0" class="img_whs12"></p>\r
309 \r
310 <p class="whs13">&nbsp;</p>\r
311 \r
312 <p>&nbsp;</p>\r
313 \r
314 <p class="whs4"><a NAME=torus\r
315                                                                 style="font-size: 14pt;"><img src="salome2_sp3_primitivegui_functions_salome2_sp3_primitivegui_functions_image102.gif" width="20px" height="20px" border="0" class="img_whs5"><b><font style="font-size: 14pt;"\r
316                                                 size=4> Torus</font></b></a></p>\r
317 \r
318 <p class="whs4">&nbsp;</p>\r
319 \r
320 <p><b style="font-weight: bold;">Description:</b> Creates a torus.</p>\r
321 \r
322 <p>&nbsp;</p>\r
323 \r
324 <p><b style="font-weight: bold;">Result:</b> GEOM_Object (solid).</p>\r
325 \r
326 <p>&nbsp;</p>\r
327 \r
328 <p><b style="font-weight: bold;">TUI Command:</b> <span style="font-style: italic;"><I>geompy.MakeTorus(Point, \r
329  Vector, RadiusMajor, RadiusMinor)</I></span>, where Point is a central point \r
330  of the torus, Vector is an axis of symmetry, RadiusMajor and RadiusMinor \r
331  &nbsp;are correspondingly \r
332  a major and minor radiuses of the torus.</p>\r
333 \r
334 <p>&nbsp;</p>\r
335 \r
336 <p><b style="font-weight: bold;">Arguments:</b></p>\r
337 \r
338 <ul type="disc" class="whs2">\r
339         \r
340         <li class=kadov-p><p><b style="font-weight: bold;"><span>1st Constructor:</b> \r
341  1 vertex + 1 edge (for direction) + 2 values (1 &amp; 2 Radius).</span></p></li>\r
342         \r
343         <li class=kadov-p><p><b style="font-weight: bold;">2nd Constructor:</b> \r
344  2 values (1 &amp; 2 Radius from the origin).</p></li>\r
345 </ul>\r
346 \r
347 <p>&nbsp;</p>\r
348 \r
349 <p><b style="font-weight: bold;">Dialog Box:</b></p>\r
350 \r
351 <p>&nbsp;</p>\r
352 \r
353 <p class="whs3"><img src="../image105.jpg" width="200px" height="211px" border="0" class="img_whs9"> &nbsp;<img src="../image106.jpg" width="200px" height="211px" border="0" class="img_whs9"></p>\r
354 \r
355 <p>&nbsp;</p>\r
356 \r
357 <p><b style="font-weight: bold;">Example:</b></p>\r
358 \r
359 <p class="whs3">&nbsp;</p>\r
360 \r
361 <p class="whs3"><img src="../image97.jpg" width="150px" height="96px" border="0" class="img_whs14"></p>\r
362 \r
363 <p>&nbsp;</p>\r
364 \r
365 <p>&nbsp;</p>\r
366 \r
367 <p class="whs4"><a NAME=cone\r
368                                                                 style="font-size: 14pt;"><img src="salome2_sp3_primitivegui_functions_salome2_sp3_primitivegui_functions_image103.gif" width="20px" height="20px" border="0" class="img_whs5"><b><font style="font-size: 14pt;"\r
369                                                 size=4> Cone</font></b></a></p>\r
370 \r
371 <p class="whs4">&nbsp;</p>\r
372 \r
373 <p><b style="font-weight: bold;">Description:</b> Creates a cone.</p>\r
374 \r
375 <p>&nbsp;</p>\r
376 \r
377 <p><b style="font-weight: bold;">Result:</b> GEOM_Object (SOLID).</p>\r
378 \r
379 <p>&nbsp;</p>\r
380 \r
381 <p><b style="font-weight: bold;">TUI Command:</b> <span style="font-style: italic;"><I>geompy.MakeCone(Point, \r
382  Axis, Radius1, Radius2)</I></span>, where Point is a central point of the \r
383  cone base, Axis (vector value) is an axis of the cone, Radius1 and Radius2 \r
384  are correspondingly the first and the second radiuses of the cone</p>\r
385 \r
386 <p>&nbsp;</p>\r
387 \r
388 <p><b style="font-weight: bold;">Arguments:</b></p>\r
389 \r
390 <ul type="disc" class="whs2">\r
391         \r
392         <li class=kadov-p><p><b style="font-weight: bold;"><span>1st Constructor:</b> \r
393  1 vertex + 1 edge (for direction) + 3 values (Radius of the base part, \r
394  radius of the upper part, height).</span></p></li>\r
395         \r
396         <li class=kadov-p><p><b style="font-weight: bold;">2nd Constructor:</b> \r
397  3 values (Radius of the base part, radius of the upper part, height).</p></li>\r
398 </ul>\r
399 \r
400 <p>&nbsp;</p>\r
401 \r
402 <p><b style="font-weight: bold;">Dialog Box:</b></p>\r
403 \r
404 <p>&nbsp;</p>\r
405 \r
406 <p class="whs3"><img src="../image107.jpg" width="200px" height="229px" border="0" class="img_whs15"> &nbsp;<img src="../image108.jpg" width="200px" height="229px" border="0" class="img_whs15"></p>\r
407 \r
408 <p>&nbsp;</p>\r
409 \r
410 <p><b style="font-weight: bold;">Example:</b></p>\r
411 \r
412 <p>&nbsp;</p>\r
413 \r
414 <p class="whs16"><img src="../image98.jpg" width="150px" height="119px" border="0" class="img_whs17"></p>\r
415 \r
416 <script type="text/javascript" language="javascript1.2">\r
417 <!--\r
418 if (window.writeIntopicBar)\r
419         writeIntopicBar(0);\r
420 //-->\r
421 </script>\r
422 </body>\r
423 \r
424 </html>\r