X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FFeaturesPlugin%2Fdoc%2FremoveSubShapesFeature.rst;h=6c04798bb1f0df02a99d1820b8416f45787af92c;hb=79470833af46e5a11abc700ebd07a26ec3e2d5a0;hp=ff7740ad06f472d309093f48ed24a767650b7f85;hpb=bcd96990e1fca77402d522bc8b095ebfa1091894;p=modules%2Fshaper.git diff --git a/src/FeaturesPlugin/doc/removeSubShapesFeature.rst b/src/FeaturesPlugin/doc/removeSubShapesFeature.rst index ff7740ad0..6c04798bb 100644 --- a/src/FeaturesPlugin/doc/removeSubShapesFeature.rst +++ b/src/FeaturesPlugin/doc/removeSubShapesFeature.rst @@ -1,3 +1,4 @@ +.. |remove_subshapes_btn.icon| image:: images/remove_subshapes_btn.png Remove Sub-Shapes ================= @@ -7,50 +8,53 @@ Remove Sub-Shapes allows removing sub shapes from wires, shells, compsolids and To Remove Sub-Shapes in the active part: #. select in the Main Menu *Features - > Remove Sub-Shapes* item or -#. click **Remove Sub-Shapes** button in the toolbar - -.. image:: images/remove_subshapes_btn.png - :align: center - -.. centered:: - **Remove Sub-Shapes** button +#. click |remove_subshapes_btn.icon| **Remove Sub-Shapes** button in the toolbar The following property panel will be opened: -.. image:: images/RemoveSubShapes.png +.. figure:: images/RemoveSubShapes.png :align: center -.. centered:: Remove Sub-Shapes +.. |by_removing| image:: images/remove_subshapes_32x32.png +.. |by_keeping| image:: images/keep_subshapes_32x32.png + - **Shape** shape from which sub-shapes should be removed. Only wires, shells, compsolids or compounds are allowed for selection. There are 2 options for removing sub-shapes: -.. image:: images/remove_subshapes_32x32.png - :align: left -**By removing** allows selecting sub-shapes to be removed. +|by_removing| **By removing** allows selecting sub-shapes to be removed. - **Sub-Shapes to remove** the list of sub-shapes which should be removed. **TUI Command**: - | *Remove_SubShapes_1 = model.addRemoveSubShapes(Part_1_doc, object)* - | *Remove_SubShapes_1.setSubShapesToRemove(subShapes)* -**Arguments**: Part + object; List of sub-shapes to remove. +.. py:function:: model.addRemoveSubShapes(Part_1_doc, object) + + :param part: The current part object. + :param object: The object. + :return: Created object. +.. py:function:: Remove_SubShapes_1.setSubShapesToRemove(subShapes) -.. image:: images/keep_subshapes_32x32.png - :align: left -**By keeping** allows select sub-shapes to be kept. + :param list: A list of objects. + +|by_keeping| **By keeping** allows select sub-shapes to be kept. - **Sub-Shapes to keep** the list of sub-shapes which should be kept. **TUI Command**: - | *Remove_SubShapes_1 = model.addRemoveSubShapes(Part_1_doc, object)* - | *Remove_SubShapes_1.setSubShapesToKeep(subShapes)* -**Arguments**: Part + object; List of sub-shapes to keep. +.. py:function:: model.addRemoveSubShapes(Part_1_doc, object) + + :param part: The current part object. + :param object: The object. + :return: Created object. + +.. py:function:: Remove_SubShapes_1.setSubShapesToKeep(subShapes) + + :param list: A list of sub-shapes to keep. Result @@ -58,10 +62,9 @@ Result The Result of the operation will be a shape without removed sub-shapes: -.. image:: images/remove_subshapes_result.png - :align: center +.. figure:: images/remove_subshapes_result.png + :align: center -.. centered:: **Remove Sub-Shapes** **See Also** a sample TUI Script of :ref:`tui_create_remove_subshapes` operation.