src/SketchPlugin/doc/offsetFeature.rst

   1 .. |offset.icon|    image:: images/offset.png
   2
   3 Offset
   4 ======
   5
   6 Offset operation offsets sketch entities on a given distance.
   7 Gaps are filled by arcs.
   8 Offset is performed outside a closed contour or to the right
   9 of an open one, unless the **Reversed** flag is not set.
  10
  11 To create an Offset in the active Sketch:
  12
  13 #. select in the Main Menu *Sketch - > Offset* item  or
  14 #. click |offset.icon| **Offset** button in Sketch toolbar:
  15
  16 Property panel:
  17
  18 .. image:: images/Offset_panel.png
  19   :align: center
  20
  21 .. centered::
  22    Offset
  23
  24 Input fields:
  25
  26 - **Edges** is the list of segments (lines, circles, arcs) selected in the view.
  27 - **Offset value** is the offset distance.
  28 - **Reversed** sets the reversed offset side (inside a closed contour or to the left of an open one).
  29
  30 Button:
  31
  32 - **Select wire** button adds edges connected by coincident boundary constraint
  33                   and composing a wire with the already selected segments.
  34                   Not more than 2 edges can be connected with one coincident point.
  35
  36 **TUI Command**:
  37
  38 .. py:function:: Sketch_1.addOffset(Objects, Distance, isReversed)
  39
  40     :param list: A list of objects.
  41     :param real: An offset distance.
  42     :param boolean: Reversed flag.
  43     :return: Result object.
  44
  45 Result
  46 """"""
  47
  48 Created Offset appears in the view.
  49
  50 | The original and the offset objects are marked with a special sign.
  51 | Offset object is drawn with a thinner line.
  52
  53 .. image:: images/Offset_res.png
  54            :align: center
  55
  56 .. centered::
  57    Offset created
  58
  59 **See Also** a sample TUI Script of :ref:`tui_create_offset` operation.