+.. |plane_button.icon| image:: images/plane_button.png
Plane
=====
-The feature Plane creates a new constructive plane.
+Plane feature 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:
+Plane is a construction object that can be created in a part or in a partset. 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
+#. click |plane_button.icon| **Point** button in the toolbar
There are 4 algorithms for creation of a Plane:
: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.
+A plane is created by selecting three points in a viewer.
+
+**TUI Commands**:
+
+.. py:function:: 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"))
+
+ :param part: The current part object.
+ :param object: Vertex 1.
+ :param object: Vertex 2.
+ :param object: Vertex 3.
+ :return: Result object.
+
+Result
+""""""
+
+The Result of the operation will be a plane:
+
+.. image:: images/CreatedPlane1.png
+ :align: center
-**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"))*
+.. centered::
+ **A plane by three points**
+
+**See Also** a sample TUI Script of :ref:`tui_create_plane_points` operation.
-**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.
+A plane is created by selecting a linear edge and point. It is possible to create a new plane perpendicular to the selected edge.
+
+**TUI Commands**:
+
+.. py:function:: 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)
+
+ :param part: The current part object.
+ :param object: A line.
+ :param object: A point.
+ :param boolean: Is perpendicular to line.
+ :return: Result object.
+
+Result
+""""""
+
+The Result of the operation will be a plane:
+
+.. image:: images/CreatedPlane2.png
+ :align: center
-**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)*
+.. centered::
+ Plane created
+
+**See Also** a sample TUI Script of :ref:`tui_create_plane_line` operation.
-**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:
+A plane is created by selecting 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
.. image:: images/plane_by_coincident_to_point_24x24.png
:align: left
-By coincidence to a point.
+By coincidence with a point.
.. image:: images/plane_by_rotation_24x24.png
:align: left
-By rotation around an edge on a specified angle.
+By rotation around an edge by a specified angle.
-**TUI Commands**: *model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Front"), 10, False)*
+**TUI Commands**:
+
+.. py:function:: model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Front"), 10, False)
+
+ :param part: The current part object.
+ :param object: A plane.
+ :param real: An offset.
+ :param boolean: Is reverse.
+ :return: Result object.
+
+Result
+""""""
+
+The Result of the operation will be a plane parallel to already existing one:
+
+.. image:: images/CreatedPlane3.png
+ :align: center
+
+.. centered::
+ **Plane parallel to a planar face**
+
+**See Also** a sample TUI Script of :ref:`tui_create_plane_plane` operation.
-**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.
+A plane is created by selecting two parallel planes. A new plane will be defined between them.
+
+**TUI Commands**:
-**TUI Commands**: *model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Right"))*
+.. py:function:: model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Right"))
-**Arguments**: Part + 2 planes.
+ :param part: The current part object.
+ :param object: A plane 1.
+ :param object: A plane 2.
+ :return: Result object.
Result
""""""
-The Result of the operation will be a plane:
+The Result of the operation will be a plane created between two selected planes:
-.. image:: images/CreatedPlane.png
+.. image:: images/CreatedPlane4.png
:align: center
.. centered::
- Plane created
+ **Plane created between others**
-**See Also** a sample TUI Script of a :ref:`tui_create_plane` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_plane_parallel` operation.