Salome HOME
PAL12557: Documentation for scripts is not up to date.
[modules/geom.git] / doc / salome / gui / GEOM / point.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>Point</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-size:12pt; margin-left:40px; }\r
20 img_whs4 { border:none; width:312px; height:332px; float:none; border-style:none; }\r
21 img_whs5 { border:none; width:312px; height:473px; float:none; border-style:none; }\r
22 p.whs6 { font-size:12pt; margin-left:120px; }\r
23 p.whs7 { font-size:12pt; margin-left:0px; }\r
24 p.whs8 { font-size:12pt; font-style:italic; margin-left:0px; }\r
25 img_whs9 { border:none; width:312px; height:421px; float:none; border-style:none; }\r
26 p.whs10 { font-size:12pt; color:#000000; }\r
27 p.whs11 { color:#808080; font-size:12pt; }\r
28 img_whs12 { border:none; width:354px; height:326px; float:none; border-style:none; }\r
29 p.whs13 { color:#808080; font-size:12pt; margin-left:40px; }\r
30 -->\r
31 </style><script type="text/javascript" language="JavaScript">\r
32 <!--\r
33 if ((navigator.appName == "Netscape") && (parseInt(navigator.appVersion) == 4))\r
34 {\r
35   var strNSS = "<style type='text/css'>";\r
36   strNSS += "p.whs7 {margin-left:1pt; }";\r
37   strNSS += "p.whs8 {margin-left:1pt; }";\r
38   strNSS +="</style>";\r
39   document.write(strNSS);\r
40 }\r
41 //-->\r
42 </script>\r
43 <script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">\r
44 <!--\r
45 function reDo() {\r
46   if (innerWidth != origWidth || innerHeight != origHeight)\r
47      location.reload();\r
48 }\r
49 if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {\r
50         origWidth = innerWidth;\r
51         origHeight = innerHeight;\r
52         onresize = reDo;\r
53 }\r
54 onerror = null; \r
55 //-->\r
56 </script>\r
57 <style type="text/css">\r
58 <!--\r
59 div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
60 p.WebHelpNavBar { text-align:right; }\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 <script type="text/javascript" language="javascript1.2">\r
68 <!--\r
69 if (window.gbWhTopic)\r
70 {\r
71         if (window.setRelStartPage)\r
72         {\r
73         addTocInfo("Geometry module\nCreating geometrical objects\nCreating Basic Geometric Objects\nPoint");\r
74 addButton("show",BTN_IMG,"Show","","","","",0,0,"whd_show0.gif","whd_show2.gif","whd_show1.gif");\r
75 addButton("hide",BTN_IMG,"Hide","","","","",0,0,"whd_hide0.gif","whd_hide2.gif","whd_hide1.gif");\r
76 \r
77         }\r
78 \r
79 \r
80         if (window.setRelStartPage)\r
81         {\r
82         setRelStartPage("index.htm");\r
83 \r
84                 autoSync(1);\r
85                 sendSyncInfo();\r
86                 sendAveInfoOut();\r
87         }\r
88 \r
89 }\r
90 else\r
91         if (window.gbIE4)\r
92                 document.location.reload();\r
93 //-->\r
94 </script>\r
95 </head>\r
96 <body><script type="text/javascript" language="javascript1.2">\r
97 <!--\r
98 if (window.writeIntopicBar)\r
99         writeIntopicBar(4);\r
100 //-->\r
101 </script>\r
102 <h1><b style="font-weight: bold;"><span style="font-size: 14pt;"><font size=4 style="font-size:14pt;"><img src="files/salome2_sp3_basicgui_functions_salome2_sp3_basicgui_functions_image27.gif" width="20px" height="20px" border="0" class="img_whs1"> </font></span></b>Point</h1>\r
103 \r
104 <p>To create a <span style="font-weight: bold;"><B>Point</B></span> in the <span \r
105  style="font-weight: bold;"><B>Main Menu</B></span> select <span style="font-weight: bold;"><B>New \r
106  Entity - &gt; Basic - &gt; Point</B></span></p>\r
107 \r
108 <p>&nbsp;</p>\r
109 \r
110 <p>There are three algorithms to <span style="font-size: 12pt;"><font size=3 style="font-size:12pt;">create \r
111  a </font></span><span style="font-size: 12pt; font-weight: bold;"><font size=3 style="font-size:12pt;"><B>Point</B></font></span><span \r
112  style="font-size: 12pt;"><font size=3 style="font-size:12pt;"> in the 3D space.</font></span></p>\r
113 \r
114 <p class="whs2"><b style="font-weight: bold;"><span style="font-weight: normal;">Each \r
115  time the</span> Result <span style="font-weight: normal;">of the operation \r
116  will be a</span></b> GEOM_Object (vertex).</p>\r
117 \r
118 <p class="whs2">&nbsp;</p>\r
119 \r
120 <p class="whs2"><b style="font-weight: bold;"><span style="font-weight: normal;">Firstly, \r
121  we can define a point by setting its X, Y and Z </span><span style="font-weight: bold;"><B>C</B></span></b><b><span \r
122  style="font-weight: bold;"><B>oordinates</B></span><span style="font-weight: normal;">.</span> \r
123  </b></p>\r
124 \r
125 <p class="whs2"><b style="font-weight: bold;">TUI Command :</b> \r
126  &nbsp;&nbsp;<span style="font-style: italic;"><I>g</I></span>eompy.MakeVertex(X, \r
127  Y, Z) </p>\r
128 \r
129 <p class="whs2"><b style="font-weight: bold;">Arguments: </b>Name \r
130  <b><span style="font-weight: normal;">(Vertex_n by default) </span></b>+ \r
131  X, Y and Z coordinates of the point.</p>\r
132 \r
133 <p class="whs2">&nbsp;</p>\r
134 \r
135 <p class="whs3"><img src="pics/point1.png" x-maintain-ratio="TRUE" width="312px" height="332px" border="0" class="img_whs4"></p>\r
136 \r
137 <p class="whs2">&nbsp;</p>\r
138 \r
139 <p class="whs2">Secondly, &nbsp;we \r
140  can define a point by a <span style="font-weight: bold;"><B>Reference</B></span> \r
141  to another point and the shift of the coordinates of the new point regarding \r
142  the coordinates of the old one. </p>\r
143 \r
144 <p class="whs2"><b style="font-weight: bold;">TUI Command :</b> \r
145  &nbsp;&nbsp;<span style="font-style: italic;"><I>geompy.MakeVertexWithRef(Reference, \r
146  X, Y, Z).</I></span></p>\r
147 \r
148 <p class="whs2"><b style="font-weight: bold;">Arguments: </b>Name \r
149  + 1 reference point + 3 coordinates defining the position of this point \r
150  regarding the reference one.</p>\r
151 \r
152 <p class="whs2">&nbsp;</p>\r
153 \r
154 <p class="whs3"><span style="font-style: italic;"><I><img src="pics/neo-point2.png" x-maintain-ratio="TRUE" width="312px" height="473px" border="0" class="img_whs5"></I></span></p>\r
155 \r
156 <p class="whs6">&nbsp;</p>\r
157 \r
158 <p class="whs7">Finally, we can define a \r
159  point by an <span style="font-weight: bold;"><B>Edge</B></span> and a <span style="font-weight: bold;"><B>Parameter</B></span> \r
160  &nbsp;indicating \r
161  its position on the Edge. For example, 0.5 means that the point is located \r
162  in the middle of the edge.<span style="font-style: italic;"> <I></I></span></p>\r
163 \r
164 <p class="whs8"><span style="font-style: italic;"><I><b style="font-weight: bold; font-style: normal;">TUI \r
165  Command :</b> &nbsp;&nbsp;geompy.MakeVertexOnCurve(Edge, \r
166  Parameter).</I></span></p>\r
167 \r
168 <p class="whs2"><b style="font-weight: bold;">Arguments: N</b>ame \r
169  + 1 edge &nbsp;+ \r
170  1 Parameter defining the position of the point on the given edge.</p>\r
171 \r
172 <p class="whs2">&nbsp;</p>\r
173 \r
174 <p class="whs3"><span style="font-style: italic;"><I><b \r
175  style="font-weight: bold;"><img src="pics/point3.png" x-maintain-ratio="TRUE" width="312px" height="421px" border="0" class="img_whs9"></b></I></span></p>\r
176 \r
177 <p class="whs2">&nbsp;</p>\r
178 \r
179 <p class="whs10"><span style="font-style: italic;"><I><span \r
180  style="font-size: 12pt; color: #000000;"><font size=3 color=black style="font-size:12.000000pt;"><b style="font-weight: bold;"><b \r
181  style="font-weight: bold;">E</b>xample:</b></font></span></I></span></p>\r
182 \r
183 <p class="whs11">&nbsp;</p>\r
184 \r
185 <p class="whs3"><span style="font-style: italic;"><I><b \r
186  style="font-weight: bold;"><img src="pics/points.png" x-maintain-ratio="TRUE" width="354px" height="326px" border="0" class="img_whs12"></b></I></span></p>\r
187 \r
188 <p class="whs13">&nbsp;</p>\r
189 \r
190 <p class="whs2">Our <span style="font-weight: bold;"><B>TUI Scripts</B></span> \r
191  provide you with useful examples of creation of <a href="basic_geometrical_objects.htm#bookmark" style="font-style: normal;">Basic \r
192  Geometric Objects</a>. </p>\r
193 \r
194 <script type="text/javascript" language="javascript1.2">\r
195 <!--\r
196 if (window.writeIntopicBar)\r
197         writeIntopicBar(0);\r
198 //-->\r
199 </script>\r
200 </body>\r
201 </html>\r