X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FFeaturesPlugin%2Fdoc%2FremoveSubShapesFeature.rst;h=25258247bae088ab0fc36afa3936fafc9259dc5e;hb=d3afed6da21a10db226a968698b63af318e6111e;hp=c1fe7f950c80f552cc0b2169c0c88ff8a566a9d0;hpb=92fd01627d9ab299cfd35df5404e4f54a5340a55;p=modules%2Fshaper.git diff --git a/src/FeaturesPlugin/doc/removeSubShapesFeature.rst b/src/FeaturesPlugin/doc/removeSubShapesFeature.rst index c1fe7f950..25258247b 100644 --- a/src/FeaturesPlugin/doc/removeSubShapesFeature.rst +++ b/src/FeaturesPlugin/doc/removeSubShapesFeature.rst @@ -1,19 +1,14 @@ +.. |remove_subshapes_btn.icon| image:: images/remove_subshapes_btn.png Remove Sub-Shapes ================= -Remove Sub-Shapes allows to remove sub shapes from wires, shells, compsolids, compounds. +Remove Sub-Shapes allows removing sub shapes from wires, shells, compsolids and compounds. -To perform Remove Sub-Shapes in the active part: +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: @@ -23,34 +18,44 @@ The following property panel will be opened: .. centered:: Remove Sub-Shapes -- **Shape** shape from which sub-shapes should be removed. Only wires, shells, compsolids, compounds allowed for selection. +.. |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 to select which sub-shapes will be removed. +|by_removing| **By removing** allows selecting sub-shapes to be removed. -- **Sub-Shapes to remove** list of sub-shapes which should 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 to select which sub-shapes will be kept. + :param list: A list of objects. -- **Sub-Shapes to keep** list of sub-shapes which should be kept. +|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 @@ -62,6 +67,6 @@ The Result of the operation will be a shape without removed sub-shapes: :align: center .. centered:: - **Remove Sub-Shapes created** + **Remove Sub-Shapes** -**See Also** a sample TUI Script of a :ref:`tui_create_remove_subshapes` operation. +**See Also** a sample TUI Script of :ref:`tui_create_remove_subshapes` operation.