+.. |axis_button.icon| image:: images/axis_button.png
Axis
====
-The feature Axis creates a new constructive axis line.
+Axis feature creates a new constructive axis line.
-Axis is a construction object and it can be created as in a part as in part set. To create an axis:
+Axis is a construction object and it can be created in a part or in a partset. To create an axis:
#. select in the Main Menu *Construction - > Axis* item or
-#. click **Axis** button in the toolbar
-
-.. image:: images/axis_button.png
- :align: center
-
-.. centered::
- **Axis** button
+#. click |axis_button.icon| **Axis** button in the toolbar
There are 6 algorithms for creation of an Axis:
.. image:: images/axis_by_line_32x32.png
:align: left
-**As an axis of cilindrical face** creates an axis using a cilindrical face.
+**As an axis of cylindrical face** creates an axis using a cylindrical face.
.. image:: images/axis_by_line_32x32.png
:align: left
.. image:: images/axis_by_line_32x32.png
:align: left
-**By two planes** creates an axis as intersection of two planes.
+**By two planes** creates an axis as the intersection of two planes.
By three dimensions
-------------------
.. centered::
**By dX, dY, dZ values**
-In this case user has to define dX, dY, dZ values of a vector.
+An axis is defined by dX, dY and dZ values of a vector.
-**TUI Commands**: *model.addAxis(Part_doc, 10, 10, 10)*
+**TUI Commands**:
-**Arguments**: Part + 3 values (dX, dY, dZ values).
+.. py:function:: model.addAxis(Part_doc, 10, 10, 10)
+
+ :param part: The current part object.
+ :param real: dX.
+ :param real: dY.
+ :param real: dZ.
+ :return: Result object.
Result
""""""
.. centered::
**Axis by three dimensions**
-**See Also** a sample TUI Script of a :ref:`tui_create_axis_xyz` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_axis_xyz` operation.
By two points
.. centered::
**By two points**
-In this case user has to select two points or vertices.
+An axis is defined by two points or vertices.
+
+**TUI Commands**:
-**TUI Commands**: *model.addAxis(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/Bottom"))*
+.. py:function:: model.addAxis(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/Bottom"))
-**Arguments**: Part + 2 vertices.
+ :param part: The current part object.
+ :param object: Vertex 1.
+ :param object: Vertex 2.
+ :return: Result object.
-**See Also** a sample TUI Script of a :ref:`tui_create_axis_points` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_axis_points` operation.
Result
""""""
.. centered::
**Axis by two points**
-**See Also** a sample TUI Script of a :ref:`tui_create_axis_points` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_axis_points` operation.
By line
.. centered::
**By a line**
-In this case user has to select a linear edge.
+An axis is defined by a linear edge.
-**TUI Commands**: *model.addAxis(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"))*
+**TUI Commands**:
-**Arguments**: Part + edge.
+.. py:function:: model.addAxis(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"))
+
+ :param part: The current part object.
+ :param object: Edge.
+ :return: Result object.
Result
""""""
-The Result of the operation will be an axis based on selected line:
+The Result of the operation will be an axis based on the selected line:
.. image:: images/CreatedAxis3.png
:align: center
.. centered::
**Axis by line**
-**See Also** a sample TUI Script of a :ref:`tui_create_axis_line` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_axis_line` operation.
-As an axis of cilindrical face
+As an axis of cylindrical face
------------------------------
.. image:: images/Axis4.png
.. centered::
**By a cylinder**
-In this case user has to select a cylindrical face. Axis of the cylinder will define an axis object.
+An axis is defined by a cylindrical face. Axis of the cylinder will be an axis object.
+
+**TUI Commands**:
-**TUI Commands**: *model.addAxis(Part_doc, model.selection("FACE", "Cylinder_1_1/Face_1"))*
+.. py:function:: model.addAxis(Part_doc, model.selection("FACE", "Cylinder_1_1/Face_1"))
-**Arguments**: Part + cylindrical face.
+ :param part: The current part object.
+ :param object: Cylindrical face.
+ :return: Result object.
Result
""""""
-The Result of the operation will be an axis by selected cylinder:
+The Result of the operation will be an axis of the selected cylinder:
.. image:: images/CreatedAxis4.png
:align: center
.. centered::
**Axis cylindrical face**
-**See Also** a sample TUI Script of a :ref:`tui_create_axis_cylinder` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_axis_cylinder` operation.
By plane and point
.. centered::
**By a plane and point**
-In this case user has to select a point or vertex and plane (or planar face). Axis will be defined as a normal from the point to the plane.
+An axis is defined by a point or vertex and plane (or planar face) as a normal from the point to the plane.
-**TUI Commands**: *model.addAxis(Part_doc, model.selection("FACE", "Box_1_1/Front"), model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Right&Box_1_1/Top"))*
+**TUI Commands**:
-**Arguments**: Part + plane + point.
+.. py:function:: model.addAxis(Part_doc, model.selection("FACE", "Box_1_1/Front"), model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Right&Box_1_1/Top"))
+
+ :param part: The current part object.
+ :param object: Plane.
+ :param object: Point.
+ :return: Result object.
Result
""""""
.. centered::
**Axis by plane and point**
-**See Also** a sample TUI Script of a :ref:`tui_create_axis_plane` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_axis_plane` operation.
By two planes
.. centered::
**By two planes**
-In this case user has to select two planes. Intersection of that planes defines an axis. User can define offset for axis definition from both planes.
+An axis is defined by two planes. The intersection of the planes defines an axis. It is possible to define offset for axis definition from both planes.
+
+**TUI Commands**:
-**TUI Commands**: *model.addAxis(Part_doc, model.selection("FACE", "Box_1_1/Top"), 5, False, model.selection("FACE", "Box_1_1/Front"), 3, False)*
+.. py:function:: model.addAxis(Part_doc, model.selection("FACE", "Box_1_1/Top"), 5, False, model.selection("FACE", "Box_1_1/Front"), 3, False)
-**Arguments**: Part + plane + offcet value + is reversed flag + plane + offcet value + is reversed flag.
+ :param part: The current part object.
+ :param object: Plane 1.
+ :param real: Offset value.
+ :param boolean: Is reversed.
+ :param object: Plane 2.
+ :param real: Offset value.
+ :param boolean: Is reversed.
+ :return: Result object.
Result
""""""
.. centered::
**Axis by two planes**
-**See Also** a sample TUI Script of a :ref:`tui_create_axis_twoplanes` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_axis_twoplanes` operation.
