Salome HOME
0022618: [CEA 1062] Define the transparency by default in the preferences
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_curve.doc
index e442851bf0a90a2c32104692857185e69e3c3caa..4c70ca156173d18ae412380f1f0f7f3646269705 100644 (file)
 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
+There are three <b>Curve Construction</b> menu choices corresponding 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).
+The curve is defined by a list of \b Points through which it passes.
+
 
-\n <b>TUI Commands:</b>
+\n There are two ways to define these <b>Points</b>:
 <ul>
-<li><em>geompy.MakePolyline(ListOfShapes)</em></li>
-<li><em>geompy.MakeBezier(ListOfShapes)</em></li>
-<li><em>geompy.MakeInterpol(ListOfShapes)</em></li>
+<li> <b>By Selection</b> manual picking of the points in the Object Browser or 3D Viewer.
+<li> <b>Analytical</b> parametric definition of the points through
+python expressions.
 </ul>
-ListOfShape is a list of points through which the curve passes.
 
-<b>Arguments:</b> Name + at least 2 points which will serve as nodes
-on the curve.
-
-\image html curve.png
+\n The \b Result of each operation will be a GEOM_Object (edge).
 
-<b>Examples:</b>
+<b>Polyline</b>
 
 \image html polyline.png
-<center>Polyline</center>
+
+Polyline or polygonal chain is a connected series of line segments. It
+can be defined by the following parameters:
+
+\image html curve2.png
+
+<ul>
+<li><b>Points</b> at least 2 points which will serve as nodes on the curve.</li>
+<li><b>Build a closed wire</b> checkbox allows creating the curve as
+closed wire.</li>
+</ul>
+
+\n <b>TUI Command:</b> <em>geompy.MakePolyline(ListOfShapes,isClosed)</em>
+
+<b>Bezier</b>
 
 \image html bezier.png
-<center>Bezier</center>
+
+Bezier curve is a curve completely contained in a convex hull of its
+control points. It can be defined by the following parameters:
+
+
+\image html curve3.png
+
+<ul>
+<li><b>Points</b> at least 2 points used to approximate the curve.</li>
+<li><b>Build a closed edge</b> checkbox allows creating the curve as
+closed edge.</li>
+</ul>
+
+\n <b>TUI Command:</b> <em>geompy.MakeBezier(ListOfShapes,isClosed)</em>
+
+<b>B-spline</b>
 
 \image html interpol.png
-<center>B-Spline</center>
+
+B-spline is a union of curve segments defined at each node span. It
+can be defined by the following parameters:
+
+\image html curve4.png
+
+<ul>
+<li><b>Points</b> at least 2 points which will serve as nodes on the curve.</li>
+<li><b>Build a closed edge</b> checkbox allows creating the curve as
+closed edge.</li>
+<li> If <b>Reorder vertices taking into account distances</b> is
+checked, the interpolation algorithm does not follow the order of
+vertices but searches for the closest vertex.</li>
+<li><b>Tangents</b> are two vectors, defining the direction at the ends of the
+curve. It is necessary to set both vectors or none. This option is available only
+if both above check boxes are not checked.
+</li>
+</ul>
+
+\n <b>TUI Command:</b>
+<br><em>geompy.MakeInterpol(ListOfShapes,isClosed,doReordering)</em>
+<br><em>geompy.MakeInterpolWithTangents(ListOfShapes,Vector1,Vector2)</em>
+
+<b>Analytical Definition</b>
+
+The input parameters for analytical definition are common for all
+types of curves. 
+
+\image html curve1.png
+
+<ul>
+<li><b>X(t)equation, Y(t)equation, Z(t)equation</b> are python
+expressions for X, Y and Z coordinates of the basic points of the curve.</li>
+<li><b>Min t, Max t</b> are minimum and maximum values of the parameter \b t.</li>
+<li><b>Step</b> is the number of steps of the parameter \b t.</li>
+</ul> 
+
+\n <b>TUI Command:</b> <em>geompy.MakeCurveParametric(XExpr, YExpt, ZExpt, tMin, tMax, nbSteps, curveType, True)</em>
+
+\n<b>Advanced options</b> \ref preview_anchor "Preview"
 
 Our <b>TUI Scripts</b> provide you with useful examples of creation of 
 \ref tui_creation_curve "Basic Geometric Objects".
 
-*/
\ No newline at end of file
+*/