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