Salome HOME
Cosmetics. Move XML files to the separate folder inside a corresponding project in VS.
[modules/shaper.git] / src / SketchPlugin / doc / intersectionFeature.rst
index f0998acaff04c2caffb2af4d270f1183defb1225..f33a411d14f3940837bc069cdf9de0f9f72ae9f7 100644 (file)
@@ -1,10 +1,50 @@
+.. |intersection.icon|    image:: images/Intersection.png
 
 Intersection
 ============
 
+The Intersection operation creates an intersection of a 3D edge and the sketch plane.
+The result of the intersection is a point.
 
-.. image:: images/Intersection.png
-  :align: center
+To create an Intersection in the active Sketch:
 
-.. centered::
-  Create an intersection
+#. select in the Main Menu *Sketch - > Intersection* item  or
+#. click |intersection.icon| **Intersection** button in Sketch toolbar:
+
+Property panel:
+
+.. figure:: images/Intersection_panel.png
+   :align: center
+
+   Intersection
+
+Input fields:
+
+- **Object** is the 3D edge to intersect with the sketch plane.
+- **Include into the sketch result** option defines whether to include the intersection point into the sketch result.
+
+**TUI Commands**:
+
+.. py:function:: Sketch_1.addIntersectionPoint(Edge, IncludeIntoResult)*
+
+    :param object: An edge.
+    :param boolean: Include into the result flag.
+    :return: Result object.
+
+.. py:function:: Sketch_1.addIntersectionPoint(EdgeName, IncludeIntoResult)*
+
+    :param object: An edge name.
+    :param boolean: Include into the result flag.
+    :return: Result object.
+
+Result
+""""""
+
+Created Intersection appears in the view.
+
+.. figure:: images/Intersection_res.png
+   :align: center
+
+   Created intersection (purple point)
+
+**See Also** a sample TUI Script of :ref:`tui_create_sketch_intersection` operation.