src/SketchPlugin/doc/arcFeature.rst

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