geom/doc/salome/gui/GEOM/input/creating_curve.doc
2011-06-06 07:23:11 +00:00

65 lines
2.2 KiB
Plaintext

/*!
\page create_curve_page Curve
To create a \b Curve in the <b>Main Menu</b> select <b>New Entity - >
Basic - > Curve</b>
\n There are three algorithms to create a \b Curve in the 3D space. Each
time you define it by a list of \b Points through which the curve
passes. The three <b>Curve Construction</b> menu choices correspond to three
possible types of curves: Polyline, Besier or B-spline (Interpolated).
\n The \b Result of each operation will be a GEOM_Object (edge).
\n There are two ways to define <b>Points</b>:
<ul>
<li> <b>By Selection</b> choice of the points manually in the Object Browser or 3D Viewer.
<li> <b>Analitical</b> parametric definition of the points through python expressions.
</ul>
\n <b>TUI Commands:</b>
<ul>
<li><em>geompy.MakePolyline(ListOfShapes,isClosed)</em></li>
<li><em>geompy.MakeBezier(ListOfShapes,isClosed)</em></li>
<li><em>geompy.MakeInterpol(ListOfShapes,isClosed,doReordering)</em></li>
<li><em>geompy.MakeCurveParametric(XExpr, YExpt, ZExpt, tMin, tMax, tStep, curveType)</em></li>
</ul>
ListOfShape is a list of points through which the curve passes.
If isClosed is True, MakeBezier and MakeInterpol builds a closed edge,
MakePolyline builds a closed wire. If doReordering is True,
MakeInterpol does not follow the order of vertices but searches for the
closest vertex.
\n XExpr, YExpr, ZExpr python expressions for the X, Y and Z coordinates of the basic points of the curve.
\n tMin, tMax minimum and maximun values of the parameter \b t.
\n tStep step of the parameter \b t
\n curveType type of the curve Polyline, Bezier or Interpolation.
<b>Arguments:</b>
<ul>
<li>Name + at least 2 points which will serve as nodes on the curve, or</li>
<li>Name + 3 string + 3 values (python expressions for the X, Y and Z coordinates, minimum,
maximum and step values of the parameter)</li>
</ul>
\n<b>Advanced options</b> \ref preview_anchor "Preview"
\image html curve.png
\image html curve1.png
\image html curve2.png
<b>Examples:</b>
\image html polyline.png
<center>Polyline</center>
\image html bezier.png
<center>Bezier</center>
\image html interpol.png
<center>B-Spline</center>
Our <b>TUI Scripts</b> provide you with useful examples of creation of
\ref tui_creation_curve "Basic Geometric Objects".
*/