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 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 By three points
  37 """""""""""""""
  38
  39 .. image:: images/Plane1.png
  40    :align: center
  41
  42 .. centered::
  43    **By three points**
  44
  45 In this case user has to select three points in a viewer to define a new plane.
  46
  47 **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"))*
  48
  49 **Arguments**: Part + 3 vertices.
  50
  51 By line and point
  52 """""""""""""""""
  53
  54 .. image:: images/Plane2.png
  55    :align: center
  56
  57 .. centered::
  58    **Line and point**
  59
  60 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.
  61
  62 **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)*
  63
  64 **Arguments**: Part + line + point + is perpendicular to line flag.
  65
  66 By other plane
  67 """"""""""""""
  68
  69 .. image:: images/Plane3.png
  70    :align: center
  71
  72 .. centered::
  73    **By other plane**
  74
  75 In this case user has to select an already existing plane (planar face). There are following possibilities to define a new plane:
  76
  77 .. image:: images/plane_by_distance_from_other_24x24.png
  78    :align: left
  79
  80 By distance from the selected plane.
  81
  82 .. image:: images/plane_by_coincident_to_point_24x24.png
  83    :align: left
  84
  85 By coincidence to a point.
  86
  87 .. image:: images/plane_by_rotation_24x24.png
  88    :align: left
  89
  90 By rotation around an edge on a specified angle.
  91
  92 **TUI Commands**: *model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Front"), 10, False)*
  93
  94 **Arguments**: Part + a plane + offset + is reverse flag.
  95
  96
  97 By two parallel planes
  98 """"""""""""""""""""""
  99
 100 .. image:: images/Plane4.png
 101    :align: center
 102
 103 .. centered::
 104    **By two parallel planes**
 105
 106 In this case user has to select two parallel planes. A new plane will be defined between them.
 107
 108 **TUI Commands**: *model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Right"))*
 109
 110 **Arguments**: Part + 2 planes.
 111
 112 Result
 113 """"""
 114
 115 The Result of the operation will be a plane:
 116
 117 .. image:: images/CreatedPlane.png
 118            :align: center
 119
 120 .. centered::
 121    Plane created
 122
 123 **See Also** a sample TUI Script of a :ref:`tui_create_plane` operation.