Salome HOME
PAL12557: Documentation for scripts is not up to date.
[modules/geom.git] / doc / salome / gui / GEOM / box.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>Box</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 img_whs1 { width:20px; height:20px; border-style:none; }\r
18 p.whs2 { font-size:12pt; }\r
19 p.whs3 { font-style:italic; }\r
20 p.whs4 { margin-left:40px; }\r
21 img_whs5 { border:none; width:312px; height:324px; float:none; border-style:none; }\r
22 p.whs6 { font-weight:normal; }\r
23 p.whs7 { font-size:12pt; margin-left:40px; }\r
24 img_whs8 { border:none; width:312px; height:332px; float:none; border-style:none; }\r
25 p.whs9 { font-size:12pt; font-weight:bold; }\r
26 p.whs10 { font-size:12pt; font-weight:bold; font-style:normal; }\r
27 p.whs11 { font-size:12pt; font-style:normal; font-weight:bold; }\r
28 img_whs12 { border:none; width:267px; height:280px; float:none; border-style:none; }\r
29 -->\r
30 </style><script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">\r
31 <!--\r
32 function reDo() {\r
33   if (innerWidth != origWidth || innerHeight != origHeight)\r
34      location.reload();\r
35 }\r
36 if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {\r
37         origWidth = innerWidth;\r
38         origHeight = innerHeight;\r
39         onresize = reDo;\r
40 }\r
41 onerror = null; \r
42 //-->\r
43 </script>\r
44 <style type="text/css">\r
45 <!--\r
46 div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
47 p.WebHelpNavBar { text-align:right; }\r
48 -->\r
49 </style><script type="text/javascript" language="javascript1.2" src="whmsg.js"></script>\r
50 <script type="text/javascript" language="javascript" src="whver.js"></script>\r
51 <script type="text/javascript" language="javascript1.2" src="whproxy.js"></script>\r
52 <script type="text/javascript" language="javascript1.2" src="whutils.js"></script>\r
53 <script type="text/javascript" language="javascript1.2" src="whtopic.js"></script>\r
54 <script type="text/javascript" language="javascript1.2">\r
55 <!--\r
56 if (window.gbWhTopic)\r
57 {\r
58         if (window.setRelStartPage)\r
59         {\r
60         addTocInfo("Geometry module\nCreating geometrical objects\nCreating Primitives\nBox");\r
61 addButton("show",BTN_IMG,"Show","","","","",0,0,"whd_show0.gif","whd_show2.gif","whd_show1.gif");\r
62 addButton("hide",BTN_IMG,"Hide","","","","",0,0,"whd_hide0.gif","whd_hide2.gif","whd_hide1.gif");\r
63 \r
64         }\r
65 \r
66 \r
67         if (window.setRelStartPage)\r
68         {\r
69         setRelStartPage("index.htm");\r
70 \r
71                 autoSync(1);\r
72                 sendSyncInfo();\r
73                 sendAveInfoOut();\r
74         }\r
75 \r
76 }\r
77 else\r
78         if (window.gbIE4)\r
79                 document.location.reload();\r
80 //-->\r
81 </script>\r
82 </head>\r
83 <body><script type="text/javascript" language="javascript1.2">\r
84 <!--\r
85 if (window.writeIntopicBar)\r
86         writeIntopicBar(4);\r
87 //-->\r
88 </script>\r
89 <h1><span style="font-size: 14pt;"><font size=4 style="font-size:14pt;"><b style="font-weight: bold;"><img src="files/salome2_sp3_primitivegui_functions_salome2_sp3_primitivegui_functions_image99.gif" width="20px" height="20px" border="0" class="img_whs1"> </b></font></span>Box</h1>\r
90 \r
91 <p><b><span style="font-weight: normal;">T</b>o</span> create a <span style="font-weight: bold;"><B>Box</B></span> \r
92  in the <span style="font-weight: bold;"><B>Main Menu</B></span> select <span \r
93  style="font-weight: bold;"><B>New Entity - &gt; Primitives - &gt; Box</B></span></p>\r
94 \r
95 <p>&nbsp;</p>\r
96 \r
97 <p>There are 2 algorithms for creation of a <span style="font-weight: bold;"><B>Box</B></span>. \r
98  </p>\r
99 \r
100 <p class="whs2"><b style="font-weight: bold;"><span style="font-weight: normal;">The</span> \r
101  Result <span style="font-weight: normal;">of each operation will be a</span></b> \r
102  GEOM_Object (SOLID).</p>\r
103 \r
104 <p>&nbsp;</p>\r
105 \r
106 <p>Firstly, you can define a <span style="font-weight: bold;"><B>Box</B></span> \r
107  by two specified <span style="font-weight: bold;"><B>Vertices (</B></span>its \r
108  opposite corners), and with edges, parallel to the coordinate axes. </p>\r
109 \r
110 <p><span style="font-weight: bold;"><B><b style="font-weight: bold;">TUI Command \r
111  :</b> </B></span><span style="font-style: italic;"><I>geompy.MakeBoxTwoPnt(Point1, \r
112  Point2)</I></span></p>\r
113 \r
114 <p><b style="font-weight: bold;">Arguments: </b><span style="font-size: 12pt;"><font size=3 style="font-size:12pt;">Name \r
115  + </font></span>2 vertices (opposite corners of the box).</p>\r
116 \r
117 <p class="whs3">&nbsp;</p>\r
118 \r
119 <p class="whs4"><b style="font-weight: bold;"><img src="pics/box1.png" x-maintain-ratio="TRUE" width="312px" height="324px" border="0" class="img_whs5"></b></p>\r
120 \r
121 <p>&nbsp;</p>\r
122 \r
123 <p class="whs6"><b style="font-weight: normal;"><span style="font-weight: normal;">Secondly, \r
124  you can define a </span><span style="font-weight: bold;"><B>Box</B></span><span \r
125  style="font-weight: normal;"> by </b>specified dimensions along the coordinate \r
126  axes</span> and with edges, parallel to them. &nbsp;The \r
127  center of the box will be at point (DX/2, DY/2, DZ/2). </p>\r
128 \r
129 <p><span style="font-weight: bold;"><B><b style="font-weight: bold;">TUI Command \r
130  :</b> </B></span><span style="font-style: italic;"><I>geompy.MakeBoxDXDYDZ(DX, \r
131  DY, DZ)</I></span></p>\r
132 \r
133 <p><span><b style="font-weight: bold;">Arguments: </b></span><span style="font-size: 12pt;"><font size=3 style="font-size:12pt;">Name \r
134  + 3 values (dimensions at origin).</font></span></p>\r
135 \r
136 <p class="whs7"><b style="font-weight: bold;"><img src="pics/box2.png" x-maintain-ratio="TRUE" width="312px" height="332px" border="0" class="img_whs8"></b></p>\r
137 \r
138 <p>&nbsp;</p>\r
139 \r
140 <p><span style="font-size: 12pt; font-weight: bold;"><font size=3 style="font-size:12pt;"><B>NB! </B></font></span>There is \r
141  a third way to create a Box, which is currently accessible only via<span \r
142  style="font-size: 12pt; font-weight: bold;"><font size=3 style="font-size:12pt;"><B> TUI </B></font></span>commands.</p>\r
143 \r
144 <p class="whs9"><span style="font-weight: normal;">You \r
145  can define a </span>Box<span style="font-weight: normal;"> by the coordinates \r
146  of two </span>Vertices<span style="font-weight: normal;"> (in this way \r
147  you don't need to create them in advance). </span></p>\r
148 \r
149 <p class="whs10"><b style="font-weight: bold;">TUI Command:</b> \r
150  <span style="font-weight: normal; font-style: italic;"><I>geompy.MakeBox(x1,y1,z1,x2,y2,z2)</I></span> \r
151  </p>\r
152 \r
153 <span style="font-size: 12pt; font-weight: bold;"><font size=3 style="font-size:12pt;"><B>Arguments: </B></font></span>Name \r
154  + X, Y and Z coordinates of both points. \r
155 \r
156 <p>&nbsp;</p>\r
157 \r
158 <p class="whs11">Example:</p>\r
159 \r
160 <p class="whs7"><img src="pics/boxes.png" x-maintain-ratio="TRUE" width="267px" height="280px" border="0" class="img_whs12"></p>\r
161 \r
162 <p>&nbsp;</p>\r
163 \r
164 <p class="whs2">Our <span style="font-weight: bold;"><B>TUI Scripts</B></span> \r
165  provide you with useful examples of creation of <a href="primitives.htm#bookmark">Primitives</a>. \r
166  </p>\r
167 \r
168 <p>&nbsp;</p>\r
169 \r
170 <script type="text/javascript" language="javascript1.2">\r
171 <!--\r
172 if (window.writeIntopicBar)\r
173         writeIntopicBar(0);\r
174 //-->\r
175 </script>\r
176 </body>\r
177 </html>\r