]> SALOME platform Git repositories - modules/geom.git/blob - doc/salome/gui/GEOM/files/salome2_sp3_measuregui_functions.htm
Salome HOME
Merge with OCC-V2_1_0_deb
[modules/geom.git] / doc / salome / gui / GEOM / files / salome2_sp3_measuregui_functions.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>Titre</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>\r
16 <!--\r
17 A:visited { color:#800080; }\r
18 A:link { color:#0000ff; }\r
19 -->\r
20 </style><style type="text/css">\r
21 <!--\r
22 p.whs1 { font-size:12pt; }\r
23 img_whs2 { border-style:none; border:none; float:none; width:30px; height:30px; }\r
24 p.whs3 { margin-left:40px; }\r
25 img_whs4 { border-style:none; border:none; width:21px; height:19px; }\r
26 p.whs5 { font-size:12pt; margin-left:40px; font-weight:bold; }\r
27 img_whs6 { border:none; width:216px; height:250px; }\r
28 p.whs7 { font-family:'Times New Roman' , serif; font-size:14pt; }\r
29 img_whs8 { border-style:none; width:20px; height:20px; }\r
30 p.whs9 { font-family:'Times New Roman' , serif; font-size:12pt; }\r
31 img_whs10 { border:none; width:283px; height:250px; }\r
32 p.whs11 { font-size:12pt; margin-left:40px; }\r
33 img_whs12 { border:none; width:199px; height:250px; }\r
34 p.whs13 { font-size:12pt; margin-left:400px; }\r
35 img_whs14 { border:none; width:256px; height:250px; }\r
36 p.whs15 { font-size:12pt; font-weight:bold; }\r
37 img_whs16 { border:none; width:263px; height:250px; }\r
38 p.whs17 { font-size:12pt; font-weight:normal; }\r
39 img_whs18 { border:none; width:310px; height:250px; }\r
40 img_whs19 { border:none; width:262px; height:250px; }\r
41 img_whs20 { border:none; width:268px; height:250px; }\r
42 img_whs21 { border:none; width:266px; height:250px; }\r
43 -->\r
44 </style><script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">\r
45 <!--\r
46 function reDo() {\r
47   if (innerWidth != origWidth || innerHeight != origHeight)\r
48      location.reload();\r
49 }\r
50 if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {\r
51         origWidth = innerWidth;\r
52         origHeight = innerHeight;\r
53         onresize = reDo;\r
54 }\r
55 onerror = null; \r
56 //-->\r
57 </script>\r
58 <style type="text/css">\r
59 <!--\r
60 div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
61 -->\r
62 </style><script type="text/javascript" language="javascript1.2" src="../whmsg.js"></script>\r
63 <script type="text/javascript" language="javascript" src="../whver.js"></script>\r
64 <script type="text/javascript" language="javascript1.2" src="../whproxy.js"></script>\r
65 <script type="text/javascript" language="javascript1.2" src="../whutils.js"></script>\r
66 <script type="text/javascript" language="javascript1.2" src="../whtopic.js"></script>\r
67 </head>\r
68 <body><script type="text/javascript" language="javascript1.2">\r
69 <!--\r
70 if (window.gbWhTopic)\r
71 {\r
72         if (window.addTocInfo)\r
73         {\r
74         addTocInfo("GEOM module\nUsing measurement tools");\r
75 addButton("show",BTN_TEXT,"Show","","","","",0,0,"","","");\r
76 \r
77         }\r
78         if (window.writeBtnStyle)\r
79                 writeBtnStyle();\r
80 \r
81         if (window.writeIntopicBar)\r
82                 writeIntopicBar(1);\r
83 \r
84         if (window.setRelStartPage)\r
85         {\r
86         setRelStartPage("../geom.htm");\r
87 \r
88                 autoSync(1);\r
89                 sendSyncInfo();\r
90                 sendAveInfoOut();\r
91         }\r
92 }\r
93 else\r
94         if (window.gbIE4)\r
95                 document.location.reload();\r
96 //-->\r
97 </script>\r
98 <h1>Using measurement tools</h1>\r
99 \r
100 <p class="whs1"><b style="font-weight: normal;"><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_whs2">Measurement tools in GEOM are necessary for getting</b> different \r
101  data concerning created or imported geometrical objects. They are:</p>\r
102 \r
103 <p class="whs1">&nbsp;</p>\r
104 \r
105 <ul>\r
106         \r
107         <li class=kadov-p><p class="whs1"><a href="#PointCoord">Point \r
108  coordinates</a></p></li>\r
109         \r
110         <li class=kadov-p><p class="whs1"><a href="#Basic_properties">Basic \r
111  properties</a></p></li>\r
112         \r
113         <li class=kadov-p><p class="whs1"><a href="#Center_gravity">Center \r
114  of mass</a></p></li>\r
115         \r
116         <li class=kadov-p><p class="whs1"><a href="#Inertia_axis">Inertia</a></p></li>\r
117         \r
118         <li class=kadov-p><p class="whs1"><a href="#Bounding_box">Bounding \r
119  box</a></p></li>\r
120         \r
121         <li class=kadov-p><p class="whs1"><a href="#Min_distance">Min. \r
122  distance</a></p></li>\r
123         \r
124         <li class=kadov-p><p class="whs1"><a href="#Tolerance">Tolerance</a></p></li>\r
125         \r
126         <li class=kadov-p><p class="whs1"><a href="#Whatis">WhatIs</a></p></li>\r
127         \r
128         <li class=kadov-p><p class="whs1"><a href="#check">Check</a></p></li>\r
129 </ul>\r
130 \r
131 <p class="whs1">&nbsp;</p>\r
132 \r
133 <p class=TODO>To use measurement tools:</p>\r
134 \r
135 <p class=TODO>&nbsp;</p>\r
136 \r
137 <p class="whs3">In the main menu select <span style="font-weight: bold;"><B>Measures \r
138  </B></span>submenu.</p>\r
139 \r
140 <p class="whs3">&nbsp;</p>\r
141 \r
142 <p class="whs1">&nbsp;</p>\r
143 \r
144 <p class="whs1"><a name=PointCoord>&nbsp;<img src="../image49.gif" width="21px" height="19px" border="0" class="img_whs4"> <span style="font-weight: bold; font-size: 14pt;"><font size=4 style="font-size:14pt;"><B>Point coordinates</B></font></span></a></p>\r
145 \r
146 <p class="whs1">&nbsp;</p>\r
147 \r
148 <p class="whs1"><span style="font-size: 12pt;"><font size=3 style="font-size:12pt;"><b style="font-weight: bold;">Description:</b> \r
149  Returns the coordinates of a point.</font></span></p>\r
150 \r
151 <p class="whs1">&nbsp;</p>\r
152 \r
153 <p class="whs1"><b style="font-weight: bold;">Result:</b> Point \r
154  coordinates (X, Y, Z) in 3D space in the form of Python Tuple.</p>\r
155 \r
156 <p class="whs1">&nbsp;</p>\r
157 \r
158 <p class="whs1"><span style="font-weight: bold;"><B>TUI command:</B></span> \r
159  <span style="font-style: italic;"><I>geompy.PointCoordinates(Point)</I></span>, \r
160  where Point is a point whose coordinates are inquired.</p>\r
161 \r
162 <p class="whs1">&nbsp;</p>\r
163 \r
164 <p class="whs1">&nbsp;</p>\r
165 \r
166 <p class="whs1"><b style="font-weight: bold;">Arguments:</b> \r
167  1 point.</p>\r
168 \r
169 <p class="whs1">&nbsp;</p>\r
170 \r
171 <p class="whs1"><b style="font-weight: bold;">Dialog Box:</b></p>\r
172 \r
173 <p class="whs1">&nbsp;</p>\r
174 \r
175 <p class="whs5"><img src="../image292.jpg" width="216px" height="250px" border="0" class="img_whs6"></p>\r
176 \r
177 <p class="whs1">&nbsp;</p>\r
178 \r
179 <p class="whs1">&nbsp;</p>\r
180 \r
181 <p class="whs7"><b style="font-weight: bold;"><a \r
182  NAME=Basic_properties\r
183         style="font-size: 14pt;"><img src="salome2_sp3_measuregui_functions_salome2_sp3_measuregui_functions_image71.gif" width="20px" height="20px" border="0" class="img_whs8"> Basic properties</a></b> \r
184  </p>\r
185 \r
186 <p class="whs9">&nbsp;</p>\r
187 \r
188 <p class="whs1"><b style="font-weight: bold;">Description:</b> \r
189  Return the properties (Length, Surface &amp; Volume) of a definite geometrical \r
190  object.</p>\r
191 \r
192 <p class="whs1">&nbsp;</p>\r
193 \r
194 <p class="whs1"><b style="font-weight: bold;">Result:</b> Display \r
195  Length, Surface &amp; Volume in the form of Python Tuple.</p>\r
196 \r
197 <p class="whs1">&nbsp;</p>\r
198 \r
199 <p class="whs1"><span style="font-weight: bold;"><B>TUI command:</B></span> \r
200  <span style="font-style: italic;"><I>geompy.BasicProperties(Shape)</I></span>, \r
201  where Shape is a shape whose properties are inquired.</p>\r
202 \r
203 <p class="whs1">&nbsp;</p>\r
204 \r
205 <p class="whs1"><b style="font-weight: bold;">Arguments:</b> \r
206  1 shape.</p>\r
207 \r
208 <p class="whs1">&nbsp;</p>\r
209 \r
210 <p class="whs1"><b style="font-weight: bold;">Dialog Box:</b></p>\r
211 \r
212 <p class="whs1">&nbsp;</p>\r
213 \r
214 <p class="whs3"><img src="../image293.jpg" width="283px" height="250px" border="0" class="img_whs10"></p>\r
215 \r
216 <p>&nbsp;</p>\r
217 \r
218 <p>&nbsp;</p>\r
219 \r
220 <p class="whs7"><a name=Center_gravity\r
221         style="font-size: 14pt;"><img src="salome2_sp3_measuregui_functions_salome2_sp3_measuregui_functions_image72.gif" width="20px" height="20px" border="0" class="img_whs8"><b style="font-size: 14pt;"> \r
222  Center of mass</b></a></p>\r
223 \r
224 <p class="whs9">&nbsp;</p>\r
225 \r
226 <p class="whs1"><b style="font-weight: bold;">Description:</b> \r
227  Creates a gravity center of a shape and returns its coordinates.</p>\r
228 \r
229 <p class="whs1">&nbsp;</p>\r
230 \r
231 <p class="whs1"><b style="font-weight: bold;">Result:</b> GEOM_Object \r
232  (vertex).</p>\r
233 \r
234 <p class="whs1">&nbsp;</p>\r
235 \r
236 <p class="whs1"><b style="font-weight: bold;">TUI Command:</b><i> \r
237  </i><span style="font-style: italic;"><I>geompy.MakeCDG(Shape)</I></span>, where \r
238  Shape is the shape for which a center of gravity is computed.</p>\r
239 \r
240 <p class="whs1">&nbsp;</p>\r
241 \r
242 <p class="whs1"><b style="font-weight: bold;">Arguments:</b> \r
243  1 shape.</p>\r
244 \r
245 <p class="whs1">&nbsp;</p>\r
246 \r
247 <p class="whs1"><b style="font-weight: bold;">Dialog Box:</b></p>\r
248 \r
249 <p class="whs1">&nbsp;</p>\r
250 \r
251 <p class="whs11"><img src="../image294.jpg" width="199px" height="250px" border="0" class="img_whs12"></p>\r
252 \r
253 <p class="whs1">&nbsp;</p>\r
254 \r
255 <p class="whs7">&nbsp;</p>\r
256 \r
257 <p class="whs7"><a NAME=Inertia_axis\r
258         style="font-size: 14pt;"><img src="salome2_sp3_measuregui_functions_salome2_sp3_measuregui_functions_image73.gif" width="20px" height="20px" border="0" class="img_whs8"><b><font style="font-size: 14pt;"\r
259                                                                                                                 size=4> Inertia</font></b></a> \r
260  </p>\r
261 \r
262 <p class="whs7">&nbsp;</p>\r
263 \r
264 <p class="whs1"><b style="font-weight: bold;">Description:</b> \r
265  Returns the inertia axis of a geometrical object.</p>\r
266 \r
267 <p class="whs1">&nbsp;</p>\r
268 \r
269 <p class="whs1"><b style="font-weight: bold;">Result:</b> Display \r
270  the matrix and moments of inretia in the form of Python Tuple (I11, I12, \r
271  I13, </p>\r
272 \r
273 <p class="whs13">&nbsp;I21, \r
274  I22, I23, </p>\r
275 \r
276 <p class="whs13">&nbsp;I31, \r
277  I32, I33,</p>\r
278 \r
279 <p class="whs13"><span style="font-size: 12pt;"><font size=3 style="font-size:12pt;">&nbsp;Ix, \r
280  Iy, Iz)</font></span>.</p>\r
281 \r
282 <p class="whs1">&nbsp;</p>\r
283 \r
284 <p class="whs1"><span style="font-weight: bold;"><B>TUI command:</B></span> \r
285  <span style="font-style: italic;"><I>geompy.Inertia(Shape)</I></span>, where \r
286  Shape is a shape for which a matrix of inertia and moment of inertia are \r
287  returned.</p>\r
288 \r
289 <p class="whs1">&nbsp;</p>\r
290 \r
291 <p class="whs1"><b style="font-weight: bold;">Arguments:</b> \r
292  1 shape.</p>\r
293 \r
294 <p class="whs1">&nbsp;</p>\r
295 \r
296 <p class="whs1"><b style="font-weight: bold;">Dialog Box:</b></p>\r
297 \r
298 <p class="whs11">&nbsp;</p>\r
299 \r
300 <p class="whs11"><img src="../image295.jpg" width="256px" height="250px" border="0" class="img_whs14"></p>\r
301 \r
302 <p class="whs1">&nbsp;</p>\r
303 \r
304 <p class="whs1">&nbsp;</p>\r
305 \r
306 <p class="whs7"><a NAME=Bounding_box\r
307         style="font-size: 14pt;"><img src="salome2_sp3_measuregui_functions_salome2_sp3_measuregui_functions_image74.gif" width="20px" height="20px" border="0" class="img_whs8"><b><font style="font-size: 14pt;"\r
308                                                                                                                 size=4> Bounding \r
309  box</font></b></a> </p>\r
310 \r
311 <p class="whs7">&nbsp;</p>\r
312 \r
313 <p class="whs1"><b style="font-weight: bold;">Description:</b> \r
314  Returns the dimensions of the bounding box of a geometrical object.</p>\r
315 \r
316 <p class="whs1">&nbsp;</p>\r
317 \r
318 <p class="whs1"><b style="font-weight: bold;">Result:</b> Displays \r
319  the dimensions of the bounding box of a geometrical object in the form \r
320  of Python Tuple (Xmin, Xmax, Ymin, Ymax, Zmin, Zmax).</p>\r
321 \r
322 <p class="whs1">&nbsp;</p>\r
323 \r
324 <p class="whs15">TUI command: <span style="font-weight: normal; font-style: italic;"><I>geompy.BoundingBox(Shape)</I></span><span \r
325  style="font-weight: normal;">, where Shape is a shape for which a bounding \r
326  box is computed.</span></p>\r
327 \r
328 <p class="whs1">&nbsp;</p>\r
329 \r
330 <p class="whs1"><b style="font-weight: bold;">Arguments:</b> \r
331  1 shape.</p>\r
332 \r
333 <p class="whs1">&nbsp;</p>\r
334 \r
335 <p class="whs1"><b style="font-weight: bold;">Dialog Box:</b></p>\r
336 \r
337 <p class="whs1">&nbsp;</p>\r
338 \r
339 <p class="whs11"><img src="../image296.jpg" width="263px" height="250px" border="0" class="img_whs16"></p>\r
340 \r
341 <p class="whs1">&nbsp;</p>\r
342 \r
343 <p class="whs1">&nbsp;</p>\r
344 \r
345 <p class="whs7"><a NAME=Min_distance\r
346         style="font-size: 14pt;"><img src="salome2_sp3_measuregui_functions_salome2_sp3_measuregui_functions_image75.gif" width="20px" height="20px" border="0" class="img_whs8"><b><font style="font-size: 14pt;"\r
347                                                                                                                 size=4> Min. distance</font></b></a></p>\r
348 \r
349 <p class="whs7">&nbsp;</p>\r
350 \r
351 <p class="whs1"><b style="font-weight: bold;">Description:</b> \r
352  Returns the min. distance between 2 geometrical objects.</p>\r
353 \r
354 <p class="whs1">&nbsp;</p>\r
355 \r
356 <p class="whs1"><b style="font-weight: bold;">Result:</b> Displays \r
357  the min. distance.</p>\r
358 \r
359 <p class="whs1">&nbsp;</p>\r
360 \r
361 <p class="whs15">TUI command: <span style="font-weight: normal; font-style: italic;"><I>geompy.MinDistance(Shape1, \r
362  Shape2)</I></span><span style="font-weight: normal;">, where Shape1 and Shape2 \r
363  are shapes between which the minimal distance computed.</span></p>\r
364 \r
365 <p class="whs17">&nbsp;</p>\r
366 \r
367 <p class="whs1"><b style="font-weight: bold;">Arguments:</b> \r
368  2 shapes.</p>\r
369 \r
370 <p class="whs1">&nbsp;</p>\r
371 \r
372 <p class="whs1"><b style="font-weight: bold;">Dialog Box:</b></p>\r
373 \r
374 <p class="whs1">&nbsp;</p>\r
375 \r
376 <p class="whs11"><img src="../image297.jpg" width="310px" height="250px" border="0" class="img_whs18"></p>\r
377 \r
378 <p class="whs1">&nbsp;</p>\r
379 \r
380 <p class="whs1">&nbsp;</p>\r
381 \r
382 <p class="whs7"><a NAME=Tolerance\r
383         style="font-size: 14pt;"><img src="salome2_sp3_measuregui_functions_salome2_sp3_measuregui_functions_image76.gif" width="20px" height="20px" border="0" class="img_whs8"><b style="font-size: 14pt;"> \r
384  Tolerance</b></a> </p>\r
385 \r
386 <p class="whs9">&nbsp;</p>\r
387 \r
388 <p class="whs1"><b style="font-weight: bold;">Description:</b> \r
389  Returns the tolerance of a geometrical object.</p>\r
390 \r
391 <p class="whs1">&nbsp;</p>\r
392 \r
393 <p class="whs1"><b style="font-weight: bold;">Result:</b> Displays \r
394  the tolerance values (FaceMinTol, FaceMaxTol, EgdeMinTol, EgdeMaxTol, \r
395  VertexMinTol, VertexMaxTol).</p>\r
396 \r
397 <p class="whs1">&nbsp;</p>\r
398 \r
399 <p class="whs15">TUI command: <span style="font-weight: normal; font-style: italic;"><I>geompy.Tolerance(Shape)</I></span><span \r
400  style="font-weight: normal;">, where Shape is a shape for which minimal \r
401  and maximal tolerances are returned.</span></p>\r
402 \r
403 <p class="whs1">&nbsp;</p>\r
404 \r
405 <p class="whs1"><b style="font-weight: bold;">Arguments:</b> \r
406  1 shape.</p>\r
407 \r
408 <p class="whs1">&nbsp;</p>\r
409 \r
410 <p class="whs1"><b style="font-weight: bold;">Dialog Box:</b></p>\r
411 \r
412 <p class="whs1">&nbsp;</p>\r
413 \r
414 <p class="whs11"><img src="../image298.jpg" width="262px" height="250px" border="0" class="img_whs19"></p>\r
415 \r
416 <p class="whs1">&nbsp;</p>\r
417 \r
418 <p class="whs1">&nbsp;</p>\r
419 \r
420 <p class="whs7"><a NAME=Whatis><span \r
421  style="font-size: 14pt;"><font size=4 style="font-size:14pt;"><img src="salome2_sp3_measuregui_functions_salome2_sp3_measuregui_functions_image77.gif" width="20px" height="20px" border="0" class="img_whs8"><b style="font-size: 14pt;"> WhatIs</b></a> \r
422  </font></span></p>\r
423 \r
424 <p class="whs9">&nbsp;</p>\r
425 \r
426 <p class="whs1"><b style="font-weight: bold;">Description:</b> \r
427  Returns the type of a geometrical object.</p>\r
428 \r
429 <p class="whs1">&nbsp;</p>\r
430 \r
431 <p class="whs1"><b style="font-weight: bold;">Result:</b> Displays \r
432  all elements composing your geometrical object.</p>\r
433 \r
434 <p class="whs1">&nbsp;</p>\r
435 \r
436 <p class="whs1"><span style="font-weight: bold;"><B>TUI command:</B></span> \r
437  <span style="font-style: italic;"><I>geompy.WhatIs(Shape)</I></span>, where Shape \r
438  is a shape from which a description is returned.</p>\r
439 \r
440 <p class="whs1">&nbsp;</p>\r
441 \r
442 <p class="whs1"><b style="font-weight: bold;">Arguments:</b> \r
443  1 shape.</p>\r
444 \r
445 <p class="whs1">&nbsp;</p>\r
446 \r
447 <p class="whs1"><b style="font-weight: bold;">Dialog Box:</b></p>\r
448 \r
449 <p class="whs1">&nbsp;</p>\r
450 \r
451 <p class="whs11"><img src="../image299.jpg" width="268px" height="250px" border="0" class="img_whs20"></p>\r
452 \r
453 <p class="whs11">&nbsp;</p>\r
454 \r
455 <p class="whs11">&nbsp;</p>\r
456 \r
457 <p class="whs7"><a NAME=check\r
458         style="font-size: 14pt;"><img src="salome2_sp3_measuregui_functions_salome2_sp3_measuregui_functions_image78.gif" width="20px" height="20px" border="0" class="img_whs8"><b><font style="font-size: 14pt;"\r
459                                                                                                                 size=4> Check</font></b></a> \r
460  </p>\r
461 \r
462 <p class="whs7">&nbsp;</p>\r
463 \r
464 <p class="whs1"><b style="font-weight: bold;">Description:</b> \r
465  Return True if this geometrical object is valid.</p>\r
466 \r
467 <p class="whs1">&nbsp;</p>\r
468 \r
469 <p class="whs1"><b style="font-weight: bold;">Result:</b> Boolean.</p>\r
470 \r
471 <p class="whs1">&nbsp;</p>\r
472 \r
473 <p class="whs1"><b style="font-weight: bold;">TUI Command:</b><i> \r
474  </i><span style="font-style: italic;"><I>geompy.CheckShape(Shape)</I></span>, \r
475  where is shape which is checked for validity.</p>\r
476 \r
477 <p class="whs1">&nbsp;</p>\r
478 \r
479 <p class="whs1"><b style="font-weight: bold;">Arguments:</b> \r
480  1 shape.</p>\r
481 \r
482 <p class="whs1">&nbsp;</p>\r
483 \r
484 <p class="whs1"><b style="font-weight: bold;">Dialog Box:</b></p>\r
485 \r
486 <p class="whs1">&nbsp;</p>\r
487 \r
488 <p class="whs11"><img src="../image300.jpg" width="266px" height="250px" border="0" class="img_whs21"></p>\r
489 \r
490 <p class="whs11">&nbsp;</p>\r
491 \r
492 <script type="text/javascript" language="javascript1.2">\r
493 <!--\r
494 if (window.writeIntopicBar)\r
495         writeIntopicBar(0);\r
496 //-->\r
497 </script>\r
498 </body>\r
499 </html>\r