src/ConstructionPlugin/doc/planeFeature.rst

   1 .. |plane_button.icon|    image:: images/plane_button.png
   2
   3 Plane
   4 =====
   5
   6 Plane feature creates a new constructive plane.
   7
   8 Plane is a construction object that can be created in a part or in a partset. To create a plane:
   9
  10 #. select in the Main Menu *Construction - > Plane* item  or
  11 #. click |plane_button.icon| **Point** button in the toolbar
  12
  13 There are 4 algorithms for creation of a Plane:
  14
  15 .. figure:: images/plane_by_three_points_32x32.png
  16    :align: left
  17    :height: 24px
  18
  19 **By three points** creates a plane by three points.
  20
  21 .. figure:: images/plane_by_line_and_point_32x32.png
  22    :align: left
  23    :height: 24px
  24
  25 **By line and point** creates a plane by a line and a point.
  26
  27 .. figure:: images/plane_by_other_plane_32x32.png
  28    :align: left
  29    :height: 24px
  30
  31 **By other plane** creates a plane or planes(if the number of copies is more than one) parallel to another plane.
  32
  33 .. figure:: images/plane_by_two_parallel_planes_32x32.png
  34    :align: left
  35    :height: 24px
  36
  37 **By two parallel planes** creates a plane between two parallel planes.
  38
  39 --------------------------------------------------------------------------------
  40
  41 By three points
  42 ---------------
  43
  44 .. figure:: images/Plane1.png
  45    :align: center
  46
  47    **By three points**
  48
  49 A plane is created by selecting three points in a viewer.
  50
  51 **TUI Commands**:
  52
  53 .. py:function:: model.addPlane(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/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Left&Box_1_1/Bottom"))
  54
  55     :param part: The current part object.
  56     :param object: Vertex 1.
  57     :param object: Vertex 2.
  58     :param object: Vertex 3.
  59     :return: Result object.
  60
  61 Result
  62 """"""
  63
  64 The Result of the operation will be a plane:
  65
  66 .. figure:: images/CreatedPlane1.png
  67    :align: center
  68
  69    **A plane by three points**
  70
  71 **See Also** a sample TUI Script of :ref:`tui_create_plane_points` operation.
  72
  73
  74 By line and point
  75 -----------------
  76
  77 .. figure:: images/Plane2.png
  78    :align: center
  79
  80    **Line and point**
  81
  82 A plane is created by selecting  a linear edge and point. It is possible to create a new plane perpendicular to the selected edge.
  83
  84 **TUI Commands**:
  85
  86 .. py:function:: model.addPlane(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Bottom"), False)
  87
  88     :param part: The current part object.
  89     :param object: A line.
  90     :param object: A point.
  91     :param boolean: Is perpendicular to line.
  92     :return: Result object.
  93
  94 Result
  95 """"""
  96
  97 The Result of the operation will be a plane:
  98
  99 .. figure:: images/CreatedPlane2.png
 100    :align: center
 101
 102    Plane created
 103
 104 **See Also** a sample TUI Script of :ref:`tui_create_plane_line` operation.
 105
 106
 107 By other plane
 108 --------------
 109
 110 .. figure:: images/Plane3.png
 111    :align: center
 112
 113    **By other plane**
 114
 115 A plane is created by selecting an already existing plane (planar face). There are following possibilities to define a new plane:
 116
 117 .. figure:: images/plane_by_distance_from_other_24x24.png
 118    :height: 24px
 119    :align: left
 120
 121 By distance from the selected plane.
 122
 123 .. figure:: images/plane_by_coincident_to_point_24x24.png
 124    :height: 24px
 125    :align: left
 126
 127 By coincidence with a point.
 128
 129 .. figure:: images/plane_by_rotation_24x24.png
 130    :height: 24px
 131    :align: left
 132
 133 By rotation around an edge by a specified angle.
 134
 135 **TUI Commands**:
 136
 137 .. py:function:: model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Front"), 10, False, 1)
 138
 139     :param part: The current part object.
 140     :param object: A plane.
 141     :param real: An offset.
 142     :param boolean: Is reverse.
 143     :param integer: Number of copies
 144     :return: Result object.
 145
 146 Result
 147 """"""
 148
 149 The Result of the operation will be a plane (or planes at equal distance from each other, if the number of copies is more than one) parallel to already existing one:
 150
 151 .. figure:: images/CreatedPlane3.png
 152    :align: center
 153
 154    **Plane parallel to a planar face**
 155
 156 **See Also** a sample TUI Script of :ref:`tui_create_plane_plane` operation.
 157
 158
 159 By two parallel planes
 160 ----------------------
 161
 162 .. figure:: images/Plane4.png
 163    :align: center
 164
 165    **By two parallel planes**
 166
 167 A plane is created by selecting two parallel planes. A new plane will be defined between them.
 168
 169 **TUI Commands**:
 170
 171 .. py:function:: model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Right"))
 172
 173     :param part: The current part object.
 174     :param object: A plane 1.
 175     :param object: A plane 2.
 176     :return: Result object.
 177
 178 Result
 179 """"""
 180
 181 The Result of the operation will be a plane created between two selected planes:
 182
 183 .. figure:: images/CreatedPlane4.png
 184    :align: center
 185
 186    **Plane created between others**
 187
 188 **See Also** a sample TUI Script of :ref:`tui_create_plane_parallel` operation.