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 (coupled with a radius
  10 or a center for an arc) or a destination direction coupled with length
  11 of a segment or angle and radius of an arc.
  12
  13 \n <b>Warning:</b> When constructing an arc by its center and destination point,
  14 the constraint on the center is first taken into account. Therefore
  15 if the constraints are incompatible the destination point <b> won't lie
  16 on the constructed arc</b> (a warning message will be displayed).
  17
  18 \n Sketcher is able to create planar curves only. Therefore, it is
  19 necessary to select coordinate system (Global or Local) before starting
  20 a sketch. Sketcher creates curves lying in the XOY plane of the selected Coordinate System.
  21
  22 \n This functionality is available from the main menu via <em>New
  23 Entity / Sketch</em>.
  24
  25 \n The Result of the operation will be a \b GEOM_Object.
  26
  27 \n <b>TUI Command:</b> <em>geompy.MakeSketcher(Command, WorkingPlane)</em>
  28 \n This algorithm creates a sketcher (wire or face), following the
  29 textual description, passed through the Command argument. The edges of
  30 the resulting wire or face will be arcs of circles and/or linear
  31 segments.
  32 \n \em Command is a string, defining the sketcher by the coordinates of
  33 points in the current LCS.
  34 \n <em>WorkingPlane</em> can be a Local CS, a plane, or a planar face. The plane is
  35 defined by the XYZ coordinates of three non-coincident points. The
  36 planar face is an existing GEOM_Object.
  37
  38 \n <b>Arguments:</b>
  39 <ol>
  40 <li>Coordinate system (Local or Global CS can be selected)</li>
  41 <li>Element type (segment or arc).</li>
  42 <li>Destination type (point or direction).</li>
  43 <li>Destination point by means of:</li>
  44 <ul>
  45 <li>absolute coordinates X,Y;</li>
  46 <li>relative coordinates DX, DY (with respect to the current point);</li>
  47 <li>selection of an existing point.</li>
  48 </ul>
  49 <li>Destination direction by means of:</li>
  50 <ul>
  51 <li>angle between the new segment and the previous one;</li>
  52 <li>perpendicular to the previous segment (same as previous, but angle
  53 is predefined and is equal to 90 degrees);</li>
  54 <li>tangent to the previous segment;</li>
  55 <li>vector components DX, DY.</li>
  56 </ul>
  57 <li>Parameters of an element (for segment : length or target X or Y coordinate value, for arc : radius, angle or center coordinates).</li>
  58 </ol>
  59
  60 \b Buttons:
  61
  62 <b>"Restore"</b> button orientates the viewer correspondingly to the chosen working plane and fits the scene to show all its objects.
  63 \n <b>"Sketch Validation"</b> button applies the wire, only red part will be built by "Sketch Validation".
  64 \n <b>"Sketch Closure"</b> will close the Sketch by straight line from last red part and apply it.
  65
  66 \n <b>Dialog Box:</b>
  67
  68 \image html neo-scetcher1.png
  69 <br>
  70 \image html neo-scetcher2.png
  71
  72 \n <b>Example:</b>
  73
  74 \image html image204.png "Creation of a circle with sketcher"
  75
  76 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  77 \ref tui_sketcher_page "Sketcher".
  78
  79 */