src/SketchPlugin/doc/projectionFeature.rst

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