Documentation - Fix whitespaces and typos (#824)

- Fixed excessive whitespace in multi-line comments
- Corrected spelling errors (e.g., "selectionnable" → "selectable", "begenning" → "beginning")
- Improved comment formatting and readability
This commit is contained in:
luzpaz
2025-11-13 15:31:57 -05:00
committed by GitHub
parent 570b34b666
commit 79289339d8
161 changed files with 879 additions and 883 deletions

View File

@@ -35,7 +35,7 @@ class AdvApprox_Cutting;
class AdvApp2Var_Criterion;
class Geom_BSplineSurface;
//! Perform the approximation of <Func> F(U,V)
//! Perform the approximation of <Func> F(U,V)
//! Arguments are :
//! Num1DSS, Num2DSS, Num3DSS :The numbers of 1,2,3 dimensional subspaces
//! OneDTol, TwoDTol, ThreeDTol: The tolerance of approximation in each
@@ -55,9 +55,9 @@ class Geom_BSplineSurface;
//! MaxDegInV : Maximum u-degree waiting in V
//! Warning:
//! MaxDegInU (resp. MaxDegInV) must be >= 2*iu (resp. iv) + 1,
//! where iu (resp. iv) = 0 if ContInU (resp. ContInV) = GeomAbs_C0,
//! = 1 if = GeomAbs_C1,
//! = 2 if = GeomAbs_C2.
//! where iu (resp. iv) = 0 if ContInU (resp. ContInV) = GeomAbs_C0,
//! = 1 if = GeomAbs_C1,
//! = 2 if = GeomAbs_C2.
//! MaxPatch : Maximum number of Patch waiting
//! number of Patch is number of u span * number of v span
//! Func : The external method to evaluate F(U,V)

View File

@@ -126,7 +126,7 @@ public:
Standard_EXPORT void Perform(const AppDef_MultiLine& Line);
//! The approximation will begin with the
//! set of parameters <ThePar>.
//! set of parameters <ThePar>.
Standard_EXPORT void SetParameters(const math_Vector& ThePar);
//! The approximation will be done with the

View File

@@ -145,7 +145,7 @@ public:
Standard_EXPORT void SetTang2d(const Standard_Integer Index, const gp_Vec2d& Tang2d);
//! returns the tangency value of the point of range Index.
//! An exception is raised if Index < number of 3d points or
//! An exception is raised if Index < number of 3d points or
//! if Index > total number of points.
Standard_EXPORT gp_Vec2d Tang2d(const Standard_Integer Index) const;

View File

@@ -33,7 +33,7 @@ class math_Matrix;
class AppDef_SmoothCriterion;
DEFINE_STANDARD_HANDLE(AppDef_SmoothCriterion, Standard_Transient)
//! defined criterion to smooth points in curve
//! defined criterion to smooth points in curve
class AppDef_SmoothCriterion : public Standard_Transient
{

View File

@@ -48,13 +48,12 @@ public:
//! Constructor.
//! Initialization of the fields.
//! warning : Nc0 : number of PassagePoint consraints
//! Warning:
//! Nc0 : number of PassagePoint consraints
//! Nc2 : number of TangencyPoint constraints
//! Nc3 : number of CurvaturePoint constraints
//! if
//! ((MaxDegree-Continuity)*MaxSegment -Nc0 - 2*Nc1
//! -3*Nc2)
//! is negative
//! if ((MaxDegree-Continuity)*MaxSegment -Nc0 - 2*Nc1 -3*Nc2)
//! is negative
//! The problem is over-constrained.
//!
//! Limitation : The MultiLine from AppDef has to be composed by
@@ -79,7 +78,7 @@ public:
//! and correspond to the current fields.
Standard_EXPORT Standard_Boolean IsCreated() const;
//! returns True if the approximation is ok
//! returns True if the approximation is ok
//! and correspond to the current fields.
Standard_EXPORT Standard_Boolean IsDone() const;
@@ -186,7 +185,7 @@ public:
//! this method modify nothing and returns false
Standard_EXPORT Standard_Boolean SetContinuity(const GeomAbs_Shape C);
//! Define if the approximation search to minimize the
//! Define if the approximation search to minimize the
//! maximum Error or not.
Standard_EXPORT void SetWithMinMax(const Standard_Boolean MinMax);
@@ -196,7 +195,7 @@ public:
Standard_EXPORT Standard_Boolean SetWithCutting(const Standard_Boolean Cutting);
//! define the Weights (as percent) associed to the criterium used in
//! the optimization.
//! the optimization.
//!
//! if Percent <= 0
Standard_EXPORT void SetCriteriumWeight(const Standard_Real Percent1,

View File

@@ -68,7 +68,7 @@ public:
Standard_EXPORT Standard_Real MaxError2dU() const;
//! returns the maximum errors relatively to the U component or the V component of the
//! returns the maximum errors relatively to the U component or the V component of the
//! 2d Curve
Standard_EXPORT Standard_Real MaxError2dV() const;

View File

@@ -50,14 +50,14 @@ public:
Standard_EXPORT Standard_Real LastParameter() const;
//! Returns the number of intervals for continuity
//! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const;
//! Stores in <T> the parameters bounding the intervals
//! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
//! The array must provide enough room to accommodate
//! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
Standard_EXPORT void Intervals(TColStd_Array1OfReal& T, const GeomAbs_Shape S) const;
@@ -76,7 +76,7 @@ public:
Standard_EXPORT Standard_Real GetLength() const;
//! returns original parameter corresponding S. if
//! returns original parameter corresponding S. if
//! Case == 1 computation is performed on myC2D1 and mySurf1,
//! otherwise it is done on myC2D2 and mySurf2.
Standard_EXPORT Standard_Real GetUParameter(Adaptor3d_Curve& C,

View File

@@ -48,7 +48,7 @@ public:
TColgp_Array1OfPnt2d& Poles2d,
TColStd_Array1OfReal& Weigths) = 0;
//! compute the first derivative in v direction of the
//! compute the first derivative in v direction of the
//! section for v = param
//! Warning : It used only for C1 or C2 approximation
Standard_EXPORT virtual Standard_Boolean D1(const Standard_Real Param,
@@ -112,7 +112,7 @@ public:
//! function is not Cn.
Standard_EXPORT virtual void SetInterval(const Standard_Real First, const Standard_Real Last) = 0;
//! Returns the resolutions in the sub-space 2d <Index>
//! Returns the resolutions in the sub-space 2d <Index>
//! This information is useful to find a good tolerance in
//! 2d approximation.
Standard_EXPORT virtual void Resolution(const Standard_Integer Index,
@@ -141,11 +141,11 @@ public:
Standard_EXPORT virtual gp_Pnt BarycentreOfSurf() const;
//! Returns the length of the greater section.
//! Thisinformation is useful to G1's control.
//! This information is useful to G1's control.
//! Warning: With an little value, approximation can be slower.
Standard_EXPORT virtual Standard_Real MaximalSection() const;
//! Compute the minimal value of weight for each poles in all sections.
//! Compute the minimal value of weight for each poles in all sections.
//! This information is useful to control error in rational approximation.
//! Warning: Used only if <me> IsRational
Standard_EXPORT virtual void GetMinimalWeight(TColStd_Array1OfReal& Weigths) const;

View File

@@ -37,8 +37,8 @@ public:
//! B is then enlarged by the tolerance value Tol.
//! Note: depending on the type of curve, one of the following
//! representations of the curve C is used to include it in the bounding box B:
//! - an exact representation if C is built from a line, a circle or a conic curve,
//! - the poles of the curve if C is built from a Bezier curve or a BSpline curve,
//! - an exact representation if C is built from a line, a circle or a conic curve,
//! - the poles of the curve if C is built from a Bezier curve or a BSpline curve,
//! - if not, the points of an approximation of the curve C.
//! Warning
//! C is an adapted curve, that is, an object which is an interface between:
@@ -69,8 +69,8 @@ public:
//! B is then enlarged by the tolerance value Tol.
//! Note: depending on the type of curve, one of the following
//! representations of the curve C is used to include it in the bounding box B:
//! - an exact representation if C is built from a line, a circle or a conic curve,
//! - the poles of the curve if C is built from a Bezier curve or a BSpline curve,
//! - an exact representation if C is built from a line, a circle or a conic curve,
//! - the poles of the curve if C is built from a Bezier curve or a BSpline curve,
//! - if not, the points of an approximation of the curve C.
//! Warning
//! C is an adapted curve, that is, an object which is an interface between:
@@ -127,9 +127,9 @@ public:
//! B is then enlarged by the tolerance value Tol.
//! U1, U2 - the parametric range to compute the bounding box;
//! Note: depending on the type of curve, one of the following
//! algorithms is used to include it in the bounding box B:
//! algorithms is used to include it in the bounding box B:
//! - an exact analytical if C is built from a line, a circle or a conic curve,
//! - numerical calculation of bounding box sizes, based on minimization algorithm, for other
//! - numerical calculation of bounding box sizes, based on minimization algorithm, for other
//! types of curve If Tol = < Precision::PConfusion(), Precision::PConfusion is used as tolerance
//! for calculation
Standard_EXPORT static void AddOptimal(const Handle(Geom2d_Curve)& C,

View File

@@ -36,12 +36,12 @@ public:
//! B is then enlarged by the tolerance value Tol.
//! Note: depending on the type of curve, one of the following
//! representations of the curve C is used to include it in the bounding box B:
//! - an exact representation if C is built from a line, a circle or a conic curve,
//! - the poles of the curve if C is built from a Bezier curve or a BSpline curve,
//! - an exact representation if C is built from a line, a circle or a conic curve,
//! - the poles of the curve if C is built from a Bezier curve or a BSpline curve,
//! if not, the points of an approximation of the curve C.
//! Warning
//! C is an adapted curve, that is, an object which is an interface between:
//! - the services provided by a 3D curve from the package Geom
//! - the services provided by a 3D curve from the package Geom
//! - and those required of the curve by the computation algorithm.
//! The adapted curve is created in the following way:
//! Handle(Geom_Curve) mycurve = ... ;
@@ -64,12 +64,12 @@ public:
//! the arc of the curve C limited by the two parameter values P1 and P2.
//! Note: depending on the type of curve, one of the following
//! representations of the curve C is used to include it in the bounding box B:
//! - an exact representation if C is built from a line, a circle or a conic curve,
//! - the poles of the curve if C is built from a Bezier curve or a BSpline curve,
//! - an exact representation if C is built from a line, a circle or a conic curve,
//! - the poles of the curve if C is built from a Bezier curve or a BSpline curve,
//! if not, the points of an approximation of the curve C.
//! Warning
//! C is an adapted curve, that is, an object which is an interface between:
//! - the services provided by a 3D curve from the package Geom
//! - the services provided by a 3D curve from the package Geom
//! - and those required of the curve by the computation algorithm.
//! The adapted curve is created in the following way:
//! Handle(Geom_Curve) mycurve = ... ;

View File

@@ -28,7 +28,7 @@
//! Implements a function for the Newton algorithm to find the
//! solution of Integral(F) = L
//! (compute Length and Derivative of the curve for Newton)
//! (compute Length and Derivative of the curve for Newton)
class CPnts_MyRootFunction : public math_FunctionWithDerivative
{
public:

View File

@@ -50,12 +50,12 @@ public:
static GeomAbs_Shape Continuity(const Adaptor2d_Curve2d& C);
//! If necessary, breaks the curve in intervals of
//! continuity <S>. And returns the number of
//! If necessary, breaks the curve in intervals of
//! continuity <S>. And returns the number of
//! intervals.
static Standard_Integer NbIntervals(const Adaptor2d_Curve2d& C, const GeomAbs_Shape S);
//! Stores in <T> the parameters bounding the intervals
//! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
static void Intervals(const Adaptor2d_Curve2d& C, TColStd_Array1OfReal& T, const GeomAbs_Shape S);

View File

@@ -50,14 +50,14 @@ public:
static GeomAbs_Shape Continuity(const Adaptor3d_Curve& C);
//! Returns the number of intervals for continuity
//! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
static Standard_Integer NbIntervals(Adaptor3d_Curve& C, const GeomAbs_Shape S);
//! Stores in <T> the parameters bounding the intervals
//! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
//! The array must provide enough room to accommodate
//! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
static void Intervals(Adaptor3d_Curve& C, TColStd_Array1OfReal& T, const GeomAbs_Shape S);

View File

@@ -37,7 +37,7 @@ public:
DEFINE_STANDARD_ALLOC
//! Calculates all the distances as above
//! between Uinf and Usup for C1 and between Vinf and Vsup
//! between Uinf and Usup for C1 and between Vinf and Vsup
//! for C2.
Standard_EXPORT Extrema_ECC();
@@ -48,7 +48,7 @@ public:
Standard_EXPORT Extrema_ECC(const Adaptor3d_Curve& C1, const Adaptor3d_Curve& C2);
//! Calculates all the distances as above
//! between Uinf and Usup for C1 and between Vinf and Vsup
//! between Uinf and Usup for C1 and between Vinf and Vsup
//! for C2.
Standard_EXPORT Extrema_ECC(const Adaptor3d_Curve& C1,
const Adaptor3d_Curve& C2,

View File

@@ -35,7 +35,7 @@ public:
DEFINE_STANDARD_ALLOC
//! Calculates all the distances as above
//! between Uinf and Usup for C1 and between Vinf and Vsup
//! between Uinf and Usup for C1 and between Vinf and Vsup
//! for C2.
Standard_EXPORT Extrema_ECC2d();

View File

@@ -52,7 +52,7 @@ public:
//! when g(u)=dF/du=0. The algorithm searches all the
//! zeros inside the definition range of the curve.
//! Zeros are searched between uinf and usup.
//! Tol is used to decide to stop the
//! Tol is used to decide to stop the
//! iterations according to the following condition:
//! if n is the number of iterations,
//! the algorithm stops when abs(F(Un)-F(Un-1)) < Tol.

View File

@@ -52,7 +52,7 @@ public:
//! when g(u)=dF/du=0. The algorithm searches all the
//! zeros inside the definition range of the curve.
//! Zeros are searched between uinf and usup.
//! Tol is used to decide to stop the
//! Tol is used to decide to stop the
//! iterations according to the following condition:
//! if n is the number of iterations,
//! the algorithm stops when abs(F(Un)-F(Un-1)) < Tol.

View File

@@ -51,7 +51,7 @@ public:
//! when g(u)=dF/du=0. The algorithm searches all the
//! zeros inside the definition range of the curve.
//! Zeros are searched between uinf and usup.
//! Tol is used to decide to stop the
//! Tol is used to decide to stop the
//! iterations according to the following condition:
//! if n is the number of iterations,
//! the algorithm stops when abs(F(Un)-F(Un-1)) < Tol.

View File

@@ -51,7 +51,7 @@ public:
//! when g(u)=dF/du=0. The algorithm searches all the
//! zeros inside the definition range of the curve.
//! Zeros are searched between uinf and usup.
//! Tol is used to decide to stop the
//! Tol is used to decide to stop the
//! iterations according to the following condition:
//! if n is the number of iterations,
//! the algorithm stops when abs(F(Un)-F(Un-1)) < Tol.

View File

@@ -47,10 +47,10 @@ public:
//! To know if two dimension are independent.
Standard_EXPORT virtual Handle(TColStd_HArray2OfInteger) DependenceTable() const = 0;
//! To Compute J(E) where E is the current Element
//! To Compute J(E) where E is the current Element
Standard_EXPORT virtual Standard_Real Value() = 0;
//! To Compute J(E) the coefficients of Hessian matrix of
//! To Compute J(E) the coefficients of Hessian matrix of
//! J(E) which are crossed derivatives in dimensions <Dim1>
//! and <Dim2>.
//! If DependenceTable(Dimension1,Dimension2) is False

View File

@@ -30,7 +30,7 @@
class FEmTool_LinearFlexion;
DEFINE_STANDARD_HANDLE(FEmTool_LinearFlexion, FEmTool_ElementaryCriterion)
//! Criterium of LinearFlexion To Hermit-Jacobi elements
//! Criterium of LinearFlexion To Hermit-Jacobi elements
class FEmTool_LinearFlexion : public FEmTool_ElementaryCriterion
{

View File

@@ -31,7 +31,7 @@
class FEmTool_ProfileMatrix;
DEFINE_STANDARD_HANDLE(FEmTool_ProfileMatrix, FEmTool_SparseMatrix)
//! Symmetric Sparse ProfileMatrix useful for 1D Finite
//! Symmetric Sparse ProfileMatrix useful for 1D Finite
//! Element methods
class FEmTool_ProfileMatrix : public FEmTool_SparseMatrix
{
@@ -53,7 +53,7 @@ public:
//! Make Preparation to iterative solve
Standard_EXPORT Standard_Boolean Prepare() Standard_OVERRIDE;
//! Iterative solve of AX = B
//! Iterative solve of AX = B
Standard_EXPORT void Solve(const math_Vector& B,
const math_Vector& Init,
math_Vector& X,

View File

@@ -44,13 +44,13 @@ class gp_Pnt;
//! it gives the direction of increasing parametric value V.
//! The apex of the surface is on the negative side of this axis.
//!
//! The parametrization range is :
//! U [0, 2*PI], V ]-infinite, + infinite[
//! The parametrization range is:
//! U [0, 2*PI], V ]-infinite, + infinite[
//!
//! The "XAxis" and the "YAxis" define the placement plane of the
//! surface (Z = 0, and parametric value V = 0) perpendicular to
//! surface (Z = 0, and parametric value V = 0) perpendicular to
//! the symmetry axis. The "XAxis" defines the origin of the
//! parameter U = 0. The trigonometric sense gives the positive
//! parameter U = 0. The trigonometric sense gives the positive
//! orientation for the parameter U.
//!
//! When you create a ConicalSurface the U and V directions of

View File

@@ -47,12 +47,12 @@ class gp_Circ;
//! it gives the direction of increasing parametric value V.
//!
//! The parametrization range is :
//! U [0, 2*PI], V ]- infinite, + infinite[
//! U [0, 2*PI], V ]- infinite, + infinite[
//!
//! The "XAxis" and the "YAxis" define the placement plane of the
//! surface (Z = 0, and parametric value V = 0) perpendicular to
//! surface (Z = 0, and parametric value V = 0) perpendicular to
//! the symmetry axis. The "XAxis" defines the origin of the
//! parameter U = 0. The trigonometric sense gives the positive
//! parameter U = 0. The trigonometric sense gives the positive
//! orientation for the parameter U.
class GC_MakeCylindricalSurface : public GC_Root
{

View File

@@ -45,7 +45,7 @@ class Geom2d_Curve;
//! References :
//! . Generating the Bezier Points of B-spline curves and surfaces
//! (Wolfgang Bohm) CAGD volume 13 number 6 november 1981
//! . On NURBS: A Survey (Leslie Piegl) IEEE Computer Graphics and
//! . On NURBS: A Survey (Leslie Piegl) IEEE Computer Graphics and
//! Application January 1991
//! . Curve and surface construction using rational B-splines
//! (Leslie Piegl and Wayne Tiller) CAD Volume 19 number 9 november
@@ -57,16 +57,16 @@ class Geom2dConvert
public:
DEFINE_STANDARD_ALLOC
//! -- Convert a curve to BSpline by Approximation
//! Convert a curve to BSpline by Approximation
//!
//! This method computes the arc of B-spline curve between the two
//! knots FromK1 and ToK2. If C is periodic the arc has the same
//! knots FromK1 and ToK2. If C is periodic the arc has the same
//! orientation as C if SameOrientation = Standard_True.
//! If C is not periodic SameOrientation is not used for the
//! If C is not periodic SameOrientation is not used for the
//! computation and C is oriented from the knot fromK1 to the
//! knot toK2.
//! We just keep the local definition of C between the knots
//! FromK1 and ToK2. The returned B-spline curve has its first
//! FromK1 and ToK2. The returned B-spline curve has its first
//! and last knots with a multiplicity equal to degree + 1, where
//! degree is the polynomial degree of C.
//! The indexes of the knots FromK1 and ToK2 doesn't include the
@@ -89,7 +89,7 @@ public:
//! computation and C is oriented fromU1 toU2.
//! If U1 and U2 and two parametric values we consider that
//! U1 = U2 if Abs (U1 - U2) <= ParametricTolerance and
//! ParametricTolerance must be greater or equal to Resolution
//! ParametricTolerance must be greater or equal to Resolution
//! from package gp.
//!
//! Raised if FromU1 or ToU2 are out of the parametric bounds of the
@@ -104,10 +104,10 @@ public:
const Standard_Boolean SameOrientation = Standard_True);
//! This function converts a non infinite curve from
//! Geom into a B-spline curve. C must be an ellipse or a
//! circle or a trimmed conic or a trimmed line or a Bezier
//! curve or a trimmed Bezier curve or a BSpline curve or a
//! trimmed BSpline curve or an Offset curve or a trimmed
//! Geom into a B-spline curve. C must be an ellipse or a
//! circle or a trimmed conic or a trimmed line or a Bezier
//! curve or a trimmed Bezier curve or a BSpline curve or a
//! trimmed BSpline curve or an Offset curve or a trimmed
//! Offset curve.
//! The returned B-spline is not periodic except if C is a
//! Circle or an Ellipse.
@@ -132,9 +132,9 @@ public:
//!
//! t = tan (theta/2)
//!
//! with TgtThetaOver2 the routine will compute the number of spans
//! with TgtThetaOver2 the routine will compute the number of spans
//! using the rule num_spans = [ (ULast - UFirst) / 1.2 ] + 1
//! with TgtThetaOver2_N, N spans will be forced: an error will
//! with TgtThetaOver2_N, N spans will be forced: an error will
//! be raized if (ULast - UFirst) >= PI and N = 1,
//! ULast - UFirst >= 2 PI and N = 2
//!
@@ -174,10 +174,10 @@ public:
//! This Method concatenates G1 the ArrayOfCurves as far
//! as it is possible.
//! ArrayOfCurves[0..N-1]
//! ArrayOfToler contains the biggest tolerance of the two
//! ArrayOfToler contains the biggest tolerance of the two
//! points shared by two consecutives curves.
//! Its dimension: [0..N-2]
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! In this case ClosedTolerance contains the biggest tolerance
//! of the two points which are at the closure.
//! Otherwise its value is 0.0
@@ -193,10 +193,10 @@ public:
//! This Method concatenates C1 the ArrayOfCurves as far
//! as it is possible.
//! ArrayOfCurves[0..N-1]
//! ArrayOfToler contains the biggest tolerance of the two
//! ArrayOfToler contains the biggest tolerance of the two
//! points shared by two consecutives curves.
//! Its dimension: [0..N-2]
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! In this case ClosedTolerance contains the biggest tolerance
//! of the two points which are at the closure.
//! Otherwise its value is 0.0
@@ -213,10 +213,10 @@ public:
//! This Method concatenates C1 the ArrayOfCurves as far
//! as it is possible.
//! ArrayOfCurves[0..N-1]
//! ArrayOfToler contains the biggest tolerance of the two
//! ArrayOfToler contains the biggest tolerance of the two
//! points shared by two consecutives curves.
//! Its dimension: [0..N-2]
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! In this case ClosedTolerance contains the biggest tolerance
//! of the two points which are at the closure.
//! Otherwise its value is 0.0

View File

@@ -57,7 +57,7 @@ public:
//! limited by the two parameter values U1 and U2
//! for Example if there is a Knot Uk and
//! Uk < U < Uk + ParametricTolerance/2 the last curve
//! corresponds to the span [Uk-1, Uk] and not to [Uk, Uk+1]
//! corresponds to the span [Uk-1, Uk] and not to [Uk, Uk+1]
//! The result consists of a series of BasisCurve arcs
//! limited by points corresponding to knot values of the curve.
//! Use the available interrogation functions to ascertain
@@ -100,8 +100,8 @@ public:
//! This methode returns the bspline's knots associated to
//! the converted arcs
//! Raises DimensionError if the length of Curves is not equal to
//! NbArcs + 1
//! Raises DimensionError if the length of Curves is not equal to
//! NbArcs + 1
Standard_EXPORT void Knots(TColStd_Array1OfReal& TKnots) const;
//! Returns the number of BezierCurve arcs.

View File

@@ -52,7 +52,7 @@ class Geom_Surface;
//! References :
//! . Generating the Bezier Points of B-spline curves and surfaces
//! (Wolfgang Bohm) CAGD volume 13 number 6 november 1981
//! . On NURBS: A Survey (Leslie Piegl) IEEE Computer Graphics and
//! . On NURBS: A Survey (Leslie Piegl) IEEE Computer Graphics and
//! Application January 1991
//! . Curve and surface construction using rational B-splines
//! (Leslie Piegl and Wayne Tiller) CAD Volume 19 number 9 november
@@ -67,12 +67,12 @@ public:
//! Convert a curve from Geom by an approximation method
//!
//! This method computes the arc of B-spline curve between the two
//! knots FromK1 and ToK2. If C is periodic the arc has the same
//! knots FromK1 and ToK2. If C is periodic the arc has the same
//! orientation as C if SameOrientation = Standard_True.
//! If C is not periodic SameOrientation is not used for the
//! If C is not periodic SameOrientation is not used for the
//! computation and C is oriented from the knot fromK1 to the knot toK2.
//! We just keep the local definition of C between the knots
//! FromK1 and ToK2. The returned B-spline curve has its first
//! FromK1 and ToK2. The returned B-spline curve has its first
//! and last knots with a multiplicity equal to degree + 1, where
//! degree is the polynomial degree of C.
//! The indexes of the knots FromK1 and ToK2 doesn't include the
@@ -94,7 +94,7 @@ public:
//! computation and C is oriented fromU1 toU2.
//! If U1 and U2 and two parametric values we consider that
//! U1 = U2 if Abs (U1 - U2) <= ParametricTolerance and
//! ParametricTolerance must be greater or equal to Resolution
//! ParametricTolerance must be greater or equal to Resolution
//! from package gp.
//!
//! Raised if FromU1 or ToU2 are out of the parametric bounds of the
@@ -204,19 +204,19 @@ public:
const Standard_Boolean SameOrientation = Standard_True);
//! This function converts a non infinite curve from
//! Geom into a B-spline curve. C must be an ellipse or a
//! circle or a trimmed conic or a trimmed line or a Bezier
//! curve or a trimmed Bezier curve or a BSpline curve or a
//! trimmed BSpline curve or an OffsetCurve. The returned B-spline is
//! not periodic except if C is a Circle or an Ellipse. If
//! the Parameterisation is QuasiAngular than the returned
//! curve is NOT periodic in case a periodic Geom_Circle or
//! Geom_Ellipse. For TgtThetaOver2_1 and TgtThetaOver2_2 the
//! method raises an exception in case of a periodic
//! Geom into a B-spline curve. C must be an ellipse or a
//! circle or a trimmed conic or a trimmed line or a Bezier
//! curve or a trimmed Bezier curve or a BSpline curve or a
//! trimmed BSpline curve or an OffsetCurve. The returned B-spline is
//! not periodic except if C is a Circle or an Ellipse. If
//! the Parameterisation is QuasiAngular than the returned
//! curve is NOT periodic in case a periodic Geom_Circle or
//! Geom_Ellipse. For TgtThetaOver2_1 and TgtThetaOver2_2 the
//! method raises an exception in case of a periodic
//! Geom_Circle or a Geom_Ellipse ParameterisationType applies
//! only if the curve is a Circle or an ellipse :
//! TgtThetaOver2, -- TgtThetaOver2_1, -- TgtThetaOver2_2, --
//! TgtThetaOver2_3, -- TgtThetaOver2_4,
//! only if the curve is a Circle or an ellipse:
//! TgtThetaOver2, TgtThetaOver2_1, TgtThetaOver2_2,
//! TgtThetaOver2_3, TgtThetaOver2_4,
//!
//! Purpose: this is the classical rational parameterisation
//! 2
@@ -232,9 +232,9 @@ public:
//!
//! t = tan (theta/2)
//!
//! with TgtThetaOver2 the routine will compute the number of spans
//! with TgtThetaOver2 the routine will compute the number of spans
//! using the rule num_spans = [ (ULast - UFirst) / 1.2 ] + 1
//! with TgtThetaOver2_N, N spans will be forced: an error will
//! with TgtThetaOver2_N, N spans will be forced: an error will
//! be raized if (ULast - UFirst) >= PI and N = 1,
//! ULast - UFirst >= 2 PI and N = 2
//!
@@ -289,7 +289,7 @@ public:
//! ArrayOfToler contains the biggest tolerance of the two
//! points shared by two consecutives curves.
//! Its dimension: [0..N-2]
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! In this case ClosedTolerance contains the biggest tolerance
//! of the two points which are at the closure.
//! Otherwise its value is 0.0
@@ -304,10 +304,10 @@ public:
//! This Method concatenates C1 the ArrayOfCurves as far
//! as it is possible.
//! ArrayOfCurves[0..N-1]
//! ArrayOfToler contains the biggest tolerance of the two
//! ArrayOfToler contains the biggest tolerance of the two
//! points shared by two consecutives curves.
//! Its dimension: [0..N-2]
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! In this case ClosedTolerance contains the biggest tolerance
//! of the two points which are at the closure.
//! Otherwise its value is 0.0
@@ -323,10 +323,10 @@ public:
//! This Method concatenates C1 the ArrayOfCurves as far
//! as it is possible.
//! ArrayOfCurves[0..N-1]
//! ArrayOfToler contains the biggest tolerance of the two
//! ArrayOfToler contains the biggest tolerance of the two
//! points shared by two consecutives curves.
//! Its dimension: [0..N-2]
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! In this case ClosedTolerance contains the biggest tolerance
//! of the two points which are at the closure.
//! Otherwise its value is 0.0

View File

@@ -62,21 +62,21 @@ public:
//! Returns the BSpline curve resulting from the approximation algorithm.
Standard_EXPORT Handle(Geom_BSplineCurve) Curve() const;
//! returns Standard_True if the approximation has
//! been done within required tolerance
//! returns Standard_True if the approximation has
//! been done within required tolerance
Standard_EXPORT Standard_Boolean IsDone() const;
//! Returns Standard_True if the approximation did come out
//! with a result that is not NECESSARELY within the required tolerance
//! Returns Standard_True if the approximation did come out
//! with a result that is not NECESSARELY within the required tolerance
Standard_EXPORT Standard_Boolean HasResult() const;
//! Returns the greatest distance between a point on the
//! source conic and the BSpline curve resulting from the
//! approximation. (>0 when an approximation
//! has been done, 0 if no approximation)
//! has been done, 0 if no approximation)
Standard_EXPORT Standard_Real MaxError() const;
//! Print on the stream o information about the object
//! Print on the stream o information about the object
Standard_EXPORT void Dump(Standard_OStream& o) const;
protected:

View File

@@ -89,8 +89,8 @@ public:
//! This methode returns the bspline's knots associated to
//! the converted arcs
//! Raised if the length of Curves is not equal to
//! NbArcs + 1.
//! Raised if the length of Curves is not equal to
//! NbArcs + 1
Standard_EXPORT void Knots(TColStd_Array1OfReal& TKnots) const;
//! Returns the number of BezierCurve arcs.

View File

@@ -33,9 +33,9 @@ class Geom_BSplineSurface;
//! SplitBSplineSurface.
//! For a B-spline surface the discontinuities are localised at
//! the knot values. Between two knots values the B-spline is
//! infinitely continuously differentiable. For each parametric
//! infinitely continuously differentiable. For each parametric
//! direction at a knot of range index the continuity in this
//! direction is equal to : Degree - Mult (Index) where Degree
//! direction is equal to: Degree - Mult (Index) where Degree
//! is the degree of the basis B-spline functions and Mult the
//! multiplicity of the knot of range Index in the given direction.
//! If for your computation you need to have B-spline surface with a
@@ -125,7 +125,7 @@ public:
TColStd_Array1OfInteger& VSplit) const;
//! Returns the split knot of index UIndex
//! to the split knots table for the u parametric direction
//! to the split knots table for the u parametric direction
//! computed in this framework. The returned value is
//! an index in the knots table relative to the u
//! parametric direction of the BSpline surface analysed by this algorithm.
@@ -134,12 +134,12 @@ public:
//! this framework, the corresponding knot gives the
//! parameter of one of the bounding curves of the surface.
//! Exceptions
//! Standard_RangeError if UIndex is less than 1 or greater than the number
//! Standard_RangeError if UIndex is less than 1 or greater than the number
//! of split knots for the u parametric direction computed in this framework.
Standard_EXPORT Standard_Integer USplitValue(const Standard_Integer UIndex) const;
//! Returns the split knot of index VIndex
//! to the split knots table for the v parametric direction
//! to the split knots table for the v parametric direction
//! computed in this framework. The returned value is
//! an index in the knots table relative to the v
//! parametric direction of the BSpline surface analysed by this algorithm.
@@ -148,7 +148,7 @@ public:
//! this framework, the corresponding knot gives the
//! parameter of one of the bounding curves of the surface.
//! Exceptions
//! Standard_RangeError if VIndex is less than 1 or greater than the number
//! Standard_RangeError if VIndex is less than 1 or greater than the number
//! of split knots for the v parametric direction computed in this framework.
Standard_EXPORT Standard_Integer VSplitValue(const Standard_Integer VIndex) const;

View File

@@ -75,7 +75,7 @@ public:
//! Use the available interrogation functions to ascertain
//! the number of computed Bezier patches, and then to
//! construct each individual Bezier surface (or all Bezier surfaces).
//! Note: ParametricTolerance is not used. Raises DomainError
//! Note: ParametricTolerance is not used. Raises DomainError
//! if U1 or U2 or V1 or V2 are out of the parametric bounds
//! of the basis surface [FirstUKnotIndex, LastUKnotIndex] ,
//! [FirstVKnotIndex, LastVKnotIndex] The tolerance criterion is
@@ -143,14 +143,14 @@ public:
//! This methode returns the bspline's u-knots associated to
//! the converted Patches
//! Raised if the length of Curves is not equal to
//! NbUPatches + 1.
//! Raised if the length of Curves is not equal to
//! NbUPatches + 1
Standard_EXPORT void UKnots(TColStd_Array1OfReal& TKnots) const;
//! This methode returns the bspline's v-knots associated to
//! the converted Patches
//! Raised if the length of Curves is not equal to
//! NbVPatches + 1.
//! Raised if the length of Curves is not equal to
//! NbVPatches + 1
Standard_EXPORT void VKnots(TColStd_Array1OfReal& TKnots) const;
//! Returns the number of Bezier surfaces in the U direction.

View File

@@ -49,7 +49,7 @@
//! -----------------------
//! 3 | | | | |
//! -----------------------
//! UIndex [1, NbUPatches] Udirection
//! UIndex [1, NbUPatches] Udirection
//!
//! Warning! Patches must have compatible parametrization
class GeomConvert_CompBezierSurfacesToBSplineSurface
@@ -117,7 +117,7 @@ public:
//! Build an Ci uniform (Rational) BSpline surface
//! The highest Continuity Ci is imposed, like the
//! maximal deformation is lower than <Tolerance>.
//! Warning: The Continuity C0 is imposed without any check.
//! Warning: The Continuity C0 is imposed without any check.
Standard_EXPORT GeomConvert_CompBezierSurfacesToBSplineSurface(
const TColGeom_Array2OfBezierSurface& Beziers,
const Standard_Real Tolerance,
@@ -241,7 +241,7 @@ public:
//! direction of the BSpline surface whose data is computed in this framework.
const Handle(TColStd_HArray1OfReal)& UKnots() const;
//! Returns the degree for the u parametric
//! Returns the degree for the u parametric
//! direction of the BSpline surface whose data is computed in this framework.
Standard_Integer UDegree() const;
@@ -249,7 +249,7 @@ public:
//! direction of the BSpline surface whose data is computed in this framework.
const Handle(TColStd_HArray1OfReal)& VKnots() const;
//! Returns the degree for the v parametric
//! Returns the degree for the v parametric
//! direction of the BSpline surface whose data is computed in this framework.
Standard_Integer VDegree() const;

View File

@@ -41,23 +41,23 @@ class Geom_Surface;
typedef class Adaptor2d_Curve2d Adaptor2d_Curve2d;
//! Geom Library. This package provides an
//! implementation of functions for basic computation
//! Geom Library. This package provides an
//! implementation of functions for basic computation
//! on geometric entity from packages Geom and Geom2d.
class GeomLib
{
public:
DEFINE_STANDARD_ALLOC
//! Computes the curve 3d from package Geom
//! corresponding to curve 2d from package Geom2d, on
//! Computes the curve 3d from package Geom
//! corresponding to curve 2d from package Geom2d, on
//! the plan defined with the local coordinate system
//! Position.
Standard_EXPORT static Handle(Geom_Curve) To3d(const gp_Ax2& Position,
const Handle(Geom2d_Curve)& Curve2d);
//! Computes the curve 3d from package Geom
//! corresponding to the curve 3d from package Geom,
//! Computes the curve 3d from package Geom
//! corresponding to the curve 3d from package Geom,
//! transformed with the transformation <GTrsf>
//! WARNING : this method may return a null Handle if
//! it's impossible to compute the transformation of
@@ -120,7 +120,7 @@ public:
//! Extends the bounded surface Surf along one of its
//! boundaries. The chord length of the extension is equal to Length.
//! The direction of the extension is given as:
//! - the u parametric direction of Surf, if InU equals true, or
//! - the u parametric direction of Surf, if InU equals true, or
//! - the v parametric direction of Surf, if InU equals false.
//! In this parametric direction, the extension is built on the side of:
//! - the last parameter of Surf, if After equals true, or
@@ -142,19 +142,19 @@ public:
const Standard_Boolean InU,
const Standard_Boolean After);
//! Compute axes of inertia, of some points -- -- --
//! <Axe>.Location() is the BaryCentre -- -- -- -- --
//! <Axe>.XDirection is the axe of upper inertia -- -- --
//! -- <Axe>.Direction is the Normal to the average plane
//! -- -- -- IsSingular is True if points are on line --
//! Compute axes of inertia, of some points
//! <Axe>.Location() is the BaryCentre
//! <Axe>.XDirection is the axe of upper inertia
//! <Axe>.Direction is the Normal to the average plane
//! IsSingular is True if points are on line
//! Tol is used to determine singular cases.
Standard_EXPORT static void AxeOfInertia(const TColgp_Array1OfPnt& Points,
gp_Ax2& Axe,
Standard_Boolean& IsSingular,
const Standard_Real Tol = 1.0e-7);
//! Compute principale axes of inertia, and dispersion
//! value of some points.
//! Compute principale axes of inertia, and dispersion
//! value of some points.
Standard_EXPORT static void Inertia(const TColgp_Array1OfPnt& Points,
gp_Pnt& Bary,
gp_Dir& XDir,
@@ -163,7 +163,7 @@ public:
Standard_Real& YGap,
Standard_Real& ZGap);
//! Warning! This assume that the InParameter is an increasing sequence
//! Warning! This assume that the InParameter is an increasing sequence
//! of real number and it will not check for that : Unpredictable
//! result can happen if this is not satisfied. It is the caller
//! responsibility to check for that property.

View File

@@ -95,7 +95,7 @@ public:
//! surface (uses GeomProjLib_ProjectedCurve)
//! If the projection needs an approximation,
//! Precision::PApproximation() is used.
//! WARNING: if the projection has failed, this
//! WARNING: if the projection has failed, this
//! method returns a null Handle.
//! can expand a little the bounds of surface
Standard_EXPORT static Handle(Geom2d_Curve) Curve2d(const Handle(Geom_Curve)& C,
@@ -121,7 +121,7 @@ public:
Standard_Real& Tolerance);
//! Constructs the 3d-curve from the normal
//! projection of the Curve <C> on the surface <S>.
//! projection of the Curve <C> on the surface <S>.
//! WARNING: if the projection has failed, returns a
//! null Handle.
Standard_EXPORT static Handle(Geom_Curve) Project(const Handle(Geom_Curve)& C,
@@ -131,7 +131,7 @@ public:
//! of the curve <Curve> on the plane <Plane> along
//! the direction <Dir>.
//! If <KeepParametrization> is true, the parametrization
//! of the Projected Curve <PC> will be the same as the
//! of the Projected Curve <PC> will be the same as the
//! parametrization of the initial curve <C>.
//! It means: proj(C(u)) = PC(u) for each u.
//! Otherwise, the parametrization may change.

View File

@@ -65,7 +65,7 @@ public:
Standard_EXPORT void Read(Standard_IStream& IS,
const Message_ProgressRange& theProgress = Message_ProgressRange());
//! Dumps the surface on the stream, if compact is True
//! Dumps the surface on the stream, if compact is True
//! use the compact format that can be read back.
Standard_EXPORT static void PrintSurface(const Handle(Geom_Surface)& S,
Standard_OStream& OS,

View File

@@ -40,10 +40,10 @@ class gp_Pln;
//! The result of the intersection are points (Pnt from
//! gp), associated with the parameter on the conic.
//!
//! A call to an Intersection L:Lin from gp and
//! SPH: Sphere from gp can be written either :
//! A call to an Intersection L:Lin from gp and
//! SPH: Sphere from gp can be written either:
//! IntAna_IntConicQuad Inter(L,IntAna_Quadric(SPH))
//! or :
//! or:
//! IntAna_IntConicQuad Inter(L,SPH) (it is necessary
//! to include IntAna_Quadric.hxx in this case)
class IntAna_IntConicQuad

View File

@@ -86,8 +86,8 @@ public:
Standard_EXPORT const gp_Pnt& Point(const Standard_Integer N) const;
//! Returns the parameters on the "explicit quadric"
//! (i.e the cylinder or the cone, the first argument given to the constructor) of the point of
//! range N.
//! (i.e. the cylinder or the cone, the first argument given to the constructor)
//! of the point of range N.
Standard_EXPORT void Parameters(const Standard_Integer N,
Standard_Real& U1,
Standard_Real& U2) const;

View File

@@ -97,7 +97,7 @@ public:
Standard_EXPORT static gp_Lin2d Project(const gp_Torus& To, const gp_Circ& Ci);
//! Make empty P-Curve <aC> of relevant to <PC> type
//! Make empty P-Curve <aC> of relevant to <PC> type
Standard_EXPORT static void MakePCurveOfType(const ProjLib_ProjectedCurve& PC,
Handle(Geom2d_Curve)& aC);

View File

@@ -109,7 +109,7 @@ public:
//! Changes the surface.
Standard_EXPORT void Load(const Handle(Adaptor3d_Surface)& S);
//! Changes the curve.
//! Changes the curve.
Standard_EXPORT void Load(const Handle(Adaptor3d_Curve)& C);
Standard_EXPORT const Handle(Adaptor3d_Surface)& GetSurface() const;

View File

@@ -24,7 +24,7 @@
class Geom2d_BSplineCurve;
class Geom2d_BezierCurve;
//! Approximate the projection of a 3d curve on an
//! Approximate the projection of a 3d curve on an
//! analytic surface and stores the result in Approx.
//! The result is a 2d curve.
//! For approximation some parameters are used, including

View File

@@ -60,7 +60,7 @@ public:
//! False otherwise.
Standard_EXPORT Standard_Boolean Values(const math_Vector& X, math_Vector& F, math_Matrix& D);
//! returns point on surface
//! returns point on surface
Standard_EXPORT gp_Pnt2d Solution() const;
private:

View File

@@ -55,7 +55,7 @@ public:
//! by the Ax3 <Pl>.
Standard_EXPORT ProjLib_ProjectOnPlane(const gp_Ax3& Pl);
//! The projection will be along the direction <D> on
//! The projection will be along the direction <D> on
//! the plane defined by the Ax3 <Pl>.
//! raises if the direction <D> is parallel to the
//! plane <Pl>.
@@ -89,11 +89,11 @@ public:
Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE;
//! If necessary, breaks the curve in intervals of
//! continuity <S>. And returns the number of
//! continuity <S>. And returns the number of
//! intervals.
Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE;
//! Stores in <T> the parameters bounding the intervals of continuity <S>.
//! Stores in <T> the parameters bounding the intervals of continuity <S>.
//!
//! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
@@ -157,7 +157,7 @@ public:
//! to the real space resolution <R3d>.
Standard_EXPORT Standard_Real Resolution(const Standard_Real R3d) const Standard_OVERRIDE;
//! Returns the type of the curve in the current
//! Returns the type of the curve in the current
//! interval: Line, Circle, Ellipse, Hyperbola,
//! Parabola, BezierCurve, BSplineCurve, OtherCurve.
Standard_EXPORT GeomAbs_CurveType GetType() const Standard_OVERRIDE;

View File

@@ -125,7 +125,7 @@ public:
//! intervals.
Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE;
//! Stores in <T> the parameters bounding the intervals
//! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
//! The array must provide enough room to accommodate