Salome HOME
Documentation: use 'figure' instead of 'image'; improve caption layout; fix warnings.
[modules/shaper.git] / src / SketchPlugin / doc / trimFeature.rst
index 8ed75213589fd7408755e3772912c62b84f50113..3f70db204f42361aa09f8247afa02029ba8b1e69 100644 (file)
@@ -1,10 +1,53 @@
+.. |trim.icon|    image:: images/Trim.png
 
 Trim
 ====
 
+| The Trim operation trims away the specified segment of the curve.
+| The curve should have points lying on it or intersections with other curves.
+| Open curves (line or arc) require one or more points; closed curves (circle) require two or more points.
 
-.. image:: images/Trim.png
-  :align: center
+To create a Trim in the active Sketch:
 
-.. centered::
-  Trim a line
+#. select in the Main Menu *Sketch - > Trim* item  or
+#. click |trim.icon| **Trim** button in Sketch toolbar:
+
+Property panel:
+
+.. figure:: images/Trim_panel.png
+   :align: center
+
+   Trim
+
+Input fields:
+
+- **Segment** is used to select a segment to remove in the view.
+
+The selected segment is highlighted in the view:
+
+.. figure:: images/Trim_segment_sel.png
+   :align: center
+
+   The segment to remove
+
+**TUI Command**:
+
+.. py:function:: Sketch_1.addTrim(Feature, PositionPoint)
+
+    :param object: Line, arc or circle.
+    :param object: Position point.
+    :return: Result object.
+
+**Arguments**:   feature (line, arc or circle) and position point (a point on or closest to the segment to remove)
+
+Result
+""""""
+
+Created Trim appears in the view.
+
+.. figure:: images/Trim_res.png
+   :align: center
+
+   Created trim
+
+**See Also** a sample TUI Script of :ref:`tui_create_trim` operation.