From: vsr <vsr@opencascade.com>
Date: Wed, 12 May 2010 06:51:14 +0000 (+0000)
Subject: 0020764: EDF 1280 GEOM: Function 'Add Point on Edge' (in Repair menu)
X-Git-Tag: V5_1_4rc2~11
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=adda7ddab3812a5567c0b6f1b1b235b08f1f981d;p=modules%2Fgeom.git

0020764: EDF 1280 GEOM: Function 'Add Point on Edge' (in Repair menu)
Improve documentation
---

diff --git a/doc/salome/gui/GEOM/input/add_point_on_edge_operation.doc b/doc/salome/gui/GEOM/input/add_point_on_edge_operation.doc
index 465928b80..4a58ee64a 100644
--- a/doc/salome/gui/GEOM/input/add_point_on_edge_operation.doc
+++ b/doc/salome/gui/GEOM/input/add_point_on_edge_operation.doc
@@ -5,23 +5,35 @@
 \n To <b>Add Point on Edge</b> in the <b>Main Menu</b> select
 <b>Repair - > Add Point on Edge</b>.
 
-\n This operation splits an edge in two in accordance with the
+\n This operation splits an edge in two new edges in accordance with the
 specified mode (by length or by parameter) and a value specifying the
 position of the point on edge (for example val =0.5; mode =
-Length). This operation is available in <b>OCC Viewer</b> only.
+by length). This operation is available in <b>OCC Viewer</b> only.
 
 \n The \b Result will be a \b GEOM_Object.
 
 \n <b>TUI Command:</b> <em>geompy.DivideEdge(Shape, EdgeID, Value,
-IsByParameter), </em> where \em Shape is a shape which contains an edge to
-be divided, \em EdgeID is the ID of the edge to be divided, if it = -1,
-then Shape is an edge, \em Value is a paramter on the edge or a
-length. \em IsByParameter if it is True then Value is the edge parameter
-in the range [0:1] otherwise it is a part of the length of the edge in the range
-[0: full length of the edge]
-\n <b>Arguments:</b> Name + 1 Edge + 1 value setting the position of
+IsByParameter)</em>
+- \em Shape is a shape which contains an edge to be divided
+- \em EdgeID is the ID of the edge to be divided, if it is = -1, 
+then \em Shape should be an edge itself
+- \em Value is a value of parameter on edge or length parameter,
+depending on \em IsByParameter.
+- \em IsByParameter is a boolean flag, specifying operation mode:
+  - \c True: \em Value is treated as a curve parameter [0..1]
+  - \c False: \em Value is treated as a length parameter [0..1] 
+
+<b>Arguments:</b> Name + 1 Edge + 1 Value setting the position of
 the point according to one of the selected modes.
 
+The difference between "by parameter" and "by length" modes becomes
+apparent on the edges with irregular parametrization (for example,
+b-splines which usually have irregular density by the length).
+For example, value 0.5 "by length" on such edge will produce the point
+in the middle of this edge (equidistant from both its ends); the same
+0.5 value "by parameter" will result in the point situated closer to
+one of the ends (depending on the actual parametrization).
+
 \image html repair8.png
 
 \n <b>Example:</b>