src/SketchPlugin/doc/projectionFeature.rst

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