Small change of the interface for MakeVertexOnCurveByLength function: use boolean...

[modules/geom.git] / doc / salome / gui / GEOM / input / creating_point.doc

diff --git a/doc/salome/gui/GEOM/input/creating_point.doc b/doc/salome/gui/GEOM/input/creating_point.doc
index fadededd8381ae5c714a3dc90bf4794318cc489e..295e3ede18bcd153fe00d463ab967f7a449cde74 100644 (file)
--- a/doc/salome/gui/GEOM/input/creating_point.doc
+++ b/doc/salome/gui/GEOM/input/creating_point.doc
@@ -33,16 +33,27 @@ point is located in the middle of the edge.
 position of the point on the given edge.
 \image html point3.png
 
 position of the point on the given edge.
 \image html point3.png
 

-Alternatively, it is possible to define 3D coordinates of the point
+Alternatively, it is possible to define the point by \b Edge and \b Length,
+the given length must not exceed the length of the edge. The orientation of the edge can be reversed.
+\n <b>TUI Command:</b> <em>geompy.MakeVertexOnCurveByLength(Edge,Length,Reverse).</em>
+\n <b>Arguments:</b> Name + 1 edge  + 1 Length defining the
+position of the point on the given edge + 1 Reverse flag defining the direction for the
+calculation of the length (False = forward, True = reversed).
+\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
 
 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.
-\n <b>TUI Command:</b> <em>geompy.MakePointOnLinesIntersection(myLine1,myLine2).</em>
-\n <b>Arguments:</b> Name + 2 lines
+\n Fourthly, we can define a point(s) 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. (see the picture below) 
+\n <b>TUI Command:</b> <em>geompy.MakePointOnLinesIntersection(myLine1,myWire1).</em>
+\n <b>Arguments:</b> Name + 2 1D objects

 
 \image html point4.png
 
 
 \image html point4.png