lili/OCCT
1
0
Fork 0
mirror of https://github.com/Open-Cascade-SAS/OCCT.git synced 2026-05-11 01:58:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

Documentation - Fix whitespace and typos (#772)

Browse Source 
- Corrected spelling errors (e.g., "aera" → "area", "nithing" → "nothing")
- Normalized excessive whitespace in comments for better readability
- Standardized comment formatting while preserving technical content
This commit is contained in:
luzpaz
2025-10-29 13:57:19 -04:00
committed by GitHub
parent cd3fc87130
commit ae33c4ef42
59 changed files with 358 additions and 362 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
src/ModelingAlgorithms/TKGeomAlgo/Law/Law_BSpline.hxx
View File

@@ -38,29 +38,29 @@ DEFINE_STANDARD_HANDLE(Law_BSpline, Standard_Transient)
//! Rational or non-rational
//! Periodic or non-periodic
//!
//! a b-spline curve is defined by :
//! A b-spline curve is defined by:
//!
//! The Degree (up to 25)
//!
//! The Poles (and the weights if it is rational)
//! The Poles (and the weights if it is rational)
//!
//! The Knots and Multiplicities
//!
//! The knot vector is an increasing sequence of
//! reals without repetition. The multiplicities are
//! The knot vector is an increasing sequence of
//! reals without repetition. The multiplicities are
//! the repetition of the knots.
//!
//! If the knots are regularly spaced (the difference
//! of two consecutive knots is a constant), the
//! knots repartition is :
//! of two consecutive knots is a constant), the
//! knots repartition is:
//!
//! - Uniform if all multiplicities are 1.
//!
//! - Quasi-uniform if all multiplicities are 1
//! - Quasi-uniform if all multiplicities are 1
//! but the first and the last which are Degree+1.
//!
//! - PiecewiseBezier if all multiplicities are
//! Degree but the first and the last which are
//! - PiecewiseBezier if all multiplicities are
//! Degree but the first and the last which are
//! Degree+1.
//!
//! The curve may be periodic.
@@ -68,7 +68,7 @@ DEFINE_STANDARD_HANDLE(Law_BSpline, Standard_Transient)
//! On a periodic curve if there are k knots and p
//! poles. the period is knot(k) - knot(1)
//!
//! the poles and knots are infinite vectors with :
//! the poles and knots are infinite vectors with:
//!
//! knot(i+k) = knot(i) + period
//!
@@ -88,7 +88,7 @@ class Law_BSpline : public Standard_Transient
{
public:
//! Creates a non-rational B_spline curve on the
//! Creates a non-rational B_spline curve on the
//! basis <Knots, Multiplicities> of degree <Degree>.
Standard_EXPORT Law_BSpline(const TColStd_Array1OfReal& Poles,
const TColStd_Array1OfReal& Knots,
@@ -96,7 +96,7 @@ public:
const Standard_Integer Degree,
const Standard_Boolean Periodic = Standard_False);
//! Creates a rational B_spline curve on the basis
//! Creates a rational B_spline curve on the basis
//! <Knots, Multiplicities> of degree <Degree>.
Standard_EXPORT Law_BSpline(const TColStd_Array1OfReal& Poles,
const TColStd_Array1OfReal& Weights,
@@ -105,90 +105,90 @@ public:
const Standard_Integer Degree,
const Standard_Boolean Periodic = Standard_False);
//! Increase the degree to <Degree>. Nothing is done
//! if <Degree> is lower or equal to the current
//! Increase the degree to <Degree>. Nothing is done
//! if <Degree> is lower or equal to the current
//! degree.
Standard_EXPORT void IncreaseDegree(const Standard_Integer Degree);
//! Increases the multiplicity of the knot <Index> to
//! Increases the multiplicity of the knot <Index> to
//! <M>.
//!
//! If <M> is lower or equal to the current
//! multiplicity nothing is done. If <M> is higher than
//! the degree the degree is used.
//! If <M> is lower or equal to the current multiplicity
//! nothing is done. If <M> is higher than the degree
//! the degree is used.
//! If <Index> is not in [FirstUKnotIndex, LastUKnotIndex]
Standard_EXPORT void IncreaseMultiplicity(const Standard_Integer Index, const Standard_Integer M);
//! Increases the multiplicities of the knots in
//! Increases the multiplicities of the knots in
//! [I1,I2] to <M>.
//!
//! For each knot if <M> is lower or equal to the
//! current multiplicity nothing is done. If <M> is
//! For each knot if <M> is lower or equal to the
//! current multiplicity nothing is done. If <M> is
//! higher than the degree the degree is used.
//! If <I1,I2> are not in [FirstUKnotIndex, LastUKnotIndex]
Standard_EXPORT void IncreaseMultiplicity(const Standard_Integer I1,
const Standard_Integer I2,
const Standard_Integer M);
//! Increment the multiplicities of the knots in
//! Increment the multiplicities of the knots in
//! [I1,I2] by <M>.
//!
//! If <M> is not positive nithing is done.
//! If <M> is not positive nothing is done.
//!
//! For each knot the resulting multiplicity is
//! For each knot the resulting multiplicity is
//! limited to the Degree.
//! If <I1,I2> are not in [FirstUKnotIndex, LastUKnotIndex]
Standard_EXPORT void IncrementMultiplicity(const Standard_Integer I1,
const Standard_Integer I2,
const Standard_Integer M);
//! Inserts a knot value in the sequence of knots. If
//! <U> is an existing knot the multiplicity is
//! Inserts a knot value in the sequence of knots.
//! If <U> is an existing knot the multiplicity is
//! increased by <M>.
//!
//! If U is not on the parameter range nothing is
//! If U is not on the parameter range nothing is
//! done.
//!
//! If the multiplicity is negative or null nothing is
//! done. The new multiplicity is limited to the
//! done. The new multiplicity is limited to the
//! degree.
//!
//! The tolerance criterion for knots equality is
//! The tolerance criterion for knots equality is
//! the max of Epsilon(U) and ParametricTolerance.
Standard_EXPORT void InsertKnot(const Standard_Real U,
const Standard_Integer M = 1,
const Standard_Real ParametricTolerance = 0.0,
const Standard_Boolean Add = Standard_True);
//! Inserts a set of knots values in the sequence of
//! Inserts a set of knots values in the sequence of
//! knots.
//!
//! For each U = Knots(i), M = Mults(i)
//!
//! If <U> is an existing knot the multiplicity is
//! increased by <M> if <Add> is True, increased to
//! If <U> is an existing knot the multiplicity is
//! increased by <M> if <Add> is True, increased to
//! <M> if <Add> is False.
//!
//! If U is not on the parameter range nothing is
//! If U is not on the parameter range nothing is
//! done.
//!
//! If the multiplicity is negative or null nothing is
//! done. The new multiplicity is limited to the
//! done. The new multiplicity is limited to the
//! degree.
//!
//! The tolerance criterion for knots equality is
//! The tolerance criterion for knots equality is
//! the max of Epsilon(U) and ParametricTolerance.
Standard_EXPORT void InsertKnots(const TColStd_Array1OfReal& Knots,
const TColStd_Array1OfInteger& Mults,
const Standard_Real ParametricTolerance = 0.0,
const Standard_Boolean Add = Standard_False);
//! Decrement the knots multiplicity to <M>. If M is
//! 0 the knot is removed. The Poles sequence is
//! Decrement the knots multiplicity to <M>. If M is
//! 0 the knot is removed. The Poles sequence is
//! modified.
//!
//! As there are two ways to compute the new poles the
//! average is computed if the distance is lower than
//! As there are two ways to compute the new poles the
//! average is computed if the distance is lower than
//! the <Tolerance>, else False is returned.
//!
//! A low tolerance is used to prevent the modification
@@ -200,7 +200,7 @@ public:
//! [FirstUKnotIndex, LastUKnotIndex]
//! pole insertion and pole removing
//! this operation is limited to the Uniform or QuasiUniform
//! BSplineCurve. The knot values are modified . If the BSpline is
//! BSplineCurve. The knot values are modified. If the BSpline is
//! NonUniform or Piecewise Bezier an exception Construction error
//! is raised.
Standard_EXPORT Standard_Boolean RemoveKnot(const Standard_Integer Index,
@@ -359,16 +359,16 @@ public:
Standard_Real& V2,
Standard_Real& V3) const;
//! The following functions computes the point of parameter U and
//! the derivatives at this point on the B-spline curve arc
//! defined between the knot FromK1 and the knot ToK2. U can be
//! out of bounds [Knot (FromK1), Knot (ToK2)] but for the
//! computation we only use the definition of the curve between
//! these two knots. This method is useful to compute local
//! derivative, if the order of continuity of the whole curve is
//! not greater enough. Inside the parametric domain Knot
//! (FromK1), Knot (ToK2) the evaluations are the same as if we
//! consider the whole definition of the curve. Of course the
//! The following functions computes the point of parameter U and
//! the derivatives at this point on the B-spline curve arc
//! defined between the knot FromK1 and the knot ToK2. U can be
//! out of bounds [Knot (FromK1), Knot (ToK2)] but for the
//! computation we only use the definition of the curve between
//! these two knots. This method is useful to compute local
//! derivative, if the order of continuity of the whole curve is
//! not greater enough. Inside the parametric domain Knot
//! (FromK1), Knot (ToK2) the evaluations are the same as if we
//! consider the whole definition of the curve. Of course the
//! evaluations are different outside this parametric domain.
Standard_EXPORT Standard_Real DN(const Standard_Real U, const Standard_Integer N) const;
@@ -569,7 +569,7 @@ private:
//! the answer will be false
Standard_EXPORT Standard_Boolean IsCacheValid(const Standard_Real Parameter) const;
//! Recompute the flatknots, the knotsdistribution, the
//! Recompute the flatknots, the knotsdistribution, the
//! continuity.
Standard_EXPORT void UpdateKnots();