src/ConstructionPlugin/doc/axisFeature.rst

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