src/SketchPlugin/doc/circleFeature.rst

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