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 .. figure:: images/Trim_panel.png
  18    :align: center
  19
  20    Trim
  21
  22 Input fields:
  23
  24 - **Segment** is used to select a segment to remove in the view.
  25
  26 The selected segment is highlighted in the view:
  27
  28 .. figure:: images/Trim_segment_sel.png
  29    :align: center
  30
  31    The segment to remove
  32
  33 **TUI Command**:
  34
  35 .. py:function:: Sketch_1.addTrim(Feature, PositionPoint)
  36
  37     :param object: Line, arc or circle.
  38     :param object: Position point.
  39     :return: Result object.
  40
  41 **Arguments**:   feature (line, arc or circle) and position point (a point on or closest to the segment to remove)
  42
  43 Result
  44 """"""
  45
  46 Created Trim appears in the view.
  47
  48 .. figure:: images/Trim_res.png
  49    :align: center
  50
  51    Created trim
  52
  53 **See Also** a sample TUI Script of :ref:`tui_create_trim` operation.