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 Parameter
  29 indicating its position on the Edge, ranging from 0.0 to 1.0. For example, 0.5 means that the
  30 point is located in the middle of the edge.
  31 \n <b>TUI Command:</b> <em>geompy.MakeVertexOnCurve(Edge,Parameter).</em>
  32 \n <b>Arguments:</b> Name + 1 edge  + 1 Parameter defining the
  33 position of the point on the given edge.
  34 \image html point3.png
  35
  36 Alternatively, it is possible to define a point by an \b Edge and a \b Length.
  37 The \b Length defines the position of the point on the given edge. It
  38 can exceed the length of the edge or be negative. In this case the edge
  39 is extrapolated along its curve (except for bezier and b-spline
  40 curves).
  41 The <b>Start Point</b> defines the direction for the length
  42 calculation (if not defined, the first vertex of
  43 Edge is used, else the vertex of Edge closest to StartPoint is used).
  44 \n <b>TUI Command:</b> <em>geompy.MakeVertexOnCurveByLength(Edge,Length,StartPoint=None).</em>
  45 \n <b>Arguments:</b> Name + 1 edge  + 1 Length  + 1 Point.
  46
  47 \image html point3_3.png
  48
  49 It is also possible to define 3D coordinates of the point
  50 projected on the given edge to produce the resulting point.
  51 \n <b>TUI Command:</b> <em>geompy.MakeVertexOnCurveByCoord(Edge,X,Y,Z).</em>
  52 \n <b>Arguments:</b> Name + 1 edge  + 3 coordinate values of the
  53 projected point.
  54 \image html point3_2.png
  55
  56 \n Fourthly, we can define a point(s) by intersection of two \b Lines or \b Wires (or a Wire and a Line).
  57 If they intersect only once, a point will be created. If there are several intersections, a compound of
  58 points will be created. The type of the selected object (Line or Wire) can be changed in the popup menu,
  59 after clicking the corresponding selection button. (see the picture below)
  60 \n <b>TUI Command:</b> <em>geompy.MakePointOnLinesIntersection(myLine1,myWire1).</em>
  61 \n <b>Arguments:</b> Name + 2 1D objects
  62
  63 \image html point4.png
  64
  65 \n Finally, we can define a point by a \b Face and
  66 Two <b> Parameters: U </b> and \b V
  67 indicating its position on the Face, ranging from 0.0 to 1.0. For example, (0.5; 0.5) means that the
  68 point is located in the middle of the face.
  69 \n <b>TUI Command:</b> <em>geompy.MakeVertexOnSurface(myFace,myUParameter,myVParameter).</em>
  70 \n <b>Arguments:</b> Name + 1 face + 2 Parameters defining the
  71 position of the point on the given face.
  72
  73 \image html point5.png
  74
  75 Alternatively, it is possible to define 3D coordinates of the point projected on the given face.
  76 \n <b>TUI Command:</b> <em>geompy.MakeVertexOnSurfaceByCoord(myFace,X,Y,Z).</em>
  77 \n <b>Arguments:</b> Name + 1 face  + 3 coordinate values
  78 to project point on the given face.
  79
  80 \image html point5_2.png
  81
  82 <b>Example:</b>
  83
  84 \image html points.png "Points by edge and parameter and by coordinates"
  85
  86 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  87 \ref tui_creation_point "Basic Geometric Objects".
  88
  89 */