doc/salome/gui/GEOM/input/creating_curve.doc

   1 /*!
   2
   3 \page create_curve_page Curve
   4
   5 To create a \b Curve in the <b>Main Menu</b> select <b>New Entity - >
   6 Basic - > Curve</b>
   7
   8 There are three <b>Curve Construction</b> menu choices corresponding to three
   9 possible types of curves: Polyline, Besier or B-spline (Interpolated).
  10 The curve is defined by a list of \b Points through which it passes.
  11
  12
  13 \n There are two ways to define these <b>Points</b>:
  14 <ul>
  15 <li> <b>By Selection</b> manual picking of the points in the Object Browser or 3D Viewer.
  16 <li> <b>Analytical</b> parametric definition of the points through
  17 python expressions.
  18 </ul>
  19
  20 \n The \b Result of each operation will be a GEOM_Object (edge).
  21
  22 <b>Polyline</b>
  23
  24 \image html polyline.png
  25
  26 Polyline or polygonal chain is a connected series of line segments. It
  27 can be defined by the following parameters:
  28
  29 \image html curve2.png
  30
  31 <ul>
  32 <li><b>Points</b> at least 2 points which will serve as nodes on the curve.</li>
  33 <li><b>Build a closed wire</b> checkbox allows creating the curve as
  34 closed wire.</li>
  35 </ul>
  36
  37 \n <b>TUI Command:</b> <em>geompy.MakePolyline(ListOfShapes,isClosed)</em>
  38
  39 <b>Bezier</b>
  40
  41 \image html bezier.png
  42
  43 Bezier curve is a curve completely contained in a convex hull of its
  44 control points. It can be defined by the following parameters:
  45
  46
  47 \image html curve3.png
  48
  49 <ul>
  50 <li><b>Points</b> at least 2 points used to approximate the curve.</li>
  51 <li><b>Build a closed edge</b> checkbox allows creating the curve as
  52 closed edge.</li>
  53 </ul>
  54
  55 \n <b>TUI Command:</b> <em>geompy.MakeBezier(ListOfShapes,isClosed)</em>
  56
  57 <b>B-spline</b>
  58
  59 \image html interpol.png
  60
  61 B-spline is a union of curve segments defined at each node span. It
  62 can be defined by the following parameters:
  63
  64 \image html curve4.png
  65
  66 <ul>
  67 <li><b>Points</b> at least 2 points which will serve as nodes on the curve.</li>
  68 <li><b>Build a closed edge</b> checkbox allows creating the curve as
  69 closed edge.</li>
  70 <li> If <b>Reorder vertices taking into account distances</b> is
  71 checked, the interpolation algorithm does not follow the order of
  72 vertices but searches for the closest vertex.</li>
  73 <li><b>Tangents</b> are two vectors, defining the direction at the ends of the
  74 curve. It is necessary to set both vectors or none. This option is available only
  75 if both above check boxes are not checked.
  76 </li>
  77 </ul>
  78
  79 \n <b>TUI Command:</b>
  80 <br><em>geompy.MakeInterpol(ListOfShapes,isClosed,doReordering)</em>
  81 <br><em>geompy.MakeInterpolWithTangents(ListOfShapes,Vector1,Vector2)</em>
  82
  83 <b>Analytical Definition</b>
  84
  85 The input parameters for analytical definition are common for all
  86 types of curves.
  87
  88 \image html curve1.png
  89
  90 <ul>
  91 <li><b>X(t)equation, Y(t)equation, Z(t)equation</b> are python
  92 expressions for X, Y and Z coordinates of the basic points of the curve.</li>
  93 <li><b>Min t, Max t</b> are minimum and maximum values of the parameter \b t.</li>
  94 <li><b>Step</b> is the number of steps of the parameter \b t.</li>
  95 </ul>
  96
  97 \n <b>TUI Command:</b> <em>geompy.MakeCurveParametric(XExpr, YExpt, ZExpt, tMin, tMax, nbSteps, curveType, True)</em>
  98
  99 \n<b>Advanced options</b> \ref preview_anchor "Preview"
 100
 101 Our <b>TUI Scripts</b> provide you with useful examples of creation of
 102 \ref tui_creation_curve "Basic Geometric Objects".
 103
 104 */