src/SketchPlugin/doc/middleFeature.rst

   1 .. |middlepoint.icon|    image:: images/MiddlePoint.png
   2
   3 Middle point constraint
   4 =======================
   5
   6 Middle point constraint forces a point to middle of a line.
   7
   8 To create a Middle point in the active Sketch:
   9
  10 #. select in the Main Menu *Sketch - > Middle point* item  or
  11 #. click |middlepoint.icon| **Middle point** button in Sketch toolbar:
  12
  13 There are 2 algorithms for creation of a middle constraint:
  14
  15 .. figure:: images/MiddlePoint.png
  16    :align: left
  17    :height: 24px
  18
  19 **By object and point** create a middle constraint by object (segment or arc) and point
  20
  21 .. figure:: images/MiddlePoint_obj.png
  22    :align: left
  23    :height: 24px
  24
  25 **By object** create a middle point on the object (segment or arc)
  26
  27 -------------------------------------------------------------------------------------------
  28
  29 By object and point
  30 """"""""""""""""""""""""""
  31 Property panel:
  32
  33 .. figure:: images/Middlepoint_obj_point_panel.png
  34    :align: center
  35
  36 Input fields:
  37
  38 - **First object** is a point or a line selected in the view.
  39 - **Second object** is a point or a line selected in the view.
  40
  41 Note that one of two objects should be a line and the other a point (i.e. a point, a line or an arc end point, a center of a circle or an arc).
  42
  43 | After the objects are selected, the point is moved to the middle of the line.
  44 | The middle points are marked with a special sign.
  45
  46 **TUI Command**:
  47
  48 .. py:function:: Sketch_1.setMiddlePoint(Point, Line)
  49
  50     :param object: A point.
  51     :param object: A line.
  52     :return: Result object.
  53
  54 Result
  55 """"""
  56
  57 Created Middle point constraint appears in the view.
  58
  59 .. figure:: images/Middlepoint_obj_point_res.png
  60    :align: center
  61
  62    Created middle point constraint
  63
  64 By object
  65 """"""""""""""""""""""""""
  66 Property panel:
  67
  68 .. figure:: images/Middlepoint_obj_panel.png
  69    :align: center
  70
  71 Input fields:
  72
  73 - **Object** is a line selected in the view.
  74
  75 | After the object are selected, will be created auxiliary point on the middle of the line.
  76 | The middle points are marked with a special sign.
  77
  78 **TUI Command**:
  79
  80 .. py:function:: SketchPoint_1 = Sketch_1.setMiddlePoint(Line)
  81
  82     :param object: A line.
  83     :return: Created middle point.
  84
  85 Result
  86 """"""
  87
  88 Created Middle point constraint appears in the view.
  89
  90 .. figure:: images/Middlepoint_obj_res.png
  91    :align: center
  92
  93    Created middle point constraint
  94
  95 **See Also** a sample TUI Script of :ref:`tui_create_middle` operation.