src/ConstructionPlugin/doc/axisFeature.rst

   1
   2 Axis
   3 ====
   4
   5 The feature Axis creates a new constructive axis line.
   6
   7 Axis is a construction object and it can be created as in a part as in part set. 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 cilindrical face** creates an axis using a cilindrical 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 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 In this case user has to define dX, dY, 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 By two points
  60 """""""""""""
  61
  62 .. image:: images/Axis2.png
  63    :align: center
  64
  65 .. centered::
  66    **By two points**
  67
  68 In this case user has to select two points or vertices.
  69
  70 **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"))*
  71
  72 **Arguments**: Part + 2 vertices.
  73
  74 By line
  75 """""""
  76
  77 .. image:: images/Axis3.png
  78    :align: center
  79
  80 .. centered::
  81    **By a line**
  82
  83 In this case user has to select a linear edge.
  84
  85 **TUI Commands**:  *model.addAxis(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"))*
  86
  87 **Arguments**: Part + edge.
  88
  89 As an axis of cilindrical face
  90 """"""""""""""""""""""""""""""
  91
  92 .. image:: images/Axis4.png
  93    :align: center
  94
  95 .. centered::
  96    **By a cylinder**
  97
  98 In this case user has to select a cylindrical face. Axis of the cylinder will define an axis object.
  99
 100 **TUI Commands**:  *model.addAxis(Part_doc, model.selection("FACE", "Cylinder_1_1/Face_1"))*
 101
 102 **Arguments**: Part + cylindrical face.
 103
 104 By plane and point
 105 """"""""""""""""""
 106
 107 .. image:: images/Axis5.png
 108    :align: center
 109
 110 .. centered::
 111    **By a plane and point**
 112
 113 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.
 114
 115 **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"))*
 116
 117 **Arguments**: Part + plane + point.
 118
 119 By two planes
 120 """""""""""""
 121
 122 .. image:: images/Axis6.png
 123    :align: center
 124
 125 .. centered::
 126    **By two planes**
 127
 128 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.
 129
 130 **TUI Commands**: *model.addAxis(Part_doc, model.selection("FACE", "Box_1_1/Top"), 5, False, model.selection("FACE", "Box_1_1/Front"), 3, False)*
 131
 132 **Arguments**: Part + plane + offcet value + is reversed flag + plane + offcet value + is reversed flag.
 133
 134 Result
 135 """"""
 136
 137 The Result of the operation will be an axis:
 138
 139 .. image:: images/CreatedAxis.png
 140            :align: center
 141
 142 .. centered::
 143    Axis created
 144
 145 **See Also** a sample TUI Script of a :ref:`tui_create_axis` operation.