src/ConstructionPlugin/doc/planeFeature.rst

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