]> SALOME platform Git repositories - modules/shaper.git/blob - src/SketchPlugin/doc/projectionFeature.rst
Salome HOME
Revert "bos#35152 [EDF] (2023-T1) Sketch Circle should allow user to position constru...
[modules/shaper.git] / 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 .. figure:: images/Projection_panel.png
17    :align: center
18
19    Projection
20
21 Input fields:
22
23 - **Object** is the 3D object (edge or vertex) to project onto the sketch plane.
24 - **Include into the sketch result** option defines whether to include the projection line into the sketch result.
25
26 **TUI Commands**:
27
28 .. py:function:: Sketch_1.addProjection(EdgeOrVertex, IncludeIntoResult)
29
30     :param object: Edge or vertex.
31     :param boolean: Include into the result flag.
32     :return: Result object.
33
34 .. py:function:: Sketch_1.addProjection(EdgeOrVertexName, IncludeIntoResult)
35
36     :param object: Edge or vertex name.
37     :param boolean: Include into the result flag.
38     :return: Result object.
39
40 Result
41 """"""
42
43 Created Projection appears in the view.
44
45 .. figure:: images/Projection_res.png
46    :align: center
47
48    Created projection (purple line)
49
50 **See Also** a sample TUI Script of :ref:`tui_create_projection` operation.