src/SketchPlugin/doc/rectangleFeature.rst

   1   .. _create_sketch_rectangle:
   2
   3 Rectangle
   4 =========
   5
   6 Rectangle feature creates a rectangle by two opposite points in the current Sketch.
   7
   8 The result is represented in form of four Lines which compose a rectangle.
   9 Two lines have Vertical constraint and two others have Horizontal constraint.
  10
  11 To add a new Rectangle to the Sketch:
  12
  13 #. select in the Main Menu *Sketch - > Rectangle* item  or
  14 #. click **Rectangle** button in Sketch toolbar:
  15
  16 .. image:: images/rectangle.png
  17    :align: center
  18
  19 .. centered::
  20    **Rectangle**  button
  21
  22 The following property panel appears:
  23
  24 .. image:: images/Rectangle_panel.png
  25   :align: center
  26
  27 .. centered::
  28    Rectangle
  29
  30 Click in the view once to set the first corner, then move the mouse and click a second time to set the opposite corner.
  31 If an existing object is clicked, a constraint for the point will be created automatically.
  32
  33 Start and end points coordinates are displayed in the property panel.
  34
  35 **TUI Command**:  *Sketch_1.addRectangle(X1, Y1, X2, Y2)*
  36
  37 **Arguments**:    4 values (coordinates of the start and end points).
  38
  39 Result
  40 """"""
  41
  42 Created rectangle appears in the view.
  43
  44 .. image:: images/Rectangle_res.png
  45            :align: center
  46
  47 .. centered::
  48    Rectangle created
  49
  50 **See Also** a sample TUI Script of :ref:`tui_create_rectangle` operation.