Salome HOME
Issue #2998: Add help description for automatic creation of constraints
[modules/shaper.git] / src / PartSetPlugin / doc / PartSetPlugin.rst
index 9dfd8968849b1a4af14312034199dbf87c181259..df635b9b2d43b429fc029989c788bd82d44fea2f 100644 (file)
@@ -1,5 +1,61 @@
+.. |new_part.icon|    image:: images/new_part.png
+.. |remove.icon|    image:: images/remove.png
+.. |duplicate.icon|    image:: images/duplicate.png
 
 .. _partPlugin:
 
 Part plug-in
-=============
+============
+
+.. _new-part:
+
+New Part
+--------
+
+To create a New Part:
+
+#. select in the Main Menu *Part - > New part* item  or
+#. click |new_part.icon| **New part** button in Shaper toolbar:
+
+**TUI Command**:
+
+.. py:function:: model.addPart(partSet)
+
+    :param part: The current part object.
+    :return: Result object.
+
+Result
+""""""
+
+Created empty part is activated and appears in the object browser.
+
+**See Also** a sample TUI Script of :ref:`tui_create_part` operation.
+
+Duplicate Part
+--------------
+
+To duplicate an active Part:
+
+#. select in the Main Menu *Part - > Duplicate part* item  or
+#. click |duplicate.icon| **Duplicate part** button in Shaper toolbar:
+
+Result
+""""""
+
+Created copied part is activated and appears in the object browser.
+
+Copied part contains all objects existing in the source part.
+
+Remove Part
+-----------
+
+To remove an active Part:
+
+#. select in the Main Menu *Part - > Remove part* item  or
+#. click |remove.icon| **Remove part** button in Shaper toolbar:
+
+Result
+""""""
+
+Selected part is removed together with all its objects.
+