Salome HOME
Documentation: use 'figure' instead of 'image'; improve caption layout; fix warnings.
[modules/shaper.git] / src / SketchPlugin / doc / splitFeature.rst
1 .. |split.icon|    image:: images/Split.png
2
3 Split
4 =====
5
6 | The Split operation splits sketch curve into multiple segments.
7 | The curve should have points lying on it.
8 | Open curves (line or arc) require one or more points to split with; closed curves (circle) require two or more points.
9
10 To create a Split in the active Sketch:
11
12 #. select in the Main Menu *Sketch - > Split* item  or
13 #. click |split.icon| **Split** button in Sketch toolbar:
14
15 Property panel:
16
17 .. figure:: images/Split_panel.png
18    :align: center
19
20    Split
21
22 Input fields:
23
24 - **Segment** is used to select a segment to be split off in the view.
25
26 The selected segment is highlighted in the view:
27
28 .. figure:: images/Split_segment_sel.png
29    :align: center
30
31    The segment to split off
32
33 **TUI Command**:
34
35 .. py:function:: Sketch_1.addSplit(Feature, PositionPoint)
36
37     :param object: Line, arc or circle.
38     :param object: Position point (a point on the segment to split off or closest to it).
39     :return: Result object.
40
41 Result
42 """"""
43
44 Created Split appears in the view.
45
46 .. figure:: images/Split_res.png
47    :align: center
48
49    Created split 
50
51 **See Also** a sample TUI Script of :ref:`tui_create_split` operation.