doc/salome/gui/GEOM/input/add_point_on_edge_operation.doc

   1 /*!
   2
   3 \page add_point_on_edge_operation_page Add Point on Edge
   4
   5 \n To <b>Add Point on Edge</b> in the <b>Main Menu</b> select
   6 <b>Repair - > Add Point on Edge</b>.
   7
   8 \n This operation splits an edge in two new edges in accordance with the
   9 specified mode (by length or by parameter) and a value specifying the
  10 position of the point on edge (for example val =0.5; mode =
  11 by length). This operation is available in <b>OCC Viewer</b> only.
  12
  13 \n The \b Result will be a \b GEOM_Object.
  14
  15 \n <b>TUI Command:</b> <em>geompy.DivideEdge(Shape, EdgeID, Value,
  16 IsByParameter)</em>
  17 - \em Shape is a shape which contains an edge to be divided
  18 - \em EdgeID is the ID of the edge to be divided, if it is = -1,
  19 then \em Shape should be an edge itself
  20 - \em Value is a value of parameter on edge or length parameter,
  21 depending on \em IsByParameter.
  22 - \em IsByParameter is a boolean flag, specifying operation mode:
  23   - \c True: \em Value is treated as a curve parameter [0..1]
  24   - \c False: \em Value is treated as a length parameter [0..1]
  25
  26 <b>Arguments:</b> Name + 1 Edge + 1 Value setting the position of
  27 the point according to one of the selected modes.
  28
  29 The difference between "by parameter" and "by length" modes becomes
  30 apparent on the edges with irregular parametrization (for example,
  31 b-splines which usually have irregular density by the length).
  32 For example, value 0.5 "by length" on such edge will produce the point
  33 in the middle of this edge (equidistant from both its ends); the same
  34 0.5 value "by parameter" will result in the point situated closer to
  35 one of the ends (depending on the actual parametrization).
  36
  37 \image html repair8.png
  38
  39 \n <b>Example:</b>
  40
  41 \image html image167.png "The initial edge"
  42
  43 \image html image168.png "The edge split in two segments"
  44
  45 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  46 \ref tui_add_point_on_edge "Repairing Operations".
  47
  48 */