src/SketchPlugin/doc/circleFeature.rst

   1 .. |circle.icon|    image:: images/circle.png
   2
   3 Circle
   4 ======
   5
   6 The feature Circle creates a circle in the current Sketch.
   7
   8 To add a new Circle to the Sketch:
   9
  10 #. select in the Main Menu *Sketch - > Circle* item  or
  11 #. click |circle.icon| **Circle** button in Sketch toolbar:
  12
  13 There are 2 algorithms for creation of a Circle:
  14
  15 .. image:: images/circle_pt_rad_32x32.png
  16    :align: left
  17 **By center and passed point** creates a circle with the given center passing through the given point.
  18
  19 .. image:: images/circle_3pt_32x32.png
  20    :align: left
  21 **By three points** creates a circle passing through the given three points.
  22
  23 By center and passed point
  24 """"""""""""""""""""""""""
  25
  26 .. image:: images/Circle_panel_pt_rad.png
  27    :align: center
  28
  29 Click in the view once to set the center point, then move the mouse and click a second time to set the passed point.
  30
  31 - When entering a center point by selecting either a point or a segment, a Coincident constraint is created.
  32 - When entering a passing point by selecting a point, a Coincident constraint is also created.
  33 - When entering a passing point by selecting a segment, a Tangent constraint is created.
  34
  35 **TUI Command**:
  36
  37 .. py:function:: Sketch_1.addCircle(CenterX, CenterY, PassedX, PassedY)
  38
  39     :param real: Start X.
  40     :param real: Start Y.
  41     :param real: Passed X.
  42     :param real: Passed Y.
  43     :return: Result object.
  44
  45 By three points
  46 """""""""""""""
  47
  48 .. image:: images/Circle_panel_3pt.png
  49    :align: center
  50
  51 Click in the view once to set the first passed point, then move the mouse and click a second time to set the second passed point
  52 and finally move the mouse and click a third time to set the last passed point.
  53
  54 - When entering a passing point by selecting a point, a Coincident constraint is created.
  55 - When entering a passing point by selecting a segment, a Tangent constraint is created.
  56
  57 **TUI Command**:
  58
  59 .. py:function:: Sketch_1.addCircle(X1, Y1, X2, Y2, X3, Y3)
  60
  61     :param real: Start X.
  62     :param real: Start Y.
  63     :param real: Passed X.
  64     :param real: Passed Y.
  65     :param real: End X.
  66     :param real: End Y.
  67     :return: Result object.
  68
  69 Property panel in edition context
  70 """""""""""""""""""""""""""""""""
  71
  72 The following property panel appears when the user selects an existing circle.
  73
  74 .. image:: images/Circle_panel_edit.png
  75    :align: center
  76
  77 Note that the edition property panel does not show the used creation algorithm.
  78
  79 The panel shows:
  80
  81 - center coordinates and radius (read-only).
  82 - auxiliary flag (can be modified).
  83
  84 Result
  85 """"""
  86
  87 Created circle appears in the view.
  88
  89 .. image:: images/Circle_res.png
  90            :align: center
  91
  92 .. centered::
  93    Circle created
  94
  95 **See Also** a sample TUI Script of :ref:`tui_create_circle` operation.