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

Improve documentation
This commit is contained in:
vsr 2010-05-12 06:51:14 +00:00
parent bbf5ec60ee
commit adda7ddab3

View File

@ -5,23 +5,35 @@
\n To <b>Add Point on Edge</b> in the <b>Main Menu</b> select \n To <b>Add Point on Edge</b> in the <b>Main Menu</b> select
<b>Repair - > Add Point on Edge</b>. <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 specified mode (by length or by parameter) and a value specifying the
position of the point on edge (for example val =0.5; mode = 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 The \b Result will be a \b GEOM_Object.
\n <b>TUI Command:</b> <em>geompy.DivideEdge(Shape, EdgeID, Value, \n <b>TUI Command:</b> <em>geompy.DivideEdge(Shape, EdgeID, Value,
IsByParameter), </em> where \em Shape is a shape which contains an edge to IsByParameter)</em>
be divided, \em EdgeID is the ID of the edge to be divided, if it = -1, - \em Shape is a shape which contains an edge to be divided
then Shape is an edge, \em Value is a paramter on the edge or a - \em EdgeID is the ID of the edge to be divided, if it is = -1,
length. \em IsByParameter if it is True then Value is the edge parameter then \em Shape should be an edge itself
in the range [0:1] otherwise it is a part of the length of the edge in the range - \em Value is a value of parameter on edge or length parameter,
[0: full length of the edge] depending on \em IsByParameter.
\n <b>Arguments:</b> Name + 1 Edge + 1 value setting the position of - \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 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 \image html repair8.png
\n <b>Example:</b> \n <b>Example:</b>