Salome HOME
projects / modules / geom.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
PAL12557: Documentation for scripts is not up to date.
[modules/geom.git] / doc / salome / gui / GEOM / sketcher.htm
diff --git a/doc/salome/gui/GEOM/sketcher.htm b/doc/salome/gui/GEOM/sketcher.htm
index 9ffb2b5ffc228b87a3700e354ac5a3f467e313b7..1db40edfad5ad802c4ed51d132e4e6ac844545f8 100755 (executable)
--- a/doc/salome/gui/GEOM/sketcher.htm
+++ b/doc/salome/gui/GEOM/sketcher.htm
@@ -14,17 +14,16 @@ 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
+img_whs1 { border:none; float:none; width:30px; height:30px; border-style:none; }\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:none; width:200px; height:277px; border-style:none; }\r
-img_whs6 { border:none; width:200px; height:276px; border-style:none; }\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
-img_whs11 { border:none; width:200px; height:195px; border-style:none; }\r
 -->\r
 </style><script type="text/javascript" language="JavaScript">\r
 <!--\r
@@ -56,43 +55,48 @@ onerror = null;
 <style type="text/css">\r
 <!--\r
 div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
+p.WebHelpNavBar { text-align:right; }\r
 -->\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
-<body><script type="text/javascript" language="javascript1.2">\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.htm");\r
+       setRelStartPage("index.htm");\r
 \r
                autoSync(1);\r
                sendSyncInfo();\r
                sendAveInfoOut();\r
        }\r
+\r
 }\r
 else\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
 \r
 <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
@@ -117,20 +121,27 @@ 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 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;">Result:</b> GEOM_Object.</p>\r
+<p class="whs2"><b style="font-weight: bold;">TUI Command:</b><i> \r
+ </i><span style="font-style: italic;"><I>geompy.MakeSketcher(Command, WorkingPlane)</I></span></p>\r
 \r
-<p class="whs2">&nbsp;</p>\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="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
+<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
@@ -143,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
@@ -157,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
@@ -169,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
@@ -182,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
@@ -190,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
SALOME Geometry module

Copyright © 2005–2024 Open CASCADE.
All rights reserved.
Legal Information