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