Salome HOME
Merge branch HELP_DOCUMENTATION_EDITING into master.
[modules/shaper.git] / src / SketchPlugin / doc / intersectionFeature.rst
1
2 Intersection
3 ============
4
5 | The Intersection operation creates intersection of a 3D edge and the sketch plane.
6 | The result of intersection is a point.
7
8 To create Intersection in the active Sketch:
9
10 #. select in the Main Menu *Sketch - > Intersection* item  or
11 #. click **Intersection** button in Sketch toolbar:
12
13 .. image:: images/intersection.png
14    :align: center
15
16 .. centered::
17    **Intersection**  button
18
19 Property panel:
20
21 .. image:: images/Intersection_panel.png
22   :align: center
23
24 .. centered::
25    Intersection
26
27 Input fields:
28
29 - **Object** is the 3D edge to intersect with the sketch plane.
30 - **Include into the sketch result** option defines whether to include the intersection point into the sketch result.
31
32 **TUI Command**:
33
34 - *Sketch_1.addIntersectionPoint(Edge, IncludeIntoResult)*
35
36   **Arguments**: Edge and include into the result flag
37
38 - *Sketch_1.addIntersectionPoint(EdgeName, IncludeIntoResult)*
39
40   **Arguments**: Edge name and include into the result flag
41
42 Result
43 """"""
44
45 Created Intersection appears in the view.
46
47 .. image:: images/Intersection_res.png
48            :align: center
49
50 .. centered::
51    Intersection created (purple point)
52
53 **See Also** a sample TUI Script of a :ref:`tui_create_intersection` operation.