From: vsr Date: Wed, 8 Jun 2011 06:17:15 +0000 (+0000) Subject: Update user documentation X-Git-Tag: V6_3_1~14 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=79b6e210bf0e272b056c26501128ed29b43537db;p=modules%2Fgeom.git Update user documentation --- diff --git a/doc/salome/gui/GEOM/images/curve1.png b/doc/salome/gui/GEOM/images/curve1.png index 3a271f221..34edf8b90 100644 Binary files a/doc/salome/gui/GEOM/images/curve1.png and b/doc/salome/gui/GEOM/images/curve1.png differ diff --git a/doc/salome/gui/GEOM/images/curve2.png b/doc/salome/gui/GEOM/images/curve2.png index 370df7128..c3f3ab946 100644 Binary files a/doc/salome/gui/GEOM/images/curve2.png and b/doc/salome/gui/GEOM/images/curve2.png differ diff --git a/doc/salome/gui/GEOM/images/curve3.png b/doc/salome/gui/GEOM/images/curve3.png new file mode 100644 index 000000000..7215d5d32 Binary files /dev/null and b/doc/salome/gui/GEOM/images/curve3.png differ diff --git a/doc/salome/gui/GEOM/images/curve4.png b/doc/salome/gui/GEOM/images/curve4.png new file mode 100644 index 000000000..8556ea587 Binary files /dev/null and b/doc/salome/gui/GEOM/images/curve4.png differ diff --git a/doc/salome/gui/GEOM/images/glue7.png b/doc/salome/gui/GEOM/images/glue7.png new file mode 100644 index 000000000..a365ca2c4 Binary files /dev/null and b/doc/salome/gui/GEOM/images/glue7.png differ diff --git a/doc/salome/gui/GEOM/images/glue8.png b/doc/salome/gui/GEOM/images/glue8.png new file mode 100644 index 000000000..20e3aec7d Binary files /dev/null and b/doc/salome/gui/GEOM/images/glue8.png differ diff --git a/doc/salome/gui/GEOM/input/creating_curve.doc b/doc/salome/gui/GEOM/input/creating_curve.doc index 3d9a1fcb8..2a01c3a74 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: + + \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 + -\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 + -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 + +\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
+ -\image html bezier.png -
Bezier
+\n TUI Command: geompy.MakeCurveParametric(XExpr, YExpt, ZExpt, tMin, tMax, tStep, curveType) -\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". diff --git a/doc/salome/gui/GEOM/input/creating_edge.doc b/doc/salome/gui/GEOM/input/creating_edge.doc index ce4f7b8b0..f22f4c495 100644 --- a/doc/salome/gui/GEOM/input/creating_edge.doc +++ b/doc/salome/gui/GEOM/input/creating_edge.doc @@ -41,17 +41,21 @@ the connection points (sharp bend) is not processed. \image html edge2.png "Create edge from wire" -The third case allows building edges of desired length on any existing -curve (selected existing edge). Start Point parameter is optional. -Any point can be selected for it, the new edge will begin at the end -of initial edge, close to the selected point. Length can exceed -the initial edge's length or be negative to extrapolate existing edge -along its curve (except bezier and b-spline curves). +Thirdly, it is possible to build an edge of required \b Length on any existing +\b Edge. + +Start Point parameter is optional: +- if used, it allows selecting any existing point - in such a case the start point +of the new edge will be chosen as start or end point of the selected \b Edge +whatever is closest to the selected Start Point +- if it is missed, the start point of the initial edge is used + +Length can exceed the length of the initial edge length or be +negative. In this case the existing edge is extrapolated +along its curve (except for bezier and b-spline curves). TUI Command: geompy.MakeEdgeOnCurveByLength(Edge, Length, StartPoint = None)
Arguments: Name + 1 edge + Length + 1 Vertex -(StartPoint parameter is optional, it allows switching from one end of -initial edge to another. Length can exceed the initial edge's length or be negative). \image html edge3.png "Create edge on curve" diff --git a/doc/salome/gui/GEOM/input/creating_explode.doc b/doc/salome/gui/GEOM/input/creating_explode.doc index dfda1d384..fd90a0383 100644 --- a/doc/salome/gui/GEOM/input/creating_explode.doc +++ b/doc/salome/gui/GEOM/input/creating_explode.doc @@ -16,7 +16,7 @@ obtain from it. variety of ways: