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 \n There are three algorithms to create a \b Curve in the 3D space. Each
   9 time you define it by a list of \b Points through which the curve
  10 passes. The three <b>Curve Construction</b> menu choices correspond to three
  11 possible types of curves: Polyline, Besier or B-spline (Interpolated).
  12 \n The \b Result of each operation will be a GEOM_Object (edge).
  13 \n There are two ways to define <b>Points</b>:
  14 <ul>
  15 <li> <b>By Selection</b> choice of the points manually in the Object Browser or 3D Viewer.
  16 <li> <b>Analitical</b> parametric definition of the points through python expressions.
  17 </ul>
  18
  19 \n <b>TUI Commands:</b>
  20 <ul>
  21 <li><em>geompy.MakePolyline(ListOfShapes,isClosed)</em></li>
  22 <li><em>geompy.MakeBezier(ListOfShapes,isClosed)</em></li>
  23 <li><em>geompy.MakeInterpol(ListOfShapes,isClosed,doReordering)</em></li>
  24 <li><em>geompy.MakeCurveParametric(XExpr, YExpt, ZExpt, tMin, tMax, tStep, curveType)</em></li>
  25 </ul>
  26 ListOfShape is a list of points through which the curve passes.
  27 If isClosed is True, MakeBezier and MakeInterpol builds a closed edge,
  28 MakePolyline builds a closed wire. If doReordering is True,
  29 MakeInterpol does not follow the order of vertices but searches for the
  30 closest vertex.
  31 \n XExpr, YExpr, ZExpr python expressions for the X, Y and Z coordinates of the basic points of the curve.
  32 \n tMin, tMax minimum and maximun values of the parameter \b t.
  33 \n tStep step of the parameter \b t
  34 \n curveType type of the curve Polyline, Bezier or Interpolation.
  35
  36 <b>Arguments:</b>
  37 <ul>
  38 <li>Name + at least 2 points which will serve as nodes on the curve, or</li>
  39 <li>Name + 3 string + 3 values (python expressions for the X, Y and Z coordinates, minimum,
  40 maximum and step values of the parameter)</li>
  41 </ul>
  42
  43
  44 \n<b>Advanced options</b> \ref preview_anchor "Preview"
  45
  46 \image html curve.png
  47 \image html curve1.png
  48 \image html curve2.png
  49
  50 <b>Examples:</b>
  51
  52 \image html polyline.png
  53 <center>Polyline</center>
  54
  55 \image html bezier.png
  56 <center>Bezier</center>
  57
  58 \image html interpol.png
  59 <center>B-Spline</center>
  60
  61 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  62 \ref tui_creation_curve "Basic Geometric Objects".
  63
  64 */