Salome HOME
Correct documentation bugs, adapt for 'Read The Docs' theme (bos #18858)
[modules/shaper.git] / src / SketchPlugin / doc / splitFeature.rst
index 1f3beaf1ea071c07c230a2f9e8a4c784af4e0018..4ab56d80c0c23268e45150bd24f9525f74ec93d0 100644 (file)
@@ -1,10 +1,54 @@
+.. |split.icon|    image:: images/Split.png
 
 Split
 =====
 
+| The Split operation splits sketch curve into multiple segments.
+| The curve should have points lying on it.
+| Open curves (line or arc) require one or more points to split with; closed curves (circle) require two or more points.
 
-.. image:: images/Split.png
+To create a Split in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Split* item  or
+#. click |split.icon| **Split** button in Sketch toolbar:
+
+Property panel:
+
+.. image:: images/Split_panel.png
   :align: center
 
 .. centered::
-  Split a line
+   Split
+
+Input fields:
+
+- **Segment** is used to select a segment to be split off in the view.
+
+The selected segment is highlighted in the view:
+
+.. image:: images/Split_segment_sel.png
+   :align: center
+
+.. centered::
+   The segment to split off
+
+**TUI Command**:
+
+.. py:function:: Sketch_1.addSplit(Feature, PositionPoint)
+
+    :param object: Line, arc or circle.
+    :param object: Position point (a point on the segment to split off or closest to it).
+    :return: Result object.
+
+Result
+""""""
+
+Created Split appears in the view.
+
+.. image:: images/Split_res.png
+          :align: center
+
+.. centered::
+   Created split 
+
+**See Also** a sample TUI Script of :ref:`tui_create_split` operation.