doc/salome/gui/GEOM/input/creating_circle.doc

   1 /*!
   2
   3 \page create_circle_page Circle
   4
   5 To create a \b Circle in the <b>Main Menu</b> select <b>New Entity - >
   6 Basic - > Circle</b>
   7
   8 \n There are 3 algorithms to create a \b Circle in the 3D space.
   9 \n The \b Result of each operation will be a GEOM_Object (edge).
  10
  11 \n Firstly, you can define a \b Circle by a <b>Center Point</b>, a \b
  12 Vector giving the circle's normal and a \b Radius.
  13 \n <b>TUI Command:</b> <em>geompy.MakeCircle(Point, Vector,
  14 Radius)</em>
  15 \n <b>Arguments:</b> Name + 1 vertex (for the center) + 1 edge (for
  16 the direction) + Radius.
  17
  18 \note By default it is presumed that the <b>Center Point</b> is located at the  Origin of the global
  19 coordinate system, and the  \b Vector corresponds to OZ axis of the global
  20 coordinate system.
  21
  22 \image html circle1.png
  23
  24 \n Secondly, you can define a \b Circle by three \b Points that lie on it.
  25 \n <b>TUI Command:</b> <em>geompy.MakeCircleThreePnt(Point1, Point2, Point3)</em>
  26 \n <b>Arguments:</b> Name + 3 points which will form the circle.
  27
  28 \image html circle2.png
  29
  30 \n Finally, you can define a circle by a <b>Center Point</b> and two
  31 \b Points.
  32 \n <b>TUI Command:</b> <em>geompy.MakeCircleCenter2Pnt(Point1, Point2,
  33 Point3)</em>, where Point1 is the center of the circle, the distance
  34 between point1 and Point2 is the radius of the circle and Point3 helps
  35 to define the plane where the circle lies.
  36 \n <b>Arguments:</b> Name + 3 points.
  37
  38 \image html circle3.png
  39
  40 <b>Example:</b>
  41 \image html circles.png "A circle by vector and radius and a circle by three points"
  42
  43 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  44 \ref tui_creation_circle "Basic Geometric Objects".
  45
  46 */