src/ConstructionPlugin/doc/axisFeature.rst

   1
   2 Axis
   3 ====
   4
   5 Axis feature creates a new constructive axis line.
   6
   7 Axis is a construction object and it can be created in a part or in a partset. To create an axis:
   8
   9 #. select in the Main Menu *Construction - > Axis* item  or
  10 #. click **Axis** button in the toolbar
  11
  12 .. image:: images/axis_button.png
  13   :align: center
  14
  15 .. centered::
  16   **Axis** button
  17
  18 There are 6 algorithms for creation of an Axis:
  19
  20 .. image:: images/axis_dxyz_32x32.png
  21    :align: left
  22 **By three dimensions** creates an axis by dimensions along X, Y, Z axes starting form existing origin.
  23
  24 .. image:: images/by_two_points_32x32.png
  25    :align: left
  26 **By two points** creates an axis using existing points.
  27
  28 .. image:: images/axis_by_line_32x32.png
  29    :align: left
  30 **By line** creates an axis using a line.
  31
  32 .. image:: images/axis_by_line_32x32.png
  33    :align: left
  34 **As an axis of cylindrical face** creates an axis using a cylindrical face.
  35
  36 .. image:: images/axis_by_line_32x32.png
  37    :align: left
  38 **By plane and point** creates an axis using a plane and point.
  39
  40 .. image:: images/axis_by_line_32x32.png
  41    :align: left
  42 **By two planes** creates an axis as the intersection of two planes.
  43
  44 By three dimensions
  45 -------------------
  46
  47 .. image:: images/Axis1.png
  48    :align: center
  49
  50 .. centered::
  51    **By dX, dY, dZ values**
  52
  53 An axis is defined by dX, dY and dZ values of a vector.
  54
  55 **TUI Commands**:  *model.addAxis(Part_doc, 10, 10, 10)*
  56
  57 **Arguments**: Part + 3 values (dX, dY, dZ values).
  58
  59 Result
  60 """"""
  61
  62 The Result of the operation will be an axis defined by vector from origin:
  63
  64 .. image:: images/CreatedAxis1.png
  65            :align: center
  66
  67 .. centered::
  68    **Axis by three dimensions**
  69
  70 **See Also** a sample TUI Script of :ref:`tui_create_axis_xyz` operation.
  71
  72
  73 By two points
  74 -------------
  75
  76 .. image:: images/Axis2.png
  77    :align: center
  78
  79 .. centered::
  80    **By two points**
  81
  82 An axis is defined by two points or vertices.
  83
  84 **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"))*
  85
  86 **Arguments**: Part + 2 vertices.
  87
  88 **See Also** a sample TUI Script of :ref:`tui_create_axis_points` operation.
  89
  90 Result
  91 """"""
  92
  93 The Result of the operation will be an axis based on two points:
  94
  95 .. image:: images/CreatedAxis2.png
  96            :align: center
  97
  98 .. centered::
  99    **Axis by two points**
 100
 101 **See Also** a sample TUI Script of :ref:`tui_create_axis_points` operation.
 102
 103
 104 By line
 105 -------
 106
 107 .. image:: images/Axis3.png
 108    :align: center
 109
 110 .. centered::
 111    **By a line**
 112
 113 An axis is defined by a linear edge.
 114
 115 **TUI Commands**:  *model.addAxis(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"))*
 116
 117 **Arguments**: Part + edge.
 118
 119 Result
 120 """"""
 121
 122 The Result of the operation will be an axis based on the selected line:
 123
 124 .. image:: images/CreatedAxis3.png
 125            :align: center
 126
 127 .. centered::
 128    **Axis by line**
 129
 130 **See Also** a sample TUI Script of :ref:`tui_create_axis_line` operation.
 131
 132
 133 As an axis of cylindrical face
 134 ------------------------------
 135
 136 .. image:: images/Axis4.png
 137    :align: center
 138
 139 .. centered::
 140    **By a cylinder**
 141
 142 An axis is defined by a cylindrical face. Axis of the cylinder will be an axis object.
 143
 144 **TUI Commands**:  *model.addAxis(Part_doc, model.selection("FACE", "Cylinder_1_1/Face_1"))*
 145
 146 **Arguments**: Part + cylindrical face.
 147
 148 Result
 149 """"""
 150
 151 The Result of the operation will be an axis of the selected cylinder:
 152
 153 .. image:: images/CreatedAxis4.png
 154            :align: center
 155
 156 .. centered::
 157    **Axis cylindrical face**
 158
 159 **See Also** a sample TUI Script of :ref:`tui_create_axis_cylinder` operation.
 160
 161
 162 By plane and point
 163 ------------------
 164
 165 .. image:: images/Axis5.png
 166    :align: center
 167
 168 .. centered::
 169    **By a plane and point**
 170
 171 An axis is defined by a point or vertex and plane (or planar face) as a normal from the point to the plane.
 172
 173 **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"))*
 174
 175 **Arguments**: Part + plane + point.
 176
 177 Result
 178 """"""
 179
 180 The Result of the operation will be an axis:
 181
 182 .. image:: images/CreatedAxis5.png
 183            :align: center
 184
 185 .. centered::
 186    **Axis by plane and point**
 187
 188 **See Also** a sample TUI Script of :ref:`tui_create_axis_plane` operation.
 189
 190
 191 By two planes
 192 -------------
 193
 194 .. image:: images/Axis6.png
 195    :align: center
 196
 197 .. centered::
 198    **By two planes**
 199
 200 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.
 201
 202 **TUI Commands**: *model.addAxis(Part_doc, model.selection("FACE", "Box_1_1/Top"), 5, False, model.selection("FACE", "Box_1_1/Front"), 3, False)*
 203
 204 **Arguments**: Part + plane + offset value + is reversed flag + plane + offset value + is reversed flag.
 205
 206 Result
 207 """"""
 208
 209 The Result of the operation will be an axis:
 210
 211 .. image:: images/CreatedAxis6.png
 212            :align: center
 213
 214 .. centered::
 215    **Axis by two planes**
 216
 217 **See Also** a sample TUI Script of :ref:`tui_create_axis_twoplanes` operation.