src/SketchPlugin/doc/arcFeature.rst

   1
   2 Arc
   3 ===
   4
   5 Arc feature creates an arc segment in the current Sketch.
   6
   7 To add a new Arc to the Sketch:
   8
   9 #. select in the Main Menu *Sketch - > Arc* item  or
  10 #. click **Arc** button in Sketch toolbar:
  11
  12 .. image:: images/arc.png
  13    :align: center
  14
  15 .. centered::
  16    **Arc**  button
  17
  18 There are 3 algorithms for creation of an Arc:
  19
  20 .. image:: images/arc_base_32x32.png
  21    :align: left
  22 **By center and two points** creates an arc segment with the given center passing from the start point to the end point on the circle.
  23
  24 .. image:: images/arc_3pt_32x32.png
  25    :align: left
  26 **By three points** creates an arc segment passing from the start point to end point through another point on the circle.
  27
  28 .. image:: images/arc_tang_32x32.png
  29    :align: left
  30 **By tangent point and end point** creates an arc segment with the tangent point and the end point.
  31
  32 By center and two points
  33 """"""""""""""""""""""""
  34
  35 .. image:: images/Arc_panel_base.png
  36    :align: center
  37
  38 Click in the view once to set the center point, then move the mouse and click a second time to set the start point
  39 and finally move the mouse and click a third time to set the last passed point.
  40
  41 - When entering a center or start point by selecting either a point or a segment, a Coincident constraint is created.
  42 - When entering an end point by selecting a segment, a Coincident constraint is created.
  43 - When entering an end point, only segments are selectable.
  44
  45 **TUI Command**:  *Sketch_1.addArc(CenterX, CenterY, StartX, StartY, EndX, EndY, Inversed)*
  46
  47 **Arguments**:    7 values (coordinates of the center, the start, the end, inversed flag (if true - build arc from end to start)).
  48
  49 By three points
  50 """""""""""""""
  51
  52 .. image:: images/Arc_panel_3pt.png
  53    :align: center
  54
  55 Click in the view once to set the start point, then move the mouse and click a second time to set the end point
  56 and finally move the mouse and click a third time to set the passed point.
  57
  58 - When entering a start or end point by selecting either a point or a segment, a Coincident constraint is created.
  59 - When entering a passing point by selecting a point, a Coincident constraint is created.
  60 - When entering a passing point by selecting a segment, a Tangent constraint is created.
  61
  62 **TUI Command**:  *Sketch_1.addArc(StartX, StartY, EndX, EndY, PassedX, PassedY)*
  63
  64 **Arguments**:    6 values (coordinates of the start, end and passed points).
  65
  66 By tangent point and point
  67 """"""""""""""""""""""""""
  68
  69 .. image:: images/Arc_panel_tang.png
  70    :align: center
  71
  72 Select a point on segment in the view to set the tangent point, then move the mouse and click to set the end point.
  73 The tangent point by itself is a start point. The edge on which it lies will be tangent to the arc.
  74
  75 - When entering a tangent point by selecting a point on segment, a Tangent constraint is created.
  76 - When entering an end point by selecting a segment, a Coincident constraint is created.
  77 - When entering an end point, only segments are selectable.
  78
  79 **TUI Command**:  *Sketch_1.addArc(TangetPoint, EndX, EndY, Inversed)*
  80
  81 **Arguments**:    4 values (reference to tangent point, coordinates of end point, inversed flag (if true - build arc from end to start)).
  82
  83 Result
  84 """"""
  85
  86 Created arc appears in the view.
  87
  88 .. image:: images/Arc_res.png
  89            :align: center
  90
  91 .. centered::
  92    Circle created
  93
  94 **See Also** a sample TUI Script of :ref:`tui_create_arc` operation.