Salome HOME
Merge branch 'fbt/addAngleInCylPrimitive'
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_point.doc
index 5e170327046556b193c2c3e5963f77c341be847b..a235bf0cd6a35f7e58e1566f91e178b793791085 100644 (file)
@@ -5,7 +5,7 @@
 To create a \b Point in the <b>Main Menu</b> select <b>New Entity - >
 Basic - > Point</b>
 
-\n There are four algorithms to create a \b Point in the 3D space.
+\n There are five algorithms to create a \b Point in the 3D space.
 \n Each time the \b Result of the operation will be a GEOM_Object
 (vertex).
 
@@ -31,19 +31,54 @@ point is located in the middle of the edge.
 \n <b>TUI Command:</b> <em>geompy.MakeVertexOnCurve(Edge,Parameter).</em>
 \n <b>Arguments:</b> Name + 1 edge  + 1 Parameter defining the
 position of the point on the given edge.
-
 \image html point3.png
 
-\n Finally, we can define a point by intersection of two \b  Lines.
-\n <b>TUI Command:</b> <em>geompy.MakePointOnLinesIntersection(myLine1,myLine2).</em>
-\n <b>Arguments:</b> Name + 2 lines
+Alternatively, it is possible to define a point by an \b Edge and a \b Length.
+The \b Length defines the position of the point on the given edge. It
+can exceed the length of the edge or be negative. In this case the edge
+is extrapolated along its curve (except for bezier and b-spline
+curves). 
+The <b>Start Point</b> defines the direction for the length
+calculation (if not defined, the first vertex of the 
+Edge is used, else the vertex of the Edge, which is closest to the Start Point).
+\n <b>TUI Command:</b> <em>geompy.MakeVertexOnCurveByLength(Edge,Length,StartPoint=None).</em>
+\n <b>Arguments:</b> Name + 1 edge  + 1 Length  + 1 Point.
+
+\image html point3_3.png
+
+It is also possible to define 3D coordinates of the point
+projected on the given edge to produce the resulting point.
+\n <b>TUI Command:</b> <em>geompy.MakeVertexOnCurveByCoord(Edge,X,Y,Z).</em>
+\n <b>Arguments:</b> Name + 1 edge  + 3 coordinate values of the
+projected point.
+\image html point3_2.png
+
+\n Fourthly, we can define a point by intersection of two \b Lines or \b Wires (or a Wire and a Line). 
+If they intersect only once, a point will be created. If there are several intersections, a compound of points will be created. The type of the selected object (Line or Wire) can be changed in the popup menu, after clicking the corresponding selection button. 
+\n <b>TUI Command:</b> <em>geompy.MakePointOnLinesIntersection(myLine1,myWire1).</em>
+\n <b>Arguments:</b> Name + 2 1D objects
 
 \image html point4.png
+
+\n Finally, we can define a point located on a \b Face. 
+The position of the point on it can be defined in one of two ways:
+
+- by two <b> Parameters: U </b> and \b V, ranging from 0.0 to 1.0. For example, (0.5; 0.5) means that the point is located in the middle of the face.
+\n <b>TUI Command:</b> <em>geompy.MakeVertexOnSurface(myFace,myUParameter,myVParameter).</em>
+\n <b>Arguments:</b> Name + 1 face + 2 Parameters defining the position of the point on the given face.
+
+\image html point5.png
+
+- by three coordinates of the point projected on the given face.
+\n <b>TUI Command:</b> <em>geompy.MakeVertexOnSurfaceByCoord(myFace,X,Y,Z).</em>
+\n <b>Arguments:</b> Name + 1 face  + 3 coordinate values to project point on the given face.
+
+\image html point5_2.png
+
 <b>Example:</b>
 
-\image html points.png
+\image html points.png "Points by edge and parameter and by coordinates"
 
-Our <b>TUI Scripts</b> provide you with useful examples of creation of 
-\ref tui_creation_point "Basic Geometric Objects".
+Our <b>TUI Scripts</b> provide you with useful examples of creation of \ref tui_creation_point "Basic Geometric Objects".
 
 */