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 .. figure:: images/Intersection_panel.png
  17    :align: center
  18
  19    Intersection
  20
  21 Input fields:
  22
  23 - **Object** is the 3D edge to intersect with the sketch plane.
  24 - **Include into the sketch result** option defines whether to include the intersection point into the sketch result.
  25
  26 **TUI Commands**:
  27
  28 .. py:function:: Sketch_1.addIntersectionPoint(Edge, IncludeIntoResult)*
  29
  30     :param object: An edge.
  31     :param boolean: Include into the result flag.
  32     :return: Result object.
  33
  34 .. py:function:: Sketch_1.addIntersectionPoint(EdgeName, IncludeIntoResult)*
  35
  36     :param object: An edge name.
  37     :param boolean: Include into the result flag.
  38     :return: Result object.
  39
  40 Result
  41 """"""
  42
  43 Created Intersection appears in the view.
  44
  45 .. figure:: images/Intersection_res.png
  46    :align: center
  47
  48    Created intersection (purple point)
  49
  50 **See Also** a sample TUI Script of :ref:`tui_create_sketch_intersection` operation.