X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FFeaturesPlugin%2Fdoc%2FextrusionFeature.rst;h=897279fbb0d5f125103fafb376640fcdc95507d2;hb=7eb4c88d46d8fa7d664bc5f505952f4677fd4628;hp=7ba3b93c6fc8a327ead51c1a0cfad302d68a6356;hpb=547a3952b37fe76f0d4e031a7d8a943ac6a45bb5;p=modules%2Fshaper.git diff --git a/src/FeaturesPlugin/doc/extrusionFeature.rst b/src/FeaturesPlugin/doc/extrusionFeature.rst index 7ba3b93c6..897279fbb 100644 --- a/src/FeaturesPlugin/doc/extrusionFeature.rst +++ b/src/FeaturesPlugin/doc/extrusionFeature.rst @@ -1,7 +1,16 @@ +.. |extrusion_btn.icon| image:: images/extrusion_btn.png Extrusion ========= +Extrusion feature extrudes selected objects along their normals or the selected axis. + +To perform Extrusion in the active part: + +#. select in the Main Menu *Features - > Extrusion* item or +#. click |extrusion_btn.icon| **Extrusion** button in the toolbar + +The following property panel will be opened: .. image:: images/StartSketch.png :align: center @@ -9,6 +18,19 @@ Extrusion .. centered:: Start sketch +There are two variants of the property panel for Extrusion depending on the chosen option: + +.. image:: images/extrusion_by_sizes.png + :align: left +**By Sizes** extrudes objects by specifying sizes. + +.. image:: images/extrusion_by_bounding_planes.png + :align: left +**By Bounding Faces** extrudes objects by specifying bounding faces/planes and offsets. + + +By sizes +-------- .. image:: images/Extrusion1.png :align: center @@ -16,9 +38,109 @@ Extrusion .. centered:: Extrusion: definition by sizes +- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded. +- **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used. +- **To size** - size for extrusion in the direction. +- **From size** - size for extrusion in the opposite direction. + +**TUI Commands**: + +.. py:function:: model.addExtrusion(part, objects, size) + + :param part: The current part object. + :param list: A list of objects for extrusion. + :param number: Size of extrucion. + :return: Created object. + +.. py:function:: model.addExtrusion(part, objects, direction, size) + + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: A direction of extrusion + :param number: Size of extrucion. + :return: Created object. + +.. py:function:: model.addExtrusion(part, objects, toSize, fromSize) + + :param part: The current part object. + :param list: A list of objects for extrusion. + :param number: "Size to" value. + :param number: "Size from" value. + :return: Created object. + +.. py:function:: model.addExtrusion(part, objects, direction, toSize, fromSize) + + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: A direction of extrusion + :param number: "Size to" value. + :param number: "Size from" value. + :return: Created object. + +Result +"""""" + +The Result of the operation will be an extruded shape: + +.. image:: images/extrusion_by_sizes_result.png + :align: center + +.. centered:: + **Created Extrusion** + +**See Also** a sample TUI Script of :ref:`tui_create_extrusion_by_sizes` operation. + +By bounding faces +------------------ .. image:: images/Extrusion2.png :align: center .. centered:: - Extrusion: definition by bounding planes + Extrusion: definition by bounding faces + +- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded. +- **Axis** if selected, it will be direction of extrusion, otherwise objects normals will be used. +- **To face** - a face can be selected to bound extrusion from one side. +- **To offset** - offset for extrusion or for bounding plane, if selected. +- **From face** - a face can be selected to bound extrusion from the other side. +- **From offset** - offset for extrusion or for bounding plane, if selected. + +Planar face selected as a boundary of extrusion will be enlarged infinitely. As a result, extrusion bounded only by planar faces will be completed always. +On the other hand, if the boundary face is not planar, extrusion may fail, for example, in case of the base object cannot be projected to this face along given direction. + +**TUI Commands**: + +.. py:function:: model.addExtrusion(part, objects, toObject, toOffset, fromObject, fromOffset) + + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: "To object" + :param number: "To offset". + :param object: "From object" + :param number: "From offset". + :return: Created object. + +.. py:function:: model.addExtrusion(part, objects, direction, toObject, toOffset, fromObject, fromOffset) + + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: A direction of extrusion + :param object: "To object" + :param number: "To offset". + :param object: "From object" + :param number: "From offset". + :return: Created object. + +Result +"""""" + +The Result of the operation will be an extruded shape: + +.. image:: images/extrusion_by_bounding_planes_result.png + :align: center + +.. centered:: + **Created Extrusion** + +**See Also** a sample TUI Script of :ref:`tui_create_extrusion_by_bounding_planes` operation.