X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FGEOM%2Finput%2Fcreating_curve.doc;h=9c3371826f9c2c6943f738b0b66b7dbd29d7a83a;hb=4fba47faef4e78e8730b1083c11f84adf2cf6e6a;hp=3d9a1fcb8e111e9ac1008779986b7012e56b74d7;hpb=7f46e5fa52cfe13e206ab10e628556e7e393aaf5;p=modules%2Fgeom.git
diff --git a/doc/salome/gui/GEOM/input/creating_curve.doc b/doc/salome/gui/GEOM/input/creating_curve.doc
index 3d9a1fcb8..9c3371826 100644
--- a/doc/salome/gui/GEOM/input/creating_curve.doc
+++ b/doc/salome/gui/GEOM/input/creating_curve.doc
@@ -5,58 +5,93 @@
To create a \b Curve in the Main Menu select New Entity - >
Basic - > Curve
-\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 Curve Construction menu choices correspond to three
+There are three Curve Construction menu choices corresponding to three
possible types of curves: Polyline, Besier or B-spline (Interpolated).
+The curve is defined by a list of \b Points through which it passes.
+
+
+\n There are two ways to define these Points:
+
+- By Selection manual picking of the points in the Object Browser or 3D Viewer.
+
- Analytical parametric definition of the points through
+python expressions.
+
+
\n The \b Result of each operation will be a GEOM_Object (edge).
-\n There are two ways to define Points:
+
+Polyline
+
+\image html polyline.png
+
+Polyline or polygonal chain is a connected series of line segments. It
+can be defined by the following parameters:
+
+\image html curve2.png
+
-- By Selection choice of the points manually in the Object Browser or 3D Viewer.
-
- Analitical parametric definition of the points through python expressions.
+
- Points at least 2 points which will serve as nodes on the curve.
+- Build a closed wire checkbox allows creating the curve as
+closed wire.
-\n TUI Commands:
+\n TUI Command: geompy.MakePolyline(ListOfShapes,isClosed)
+
+Bezier
+
+\image html bezier.png
+
+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
+
-- geompy.MakePolyline(ListOfShapes,isClosed)
-- geompy.MakeBezier(ListOfShapes,isClosed)
-- geompy.MakeInterpol(ListOfShapes,isClosed,doReordering)
-- geompy.MakeCurveParametric(XExpr, YExpt, ZExpt, tMin, tMax, tStep, curveType)
+- Points at least 2 points used to approximate the curve.
+- Build a closed edge checkbox allows creating the curve as
+closed edge.
-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.
-
-Arguments:
+
+\n TUI Command: geompy.MakeBezier(ListOfShapes,isClosed)
+
+B-spline
+
+\image html interpol.png
+
+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
+
-- Name + at least 2 points which will serve as nodes on the curve, or
-- Name + 3 string + 3 values (python expressions for the X, Y and Z coordinates, minimum,
-maximum and step values of the parameter)
+- Points at least 2 points which will serve as nodes on the curve.
+- Build a closed edge checkbox allows creating the curve as
+closed edge.
+- If Reorder vertices taking into account distances is
+checked, the interpolation algorithm does not follow the order of
+vertices but searches for the closest vertex.
+\n TUI Command:
+geompy.MakeInterpol(ListOfShapes,isClosed,doReordering)
-\nAdvanced options \ref preview_anchor "Preview"
+Analytical Definition
-\image html curve.png
-\image html curve1.png
-\image html curve2.png
+The input parameters for analytical definition are common for all
+types of curves.
-Examples:
+\image html curve1.png
-\image html polyline.png
-Polyline
+
+- X(t)equation, Y(t)equation, Z(t)equation are python
+expressions for X, Y and Z coordinates of the basic points of the curve.
+- Min t, Max t are minimum and maximum values of the parameter \b t.
+- Step is the number of steps of the parameter \b t.
+
-\image html bezier.png
-Bezier
+\n TUI Command: geompy.MakeCurveParametric(XExpr, YExpt, ZExpt, tMin, tMax, nbSteps, curveType, True)
-\image html interpol.png
-B-Spline
+\nAdvanced options \ref preview_anchor "Preview"
Our TUI Scripts provide you with useful examples of creation of
\ref tui_creation_curve "Basic Geometric Objects".