Salome HOME
Merge branch HELP_DOCUMENTATION_EDITING into master.
[modules/shaper.git] / src / ConstructionPlugin / doc / axisFeature.rst
index bb372bbca1fae423425f3e5c2452ff5bb241bcd7..5be237cb951116bc5f37e5cfb1df3174058a2d4d 100644 (file)
@@ -1,3 +1,145 @@
 
 Axis
 ====
+
+The feature Axis 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:
+
+#. 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
+
+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 cilindrical face** creates an axis using a cilindrical 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 intersection of two planes.
+
+By three dimensions
+"""""""""""""""""""
+
+.. image:: images/Axis1.png
+   :align: center
+       
+.. centered::
+   **By dX, dY, dZ values**
+
+In this case user has to define dX, dY, dZ values of a vector.
+
+**TUI Commands**:  *model.addAxis(Part_doc, 10, 10, 10)*
+
+**Arguments**: Part + 3 values (dX, dY, dZ values).
+
+By two points
+"""""""""""""
+
+.. image:: images/Axis2.png
+   :align: center
+       
+.. centered::
+   **By two points**
+
+In this case user has to select two points or vertices.
+
+**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"))*
+
+**Arguments**: Part + 2 vertices.
+
+By line
+"""""""
+
+.. image:: images/Axis3.png
+   :align: center
+       
+.. centered::
+   **By a line**
+
+In this case user has to select a linear edge.
+
+**TUI Commands**:  *model.addAxis(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"))*
+
+**Arguments**: Part + edge.
+
+As an axis of cilindrical face
+""""""""""""""""""""""""""""""
+
+.. image:: images/Axis4.png
+   :align: center
+       
+.. centered::
+   **By a cylinder**
+
+In this case user has to select a cylindrical face. Axis of the cylinder will define an axis object.
+
+**TUI Commands**:  *model.addAxis(Part_doc, model.selection("FACE", "Cylinder_1_1/Face_1"))*
+
+**Arguments**: Part + cylindrical face.
+
+By plane and point
+""""""""""""""""""
+
+.. image:: images/Axis5.png
+   :align: center
+       
+.. 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.
+
+**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"))*
+
+**Arguments**: Part + plane + point.
+
+By two planes
+"""""""""""""
+
+.. image:: images/Axis6.png
+   :align: center
+       
+.. 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.
+
+**TUI Commands**: *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.
+
+Result
+""""""
+
+The Result of the operation will be an axis:
+
+.. image:: images/CreatedAxis.png
+          :align: center
+
+.. centered::
+   Axis created  
+
+**See Also** a sample TUI Script of a :ref:`tui_create_axis` operation.