doc/salome/gui/GEOM/input/creating_sketcher.doc

   1 /*!
   2
   3 \page create_sketcher_page Sketcher
   4
   5 Sketcher allows to create curves of 2 types: line segment and arc.
   6 By default the start point of the curve is located at the point of
   7 origin of the reference coordinate system and the curve lies in the
   8 plane XOY.  The end of the curve is defined by
   9 means of "destination", which can be a destination point (for segment
  10 only) or destination direction coupled with length of a segment or
  11 angle and radius of an arc.
  12
  13 \n Sketcher is able to create planar curves only. Therefore, it is
  14 necessary to select a working plane before starting a sketch (by
  15 default, XOY plane is used). Sketcher creates curves lying in the
  16 current working plane (New Entity -> Basic -> Working Plane).
  17
  18 \n This functionality is available from the main menu via <em>New
  19 Entity / Sketch</em>.
  20
  21 \n The Result of the operation will be a \b GEOM_Object.
  22
  23 \n <b>TUI Command:</b> <em>geompy.MakeSketcher(Command, WorkingPlane)</em>
  24 \n This algorithm creates a sketcher (wire or face), following the
  25 textual description, passed through the Command argument. The edges of
  26 the resulting wire or face will be arcs of circles and/or linear
  27 segments.
  28 \n \em Command is a string, defining the sketcher by the coordinates of
  29 points in the local working plane.
  30 \n <em>WorkingPlane</em> can be a plane or a planar face. The plane is
  31 defined by the XYZ coordinates of three non-coincident points. The
  32 planar face is an existing GEOM_Object.
  33
  34 \n <b>Arguments:</b>
  35 <ol>
  36 <li>Element type (segment or arc).</li>
  37 <li>Destination type (point or direction).</li>
  38 <li>Destination point by means of:</li>
  39 <ul>
  40 <li>absolute coordinates X,Y;</li>
  41 <li>relative coordinates DX, DY (with respect to the current point);</li>
  42 <li>selection of an existing point.</li>
  43 </ul>
  44 <li>Destination direction by means of:</li>
  45 <ul>
  46 <li>angle between the new segment and the previous one;</li>
  47 <li>perpendicular to the previous segment (same as previous, but angle
  48 is predefined and is equal to 90 degrees);</li>
  49 <li>tangent to the previous segment;</li>
  50 <li>vector components DX, DY.</li>
  51 </ul>
  52 <li>Parameters of an element (for segment : length or target X or Y coordinate value, for arc : radius and angle).</li>
  53 </ol>
  54
  55 \b Buttons:
  56
  57 <b>"Sketch Validation"</b> button applies the wire, only red part will be built by "Sketch Validation".
  58 \n <b>"Sketch Closure"</b> will close the Sketch by straight line from last red part and apply it.
  59
  60 \n <b>Dialog Box:</b>
  61
  62 \image html neo-scetcher1.png
  63
  64 \image html neo-scetcher2.png
  65
  66 \n <b>Example:</b>
  67
  68 \image html image204.jpg "Creation of a circle with sketcher"
  69
  70 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  71 \ref tui_sketcher_page "Sketcher".
  72
  73 */