Salome HOME
Documentation: use 'figure' instead of 'image'; improve caption layout; fix warnings.
[modules/shaper.git] / src / BuildPlugin / doc / faceFeature.rst
index 2cfcd473ad31fd121be031d5ea5aa43a7e7edafe..57f37737beb14f3a4a397df5e183ab96a1752ada 100644 (file)
@@ -1,10 +1,47 @@
+.. _buildFace:
+.. |feature_face.icon|    image:: images/feature_face.png
 
 Face
 ====
 
+Face feature creates one or several faces using shapes already existing in other objects.
 
-.. image:: images/Face.png
+To create a face in the active part:
+
+#. select in the Main Menu *Build - > Face* item  or
+#. click |feature_face.icon| **Face** button in the toolbar
+
+The following property panel will be opened:
+   
+.. figure:: images/Face.png
   :align: center
 
-.. centered::
   Create a face
+  
+Select one or several faces in viewer. Additionally, a face can be build by a closed wire or a set of edges composing a closed wire.
+
+It is also possible to select a whole sketch result from the object browser. In this case, the smallest closed contour of the sketch will be transformed to the planar face.
+
+**Apply** button creates faces.
+
+**Cancel** button cancels the operation. 
+
+**TUI Command**:
+
+.. py:function:: model.addFace(Part_doc, Shapes)
+
+    :param part: The current part object.
+    :param list: A list of shapes.
+    :return: Result object.
+
+Result
+""""""
+
+The result of the operation will be a set of faces created from the selected shapes:
+
+.. figure:: images/CreateFace.png
+  :align: center
+
+  Result of the operation.
+
+**See Also** a sample TUI Script of :ref:`tui_create_face` operation.