Salome HOME
Issue #2998: Add help description for automatic creation of constraints
[modules/shaper.git] / src / ConstructionPlugin / doc / axisFeature.rst
index bb372bbca1fae423425f3e5c2452ff5bb241bcd7..bb691a50857fd4b833a9a74d628ad439d6860522 100644 (file)
@@ -1,3 +1,245 @@
+.. |axis_button.icon|    image:: images/axis_button.png
 
 Axis
 ====
+
+Axis feature creates a new constructive axis line.
+
+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.icon| **Axis** button in the toolbar
+
+There are 6 algorithms for creation of an Axis:
+
+.. image:: images/axis_dxyz_32x32.png
+   :align: left
+**By three dimensions** creates an axis by dimensions along X, Y, Z axes starting form existing origin.
+
+.. image:: images/by_two_points_32x32.png
+   :align: left
+**By two points** creates an axis using existing points.
+
+.. image:: images/axis_by_line_32x32.png
+   :align: left
+**By line** creates an axis using a line.
+
+.. image:: images/axis_by_line_32x32.png
+   :align: left
+**As an axis of cylindrical face** creates an axis using a cylindrical face.
+
+.. image:: images/axis_by_line_32x32.png
+   :align: left
+**By plane and point** creates an axis using a plane and point.
+
+.. image:: images/axis_by_line_32x32.png
+   :align: left
+**By two planes** creates an axis as the intersection of two planes.
+
+By three dimensions
+-------------------
+
+.. image:: images/Axis1.png
+   :align: center
+       
+.. centered::
+   **By dX, dY, dZ values**
+
+An axis is defined by dX, dY and dZ values of a vector.
+
+**TUI Commands**:
+
+.. 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
+""""""
+
+The Result of the operation will be an axis defined by vector from origin:
+
+.. image:: images/CreatedAxis1.png
+          :align: center
+
+.. centered::
+   **Axis by three dimensions**
+
+**See Also** a sample TUI Script of :ref:`tui_create_axis_xyz` operation.
+
+
+By two points
+-------------
+
+.. image:: images/Axis2.png
+   :align: center
+       
+.. centered::
+   **By two points**
+
+An axis is defined by two points or vertices.
+
+**TUI Commands**:
+
+.. 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"))
+
+    :param part: The current part object.
+    :param object: Vertex 1.
+    :param object: Vertex 2.
+    :return: Result object.
+
+**See Also** a sample TUI Script of :ref:`tui_create_axis_points` operation.
+
+Result
+""""""
+
+The Result of the operation will be an axis based on two points:
+
+.. image:: images/CreatedAxis2.png
+          :align: center
+
+.. centered::
+   **Axis by two points**
+
+**See Also** a sample TUI Script of :ref:`tui_create_axis_points` operation.
+
+
+By line
+-------
+
+.. image:: images/Axis3.png
+   :align: center
+       
+.. centered::
+   **By a line**
+
+An axis is defined by a linear edge.
+
+**TUI Commands**:
+
+.. 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 the selected line:
+
+.. image:: images/CreatedAxis3.png
+          :align: center
+
+.. centered::
+   **Axis by line**
+
+**See Also** a sample TUI Script of :ref:`tui_create_axis_line` operation.
+
+
+As an axis of cylindrical face
+------------------------------
+
+.. image:: images/Axis4.png
+   :align: center
+       
+.. centered::
+   **By a cylinder**
+
+An axis is defined by a cylindrical face. Axis of the cylinder will be an axis object.
+
+**TUI Commands**:
+
+.. py:function:: model.addAxis(Part_doc, model.selection("FACE", "Cylinder_1_1/Face_1"))
+
+    :param part: The current part object.
+    :param object: Cylindrical face.
+    :return: Result object.
+
+Result
+""""""
+
+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 :ref:`tui_create_axis_cylinder` operation.
+
+
+By plane and point
+------------------
+
+.. image:: images/Axis5.png
+   :align: center
+       
+.. centered::
+   **By a plane and point**
+
+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**:
+
+.. 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
+""""""
+
+The Result of the operation will be an axis:
+
+.. image:: images/CreatedAxis5.png
+          :align: center
+
+.. centered::
+   **Axis by plane and point**
+
+**See Also** a sample TUI Script of :ref:`tui_create_axis_plane` operation.
+
+
+By two planes
+-------------
+
+.. image:: images/Axis6.png
+   :align: center
+       
+.. centered::
+   **By two 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**:
+
+.. py:function:: model.addAxis(Part_doc, model.selection("FACE", "Box_1_1/Top"), 5, False, model.selection("FACE", "Box_1_1/Front"), 3, False)
+
+    :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
+""""""
+
+The Result of the operation will be an axis:
+
+.. image:: images/CreatedAxis6.png
+          :align: center
+
+.. centered::
+   **Axis by two planes**
+
+**See Also** a sample TUI Script of :ref:`tui_create_axis_twoplanes` operation.