src/SketchPlugin/doc/intersectionFeature.rst

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