X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FFeaturesPlugin%2Fdoc%2FcutFeature.rst;h=9a99224068308aa9988977f7fbc173a021c03233;hb=0fcd69345a4dfdb31e252574c68bc70e123999e8;hp=e5c8bae88497df4b413379d667593c16e39e9539;hpb=b73fb7468bea81901dbeed8e229d742f788ec282;p=modules%2Fshaper.git diff --git a/src/FeaturesPlugin/doc/cutFeature.rst b/src/FeaturesPlugin/doc/cutFeature.rst index e5c8bae88..9a9922406 100644 --- a/src/FeaturesPlugin/doc/cutFeature.rst +++ b/src/FeaturesPlugin/doc/cutFeature.rst @@ -1,46 +1,67 @@ .. _featureCut: +.. |bool_cut.icon| image:: images/bool_cut.png Cut === -The feature Cut implements a boolean operation to cut tool objects from a main objects. +Cut feature implements a Boolean operation to cut tool objects from main objects. -To perform a boolean opration Cut in the active part: +To perform a Cut operationin the active part: #. select in the Main Menu *Features - > Cut* item or -#. click **Cut** button in the toolbar - -.. image:: images/bool_cut.png - :align: center - -.. centered:: - **Cut** button +#. click |bool_cut.icon| **Cut** button in the toolbar The following property panel will be opened: -.. image:: images/Cut.png +.. image:: images/boolean_cut_property_panel.png :align: center .. centered:: **Cut operation** - **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut by tool objects. -- **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut main objects. -- **See preview** button shows a result of the operation. + Any kind of shape can be selected, including subshapes of compsolids/compounds. + In this case only selected subshapes will be cut, others will stay untouched (as much as possible). +- **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will cut main objects. + Any kind of shape can be selected, including subshapes of compsolids/compounds. + Non-selected subshapes from compsolids/compounds will be ignored. +- **See preview** button shows a result of the operation. + +**TUI Command**: -**TUI Command**: *model.addCut(Part_doc, mainObjects, toolObjects)* +.. py:function:: model.addCut(Part_doc, mainObjects, toolObjects) -**Arguments**: Part + list of main objects + list of tool objects. + :param part: The current part object + :param list: A list of main objects. + :param list: A list of tool objects. + :return: Created object Result """""" -The Result of the operation will be a shape which is a cut of tool objects from main objects: +A result shape which is a cut by tool objects from main object, will be produced for each selected object: .. image:: images/CreatedCut.png - :align: center + :align: center .. centered:: - **Cut created** + **Created cut** + +If a subsolid (yellow wireframe) of a compsolid was selected: + +.. image:: images/boolean_cut_subsolids_arguments.png + :align: center + +.. centered:: + **Cut arguments** + +it will be cut in the result and not selected subsolids will be added to it: + +.. image:: images/boolean_cut_subsolids_result.png + :align: center + +.. centered:: + **Cut subsolid result** + -**See Also** a sample TUI Script of a :ref:`tui_create_cut` operation. +**See Also** a sample TUI Script of :ref:`tui_create_cut` operation.