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 .. image:: 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 .. image:: 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 .. image:: images/plane_by_other_plane_32x32.png
  28    :align: left
  29    :height: 24px
  30
  31 **By other plane** creates a plane parallel to another plane.
  32
  33 .. image:: 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 .. image:: images/Plane1.png
  45    :align: center
  46
  47 .. centered::
  48    **By three points**
  49
  50 A plane is created by selecting three points in a viewer.
  51
  52 **TUI Commands**:
  53
  54 .. 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"))
  55
  56     :param part: The current part object.
  57     :param object: Vertex 1.
  58     :param object: Vertex 2.
  59     :param object: Vertex 3.
  60     :return: Result object.
  61
  62 Result
  63 """"""
  64
  65 The Result of the operation will be a plane:
  66
  67 .. image:: images/CreatedPlane1.png
  68            :align: center
  69
  70 .. centered::
  71    **A plane by three points**
  72
  73 **See Also** a sample TUI Script of :ref:`tui_create_plane_points` operation.
  74
  75
  76 By line and point
  77 -----------------
  78
  79 .. image:: images/Plane2.png
  80    :align: center
  81
  82 .. centered::
  83    **Line and point**
  84
  85 A plane is created by selecting  a linear edge and point. It is possible to create a new plane perpendicular to the selected edge.
  86
  87 **TUI Commands**:
  88
  89 .. 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)
  90
  91     :param part: The current part object.
  92     :param object: A line.
  93     :param object: A point.
  94     :param boolean: Is perpendicular to line.
  95     :return: Result object.
  96
  97 Result
  98 """"""
  99
 100 The Result of the operation will be a plane:
 101
 102 .. image:: images/CreatedPlane2.png
 103            :align: center
 104
 105 .. centered::
 106    Plane created
 107
 108 **See Also** a sample TUI Script of :ref:`tui_create_plane_line` operation.
 109
 110
 111 By other plane
 112 --------------
 113
 114 .. image:: images/Plane3.png
 115    :align: center
 116
 117 .. centered::
 118    **By other plane**
 119
 120 A plane is created by selecting an already existing plane (planar face). There are following possibilities to define a new plane:
 121
 122 .. image:: images/plane_by_distance_from_other_24x24.png
 123    :height: 24px
 124    :align: left
 125
 126 By distance from the selected plane.
 127
 128 .. image:: images/plane_by_coincident_to_point_24x24.png
 129    :height: 24px
 130    :align: left
 131
 132 By coincidence with a point.
 133
 134 .. image:: images/plane_by_rotation_24x24.png
 135    :height: 24px
 136    :align: left
 137
 138 By rotation around an edge by a specified angle.
 139
 140 **TUI Commands**:
 141
 142 .. py:function:: model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Front"), 10, False)
 143
 144     :param part: The current part object.
 145     :param object: A plane.
 146     :param real: An offset.
 147     :param boolean: Is reverse.
 148     :return: Result object.
 149
 150 Result
 151 """"""
 152
 153 The Result of the operation will be a plane parallel to already existing one:
 154
 155 .. image:: images/CreatedPlane3.png
 156            :align: center
 157
 158 .. centered::
 159    **Plane parallel to a planar face**
 160
 161 **See Also** a sample TUI Script of :ref:`tui_create_plane_plane` operation.
 162
 163
 164 By two parallel planes
 165 ----------------------
 166
 167 .. image:: images/Plane4.png
 168    :align: center
 169
 170 .. centered::
 171    **By two parallel planes**
 172
 173 A plane is created by selecting two parallel planes. A new plane will be defined between them.
 174
 175 **TUI Commands**:
 176
 177 .. py:function:: model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Right"))
 178
 179     :param part: The current part object.
 180     :param object: A plane 1.
 181     :param object: A plane 2.
 182     :return: Result object.
 183
 184 Result
 185 """"""
 186
 187 The Result of the operation will be a plane created between two selected planes:
 188
 189 .. image:: images/CreatedPlane4.png
 190            :align: center
 191
 192 .. centered::
 193    **Plane created between others**
 194
 195 **See Also** a sample TUI Script of :ref:`tui_create_plane_parallel` operation.