Salome HOME
Documentation: use 'figure' instead of 'image'; improve caption layout; fix warnings.
[modules/shaper.git] / src / BuildPlugin / doc / shellFeature.rst
index 8c6266564fcf3365a9240a1b3bec45da2cb4ab26..05529713a3df13486b5f5b65cc7d3a95b8b9243c 100644 (file)
@@ -1,10 +1,44 @@
+.. |feature_shell.icon|    image:: images/feature_shell.png
 
 Shell
 =====
 
+Shell feature creates a shell using faces already existing in other objects.
 
-.. image:: images/Shell.png
+To create a shell in the active part:
+
+#. select in the Main Menu *Build - > Shell* item  or
+#. click |feature_shell.icon| **Shell** button in the toolbar
+
+The following property panel will be opened:
+
+.. figure:: images/Shell.png
   :align: center
 
-.. centered::
   Create a shell
+  
+Select one or several faces in the viewer. Additionally, it is allowed to select a whole sketch result from the object browser. In this case, the result shell will contain faces corresponding to all smallest closed contours of the sketch.
+
+**Apply** button creates a shell.
+
+**Cancel** button cancels the operation. 
+
+**TUI Command**:
+
+.. py:function:: model.addShell(Part_doc, Objects)
+
+    :param part: The current part object.
+    :param list: A list of shapes.
+    :return: Result object.
+
+Result
+""""""
+
+The result of the operation will be a shell created from the selected shapes:
+
+.. figure:: images/CreateShell.png
+  :align: center
+
+  Result of the operation.
+
+**See Also** a sample TUI Script of :ref:`tui_create_shell` operation.