doc/salome/gui/GEOM/input/creating_edge.doc

   1 /*!
   2
   3 \page create_edge_page Edge
   4
   5 To create an \b Edge, in the <b>Main Menu</b> select <b>New Entity >
   6 Build > Edge</b>
   7
   8 There are three ways to create an edge. In all cases the \b Result
   9 will be a \b GEOM_Object (EDGE).
  10
  11 Firstly, you can create a linear \b Edge by specifying two points (\b Point1 and
  12 \b Point2), which are the first and the last vertices of the edge.
  13
  14 <b>TUI Command:</b> <em>geompy.MakeEdge(Vertex1, Vertex2)</em><br>
  15 <b>Arguments:</b> Name + 2 vertices (Vertex1 and Vertex2 are
  16 correspondingly the first and the last vertex of the edge).
  17
  18 \image html edge1.png "Create edge by two points"
  19
  20 Secondly, you can create an \b Edge by specifying a single wire.
  21
  22 In this mode the following use cases are possible:
  23 - All edges that form the wire lie on the same geometrical curve
  24 (i.e. curve(edge1) == curve(edge2)).
  25 - The edges that form the wire lie on analytical curves of the same
  26 type, for example, segments of line, arcs, etc. In this case, the
  27 algorithm checks geometrical coincidence of these curves using
  28 a certain tolerance. If the curves are coinciding in terms of the given
  29 tolerance, the resulting edge is built as if on a single curve.
  30 - The edges that form the wire have the same tangency in the connection
  31 points. In this case the curves are interpolated by the single
  32 b-spline curve with sufficient precision. The resulting edge will
  33 be built on this curve.
  34
  35 The case when the edges that form the wire have different tangency in
  36 the connection points (sharp bend) is not processed.
  37
  38 <b>TUI Command:</b> <em>geompy.MakeEdgeWire(Wire, LinearTolerance, AngularTolerance)</em><br>
  39 <b>Arguments:</b> Name + 1 wire + Linear Tolerance + Angular Tolerance
  40 (tolerance values are used to check coincidence of the underlying curves).
  41
  42 \image html edge2.png "Create edge from wire"
  43
  44 Thirdly, it is possible to build an edge of required \b Length on any existing
  45 \b Edge.
  46
  47 <b>Start Point</b> parameter is optional:
  48 - if used, it allows selecting any existing point - in such a case the start point
  49 of the new edge will be chosen as start or end point of the selected \b Edge
  50 whatever is closest to the selected <b>Start Point</b>
  51 - if it is missed, the start point of the initial edge is used
  52
  53 <b>Length</b> can exceed the length of the initial edge length or be
  54 negative. In this case the existing edge is extrapolated
  55 along its curve (except for bezier and b-spline curves).
  56
  57 <b>TUI Command:</b> <em>geompy.MakeEdgeOnCurveByLength(Edge, Length, StartPoint = None)</em><br>
  58 <b>Arguments:</b> Name + 1 edge + Length + 1 Vertex
  59
  60 \image html edge3.png "Create edge on curve"
  61
  62 <b>Example:</b>
  63
  64 \image html edgesn.png "Edge"
  65
  66 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  67 \ref tui_creation_edge "Advanced Geometric Objects".
  68
  69 */