Salome HOME
PAL12557: Documentation for scripts is not up to date.
[modules/geom.git] / doc / salome / gui / GEOM / sketcher.htm
index 98a5508941e1f43627c18e54d183592c4a8b3915..1db40edfad5ad802c4ed51d132e4e6ac844545f8 100755 (executable)
@@ -2,31 +2,11 @@
 \r
 <html>\r
 \r
-<!--(==============================================================)-->\r
-<!--(Document created with RoboEditor. )============================-->\r
-<!--(==============================================================)-->\r
-\r
 <head>\r
-\r
 <title>Sketcher</title>\r
-\r
-<!--(Meta)==========================================================-->\r
-\r
-<meta http-equiv=content-type content="text/html; charset=windows-1252">\r
-<meta name=generator content="RoboHELP by eHelp Corporation - www.ehelp.com">\r
-<meta name=generator-major-version content=0.1>\r
-<meta name=generator-minor-version content=1>\r
-<meta name=filetype content=kadov>\r
-<meta name=filetype-version content=1>\r
-<meta name=page-count content=1>\r
-<meta name=layout-height content=1268>\r
-<meta name=layout-width content=740>\r
-\r
-\r
-<!--(Links)=========================================================-->\r
-\r
- <link rel='stylesheet' href='default_ns.css'>\r
-<script type="text/javascript" language="JavaScript" title="WebHelpSplitCss">\r
+<meta http-equiv="content-type" content="text/html; charset=windows-1252">\r
+<meta name="generator" content="RoboHelp by eHelp Corporation www.ehelp.com">\r
+<link rel="stylesheet" href="default_ns.css"><script type="text/javascript" language="JavaScript" title="WebHelpSplitCss">\r
 <!--\r
 if (navigator.appName !="Netscape")\r
 {   document.write("<link rel='stylesheet' href='default.css'>");}\r
@@ -34,27 +14,25 @@ if (navigator.appName !="Netscape")
 </script>\r
 <style type="text/css">\r
 <!--\r
-img_whs1 {border-style: none; border: none; float: none; width: 30px; height: 30px;}\r
-p.whs2 {font-size: 12pt;}\r
-ul.whs3 {list-style: disc;}\r
-p.whs4 {margin-left: 40px; font-size: 12pt;}\r
-img_whs5 {border-style: none; border: none; width: 200px; height: 277px;}\r
-img_whs6 {border-style: none; border: none; width: 200px; height: 276px;}\r
-p.whs7 {font-size: 12pt; margin-left: 40px; text-indent: -40px;}\r
-p.whs8 {font-size: 12pt; margin-left: 40px; text-indent: -40px; font-weight: bold;}\r
-p.whs9 {font-size: 12pt; text-indent: -40px; font-weight: bold; margin-left: 80px;}\r
-img_whs10 {border-style: none; border: none; width: 200px; height: 200px;}\r
-img_whs11 {border-style: none; border: none; width: 200px; height: 195px;}\r
+img_whs1 { border:none; float:none; width:30px; height:30px; border-style:none; }\r
+p.whs2 { font-size:12pt; }\r
+p.whs3 { margin-left:108px; font-size:12pt; }\r
+ul.whs4 { list-style:disc; }\r
+p.whs5 { margin-left:40px; font-size:12pt; }\r
+img_whs6 { border:none; width:321px; height:496px; float:none; border-style:none; }\r
+p.whs7 { font-size:12pt; margin-left:40px; text-indent:-40px; }\r
+p.whs8 { font-size:12pt; margin-left:40px; text-indent:-40px; font-weight:bold; }\r
+p.whs9 { font-size:12pt; text-indent:-40px; font-weight:bold; margin-left:80px; }\r
+img_whs10 { border:none; width:200px; height:200px; border-style:none; }\r
 -->\r
-</style>\r
-<script type="text/javascript" language="JavaScript">\r
+</style><script type="text/javascript" language="JavaScript">\r
 <!--\r
 if ((navigator.appName == "Netscape") && (parseInt(navigator.appVersion) == 4))\r
 {\r
   var strNSS = "<style type='text/css'>";\r
-  strNSS += "p.whs7 {text-indent:1; }";\r
-  strNSS += "p.whs8 {text-indent:1; }";\r
-  strNSS += "p.whs9 {text-indent:1; }";\r
+  strNSS += "p.whs7 {text-indent:1pt; }";\r
+  strNSS += "p.whs8 {text-indent:1pt; }";\r
+  strNSS += "p.whs9 {text-indent:1pt; }";\r
   strNSS +="</style>";\r
   document.write(strNSS);\r
 }\r
@@ -76,48 +54,47 @@ onerror = null;
 </script>\r
 <style type="text/css">\r
 <!--\r
-  div.WebHelpPopupMenu {position:absolute; left:0px; top:0px; z-index:4; visibility:hidden;}\r
+div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
+p.WebHelpNavBar { text-align:right; }\r
 -->\r
-</style>\r
-<script type="text/javascript" language="javascript1.2" src="whmsg.js"></script>\r
+</style><script type="text/javascript" language="javascript1.2" src="whmsg.js"></script>\r
 <script type="text/javascript" language="javascript" src="whver.js"></script>\r
 <script type="text/javascript" language="javascript1.2" src="whproxy.js"></script>\r
 <script type="text/javascript" language="javascript1.2" src="whutils.js"></script>\r
 <script type="text/javascript" language="javascript1.2" src="whtopic.js"></script>\r
-</head>\r
-\r
-<!--(Body)==========================================================-->\r
-\r
-\r
-<body>\r
-\r
 <script type="text/javascript" language="javascript1.2">\r
 <!--\r
 if (window.gbWhTopic)\r
 {\r
-       if (window.addTocInfo)\r
+       if (window.setRelStartPage)\r
        {\r
-       addTocInfo("GEOM module\nCreating geometrical objects\nSketcher");\r
-addButton("show",BTN_TEXT,"Show","","","","",0,0,"","","");\r
+       addTocInfo("Geometry module\nCreating geometrical objects\nSketcher");\r
+addButton("show",BTN_IMG,"Show","","","","",0,0,"whd_show0.gif","whd_show2.gif","whd_show1.gif");\r
+addButton("hide",BTN_IMG,"Hide","","","","",0,0,"whd_hide0.gif","whd_hide2.gif","whd_hide1.gif");\r
 \r
        }\r
-       if (window.writeBtnStyle)\r
-               writeBtnStyle();\r
 \r
-       if (window.writeIntopicBar)\r
-               writeIntopicBar(1);\r
 \r
        if (window.setRelStartPage)\r
        {\r
-       setRelStartPage("geom.html");\r
+       setRelStartPage("index.htm");\r
 \r
-               autoSync(0);\r
+               autoSync(1);\r
                sendSyncInfo();\r
                sendAveInfoOut();\r
        }\r
+\r
 }\r
 else\r
-       document.location.reload();\r
+       if (window.gbIE4)\r
+               document.location.reload();\r
+//-->\r
+</script>\r
+</head>\r
+<body><script type="text/javascript" language="javascript1.2">\r
+<!--\r
+if (window.writeIntopicBar)\r
+       writeIntopicBar(4);\r
 //-->\r
 </script>\r
 <h1>Sketcher</h1>\r
@@ -139,20 +116,32 @@ else
 \r
 <p>&nbsp;</p>\r
 \r
-<p class="whs2"><span style="font-size: 12pt;"><font size=3 style="font-size:12pt;"><b style="font-weight: bold;">Description:</b> \r
Creates curves (line segment and arc).</font></span></p>\r
+<p>This functionality is available from the main menu via <span style="font-style: italic;"><I>New \r
Entity / Sketch.</I></span></p>\r
 \r
-<p class="whs2">&nbsp;</p>\r
+<p>&nbsp;</p>\r
 \r
-<p class="whs2"><b style="font-weight: bold;">Result:</b> GEOM_Object.</p>\r
+<p class="whs2"><b><span style="font-weight: normal;">T</span></b><b><span \r
+ style="font-weight: normal;">he</span> Result <span style="font-weight: normal;">of \r
+ the operation will be a</span></b><b> <span style="font-weight: bold;"><B>GEOM_Object</b>.</B></span></p>\r
 \r
-<p class="whs2">&nbsp;</p>\r
+<p>&nbsp;</p>\r
 \r
 <p class="whs2"><b style="font-weight: bold;">TUI Command:</b><i> \r
- </i><span style="font-style: italic;"><I>geompy.MakeSketcher(Command, LWP)</I></span>, \r
- where Command is a string containing the coordinates of points in the \r
- local working plane, LWP is a list of 9 doubles which are coordinates \r
- of OZ and OX of the local working plane.</p>\r
+ </i><span style="font-style: italic;"><I>geompy.MakeSketcher(Command, WorkingPlane)</I></span></p>\r
+\r
+<p class="whs3">This algorithm creates \r
+ a sketcher (wire or face), following the textual description, passed through \r
+ the Command argument. The edges of the resulting wire or face will be \r
+ arcs of circles and/or linear segments.</p>\r
+\r
+<p class="whs3"><span style="font-style: italic;"><I>Command</I></span> \r
+ is a string, defining the sketcher by the coordinates of points in the \r
+ local working plane.</p>\r
+\r
+<p class="whs3"><span style="font-style: italic;"><I>WorkingPlane</I></span> \r
+ is a planar face of the working plane (a list of 9 doubles which are coordinates \r
+ of OZ and OX of the local working plane).</p>\r
 \r
 <p class="whs2">&nbsp;</p>\r
 \r
@@ -165,7 +154,7 @@ else
 \r
 <p class="whs2">3. <span>Destination point by means of:</span></p>\r
 \r
-<ul type="disc" class="whs3">\r
+<ul type="disc" class="whs4">\r
        \r
        <li class=kadov-p><p class="whs2">absolute coordinates \r
  X,Y;</p></li>\r
@@ -179,7 +168,7 @@ else
 \r
 <p class="whs2">4. Destination direction by means of:</p>\r
 \r
-<ul type="disc" class="whs3">\r
+<ul type="disc" class="whs4">\r
        \r
        <li class=kadov-p><p class="whs2">angle between the new \r
  segment and the previous one;</p></li>\r
@@ -191,7 +180,7 @@ else
        <li class=kadov-p><p class="whs2">tangent to the previous \r
  segment;</p></li>\r
        \r
-       <li class=kadov-p><p class="whs2">vector components VX, \r
+       <li class=kadov-p><p class="whs2">vector components DX, \r
  DY.</p></li>\r
 </ul>\r
 \r
@@ -204,7 +193,7 @@ else
 \r
 <p class="whs2">&nbsp;</p>\r
 \r
-<p class="whs4"><img src="image203.jpg" width="200px" height="277px" border="0" class="img_whs5"> &nbsp;&nbsp;<img src="image205.jpg" width="200px" height="276px" border="0" class="img_whs6"></p>\r
+<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
 \r
 <p class="whs7">&nbsp;</p>\r
 \r
@@ -212,7 +201,15 @@ else
 \r
 <p class="whs9">&nbsp;</p>\r
 \r
-<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="195px" border="0" class="img_whs11"></p>\r
+<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
+\r
+<p class="whs9">&nbsp;</p>\r
+\r
+<p class="whs2">Our <span style="font-weight: bold;"><B>TUI Scripts</B></span> \r
+ provide you with useful examples of the use of <a href="sketcher_tui.htm">Sketcher</a>. \r
+ </p>\r
+\r
+<p>&nbsp;</p>\r
 \r
 <script type="text/javascript" language="javascript1.2">\r
 <!--\r
@@ -221,5 +218,4 @@ if (window.writeIntopicBar)
 //-->\r
 </script>\r
 </body>\r
-\r
 </html>\r