doc/salome/gui/GEOM/input/creating_plane.doc

   1 /*!
   2
   3 \page create_plane_page Plane
   4
   5 To create a \b Plane in the <b>Main Menu</b> select <b>New Entity - >
   6 Basic - > Plane</b>
   7
   8 \n There are three algorithms to create a plane in the 3D space.
   9 \n The \b Result of each operation will be a GEOM_Object (face).
  10
  11 \n Firstly, you can define a \b Plane by a \b Point through which  the
  12 plane passes, a \b Vector giving a normal of the plane and a <b>Size
  13 of the Plane</b> (size of a side of quadrangle face, representing the
  14 plane).
  15 \n <b>TUI Command:</b> <em>geompy.MakePlane(Point, Vector, TrimSize)</em>
  16 \n <b>Arguments:</b> Name + 1 vertex + 1 vector  + 1 value (to define
  17 the size of the plane).
  18
  19 \image html plane1.png
  20
  21 \n Secondly, you can define a \b Plane by three \b Points through
  22 which  the plane passes and a <b>Size of the Plane</b>.
  23 \n <b>TUI Command:</b> <em>geompy.MakePlaneThreePnt(Point1, Point2, Point3, TrimSize)</em>
  24 \n <b>Arguments:</b> Name + 3 vertices + 1 value (to define the size
  25 of the plane).
  26
  27 \image html plane2.png
  28
  29 \n Thirdly, you can define a \b Plane by another \b Plane or <b>Face</b> and a <b>Size of the Plane</b>.
  30 \n <b>TUI Command:</b> <em>geompy.MakePlaneFace(Face, TrimSize)</em>
  31 \n <b>Arguments:</b> Name + 1 face + 1 value (to define the size of the plane).
  32
  33 \image html plane3.png
  34
  35 \n Fourthly, you can define a \b Plane by two Vectors. The first vector defines the center point and the direction,
  36 the second vector defines the normal to the Plane.
  37 \n <b>TUI Command:</b> <em>geompy.MakePlane2Vec(Vec1, Vec2, TrimSize)</em>
  38 \n <b>Arguments:</b> Name + 2 vectors + 1 value (to define the size of the plane).
  39
  40 \image html plane4.png
  41
  42 \n Finally, you can define a \b Plane by the Local Coordinate System and the orientation (OXY, OYZ, OZX).
  43 \n <b>TUI Command:</b> <em>geompy.MakePlaneLCS(LCS, TrimSize, [1, 2, or 3])</em>
  44 \n <b>Arguments:</b> Name + LCS + 1 value (to define the size of the plane) + 1 value (to define the orientation)
  45
  46 \image html plane5.png
  47
  48 <b>Examples:</b>
  49
  50 \image html planes1.png
  51 <center>Planes created on the basis of the Global Coordinate System</center>
  52
  53 \image html plane_on_face.png
  54 <center>A Plane created on a Face of another Shape</center>
  55
  56 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  57 \ref tui_creation_plane "Basic Geometric Objects".
  58
  59 */