Salome HOME
Merge branch HELP_DOCUMENTATION_EDITING into master.
[modules/shaper.git] / src / ConstructionPlugin / doc / planeFeature.rst
index dbe2ac344ec61763c125ad934d1bee7b375791ef..eead2aebaf87776d1a27ad637c91bfe7e39f536b 100644 (file)
@@ -1,3 +1,123 @@
 
 Plane
 =====
+
+The feature Plane creates a new constructive plane.
+
+Plane is a construction object and it can be created as in a part as in part set. To create a plane:
+
+#. select in the Main Menu *Construction - > Plane* item  or
+#. click **Point** button in the toolbar
+
+.. image:: images/plane_button.png
+  :align: center
+
+.. centered::
+  **Plane** button
+
+There are 4 algorithms for creation of a Plane:
+
+.. image:: images/plane_by_three_points_32x32.png
+   :align: left
+**By three points** creates a plane by three points.
+
+.. image:: images/plane_by_line_and_point_32x32.png
+   :align: left
+**By line and point** creates a plane by a line and a point.
+
+.. image:: images/plane_by_other_plane_32x32.png
+   :align: left
+**By other plane** creates a plane parallel to another plane.
+
+.. image:: images/plane_by_two_parallel_planes_32x32.png
+   :align: left
+**By two parallel planes** creates a plane between two parallel planes.
+
+By three points
+"""""""""""""""
+
+.. image:: images/Plane1.png
+   :align: center
+       
+.. centered::
+   **By three points**
+
+In this case user has to select three points in a viewer to define a new plane.
+
+**TUI Commands**: *model.addPlane(Part_doc, model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Left&Box_1_1/Bottom"))*
+
+**Arguments**: Part + 3 vertices.
+
+By line and point
+"""""""""""""""""
+
+.. image:: images/Plane2.png
+   :align: center
+       
+.. centered::
+   **Line and point**
+
+In this case user has to select a linear edge and point to define a plane. It is possible to make the new plane perpendicular to the selected edge.
+
+**TUI Commands**: *model.addPlane(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Bottom"), False)*
+
+**Arguments**: Part + line + point + is perpendicular to line flag.
+
+By other plane
+""""""""""""""
+
+.. image:: images/Plane3.png
+   :align: center
+       
+.. centered::
+   **By other plane**
+
+In this case user has to select an already existing plane (planar face). There are following possibilities to define a new plane:
+
+.. image:: images/plane_by_distance_from_other_24x24.png
+   :align: left
+
+By distance from the selected plane.
+
+.. image:: images/plane_by_coincident_to_point_24x24.png
+   :align: left
+
+By coincidence to a point.
+
+.. image:: images/plane_by_rotation_24x24.png
+   :align: left
+
+By rotation around an edge on a specified angle.
+
+**TUI Commands**: *model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Front"), 10, False)*
+
+**Arguments**: Part + a plane + offset + is reverse flag.
+
+   
+By two parallel planes
+""""""""""""""""""""""
+   
+.. image:: images/Plane4.png
+   :align: center
+       
+.. centered::
+   **By two parallel planes**
+
+In this case user has to select two parallel planes. A new plane will be defined between them.
+
+**TUI Commands**: *model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Right"))*
+
+**Arguments**: Part + 2 planes.
+
+Result
+""""""
+
+The Result of the operation will be a plane:
+
+.. image:: images/CreatedPlane.png
+          :align: center
+
+.. centered::
+   Plane created  
+
+**See Also** a sample TUI Script of a :ref:`tui_create_plane` operation.