X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketchPlugin%2Fdoc%2FprojectionFeature.rst;h=587e05ab5237d4e66c368d58bf49d96aae965619;hb=0fcd69345a4dfdb31e252574c68bc70e123999e8;hp=27f83721ecb8a36222f4f0b5a0b851303b30d25c;hpb=547a3952b37fe76f0d4e031a7d8a943ac6a45bb5;p=modules%2Fshaper.git diff --git a/src/SketchPlugin/doc/projectionFeature.rst b/src/SketchPlugin/doc/projectionFeature.rst index 27f83721e..587e05ab5 100644 --- a/src/SketchPlugin/doc/projectionFeature.rst +++ b/src/SketchPlugin/doc/projectionFeature.rst @@ -1,10 +1,52 @@ +.. |projection.icon| image:: images/projection.png Projection ========== +| The Projection operation creates a projection of 3D edge or vertex onto the sketch plane. +| The result of projection is a line. -.. image:: images/Projection.png +To create a Projection in the active Sketch: + +#. select in the Main Menu *Sketch - > Projection* item or +#. click |projection.icon| **Projection** button in Sketch toolbar: + +Property panel: + +.. image:: images/Projection_panel.png :align: center .. centered:: - Create a projection + Projection + +Input fields: + +- **Object** is the 3D object (edge or vertex) to project onto the sketch plane. +- **Include into the sketch result** option defines whether to include the projection line into the sketch result. + +**TUI Commands**: + +.. py:function:: Sketch_1.addProjection(EdgeOrVertex, IncludeIntoResult) + + :param object: Edge or vertex. + :param boolean: Include into the result flag. + :return: Result object. + +.. py:function:: Sketch_1.addProjection(EdgeOrVertexName, IncludeIntoResult) + + :param object: Edge or vertex name. + :param boolean: Include into the result flag. + :return: Result object. + +Result +"""""" + +Created Projection appears in the view. + +.. image:: images/Projection_res.png + :align: center + +.. centered:: + Created projection (purple line) + +**See Also** a sample TUI Script of :ref:`tui_create_projection` operation. \ No newline at end of file