doc/salome/gui/GEOM/input/creating_point.doc

   1 /*!
   2
   3 \page create_point_page Point
   4
   5 To create a \b Point in the <b>Main Menu</b> select <b>New Entity - >
   6 Basic - > Point</b>
   7
   8 \n There are five algorithms to create a \b Point in the 3D space.
   9 \n Each time the \b Result of the operation will be a GEOM_Object
  10 (vertex).
  11
  12 \n Firstly, we can define a point by setting its X, Y and Z \b Coordinates.
  13 \n <b>TUI Command:</b> <em>geompy.MakeVertex(X, Y, Z)</em>
  14 \n \b Arguments: Name (Vertex_n by default) + X, Y and Z coordinates of
  15 the point.
  16
  17 \image html point1.png
  18
  19 \n Secondly,  we can define a point by a \b Reference to another point
  20 and the shift of the coordinates of the new point regarding the
  21 coordinates of the old one.
  22 \n <b>TUI Command:</b> <em>geompy.MakeVertexWithRef(Reference, X,Y,Z).</em>
  23 \n <b>Arguments:</b> Name + 1 reference point + 3 coordinates defining
  24 the position of this point regarding the reference one.
  25
  26 \image html point2.png
  27
  28 \n Thirdly, we can define a point by an \b Edge and a \b
  29 [list]
  30 [*]Parameter
  31 indicating its position on the Edge, ranging from 0.0 to 1.0. For example, 0.5 means that the
  32 point is located in the middle of the edge.
  33 \n <b>TUI Command:</b> <em>geompy.MakeVertexOnCurve(Edge,Parameter).</em>
  34 \n <b>Arguments:</b> Name + 1 edge  + 1 Parameter defining the
  35 position of the point on the given edge.
  36 \image html point3.png
  37 [*]3D co-ordinate of point to project on the given edge
  38 \n <b>TUI Command:</b> <em>geompy.MakeVertexOnCurveByCoord(Edge,X,Y,Z).</em>
  39 \n <b>Arguments:</b> Name + 1 edge  + 3 coordinate values
  40 to project point on the given edge.
  41 \image html point3_2.png
  42 [/list]
  43
  44
  45 \n Fourthly, we can define a point by intersection of two \b  Lines.
  46 \n <b>TUI Command:</b> <em>geompy.MakePointOnLinesIntersection(myLine1,myLine2).</em>
  47 \n <b>Arguments:</b> Name + 2 lines
  48
  49 \image html point4.png
  50 <b>Example:</b>
  51
  52 \n Finally, we can define a point by a \b Face and
  53 [list]
  54 [*]Two <b> Parameters: U </b> and \b V
  55 indicating its position on the Face, ranging from 0.0 to 1.0. For example, (0.5; 0.5) means that the
  56 point is located in the middle of the face.
  57 \n <b>TUI Command:</b> <em>geompy.MakeVertexOnSurface(myFace,myUParameter,myVParameter).</em>
  58 \n <b>Arguments:</b> Name + 1 face + 2 Parameters defining the
  59 position of the point on the given face.
  60 [*] 3D co-ordinate of point to project on the given face.
  61 \image html point5.png
  62 \n <b>TUI Command:</b> <em>geompy.MakeVertexOnSurface(myFace,X,Y,Z).</em>
  63 \n <b>Arguments:</b> Name + 1 face  + 3 coordinate values
  64 to project point on the given face.
  65 \image html point5_2.png
  66 [/list]
  67
  68 <b>Example:</b>
  69
  70 \image html points.png "Points by edge and parameter and by coordinates"
  71
  72 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  73 \ref tui_creation_point "Basic Geometric Objects".
  74
  75 */