Salome HOME
PAL12557: Documentation for scripts is not up to date.
[modules/geom.git] / doc / salome / gui / GEOM / sketcher.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>Sketcher</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 { border:none; float:none; width:30px; height:30px; border-style:none; }\r
18 p.whs2 { font-size:12pt; }\r
19 p.whs3 { margin-left:108px; font-size:12pt; }\r
20 ul.whs4 { list-style:disc; }\r
21 p.whs5 { margin-left:40px; font-size:12pt; }\r
22 img_whs6 { border:none; width:321px; height:496px; float:none; border-style:none; }\r
23 p.whs7 { font-size:12pt; margin-left:40px; text-indent:-40px; }\r
24 p.whs8 { font-size:12pt; margin-left:40px; text-indent:-40px; font-weight:bold; }\r
25 p.whs9 { font-size:12pt; text-indent:-40px; font-weight:bold; margin-left:80px; }\r
26 img_whs10 { border:none; width:200px; height:200px; border-style:none; }\r
27 -->\r
28 </style><script type="text/javascript" language="JavaScript">\r
29 <!--\r
30 if ((navigator.appName == "Netscape") && (parseInt(navigator.appVersion) == 4))\r
31 {\r
32   var strNSS = "<style type='text/css'>";\r
33   strNSS += "p.whs7 {text-indent:1pt; }";\r
34   strNSS += "p.whs8 {text-indent:1pt; }";\r
35   strNSS += "p.whs9 {text-indent:1pt; }";\r
36   strNSS +="</style>";\r
37   document.write(strNSS);\r
38 }\r
39 //-->\r
40 </script>\r
41 <script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">\r
42 <!--\r
43 function reDo() {\r
44   if (innerWidth != origWidth || innerHeight != origHeight)\r
45      location.reload();\r
46 }\r
47 if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {\r
48         origWidth = innerWidth;\r
49         origHeight = innerHeight;\r
50         onresize = reDo;\r
51 }\r
52 onerror = null; \r
53 //-->\r
54 </script>\r
55 <style type="text/css">\r
56 <!--\r
57 div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
58 p.WebHelpNavBar { text-align:right; }\r
59 -->\r
60 </style><script type="text/javascript" language="javascript1.2" src="whmsg.js"></script>\r
61 <script type="text/javascript" language="javascript" src="whver.js"></script>\r
62 <script type="text/javascript" language="javascript1.2" src="whproxy.js"></script>\r
63 <script type="text/javascript" language="javascript1.2" src="whutils.js"></script>\r
64 <script type="text/javascript" language="javascript1.2" src="whtopic.js"></script>\r
65 <script type="text/javascript" language="javascript1.2">\r
66 <!--\r
67 if (window.gbWhTopic)\r
68 {\r
69         if (window.setRelStartPage)\r
70         {\r
71         addTocInfo("Geometry module\nCreating geometrical objects\nSketcher");\r
72 addButton("show",BTN_IMG,"Show","","","","",0,0,"whd_show0.gif","whd_show2.gif","whd_show1.gif");\r
73 addButton("hide",BTN_IMG,"Hide","","","","",0,0,"whd_hide0.gif","whd_hide2.gif","whd_hide1.gif");\r
74 \r
75         }\r
76 \r
77 \r
78         if (window.setRelStartPage)\r
79         {\r
80         setRelStartPage("index.htm");\r
81 \r
82                 autoSync(1);\r
83                 sendSyncInfo();\r
84                 sendAveInfoOut();\r
85         }\r
86 \r
87 }\r
88 else\r
89         if (window.gbIE4)\r
90                 document.location.reload();\r
91 //-->\r
92 </script>\r
93 </head>\r
94 <body><script type="text/javascript" language="javascript1.2">\r
95 <!--\r
96 if (window.writeIntopicBar)\r
97         writeIntopicBar(4);\r
98 //-->\r
99 </script>\r
100 <h1>Sketcher</h1>\r
101 \r
102 <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"></b></font></span>Sketcher allows to create curves of 2 types: line \r
103  segment and arc. &nbsp;The \r
104  curve is created from the current point (center of coordinates when the \r
105  sketcher is started). &nbsp;The \r
106  end of the curve is defined by means of &quot;destination&quot;, which \r
107  can be a destination point (for segment only) or destination direction \r
108  coupled with length of a segment or angle and radius of an arc.</p>\r
109 \r
110 <p>&nbsp;</p>\r
111 \r
112 <p>Sketcher is able to create planar curves only. Therefore, it is necessary \r
113  to select a working plane before starting a sketch (by default, XOY plane \r
114  is used). Sketcher creates curves lying in the current working plane (New \r
115  Entity -&gt; Basic -&gt; Working Plane).</p>\r
116 \r
117 <p>&nbsp;</p>\r
118 \r
119 <p>This functionality is available from the main menu via <span style="font-style: italic;"><I>New \r
120  Entity / Sketch.</I></span></p>\r
121 \r
122 <p>&nbsp;</p>\r
123 \r
124 <p class="whs2"><b><span style="font-weight: normal;">T</span></b><b><span \r
125  style="font-weight: normal;">he</span> Result <span style="font-weight: normal;">of \r
126  the operation will be a</span></b><b> <span style="font-weight: bold;"><B>GEOM_Object</b>.</B></span></p>\r
127 \r
128 <p>&nbsp;</p>\r
129 \r
130 <p class="whs2"><b style="font-weight: bold;">TUI Command:</b><i> \r
131  </i><span style="font-style: italic;"><I>geompy.MakeSketcher(Command, WorkingPlane)</I></span></p>\r
132 \r
133 <p class="whs3">This algorithm creates \r
134  a sketcher (wire or face), following the textual description, passed through \r
135  the Command argument. The edges of the resulting wire or face will be \r
136  arcs of circles and/or linear segments.</p>\r
137 \r
138 <p class="whs3"><span style="font-style: italic;"><I>Command</I></span> \r
139  is a string, defining the sketcher by the coordinates of points in the \r
140  local working plane.</p>\r
141 \r
142 <p class="whs3"><span style="font-style: italic;"><I>WorkingPlane</I></span> \r
143  is a planar face of the working plane (a list of 9 doubles which are coordinates \r
144  of OZ and OX of the local working plane).</p>\r
145 \r
146 <p class="whs2">&nbsp;</p>\r
147 \r
148 <p class="whs2"><b style="font-weight: bold;">Arguments:</b> \r
149  </p>\r
150 \r
151 <p class="whs2"><span><font size=3 style="font-size:12pt;">1. Element type (segment or arc).</font></span></p>\r
152 \r
153 <p class="whs2">2. Destination type (point or direction).</p>\r
154 \r
155 <p class="whs2">3. <span>Destination point by means of:</span></p>\r
156 \r
157 <ul type="disc" class="whs4">\r
158         \r
159         <li class=kadov-p><p class="whs2">absolute coordinates \r
160  X,Y;</p></li>\r
161         \r
162         <li class=kadov-p><p class="whs2">relative coordinates \r
163  DX, DY (with respect to the current point);</p></li>\r
164         \r
165         <li class=kadov-p><p class="whs2">selection of an existing \r
166  point.</p></li>\r
167 </ul>\r
168 \r
169 <p class="whs2">4. Destination direction by means of:</p>\r
170 \r
171 <ul type="disc" class="whs4">\r
172         \r
173         <li class=kadov-p><p class="whs2">angle between the new \r
174  segment and the previous one;</p></li>\r
175         \r
176         <li class=kadov-p><p class="whs2">perpendicular to the \r
177  previous segment (same as previous, but angle is predefined and is equal \r
178  to 90 degrees);</p></li>\r
179         \r
180         <li class=kadov-p><p class="whs2">tangent to the previous \r
181  segment;</p></li>\r
182         \r
183         <li class=kadov-p><p class="whs2">vector components DX, \r
184  DY.</p></li>\r
185 </ul>\r
186 \r
187 <p class="whs2">5. Parameters of an element (for segment : \r
188  length or target X or Y coordinate value, for arc : radius and angle).</p>\r
189 \r
190 <p class="whs2">&nbsp;</p>\r
191 \r
192 <p class="whs2"><b style="font-weight: bold;">Dialog Box:</b></p>\r
193 \r
194 <p class="whs2">&nbsp;</p>\r
195 \r
196 <p class="whs5"><img src="pics/neo-scetcher1.png" x-maintain-ratio="TRUE" width="321px" height="496px" border="0" class="img_whs6"> &nbsp;&nbsp;<img src="pics/neo-scetcher2.png" x-maintain-ratio="TRUE" width="321px" height="496px" border="0" class="img_whs6"></p>\r
197 \r
198 <p class="whs7">&nbsp;</p>\r
199 \r
200 <p class="whs8">Example:</p>\r
201 \r
202 <p class="whs9">&nbsp;</p>\r
203 \r
204 <p class="whs9"><img src="image204.jpg" width="200px" height="200px" border="0" class="img_whs10"> &nbsp;&nbsp;<img src="image206.jpg" width="200px" height="200px" border="0" class="img_whs10"></p>\r
205 \r
206 <p class="whs9">&nbsp;</p>\r
207 \r
208 <p class="whs2">Our <span style="font-weight: bold;"><B>TUI Scripts</B></span> \r
209  provide you with useful examples of the use of <a href="sketcher_tui.htm">Sketcher</a>. \r
210  </p>\r
211 \r
212 <p>&nbsp;</p>\r
213 \r
214 <script type="text/javascript" language="javascript1.2">\r
215 <!--\r
216 if (window.writeIntopicBar)\r
217         writeIntopicBar(0);\r
218 //-->\r
219 </script>\r
220 </body>\r
221 </html>\r