src/SketchPlugin/doc/trimFeature.rst

   1 .. |trim.icon|    image:: images/Trim.png
   2
   3 Trim
   4 ====
   5
   6 | The Trim operation trims away the specified segment of the curve.
   7 | The curve should have points lying on it or intersections with other curves.
   8 | Open curves (line or arc) require one or more points; closed curves (circle) require two or more points.
   9
  10 To create a Trim in the active Sketch:
  11
  12 #. select in the Main Menu *Sketch - > Trim* item  or
  13 #. click |trim.icon| **Trim** button in Sketch toolbar:
  14
  15 Property panel:
  16
  17 .. image:: images/Trim_panel.png
  18   :align: center
  19
  20 .. centered::
  21    Trim
  22
  23 Input fields:
  24
  25 - **Segment** is used to select a segment to remove in the view.
  26
  27 The selected segment is highlighted in the view:
  28
  29 .. image:: images/Trim_segment_sel.png
  30    :align: center
  31
  32 .. centered::
  33    The segment to remove
  34
  35 **TUI Command**:
  36
  37 .. py:function:: Sketch_1.addTrim(Feature, PositionPoint)
  38
  39     :param object: Line, arc or circle.
  40     :param object: Position point.
  41     :return: Result object.
  42
  43 **Arguments**:   feature (line, arc or circle) and position point (a point on or closest to the segment to remove)
  44
  45 Result
  46 """"""
  47
  48 Created Trim appears in the view.
  49
  50 .. image:: images/Trim_res.png
  51            :align: center
  52
  53 .. centered::
  54    Created trim
  55
  56 **See Also** a sample TUI Script of :ref:`tui_create_trim` operation.