Salome HOME
Merge branch 'master' into V9_3_BR
[modules/shaper.git] / src / SketchPlugin / doc / trimFeature.rst
index 8ed75213589fd7408755e3772912c62b84f50113..ee096cca49552038e13dc8c4bd5d6bdceea4d357 100644 (file)
@@ -2,9 +2,54 @@
 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
+To create a Trim in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Trim* item  or
+#. click **Trim** button in Sketch toolbar:
+
+.. image:: images/trim.png
+   :align: center
+
+.. centered::
+   **Trim**  button
+
+Property panel:
+
+.. image:: images/Trim_panel.png
   :align: center
 
 .. centered::
-  Trim a line
+   Trim
+
+Input fields:
+
+- **Segment** is used to select a segment to remove in the view.
+
+The selected segment is highlighted in the view:
+
+.. image:: images/Trim_segment_sel.png
+   :align: center
+
+.. centered::
+   The segment to remove
+
+**TUI Command**: *Sketch_1.addTrim(Feature, PositionPoint)*
+
+**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.
+
+.. image:: images/Trim_res.png
+          :align: center
+
+.. centered::
+   Created trim
+
+**See Also** a sample TUI Script of :ref:`tui_create_trim` operation.