- Standardized spacing in documentation comments by removing extra spaces between words
- Fixed inconsistent line breaks in multi-line comment blocks
- Corrected minor spelling/grammar issues (e.g., "follow" → "follows", "form" → "from")
//! Updates the face Tolerance.
Standard_EXPORT void UpdateFace(const TopoDS_Face& F, const Standard_Real Tol) const;
- //! Sets the NaturalRestriction flag of the face.
+ //! Sets the NaturalRestriction flag of the face.
Standard_EXPORT void NaturalRestriction(const TopoDS_Face& F, const Standard_Boolean N) const;
//! Makes an undefined Edge (no geometry).
const TopoDS_Face& F,
const Standard_Real Tol) const;
- //! Sets pcurves for the edge on the closed face. If
+ //! Sets pcurves for the edge on the closed face. If
//! <C1> or <C2> is a null handle, remove any existing
//! pcurve.
void UpdateEdge(const TopoDS_Edge& E,
const Standard_Real Last,
const Standard_Boolean Only3d = Standard_False) const;
- //! Sets the range of the edge on the pcurve on the
+ //! Sets the range of the edge on the pcurve on the
//! surface.
Standard_EXPORT void Range(const TopoDS_Edge& E,
const Handle(Geom_Surface)& S,
const Standard_Real First,
const Standard_Real Last) const;
- //! Add to <Eout> the geometric representations of
- //! <Ein>.
+ //! Add to <Eout> the geometric representations of <Ein>.
Standard_EXPORT void Transfert(const TopoDS_Edge& Ein, const TopoDS_Edge& Eout) const;
//! Makes an udefined vertex without geometry.
const gp_Pnt& P,
const Standard_Real Tol) const;
- //! Sets the parameter for the vertex on the edge
- //! curves.
+ //! Sets the parameter for the vertex on the edge curves.
Standard_EXPORT void UpdateVertex(const TopoDS_Vertex& V,
const Standard_Real P,
const TopoDS_Edge& E,
const Standard_Real Tol) const;
- //! Sets the parameter for the vertex on the edge
- //! pcurve on the face.
+ //! Sets the parameter for the vertex on the edge
+ //! pcurve on the face.
void UpdateVertex(const TopoDS_Vertex& V,
const Standard_Real P,
const TopoDS_Edge& E,
const TopoDS_Face& F,
const Standard_Real Tol) const;
- //! Sets the parameter for the vertex on the edge
- //! pcurve on the surface.
+ //! Sets the parameter for the vertex on the edge
+ //! pcurve on the surface.
Standard_EXPORT void UpdateVertex(const TopoDS_Vertex& V,
const Standard_Real P,
const TopoDS_Edge& E,
//! Updates the vertex tolerance.
Standard_EXPORT void UpdateVertex(const TopoDS_Vertex& V, const Standard_Real Tol) const;
- //! Transfert the parameters of Vin on Ein as the
+ //! Transfert the parameters of Vin on Ein as the
//! parameter of Vout on Eout.
Standard_EXPORT void Transfert(const TopoDS_Edge& Ein,
const TopoDS_Edge& Eout,
class BRep_CurveOnClosedSurface;
DEFINE_STANDARD_HANDLE(BRep_CurveOnClosedSurface, BRep_CurveOnSurface)
-//! Representation of a curve by two pcurves on
+//! Representation of a curve by two pcurves on
//! a closed surface.
class BRep_CurveOnClosedSurface : public BRep_CurveOnSurface
{
class BRep_CurveOnSurface;
DEFINE_STANDARD_HANDLE(BRep_CurveOnSurface, BRep_GCurve)
-//! Representation of a curve by a curve in the
+//! Representation of a curve by a curve in the
//! parametric space of a surface.
class BRep_CurveOnSurface : public BRep_GCurve
{
//! A continuity between two surfaces.
Standard_EXPORT virtual Standard_Boolean IsRegularity() const;
- //! A curve with two parametric curves on the same
+ //! A curve with two parametric curves on the same
//! surface.
Standard_EXPORT virtual Standard_Boolean IsCurveOnClosedSurface() const;
- //! Is it a curve in the parametric space of <S> with
+ //! Is it a curve in the parametric space of <S> with
//! location <L>.
Standard_EXPORT virtual Standard_Boolean IsCurveOnSurface(const Handle(Geom_Surface)& S,
const TopLoc_Location& L) const;
- //! Is it a regularity between <S1> and <S2> with
+ //! Is it a regularity between <S1> and <S2> with
//! location <L1> and <L2>.
Standard_EXPORT virtual Standard_Boolean IsRegularity(const Handle(Geom_Surface)& S1,
const Handle(Geom_Surface)& S2,
//! A polygon in the parametric space of a surface.
Standard_EXPORT virtual Standard_Boolean IsPolygonOnSurface() const;
- //! Is it a polygon in the parametric space of <S> with
+ //! Is it a polygon in the parametric space of <S> with
//! location <L>.
Standard_EXPORT virtual Standard_Boolean IsPolygonOnSurface(const Handle(Geom_Surface)& S,
const TopLoc_Location& L) const;
- //! Two 2D polygon representations in the parametric
+ //! Two 2D polygon representations in the parametric
//! space of a surface.
Standard_EXPORT virtual Standard_Boolean IsPolygonOnClosedSurface() const;
class BRep_GCurve;
DEFINE_STANDARD_HANDLE(BRep_GCurve, BRep_CurveRepresentation)
-//! Root class for the geometric curves
+//! Root class for the geometric curves
//! representation. Contains a range.
//! Contains a first and a last parameter.
class BRep_GCurve : public BRep_CurveRepresentation
class BRep_PointOnCurveOnSurface;
DEFINE_STANDARD_HANDLE(BRep_PointOnCurveOnSurface, BRep_PointsOnSurface)
-//! Representation by a parameter on a curve on a
+//! Representation by a parameter on a curve on a
//! surface.
class BRep_PointOnCurveOnSurface : public BRep_PointsOnSurface
{
class BRep_PointRepresentation;
DEFINE_STANDARD_HANDLE(BRep_PointRepresentation, Standard_Transient)
-//! Root class for the points representations.
+//! Root class for the points representations.
//! Contains a location and a parameter.
class BRep_PointRepresentation : public Standard_Transient
{
const Handle(Geom_Surface)& S,
const TopLoc_Location& L);
- //! A 2D polygon representation in the parametric
+ //! A 2D polygon representation in the parametric
//! space of a surface.
Standard_EXPORT virtual Standard_Boolean IsPolygonOnSurface() const Standard_OVERRIDE;
- //! A 2D polygon representation in the parametric
+ //! A 2D polygon representation in the parametric
//! space of a surface.
Standard_EXPORT virtual Standard_Boolean IsPolygonOnSurface(const Handle(Geom_Surface)& S,
const TopLoc_Location& L) const
class BRep_TEdge;
DEFINE_STANDARD_HANDLE(BRep_TEdge, TopoDS_TEdge)
-//! The TEdge from BRep is inherited from the TEdge
+//! The TEdge from BRep is inherited from the TEdge
//! from TopoDS. It contains the geometric data.
//!
-//! The TEdge contains :
+//! The TEdge contains a:
//!
-//! * A tolerance.
-//!
-//! * A same parameter flag.
-//!
-//! * A same range flag.
-//!
-//! * A Degenerated flag.
-//!
-//! * A list of curve representation.
+//! * tolerance.
+//! * same parameter flag.
+//! * same range flag.
+//! * Degenerated flag.
+//! * list of curve representation.
class BRep_TEdge : public TopoDS_TEdge
{
void Tolerance(const Standard_Real T);
- //! Sets the tolerance to the max of <T> and the
- //! current tolerance.
+ //! Sets the tolerance to the max of <T> and the
+ //! current tolerance.
void UpdateTolerance(const Standard_Real T);
Standard_EXPORT Standard_Boolean SameParameter() const;
BRep_ListOfCurveRepresentation& ChangeCurves();
- //! Returns a copy of the TShape with no sub-shapes.
+ //! Returns a copy of the TShape with no sub-shapes.
Standard_EXPORT Handle(TopoDS_TShape) EmptyCopy() const Standard_OVERRIDE;
//! Dumps the content of me into the stream
class BRep_TFace;
DEFINE_STANDARD_HANDLE(BRep_TFace, TopoDS_TFace)
-//! The Tface from BRep is based on the TFace from
-//! TopoDS. The TFace contains :
+//! The Tface from BRep is based on the TFace from
+//! TopoDS. The TFace contains:
//!
//! * A surface, a tolerance and a Location.
//!
-//! * A NaturalRestriction flag, when this flag is
-//! True the boundary of the face is known to be the
+//! * A NaturalRestriction flag, when this flag is
+//! True the boundary of the face is known to be the
//! parametric space (Umin, UMax, VMin, VMax).
//!
//! * An optional list of triangulations. If there are any
//! triangulations the surface can be absent.
//!
-//! The Location is used for the Surface.
+//! The Location is used for the Surface.
//!
-//! The triangulation is in the same reference system
-//! than the TFace. A point on mySurface must be
-//! transformed with myLocation, but not a point on
+//! The triangulation is in the same reference system
+//! than the TFace. A point on mySurface must be
+//! transformed with myLocation, but not a point on
//! the triangulation.
//!
-//! The Surface may be shared by different TFaces but
-//! not the Triangulation, because the Triangulation
-//! may be modified by the edges.
+//! The Surface may be shared by different TFaces but
+//! not the Triangulation, because the Triangulation
+//! may be modified by the edges.
class BRep_TFace : public TopoDS_TFace
{
class BRep_TVertex;
DEFINE_STANDARD_HANDLE(BRep_TVertex, TopoDS_TVertex)
-//! The TVertex from BRep inherits from the TVertex
+//! The TVertex from BRep inherits from the TVertex
//! from TopoDS. It contains the geometric data.
//!
-//! The TVertex contains a 3d point, location and a tolerance.
+//! The TVertex contains a 3d point, location and a tolerance.
class BRep_TVertex : public TopoDS_TVertex
{
void Tolerance(const Standard_Real T);
- //! Sets the tolerance to the max of <T> and the
- //! current tolerance.
+ //! Sets the tolerance to the max of <T> and the
+ //! current tolerance.
void UpdateTolerance(const Standard_Real T);
const gp_Pnt& Pnt() const;
BRep_ListOfPointRepresentation& ChangePoints();
- //! Returns a copy of the TShape with no sub-shapes.
+ //! Returns a copy of the TShape with no sub-shapes.
Standard_EXPORT Handle(TopoDS_TShape) EmptyCopy() const Standard_OVERRIDE;
//! Dumps the content of me into the stream
//! Returns the tolerance of the face.
Standard_EXPORT static Standard_Real Tolerance(const TopoDS_Face& F);
- //! Returns the NaturalRestriction flag of the face.
+ //! Returns the NaturalRestriction flag of the face.
Standard_EXPORT static Standard_Boolean NaturalRestriction(const TopoDS_Face& F);
//! Returns True if <F> has a surface, false otherwise.
Standard_EXPORT static Standard_Boolean IsGeometric(const TopoDS_Face& F);
- //! Returns True if <E> is a 3d curve or a curve on
- //! surface.
+ //! Returns True if <E> is a 3d curve or a curve on surface.
Standard_EXPORT static Standard_Boolean IsGeometric(const TopoDS_Edge& E);
- //! Returns the 3D curve of the edge. May be a Null
+ //! Returns the 3D curve of the edge. May be a Null
//! handle. Returns in <L> the location for the curve.
//! In <First> and <Last> the parameter range.
Standard_EXPORT static const Handle(Geom_Curve)& Curve(const TopoDS_Edge& E,
Standard_Real& First,
Standard_Real& Last);
- //! Returns the 3D curve of the edge. May be a Null handle.
+ //! Returns the 3D curve of the edge. May be a Null handle.
//! In <First> and <Last> the parameter range.
//! It can be a copy if there is a Location.
Standard_EXPORT static Handle(Geom_Curve) Curve(const TopoDS_Edge& E,
Standard_Real& First,
Standard_Real& Last);
- //! Returns the 3D polygon of the edge. May be a Null
+ //! Returns the 3D polygon of the edge. May be a Null
//! handle. Returns in <L> the location for the polygon.
Standard_EXPORT static const Handle(Poly_Polygon3D)& Polygon3D(const TopoDS_Edge& E,
TopLoc_Location& L);
- //! Returns the curve associated to the edge in the
- //! parametric space of the face. Returns a NULL
- //! handle if this curve does not exist. Returns in
+ //! Returns the curve associated to the edge in the
+ //! parametric space of the face. Returns a NULL
+ //! handle if this curve does not exist. Returns in
//! <First> and <Last> the parameter range.
//! If the surface is a plane the curve can be not stored but created a new
//! each time. The flag pointed by <theIsStored> serves to indicate storage status.
Standard_Real& Last,
Standard_Boolean* theIsStored = NULL);
- //! Returns the curve associated to the edge in the
- //! parametric space of the surface. Returns a NULL
- //! handle if this curve does not exist. Returns in
+ //! Returns the curve associated to the edge in the
+ //! parametric space of the surface. Returns a NULL
+ //! handle if this curve does not exist. Returns in
//! <First> and <Last> the parameter range.
//! If the surface is a plane the curve can be not stored but created a new
//! each time. The flag pointed by <theIsStored> serves to indicate storage status.
Standard_Real& Last);
//! Returns in <C>, <S>, <L> a 2d curve, a surface and
- //! a location for the edge <E>. <C> and <S> are null
- //! if the edge has no curve on surface. Returns in
+ //! a location for the edge <E>. <C> and <S> are null
+ //! if the edge has no curve on surface. Returns in
//! <First> and <Last> the parameter range.
Standard_EXPORT static void CurveOnSurface(const TopoDS_Edge& E,
Handle(Geom2d_Curve)& C,
Standard_Real& Last,
const Standard_Integer Index);
- //! Returns the polygon associated to the edge in the
- //! parametric space of the face. Returns a NULL
- //! handle if this polygon does not exist.
+ //! Returns the polygon associated to the edge in the
+ //! parametric space of the face. Returns a NULL
+ //! handle if this polygon does not exist.
Standard_EXPORT static Handle(Poly_Polygon2D) PolygonOnSurface(const TopoDS_Edge& E,
const TopoDS_Face& F);
- //! Returns the polygon associated to the edge in the
- //! parametric space of the surface. Returns a NULL
- //! handle if this polygon does not exist.
+ //! Returns the polygon associated to the edge in the
+ //! parametric space of the surface. Returns a NULL
+ //! handle if this polygon does not exist.
Standard_EXPORT static Handle(Poly_Polygon2D) PolygonOnSurface(const TopoDS_Edge& E,
const Handle(Geom_Surface)& S,
const TopLoc_Location& L);
//! Returns in <C>, <S>, <L> a 2d curve, a surface and
- //! a location for the edge <E>. <C> and <S> are null
- //! if the edge has no polygon on surface.
+ //! a location for the edge <E>. <C> and <S> are null
+ //! if the edge has no polygon on surface.
Standard_EXPORT static void PolygonOnSurface(const TopoDS_Edge& E,
Handle(Poly_Polygon2D)& C,
Handle(Geom_Surface)& S,
TopLoc_Location& L,
const Standard_Integer Index);
- //! Returns the polygon associated to the edge in the
- //! parametric space of the face. Returns a NULL
- //! handle if this polygon does not exist.
+ //! Returns the polygon associated to the edge in the
+ //! parametric space of the face. Returns a NULL
+ //! handle if this polygon does not exist.
Standard_EXPORT static const Handle(Poly_PolygonOnTriangulation)& PolygonOnTriangulation(
const TopoDS_Edge& E,
const Handle(Poly_Triangulation)& T,
//! Returns in <P>, <T>, <L> a polygon on triangulation, a
//! triangulation and a location for the edge <E>.
- //! <P> and <T> are null if the edge has no
- //! polygon on triangulation.
+ //! <P> and <T> are null if the edge has no
+ //! polygon on triangulation.
Standard_EXPORT static void PolygonOnTriangulation(const TopoDS_Edge& E,
Handle(Poly_PolygonOnTriangulation)& P,
Handle(Poly_Triangulation)& T,
TopLoc_Location& L);
- //! Returns in <P>, <T>, <L> a polygon on
- //! triangulation, a triangulation and a location for
- //! the edge <E> for the range index. <C> and <S> are
+ //! Returns in <P>, <T>, <L> a polygon on
+ //! triangulation, a triangulation and a location for
+ //! the edge <E> for the range index. <C> and <S> are
//! null if the edge has no polygon on triangulation.
Standard_EXPORT static void PolygonOnTriangulation(const TopoDS_Edge& E,
Handle(Poly_PolygonOnTriangulation)& P,
TopLoc_Location& L,
const Standard_Integer Index);
- //! Returns True if <E> has two PCurves in the
- //! parametric space of <F>. i.e. <F> is on a closed
+ //! Returns True if <E> has two PCurves in the
+ //! parametric space of <F>. i.e. <F> is on a closed
//! surface and <E> is on the closing curve.
Standard_EXPORT static Standard_Boolean IsClosed(const TopoDS_Edge& E, const TopoDS_Face& F);
- //! Returns True if <E> has two PCurves in the
- //! parametric space of <S>. i.e. <S> is a closed
+ //! Returns True if <E> has two PCurves in the
+ //! parametric space of <S>. i.e. <S> is a closed
//! surface and <E> is on the closing curve.
Standard_EXPORT static Standard_Boolean IsClosed(const TopoDS_Edge& E,
const Handle(Geom_Surface)& S,
const TopLoc_Location& L);
- //! Returns True if <E> has two arrays of indices in
+ //! Returns True if <E> has two arrays of indices in
//! the triangulation <T>.
Standard_EXPORT static Standard_Boolean IsClosed(const TopoDS_Edge& E,
const Handle(Poly_Triangulation)& T,
Standard_Real& First,
Standard_Real& Last);
- //! Gets the range of the edge on the pcurve on the
- //! surface.
+ //! Gets the range of the edge on the pcurve on the surface.
Standard_EXPORT static void Range(const TopoDS_Edge& E,
const Handle(Geom_Surface)& S,
const TopLoc_Location& L,
const TopLoc_Location& L1,
const TopLoc_Location& L2);
- //! Returns True if the edge has regularity on some
- //! two surfaces
+ //! Returns True if the edge has regularity on some two surfaces.
Standard_EXPORT static Standard_Boolean HasContinuity(const TopoDS_Edge& E);
- //! Returns the max continuity of edge between some surfaces or GeomAbs_C0 if there no such
- //! surfaces.
+ //! Returns the max continuity of edge between some surfaces or GeomAbs_C0
+ //! if there are no such surfaces.
Standard_EXPORT static GeomAbs_Shape MaxContinuity(const TopoDS_Edge& theEdge);
//! Returns the 3d point.
//! Throws Standard_NoSuchObject if no parameter on edge
Standard_EXPORT static Standard_Real Parameter(const TopoDS_Vertex& V, const TopoDS_Edge& E);
- //! Returns the parameters of the vertex on the
+ //! Returns the parameters of the vertex on the
//! pcurve of the edge on the face.
Standard_EXPORT static Standard_Real Parameter(const TopoDS_Vertex& V,
const TopoDS_Edge& E,
const TopoDS_Face& F);
- //! Returns the parameters of the vertex on the
+ //! Returns the parameters of the vertex on the
//! pcurve of the edge on the surface.
Standard_EXPORT static Standard_Real Parameter(const TopoDS_Vertex& V,
const TopoDS_Edge& E,
const TopoDS_Wire& W,
const Standard_Boolean KnotByCurvilinearAbcissa = Standard_False);
- //! Creates a Curve to access the geometry of edge
- //! <W>.
+ //! Creates a Curve to access the geometry of edge <W>.
Standard_EXPORT BRepAdaptor_CompCurve(const TopoDS_Wire& W,
const Standard_Boolean KnotByCurvilinearAbcissa,
const Standard_Real First,
const Standard_Real Last,
const Standard_Real Tol);
- //! Shallow copy of adaptor
+ //! Shallow copy of adaptor.
Standard_EXPORT virtual Handle(Adaptor3d_Curve) ShallowCopy() const Standard_OVERRIDE;
//! Sets the wire <W>.
Standard_EXPORT void Initialize(const TopoDS_Wire& W,
const Standard_Boolean KnotByCurvilinearAbcissa);
- //! Sets wire <W> and trimmed parameter.
+ //! Sets wire <W> and trimmed parameter.
Standard_EXPORT void Initialize(const TopoDS_Wire& W,
const Standard_Boolean KnotByCurvilinearAbcissa,
const Standard_Real First,
//! Returns the wire.
Standard_EXPORT const TopoDS_Wire& Wire() const;
- //! returns an edge and one parameter on them
+ //! returns an edge and one parameter on them
//! corresponding to the parameter U.
Standard_EXPORT void Edge(const Standard_Real U, TopoDS_Edge& E, Standard_Real& UonE) const;
Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE;
- //! 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 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
+ //! 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 Standard_OVERRIDE;
- //! Returns a curve equivalent of <me> between
- //! parameters <First> and <Last>. <Tol> is used to
+ //! Returns a curve equivalent of <me> between
+ //! parameters <First> and <Last>. <Tol> is used to
//! test for 3d points confusion.
//! If <First> >= <Last>
Standard_EXPORT Handle(Adaptor3d_Curve) Trim(const Standard_Real First,
//! Computes the point of parameter U on the curve
//! with its first derivative.
- //! Raised if the continuity of the current interval
- //! is not C1.
+ //! Raised if the continuity of the current interval is not C1.
Standard_EXPORT void D1(const Standard_Real U, gp_Pnt& P, gp_Vec& V) const Standard_OVERRIDE;
//! Returns the point P of parameter U, the first and second
//! The returned vector gives the value of the derivative for the
//! order of derivation N.
- //! Raised if the continuity of the current interval
- //! is not CN.
+ //! Raised if the continuity of the current interval is not CN.
//! Raised if N < 1.
Standard_EXPORT gp_Vec DN(const Standard_Real U,
const Standard_Integer N) const Standard_OVERRIDE;
//!
//! It has the methods the class Curve from Adaptor3d.
//!
-//! It is created or Initialized with an Edge. It
-//! takes into account local coordinate systems. If
-//! the Edge has a 3D curve it is use with priority.
-//! If the edge has no 3D curve one of the curves on
+//! It is created or Initialized with an Edge. It
+//! takes into account local coordinate systems. If
+//! the Edge has a 3D curve it is use with priority.
+//! If the edge has no 3D curve one of the curves on
//! surface is used. It is possible to enforce using a
-//! curve on surface by creating or initialising with
+//! curve on surface by creating or initialising with
//! an Edge and a Face.
class BRepAdaptor_Curve : public Adaptor3d_Curve
{
//! Creates an undefined Curve with no Edge loaded.
Standard_EXPORT BRepAdaptor_Curve();
- //! Creates a Curve to access the geometry of edge
- //! <E>.
+ //! Creates a Curve to access the geometry of edge <E>.
Standard_EXPORT BRepAdaptor_Curve(const TopoDS_Edge& E);
- //! Creates a Curve to access the geometry of edge
- //! <E>. The geometry will be computed using the
- //! parametric curve of <E> on the face <F>. An Error
- //! is raised if the edge does not have a pcurve on
+ //! Creates a Curve to access the geometry of edge
+ //! <E>. The geometry will be computed using the
+ //! parametric curve of <E> on the face <F>. An Error
+ //! is raised if the edge does not have a pcurve on
//! the face.
Standard_EXPORT BRepAdaptor_Curve(const TopoDS_Edge& E, const TopoDS_Face& F);
//! Reset currently loaded curve (undone Load()).
Standard_EXPORT void Reset();
- //! Sets the Curve <me> to access the geometry of
+ //! Sets the Curve <me> to access the geometry of
//! edge <E>.
Standard_EXPORT void Initialize(const TopoDS_Edge& E);
- //! Sets the Curve <me> to access the geometry of
- //! edge <E>. The geometry will be computed using the
- //! parametric curve of <E> on the face <F>. An Error
- //! is raised if the edge does not have a pcurve on
+ //! Sets the Curve <me> to access the geometry of
+ //! edge <E>. The geometry will be computed using the
+ //! parametric curve of <E> on the face <F>. An Error
+ //! is raised if the edge does not have a pcurve on
//! the face.
Standard_EXPORT void Initialize(const TopoDS_Edge& E, const TopoDS_Face& F);
//! a pcurve on a surface.
Standard_EXPORT Standard_Boolean IsCurveOnSurface() const;
- //! Returns the Curve of the edge.
+ //! Returns the Curve of the edge.
Standard_EXPORT const GeomAdaptor_Curve& Curve() const;
//! Returns the CurveOnSurface of the edge.
Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE;
- //! 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 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
+ //! 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 Standard_OVERRIDE;
- //! Returns a curve equivalent of <me> between
- //! parameters <First> and <Last>. <Tol> is used to
+ //! Returns a curve equivalent of <me> between
+ //! parameters <First> and <Last>. <Tol> is used to
//! test for 3d points confusion.
//! If <First> >= <Last>
Standard_EXPORT Handle(Adaptor3d_Curve) Trim(const Standard_Real First,
#include <Geom2dAdaptor_Curve.hxx>
//! The Curve2d from BRepAdaptor allows to use an Edge
-//! on a Face like a 2d curve. (curve in the
-//! parametric space).
+//! on a Face like a 2d curve (curve in the parametric
+//! space).
//!
-//! It has the methods of the class Curve2d from
+//! It has the methods of the class Curve2d from
//! Adpator.
//!
-//! It is created or initialized with a Face and an
-//! Edge. The methods are inherited from Curve from
+//! It is created or initialized with a Face and an
+//! Edge. The methods are inherited from Curve from
//! Geom2dAdaptor.
class BRepAdaptor_Curve2d : public Geom2dAdaptor_Curve
{
DEFINE_STANDARD_HANDLE(BRepAdaptor_Surface, Adaptor3d_Surface)
-//! The Surface from BRepAdaptor allows to use a Face
+//! The Surface from BRepAdaptor allows to use a Face
//! of the BRep topology look like a 3D surface.
//!
-//! It has the methods of the class Surface from
+//! It has the methods of the class Surface from
//! Adaptor3d.
//!
//! It is created or initialized with a Face. It takes
//! into account the local coordinates system.
//!
-//! The u,v parameter range is the minmax value for
-//! the restriction, unless the flag restriction is
+//! The u,v parameter range is the minmax value for
+//! the restriction, unless the flag restriction is
//! set to false.
class BRepAdaptor_Surface : public Adaptor3d_Surface
{
//! Creates an undefined surface with no face loaded.
Standard_EXPORT BRepAdaptor_Surface();
- //! Creates a surface to access the geometry of <F>.
- //! If <Restriction> is true the parameter range is
- //! the parameter range in the UV space of the
+ //! Creates a surface to access the geometry of <F>.
+ //! If <Restriction> is true the parameter range is
+ //! the parameter range in the UV space of the
//! restriction.
Standard_EXPORT BRepAdaptor_Surface(const TopoDS_Face& F,
const Standard_Boolean R = Standard_True);
- //! Shallow copy of adaptor
+ //! Shallow copy of adaptor.
Standard_EXPORT virtual Handle(Adaptor3d_Surface) ShallowCopy() const Standard_OVERRIDE;
//! Sets the surface to the geometry of <F>.
virtual GeomAbs_Shape VContinuity() const Standard_OVERRIDE { return mySurf.VContinuity(); }
//! If necessary, breaks the surface in U intervals of
- //! continuity <S>. And returns the number of
+ //! continuity <S>. And returns the number of
//! intervals.
virtual Standard_Integer NbUIntervals(const GeomAbs_Shape theSh) const Standard_OVERRIDE
{
}
//! If necessary, breaks the surface in V intervals of
- //! continuity <S>. And returns the number of
+ //! continuity <S>. And returns the number of
//! intervals.
virtual Standard_Integer NbVIntervals(const GeomAbs_Shape theSh) const Standard_OVERRIDE
{
return mySurf.NbVIntervals(theSh);
}
- //! Returns the intervals with the requested continuity
+ //! Returns the intervals with the requested continuity
//! in the U direction.
Standard_EXPORT void UIntervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
- //! Returns the intervals with the requested continuity
+ //! Returns the intervals with the requested continuity
//! in the V direction.
Standard_EXPORT void VIntervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
- //! Returns a surface trimmed in the U direction
- //! equivalent of <me> between
- //! parameters <First> and <Last>. <Tol> is used to
- //! test for 3d points confusion.
+ //! Returns a surface trimmed in the U direction
+ //! equivalent of <me> between parameters
+ //! <First> and <Last>.
+ //! <Tol> is used to test for 3d points confusion.
//! If <First> >= <Last>
Standard_EXPORT Handle(Adaptor3d_Surface) UTrim(const Standard_Real First,
const Standard_Real Last,
const Standard_Real Tol) const Standard_OVERRIDE;
- //! Returns a surface trimmed in the V direction between
- //! parameters <First> and <Last>. <Tol> is used to
- //! test for 3d points confusion.
+ //! Returns a surface trimmed in the V direction between
+ //! parameters <First> and <Last>.
+ //! <Tol> is used to test for 3d points confusion.
//! If <First> >= <Last>
Standard_EXPORT Handle(Adaptor3d_Surface) VTrim(const Standard_Real First,
const Standard_Real Last,
const Standard_Real V,
gp_Pnt& P) const Standard_OVERRIDE;
- //! Computes the point and the first derivatives on the surface.
+ //! Computes the point and the first derivatives on the surface.
//! Raised if the continuity of the current intervals is not C1.
//!
//! Tip: use GeomLib::NormEstim() to calculate surface normal at specified (U, V) point.
gp_Vec& D1U,
gp_Vec& D1V) const Standard_OVERRIDE;
- //! Computes the point, the first and second
+ //! Computes the point, the first and second
//! derivatives on the surface.
- //! Raised if the continuity of the current
+ //! Raised if the continuity of the current
//! intervals is not C2.
Standard_EXPORT void D2(const Standard_Real U,
const Standard_Real V,
gp_Vec& D2V,
gp_Vec& D2UV) const Standard_OVERRIDE;
- //! Computes the point, the first, second and third
+ //! Computes the point, the first, second and third
//! derivatives on the surface.
- //! Raised if the continuity of the current
+ //! Raised if the continuity of the current
//! intervals is not C3.
Standard_EXPORT void D3(const Standard_Real U,
const Standard_Real V,
//! Computes the derivative of order Nu in the direction
//! U and Nv in the direction V at the point P(U, V).
- //! Raised if the current U interval is not not CNu
+ //! Raised if the current U interval is not not CNu
//! and the current V interval is not CNv.
//! Raised if Nu + Nv < 1 or Nu < 0 or Nv < 0.
Standard_EXPORT gp_Vec DN(const Standard_Real U,
const Standard_Integer Nu,
const Standard_Integer Nv) const Standard_OVERRIDE;
- //! Returns the parametric U resolution corresponding
+ //! Returns the parametric U resolution corresponding
//! to the real space resolution <R3d>.
virtual Standard_Real UResolution(const Standard_Real theR3d) const Standard_OVERRIDE
{
return mySurf.UResolution(theR3d);
}
- //! Returns the parametric V resolution corresponding
+ //! Returns the parametric V resolution corresponding
//! to the real space resolution <R3d>.
virtual Standard_Real VResolution(const Standard_Real theR3d) const Standard_OVERRIDE
{
return mySurf.VResolution(theR3d);
}
- //! Returns the type of the surface : Plane, Cylinder,
- //! Cone, Sphere, Torus, BezierSurface,
- //! BSplineSurface, SurfaceOfRevolution,
+ //! Returns the type of the surface: Plane, Cylinder,
+ //! Cone, Sphere, Torus, BezierSurface,
+ //! BSplineSurface, SurfaceOfRevolution,
//! SurfaceOfExtrusion, OtherSurface
virtual GeomAbs_SurfaceType GetType() const Standard_OVERRIDE { return mySurf.GetType(); }
Standard_EXPORT Handle(Geom_BezierSurface) Bezier() const Standard_OVERRIDE;
- //! Warning : this will make a copy of the
+ //! Warning: this will make a copy of the
//! BSpline Surface since it applies
//! to it the myTsrf transformation
//! Be Careful when using this method
DEFINE_STANDARD_ALLOC
//! Computes the regularity at the junction between C1 and
- //! C2. The point u1 on C1 and the point u2 on C2 must be
- //! confused. tl and ta are the linear and angular
+ //! C2. The point u1 on C1 and the point u2 on C2 must be
+ //! confused. tl and ta are the linear and angular
//! tolerance used two compare the derivative.
Standard_EXPORT static GeomAbs_Shape Continuity(const BRepAdaptor_Curve& C1,
const BRepAdaptor_Curve& C2,
//! The BRepTools package provides utilities for BRep
//! data structures.
//!
-//! * WireExplorer : A tool to explore the topology of
+//! * WireExplorer: Tool to explore the topology of
//! a wire in the order of the edges.
//!
-//! * ShapeSet : Tools used for dumping, writing and
+//! * ShapeSet: Tools used for dumping, writing and
//! reading.
//!
-//! * UVBounds : Methods to compute the limits of the
-//! boundary of a face, a wire or an edge in the
+//! * UVBounds: Methods to compute the limits of the
+//! boundary of a face, a wire or an edge in the
//! parametric space of a face.
//!
-//! * Update : Methods to call when a topology has
-//! been created to compute all missing data.
+//! * Update: Methods to call when a topology has been
+//! created to compute all missing data.
//!
//! * UpdateFaceUVPoints: Method to update the UV points
//! stored with the edges on a face.
//!
-//! * Compare : Method to compare two vertices.
+//! * Compare: Method to compare two vertices.
//!
-//! * Compare : Method to compare two edges.
+//! * Compare: Method to compare two edges.
//!
-//! * OuterWire : A method to find the outer wire of a
+//! * OuterWire: Method to find the outer wire of a
//! face.
//!
-//! * Map3DEdges : A method to map all the 3D Edges of
+//! * Map3DEdges: Method to map all the 3D Edges of
//! a Shape.
//!
-//! * Dump : A method to dump a BRep object.
+//! * Dump: Method to dump a BRep object.
class BRepTools
{
public:
DEFINE_STANDARD_ALLOC
- //! Returns in UMin, UMax, VMin, VMax the bounding
+ //! Returns in UMin, UMax, VMin, VMax the bounding
//! values in the parametric space of F.
Standard_EXPORT static void UVBounds(const TopoDS_Face& F,
Standard_Real& UMin,
Standard_Real& VMin,
Standard_Real& VMax);
- //! Returns in UMin, UMax, VMin, VMax the bounding
+ //! Returns in UMin, UMax, VMin, VMax the bounding
//! values of the wire in the parametric space of F.
Standard_EXPORT static void UVBounds(const TopoDS_Face& F,
const TopoDS_Wire& W,
Standard_Real& VMin,
Standard_Real& VMax);
- //! Returns in UMin, UMax, VMin, VMax the bounding
+ //! Returns in UMin, UMax, VMin, VMax the bounding
//! values of the edge in the parametric space of F.
Standard_EXPORT static void UVBounds(const TopoDS_Face& F,
const TopoDS_Edge& E,
Standard_Real& VMin,
Standard_Real& VMax);
- //! Adds to the box <B> the bounding values in the
+ //! Adds to the box <B> the bounding values in the
//! parametric space of F.
Standard_EXPORT static void AddUVBounds(const TopoDS_Face& F, Bnd_Box2d& B);
- //! Adds to the box <B> the bounding values of the
+ //! Adds to the box <B> the bounding values of the
//! wire in the parametric space of F.
Standard_EXPORT static void AddUVBounds(const TopoDS_Face& F, const TopoDS_Wire& W, Bnd_Box2d& B);
- //! Adds to the box <B> the bounding values of the
+ //! Adds to the box <B> the bounding values of the
//! edge in the parametric space of F.
Standard_EXPORT static void AddUVBounds(const TopoDS_Face& F, const TopoDS_Edge& E, Bnd_Box2d& B);
Standard_EXPORT static Standard_Boolean UnloadAllTriangulations(const TopoDS_Shape& theShape);
public:
- //! Returns True if the distance between the two
+ //! Returns True if the distance between the two
//! vertices is lower than their tolerance.
Standard_EXPORT static Standard_Boolean Compare(const TopoDS_Vertex& V1, const TopoDS_Vertex& V2);
- //! Returns True if the distance between the two
+ //! Returns True if the distance between the two
//! edges is lower than their tolerance.
Standard_EXPORT static Standard_Boolean Compare(const TopoDS_Edge& E1, const TopoDS_Edge& E2);
//! wire if <F> has no wires.
Standard_EXPORT static TopoDS_Wire OuterWire(const TopoDS_Face& F);
- //! Stores in the map <M> all the 3D topology edges
+ //! Stores in the map <M> all the 3D topology edges
//! of <S>.
Standard_EXPORT static void Map3DEdges(const TopoDS_Shape& S, TopTools_IndexedMapOfShape& M);
- //! Verifies that the edge <E> is found two times on
+ //! Verifies that the edge <E> is found two times on
//! the face <F> before calling BRep_Tool::IsClosed.
Standard_EXPORT static Standard_Boolean IsReallyClosed(const TopoDS_Edge& E,
const TopoDS_Face& F);
const TopTools_FormatVersion theVersion,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Reads a Shape from <S> in returns it in <Sh>.
+ //! Reads a Shape from <S> in returns it in <Sh>.
//! <B> is used to build the shape.
Standard_EXPORT static void Read(
TopoDS_Shape& Sh,
const TopTools_FormatVersion theVersion,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Reads a Shape from <File>, returns it in <Sh>.
+ //! Reads a Shape from <File>, returns it in <Sh>.
//! <B> is used to build the shape.
Standard_EXPORT static Standard_Boolean Read(
TopoDS_Shape& Sh,
const BRep_Builder& B,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Evals real tolerance of edge <theE>.
+ //! Evals real tolerance of edge <theE>.
//! <theC3d>, <theC2d>, <theS>, <theF>, <theL> are
//! correspondently 3d curve of edge, 2d curve on surface <theS> and
//! rang of edge
const Standard_Real theF,
const Standard_Real theL);
- //! returns the cumul of the orientation of <Edge>
- //! and thc containing wire in <Face>
+ //! returns the cumul of the orientation of <Edge>
+ //! and the containing wire in <Face>
Standard_EXPORT static TopAbs_Orientation OriEdgeInFace(const TopoDS_Edge& theEdge,
const TopoDS_Face& theFace);
class BRepTools_GTrsfModification;
DEFINE_STANDARD_HANDLE(BRepTools_GTrsfModification, BRepTools_Modification)
-//! Defines a modification of the geometry by a GTrsf
+//! Defines a modification of the geometry by a GTrsf
//! from gp. All methods return True and transform the
//! geometry.
class BRepTools_GTrsfModification : public BRepTools_Modification
//! Gives an access on the GTrsf.
Standard_EXPORT gp_GTrsf& GTrsf();
- //! Returns Standard_True if the face <F> has been
- //! modified. In this case, <S> is the new geometric
- //! support of the face, <L> the new location,<Tol>
- //! the new tolerance.<RevWires> has to be set to
- //! Standard_True when the modification reverses the
- //! normal of the surface.(the wires have to be
- //! reversed). <RevFace> has to be set to
- //! Standard_True if the orientation of the modified
- //! face changes in the shells which contain it. --
- //! Here, <RevFace> will return Standard_True if the
+ //! Returns Standard_True if the face <F> has been
+ //! modified. In this case, <S> is the new geometric
+ //! support of the face, <L> the new location,<Tol>
+ //! the new tolerance.<RevWires> has to be set to
+ //! Standard_True when the modification reverses the
+ //! normal of the surface. (the wires have to be
+ //! reversed). <RevFace> has to be set to
+ //! Standard_True if the orientation of the modified
+ //! face changes in the shells which contain it. --
+ //! Here, <RevFace> will return Standard_True if the
//! -- gp_Trsf is negative.
Standard_EXPORT Standard_Boolean NewSurface(const TopoDS_Face& F,
Handle(Geom_Surface)& S,
Standard_Boolean& RevWires,
Standard_Boolean& RevFace) Standard_OVERRIDE;
- //! Returns Standard_True if the edge <E> has been
- //! modified. In this case, <C> is the new geometric
- //! support of the edge, <L> the new location, <Tol>
- //! the new tolerance. Otherwise, returns
- //! Standard_False, and <C>, <L>, <Tol> are not
+ //! Returns Standard_True if the edge <E> has been
+ //! modified. In this case, <C> is the new geometric
+ //! support of the edge, <L> the new location, <Tol>
+ //! the new tolerance. Otherwise, returns
+ //! Standard_False, and <C>, <L>, <Tol> are not
//! significant.
Standard_EXPORT Standard_Boolean NewCurve(const TopoDS_Edge& E,
Handle(Geom_Curve)& C,
TopLoc_Location& L,
Standard_Real& Tol) Standard_OVERRIDE;
- //! Returns Standard_True if the vertex <V> has been
- //! modified.
In this case, <P> is the new geometric
- //! support of the vertex, <Tol> the new tolerance.
- //! Otherwise, returns Standard_False, and <P>, <Tol>
+ //! Returns Standard_True if the vertex <V> has been
+ //! modified.
In this case, <P> is the new geometric
+ //! support of the vertex, <Tol> the new tolerance.
+ //! Otherwise, returns Standard_False, and <P>, <Tol>
//! are not significant.
Standard_EXPORT Standard_Boolean NewPoint(const TopoDS_Vertex& V,
gp_Pnt& P,
Standard_Real& Tol) Standard_OVERRIDE;
- //! Returns Standard_True if the edge <E> has a new
+ //! Returns Standard_True if the edge <E> has a new
//! curve on surface on the face <F>.In this case, <C>
- //! is the new geometric support of the edge, <L> the
+ //! is the new geometric support of the edge, <L> the
//! new location, <Tol> the new tolerance.
- //! Otherwise, returns Standard_False, and <C>, <L>,
+ //! Otherwise, returns Standard_False, and <C>, <L>,
//! <Tol> are not significant.
Standard_EXPORT Standard_Boolean NewCurve2d(const TopoDS_Edge& E,
const TopoDS_Face& F,
Handle(Geom2d_Curve)& C,
Standard_Real& Tol) Standard_OVERRIDE;
- //! Returns Standard_True if the Vertex <V> has a new
- //! parameter on the
edge <E>. In this case, <P> is
- //! the parameter, <Tol> the new tolerance.
- //! Otherwise, returns Standard_False, and <P>, <Tol>
+ //! Returns Standard_True if the Vertex <V> has a new
+ //! parameter on the
edge <E>. In this case, <P> is
+ //! the parameter, <Tol> the new tolerance.
+ //! Otherwise, returns Standard_False, and <P>, <Tol>
//! are not significant.
Standard_EXPORT Standard_Boolean NewParameter(const TopoDS_Vertex& V,
const TopoDS_Edge& E,
Standard_Real& P,
Standard_Real& Tol) Standard_OVERRIDE;
- //! Returns the continuity of <NewE> between <NewF1>
+ //! Returns the continuity of <NewE> between <NewF1>
//! and <NewF2>.
//!
- //! <NewE> is the new edge created from <E>. <NewF1>
- //! (resp. <NewF2>) is the new face created from <F1>
+ //! <NewE> is the new edge created from <E>. <NewF1>
+ //! (resp. <NewF2>) is the new face created from <F1>
//! (resp. <F2>).
Standard_EXPORT GeomAbs_Shape Continuity(const TopoDS_Edge& E,
const TopoDS_Face& F1,
class BRepTools_NurbsConvertModification;
DEFINE_STANDARD_HANDLE(BRepTools_NurbsConvertModification, BRepTools_CopyModification)
-//! Defines a modification of the geometry by a Trsf
+//! Defines a modification of the geometry by a Trsf
//! from gp. All methods return True and transform the
//! geometry.
class BRepTools_NurbsConvertModification : public BRepTools_CopyModification
public:
Standard_EXPORT BRepTools_NurbsConvertModification();
- //! Returns Standard_True if the face <F> has been
- //! modified. In this case, <S> is the new geometric
- //! support of the face, <L> the new location,<Tol>
- //! the new tolerance.<RevWires> has to be set to
- //! Standard_True when the modification reverses the
- //! normal of the surface.(the wires have to be
- //! reversed). <RevFace> has to be set to
- //! Standard_True if the orientation of the modified
- //! face changes in the shells which contain it. --
- //! Here, <RevFace> will return Standard_True if the
+ //! Returns Standard_True if the face <F> has been
+ //! modified. In this case, <S> is the new geometric
+ //! support of the face, <L> the new location,<Tol>
+ //! the new tolerance.<RevWires> has to be set to
+ //! Standard_True when the modification reverses the
+ //! normal of the surface. (the wires have to be
+ //! reversed). <RevFace> has to be set to
+ //! Standard_True if the orientation of the modified
+ //! face changes in the shells which contain it. --
+ //! Here, <RevFace> will return Standard_True if the
//! -- gp_Trsf is negative.
Standard_EXPORT Standard_Boolean NewSurface(const TopoDS_Face& F,
Handle(Geom_Surface)& S,
Standard_Boolean& RevWires,
Standard_Boolean& RevFace) Standard_OVERRIDE;
- //! Returns Standard_True if the edge <E> has been
- //! modified. In this case, <C> is the new geometric
- //! support of the edge, <L> the new location, <Tol>
- //! the new tolerance. Otherwise, returns
- //! Standard_False, and <C>, <L>, <Tol> are not
+ //! Returns Standard_True if the edge <E> has been
+ //! modified. In this case, <C> is the new geometric
+ //! support of the edge, <L> the new location, <Tol>
+ //! the new tolerance. Otherwise, returns
+ //! Standard_False, and <C>, <L>, <Tol> are not
//! significant.
Standard_EXPORT Standard_Boolean NewCurve(const TopoDS_Edge& E,
Handle(Geom_Curve)& C,
TopLoc_Location& L,
Standard_Real& Tol) Standard_OVERRIDE;
- //! Returns Standard_True if the vertex <V> has been
- //! modified.
In this case, <P> is the new geometric
- //! support of the vertex, <Tol> the new tolerance.
- //! Otherwise, returns Standard_False, and <P>, <Tol>
+ //! Returns Standard_True if the vertex <V> has been
+ //! modified.
In this case, <P> is the new geometric
+ //! support of the vertex, <Tol> the new tolerance.
+ //! Otherwise, returns Standard_False, and <P>, <Tol>
//! are not significant.
Standard_EXPORT Standard_Boolean NewPoint(const TopoDS_Vertex& V,
gp_Pnt& P,
Standard_Real& Tol) Standard_OVERRIDE;
- //! Returns Standard_True if the edge <E> has a new
+ //! Returns Standard_True if the edge <E> has a new
//! curve on surface on the face <F>.In this case, <C>
- //! is the new geometric support of the edge, <L> the
+ //! is the new geometric support of the edge, <L> the
//! new location, <Tol> the new tolerance.
- //! Otherwise, returns Standard_False, and <C>, <L>,
+ //! Otherwise, returns Standard_False, and <C>, <L>,
//! <Tol> are not significant.
Standard_EXPORT Standard_Boolean NewCurve2d(const TopoDS_Edge& E,
const TopoDS_Face& F,
Handle(Geom2d_Curve)& C,
Standard_Real& Tol) Standard_OVERRIDE;
- //! Returns Standard_True if the Vertex <V> has a new
- //! parameter on the
edge <E>. In this case, <P> is
- //! the parameter, <Tol> the new tolerance.
- //! Otherwise, returns Standard_False, and <P>, <Tol>
+ //! Returns Standard_True if the Vertex <V> has a new
+ //! parameter on the
edge <E>. In this case, <P> is
+ //! the parameter, <Tol> the new tolerance.
+ //! Otherwise, returns Standard_False, and <P>, <Tol>
//! are not significant.
Standard_EXPORT Standard_Boolean NewParameter(const TopoDS_Vertex& V,
const TopoDS_Edge& E,
Standard_Real& P,
Standard_Real& Tol) Standard_OVERRIDE;
- //! Returns the continuity of <NewE> between <NewF1>
+ //! Returns the continuity of <NewE> between <NewF1>
//! and <NewF2>.
//!
- //! <NewE> is the new edge created from <E>. <NewF1>
- //! (resp. <NewF2>) is the new face created from <F1>
+ //! <NewE> is the new edge created from <E>. <NewF1>
+ //! (resp. <NewF2>) is the new face created from <F1>
//! (resp. <F2>).
Standard_EXPORT GeomAbs_Shape Continuity(const TopoDS_Edge& E,
const TopoDS_Face& F1,
Standard_EXPORT BRepTools_Quilt();
- //! Binds <Enew> to be the new edge instead of
- //! <Eold>.
+ //! Binds <Enew> to be the new edge instead of <Eold>.
//!
- //! The faces of the added shape containing <Eold>
+ //! The faces of the added shape containing <Eold>
//! will be copied to substitute <Eold> by <Enew>.
//!
- //! The vertices of <Eold> will be bound to the
+ //! The vertices of <Eold> will be bound to the
//! vertices of <Enew> with the same orientation.
//!
- //! If <Eold> and <Enew> have different orientations
- //! the curves are considered to be opposite and the
- //! pcurves of <Eold> will be copied and reversed in
+ //! If <Eold> and <Enew> have different orientations
+ //! the curves are considered to be opposite and the
+ //! pcurves of <Eold> will be copied and reversed in
//! the new faces.
//!
//! <Eold> must belong to the next added shape, <Enew> must belong
//! Binds <VNew> to be a new vertex instead of <Vold>.
//!
- //! The faces of the added shape containing <Vold>
+ //! The faces of the added shape containing <Vold>
//! will be copied to substitute <Vold> by <Vnew>.
Standard_EXPORT void Bind(const TopoDS_Vertex& Vold, const TopoDS_Vertex& Vnew);
- //! Add the faces of <S> to the Quilt, the faces
+ //! Add the faces of <S> to the Quilt, the faces
//! containing bounded edges are copied.
Standard_EXPORT void Add(const TopoDS_Shape& S);
- //! Returns True if <S> has been copied (<S> is a
+ //! Returns True if <S> has been copied (<S> is a
//! vertex, an edge or a face)
Standard_EXPORT Standard_Boolean IsCopied(const TopoDS_Shape& S) const;
//! Dumps the geometry of me on the stream <OS>.
Standard_EXPORT virtual void DumpGeometry(Standard_OStream& OS) const Standard_OVERRIDE;
- //! Writes the geometry of me on the stream <OS> in a
+ //! Writes the geometry of me on the stream <OS> in a
//! format that can be read back by Read.
Standard_EXPORT virtual void WriteGeometry(
Standard_OStream& OS,
const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
- //! Reads the geometry of me from the stream <IS>.
+ //! Reads the geometry of me from the stream <IS>.
Standard_EXPORT virtual void ReadGeometry(
Standard_IStream& IS,
const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
Standard_EXPORT virtual void DumpGeometry(const TopoDS_Shape& S,
Standard_OStream& OS) const Standard_OVERRIDE;
- //! Writes the geometry of <S> on the stream <OS> in a
+ //! Writes the geometry of <S> on the stream <OS> in a
//! format that can be read back by Read.
Standard_EXPORT virtual void WriteGeometry(const TopoDS_Shape& S,
Standard_OStream& OS) const Standard_OVERRIDE;
Standard_IStream& IS,
TopoDS_Shape& S) Standard_OVERRIDE;
- //! Inserts the shape <S2> in the shape <S1>. This
- //! method must be redefined to use the correct
+ //! Inserts the shape <S2> in the shape <S1>. This
+ //! method must be redefined to use the correct
//! builder.
Standard_EXPORT virtual void AddShapes(TopoDS_Shape& S1,
const TopoDS_Shape& S2) Standard_OVERRIDE;
Standard_EXPORT virtual void Check(const TopAbs_ShapeEnum T, TopoDS_Shape& S) Standard_OVERRIDE;
- //! Reads the 3d polygons of me
- //! from the stream <IS>.
+ //! Reads the 3d polygons of me
+ //! from the stream <IS>.
Standard_EXPORT void ReadPolygon3D(
Standard_IStream& IS,
const Message_ProgressRange& theProgress = Message_ProgressRange());
Standard_EXPORT void DumpPolygon3D(Standard_OStream& OS) const;
//! Reads the triangulation of me
- //! from the stream <IS>.
+ //! from the stream <IS>.
Standard_EXPORT void ReadTriangulation(
Standard_IStream& IS,
const Message_ProgressRange& theProgress = Message_ProgressRange());
Standard_EXPORT void DumpTriangulation(Standard_OStream& OS) const;
//! Reads the polygons on triangulation of me
- //! from the stream <IS>.
+ //! from the stream <IS>.
Standard_EXPORT void ReadPolygonOnTriangulation(
Standard_IStream& IS,
const Message_ProgressRange& theProgress = Message_ProgressRange());
//! <Oldshape> will be replaced by <NewShapes>.
//!
- //! <NewShapes> can be empty
, in this case <OldShape>
+ //! <NewShapes> can be empty, in this case <OldShape>
//! will disparate from its ancestors.
//!
//! if an item of <NewShapes> is oriented FORWARD.
//! the resul of <Build>
Standard_EXPORT void Build(const TopoDS_Shape& S);
- //! Returns True if <S> has been replaced .
+ //! Returns True if <S> has been replaced.
Standard_EXPORT Standard_Boolean IsCopied(const TopoDS_Shape& S) const;
//! Returns the set of shapes substituted to <S>.
//! Constructs an empty explorer (which can be initialized using Init)
Standard_EXPORT BRepTools_WireExplorer();
- //! IInitializes an exploration of the wire <W>.
+ //! IInitializes an exploration of the wire <W>.
Standard_EXPORT BRepTools_WireExplorer(const TopoDS_Wire& W);
- //! Initializes an exploration of the wire <W>.
+ //! Initializes an exploration of the wire <W>.
//! F is used to select the edge connected to the
//! previous in the parametric representation of <F>.
Standard_EXPORT BRepTools_WireExplorer(const TopoDS_Wire& W, const TopoDS_Face& F);
const Standard_Real VMin,
const Standard_Real VMax);
- //! Returns True if there is a current edge.
+ //! Returns True if there is a current edge.
Standard_EXPORT Standard_Boolean More() const;
//! Proceeds to the next edge.
//! Returns an Orientation for the current edge.
Standard_EXPORT TopAbs_Orientation Orientation() const;
- //! Returns the vertex connecting the current edge to
+ //! Returns the vertex connecting the current edge to
//! the previous one.
Standard_EXPORT const TopoDS_Vertex& CurrentVertex() const;
//! Clears the content of the set.
Standard_EXPORT void Clear();
- //! Incorporate a new Curve in the set and returns
+ //! Incorporate a new Curve in the set and returns
//! its index.
Standard_EXPORT Standard_Integer Add(const Handle(Geom2d_Curve)& C);
//! Dumps the content of me on the stream <OS>.
Standard_EXPORT void Dump(Standard_OStream& OS) const;
- //! Writes the content of me on the stream <OS> in a
+ //! Writes the content of me on the stream <OS> in a
//! format that can be read back by Read.
Standard_EXPORT void Write(Standard_OStream& OS,
const Message_ProgressRange& theRange = Message_ProgressRange()) const;
- //! Reads the content of me from the stream <IS>. me
+ //! Reads the content of me from the stream <IS>. me
//! is first cleared.
Standard_EXPORT void Read(Standard_IStream& IS,
const Message_ProgressRange& theRange = Message_ProgressRange());
//! Dumps the curve on the binary stream, that can be read back.
Standard_EXPORT static void WriteCurve2d(const Handle(Geom2d_Curve)& C, BinTools_OStream& OS);
- //! Reads the curve from the stream. The curve is
- //! assumed to have been written with the Write
+ //! Reads the curve from the stream. The curve is
+ //! assumed to have been written with the Write
//! method.
Standard_EXPORT static Standard_IStream& ReadCurve2d(Standard_IStream& IS,
Handle(Geom2d_Curve)& C);
//! Clears the content of the set.
Standard_EXPORT void Clear();
- //! Incorporate a new Curve in the set and returns
+ //! Incorporate a new Curve in the set and returns
//! its index.
Standard_EXPORT Standard_Integer Add(const Handle(Geom_Curve)& C);
//! Returns the index of <L>.
Standard_EXPORT Standard_Integer Index(const Handle(Geom_Curve)& C) const;
- //! Writes the content of me on the stream <OS> in a
+ //! Writes the content of me on the stream <OS> in a
//! format that can be read back by Read.
Standard_EXPORT void Write(Standard_OStream& OS,
const Message_ProgressRange& theRange = Message_ProgressRange()) const;
- //! Reads the content of me from the stream <IS>. me
+ //! Reads the content of me from the stream <IS>. me
//! is first cleared.
Standard_EXPORT void Read(Standard_IStream& IS,
const Message_ProgressRange& theRange = Message_ProgressRange());
//! that can be read back.
Standard_EXPORT static void WriteCurve(const Handle(Geom_Curve)& C, BinTools_OStream& OS);
- //! Reads the curve from the stream. The curve is
- //! assumed to have been written with the Write
+ //! Reads the curve from the stream. The curve is
+ //! assumed to have been written with the Write
//! method
Standard_EXPORT static Standard_IStream& ReadCurve(Standard_IStream& IS, Handle(Geom_Curve)& C);
//! Clears the content of the set.
Standard_EXPORT void Clear();
- //! Incorporate a new Location in the set and returns
+ //! Incorporate a new Location in the set and returns
//! its index.
Standard_EXPORT Standard_Integer Add(const TopLoc_Location& L);
//! Returns number of locations.
Standard_EXPORT Standard_Integer NbLocations() const;
- //! Writes the content of me on the stream <OS> in a
+ //! Writes the content of me on the stream <OS> in a
//! format that can be read back by Read.
Standard_EXPORT void Write(Standard_OStream& OS) const;
- //! Reads the content of me from the stream <IS>. me
+ //! Reads the content of me from the stream <IS>. me
//! is first cleared.
Standard_EXPORT void Read(Standard_IStream& IS);
//! Returns number of shapes read from file.
Standard_EXPORT Standard_Integer NbShapes() const;
- //! Writes the content of me on the stream <OS> in binary
+ //! Writes the content of me on the stream <OS> in binary
//! format that can be read back by Read.
//!
//! Writes the locations.
//! Writes the geometry calling WriteGeometry.
//!
//! Dumps the shapes from last to first.
- //! For each shape :
+ //! For each shape:
//! Write the type.
//! calls WriteGeometry(S).
//! Write the flags, the subshapes.
Standard_OStream& OS,
const Message_ProgressRange& theRange = Message_ProgressRange());
- //! Reads the content of me from the binary stream <IS>. me
+ //! Reads the content of me from the binary stream <IS>. me
//! is first cleared.
//!
//! Reads the locations.
Standard_IStream& IS,
const Message_ProgressRange& theRange = Message_ProgressRange());
- //! Writes on <OS> the shape <S>. Writes the
+ //! Writes on <OS> the shape <S>. Writes the
//! orientation, the index of the TShape and the index
//! of the Location.
Standard_EXPORT virtual void Write(const TopoDS_Shape& S, Standard_OStream& OS);
- //! Writes the geometry of me on the stream <OS> in a
+ //! Writes the geometry of me on the stream <OS> in a
//! binary format that can be read back by Read.
Standard_EXPORT virtual void WriteGeometry(
Standard_OStream& OS,
const Message_ProgressRange& theRange = Message_ProgressRange()) const;
- //! Reads the geometry of me from the stream <IS>.
+ //! Reads the geometry of me from the stream <IS>.
Standard_EXPORT virtual void ReadGeometry(
Standard_IStream& IS,
const Message_ProgressRange& theRange = Message_ProgressRange());
//! binary format that can be read back by Read.
Standard_EXPORT virtual void WriteShape(const TopoDS_Shape& S, Standard_OStream& OS) const;
- //! Reads a shape of type <T> from the stream <IS> and returns it in <S>.
+ //! Reads a shape of type <T> from the stream <IS> and returns it in <S>.
Standard_EXPORT virtual void ReadShape(const TopAbs_ShapeEnum T,
Standard_IStream& IS,
TopoDS_Shape& S);
//! Stores the shape <S>.
Standard_EXPORT virtual void AddShape(const TopoDS_Shape& S);
- //! Inserts the shape <S2> in the shape <S1>.
+ //! Inserts the shape <S2> in the shape <S1>.
Standard_EXPORT virtual void AddShapes(TopoDS_Shape& S1, const TopoDS_Shape& S2);
- //! Reads the 3d polygons of me
- //! from the stream <IS>.
+ //! Reads the 3d polygons of me
+ //! from the stream <IS>.
Standard_EXPORT void ReadPolygon3D(
Standard_IStream& IS,
const Message_ProgressRange& theRange = Message_ProgressRange());
const Message_ProgressRange& theRange = Message_ProgressRange()) const;
//! Reads the triangulation of me
- //! from the stream <IS>.
+ //! from the stream <IS>.
Standard_EXPORT void ReadTriangulation(
Standard_IStream& IS,
const Message_ProgressRange& theRange = Message_ProgressRange());
const Message_ProgressRange& theRange = Message_ProgressRange()) const;
//! Reads the polygons on triangulation of me
- //! from the stream <IS>.
+ //! from the stream <IS>.
Standard_EXPORT void ReadPolygonOnTriangulation(
Standard_IStream& IS,
const Message_ProgressRange& theRange = Message_ProgressRange());
//! Clears the content of the set.
Standard_EXPORT virtual void Clear() {}
- //! Writes the content of me on the stream <OS> in binary
+ //! Writes the content of me on the stream <OS> in binary
//! format that can be read back by Read.
//!
//! Writes the locations.
//! Writes the geometry calling WriteGeometry.
//!
//! Dumps the shapes from last to first.
- //! For each shape :
+ //! For each shape:
//! Write the type.
//! calls WriteGeometry(S).
//! Write the flags, the subshapes.
{
}
- //! Reads the content of me from the binary stream <IS>. me
+ //! Reads the content of me from the binary stream <IS>. me
//! is first cleared.
//!
//! Reads the locations.
{
}
- //! Writes on <OS> the shape <S>. Writes the
+ //! Writes on <OS> the shape <S>. Writes the
//! orientation, the index of the TShape and the index
//! of the Location.
Standard_EXPORT virtual void Write(const TopoDS_Shape& /*theShape*/,
//! Clears the content of the set.
Standard_EXPORT void Clear();
- //! Incorporate a new Surface in the set and returns
+ //! Incorporate a new Surface in the set and returns
//! its index.
Standard_EXPORT Standard_Integer Add(const Handle(Geom_Surface)& S);
//! Returns the index of <L>.
Standard_EXPORT Standard_Integer Index(const Handle(Geom_Surface)& S) const;
- //! Writes the content of me on the stream <OS> in
+ //! Writes the content of me on the stream <OS> in
//! binary format that can be read back by Read.
Standard_EXPORT void Write(Standard_OStream& OS,
const Message_ProgressRange& theRange = Message_ProgressRange()) const;
- //! Reads the content of me from the stream <IS>. me
+ //! Reads the content of me from the stream <IS>. me
//! is first cleared.
Standard_EXPORT void Read(Standard_IStream& IS,
const Message_ProgressRange& therange = Message_ProgressRange());
//! format that can be read back.
Standard_EXPORT static void WriteSurface(const Handle(Geom_Surface)& S, BinTools_OStream& OS);
- //! Reads the surface from the stream. The surface is
- //! assumed to have been written with the Write
- //! method.
+ //! Reads the surface from the stream. The surface is
+ //! assumed to have been written with the Write method.
Standard_EXPORT static Standard_IStream& ReadSurface(Standard_IStream& IS,
Handle(Geom_Surface)& S);
class TopoDS_Edge;
class TopoDS_Wire;
-//! This package provides basic tools to explore the
+//! This package provides basic tools to explore the
//! topological data structures.
//!
-//! * Explorer : A tool to find all sub-shapes of a given
+//! * Explorer: A tool to find all sub-shapes of a given
//! type. e.g. all faces of a solid.
//!
//! * Package methods to map sub-shapes of a shape.
//!
//! Level : Public
-//! All methods of all classes will be public.
+//! All methods of all classes will be public.
class TopExp
{
public:
const Standard_Boolean cumLoc = Standard_True);
//! Stores in the map <M> all the subshape of <S> of
- //! type <TS> for each one append to the list all
- //! the ancestors of type <TA>. For example map all
+ //! type <TS> for each one append to the list all
+ //! the ancestors of type <TA>. For example map all
//! the edges and bind the list of faces.
//! Warning: The map is not cleared at first.
Standard_EXPORT static void MapShapesAndAncestors(const TopoDS_Shape& S,
//! Stores in the map <M> all the subshape of <S> of
//! type <TS> for each one append to the list all
- //! unique ancestors of type <TA>. For example map all
+ //! unique ancestors of type <TA>. For example map all
//! the edges and bind the list of faces.
//! useOrientation = True : taking account the ancestor orientation
//! Warning: The map is not cleared at first.
TopoDS_Vertex& Vlast,
const Standard_Boolean CumOri = Standard_False);
- //! Returns in Vfirst, Vlast the first and last
+ //! Returns in Vfirst, Vlast the first and last
//! vertices of the open wire <W>. May be null shapes.
- //! if <W> is closed Vfirst and Vlast are a same
+ //! if <W> is closed Vfirst and Vlast are a same
//! vertex on <W>.
//! if <W> is no manifold. VFirst and VLast are null
//! shapes.
TopoDS_Vertex& Vfirst,
TopoDS_Vertex& Vlast);
- //! Finds the vertex <V> common to the two edges
+ //! Finds the vertex <V> common to the two edges
//! <E1,E2>, returns True if this vertex exists.
//!
//! Warning: <V> has sense only if the value <True> is returned
#include <TopoDS_Iterator.hxx>
#include <TopoDS_Shape.hxx>
-//! An Explorer is a Tool to visit a Topological Data
-//! Structure form the TopoDS package.
+//! An Explorer is a Tool to visit a Topological Data
+//! Structure from the TopoDS package.
//!
-//! An Explorer is built with :
+//! An Explorer is built with:
//!
//! * The Shape to explore.
//!
-//! * The type of Shapes to find : e.g VERTEX, EDGE.
+//! * The type of Shapes to find: e.g VERTEX, EDGE.
//! This type cannot be SHAPE.
//!
-//! * The type of Shapes to avoid. e.g SHELL, EDGE.
-//! By default this type is SHAPE which means no
+//! * The type of Shapes to avoid. e.g SHELL, EDGE.
+//! By default this type is SHAPE which means no
//! restriction on the exploration.
//!
-//! The Explorer visits all the structure to find
-//! shapes of the requested type which are not
+//! The Explorer visits all the structure to find
+//! shapes of the requested type which are not
//! contained in the type to avoid.
//!
//! Example to find all the Faces in the Shape S :
//!
//! for (Ex.Init(S,TopAbs_VERTEX,TopAbs_EDGE); ...)
//!
-//! To find all the faces in a SHELL, then all the
+//! To find all the faces in a SHELL, then all the
//! faces not in a SHELL :
//!
//! TopExp_Explorer Ex1, Ex2;
//! // visit all faces not in a shell
//! }
//!
-//! If the type to avoid is the same or is less
+//! If the type to avoid is the same or is less
//! complex than the type to find it has no effect.
//!
-//! For example searching edges not in a vertex does
+//! For example searching edges not in a vertex does
//! not make a difference.
class TopExp_Explorer
{
//! <ToFind> is the type of shapes to search.
//! TopAbs_VERTEX, TopAbs_EDGE, ...
//!
- //! <ToAvoid> is the type of shape to skip in the
- //! exploration. If <ToAvoid> is equal or less
- //! complex than <ToFind> or if <ToAVoid> is SHAPE it
+ //! <ToAvoid> is the type of shape to skip in the
+ //! exploration. If <ToAvoid> is equal or less
+ //! complex than <ToFind> or if <ToAVoid> is SHAPE it
//! has no effect on the exploration.
Standard_EXPORT TopExp_Explorer(const TopoDS_Shape& S,
const TopAbs_ShapeEnum ToFind,
//! IndexedDataMapOfShapeAddress
//! DataMapOfOrientedShapeShape
//!
-//! * LocationSet : to write sets of locations.
+//! * LocationSet: to write sets of locations.
//!
-//! * ShapeSet : to writes sets of TShapes.
+//! * ShapeSet: to writes sets of TShapes.
//!
-//! Package Methods :
+//! Package Methods:
//!
-//! Dump : To dump the topology of a Shape.
+//! Dump: To dump the topology of a Shape.
class TopTools
{
public:
DEFINE_STANDARD_ALLOC
//! A set of Shapes. Can be dump, wrote or read.
- //! Dumps the topological structure of <Sh> on the
+ //! Dumps the topological structure of <Sh> on the
//! stream <S>.
Standard_EXPORT static void Dump(const TopoDS_Shape& Sh, Standard_OStream& S);
//! This is to bypass an extraction bug. It will force
- //! the inclusion of Standard_Integer.hxx itself
- //! including Standard_OStream.hxx at the correct
+ //! the inclusion of Standard_Integer.hxx itself
+ //! including Standard_OStream.hxx at the correct
//! position.
Standard_EXPORT static void Dummy(const Standard_Integer I);
};
//! Clears the content of the set.
Standard_EXPORT void Clear();
- //! Incorporate a new Location in the set and returns
+ //! Incorporate a new Location in the set and returns
//! its index.
Standard_EXPORT Standard_Integer Add(const TopLoc_Location& L);
//! Dumps the content of me on the stream <OS>.
Standard_EXPORT void Dump(Standard_OStream& OS) const;
- //! Writes the content of me on the stream <OS> in a
+ //! Writes the content of me on the stream <OS> in a
//! format that can be read back by Read.
Standard_EXPORT void Write(
Standard_OStream& OS,
const Message_ProgressRange& theProgress = Message_ProgressRange()) const;
- //! Reads the content of me from the stream <IS>. me
+ //! Reads the content of me from the stream <IS>. me
//! is first cleared.
Standard_EXPORT void Read(Standard_IStream& IS,
const Message_ProgressRange& theProgress = Message_ProgressRange());
class TopoDS_Shape;
class TCollection_AsciiString;
-//! A ShapeSets contains a Shape and all its
-//! sub-shapes and locations. It can be dump, write
+//! A ShapeSets contains a Shape and all its
+//! sub-shapes and locations. It can be dump, write
//! and read.
//!
//! Methods to handle the geometry can be redefined.
//! Returns the TopTools_FormatVersion
Standard_EXPORT Standard_Integer FormatNb() const;
- //! Clears the content of the set. This method can be
+ //! Clears the content of the set. This method can be
//! redefined.
Standard_EXPORT virtual void Clear();
//! Dumps the locations.
Standard_EXPORT virtual void Dump(Standard_OStream& OS) const;
- //! Writes the content of me on the stream <OS> in a
+ //! Writes the content of me on the stream <OS> in a
//! format that can be read back by Read.
//!
//! Writes the locations.
Standard_OStream& OS,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Reads the content of me from the stream <IS>. me
+ //! Reads the content of me from the stream <IS>. me
//! is first cleared.
//!
//! Reads the locations.
Standard_IStream& IS,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Dumps on <OS> the shape <S>. Dumps the
+ //! Dumps on <OS> the shape <S>. Dumps the
//! orientation, the index of the TShape and the index
//! of the Location.
Standard_EXPORT void Dump(const TopoDS_Shape& S, Standard_OStream& OS) const;
- //! Writes on <OS> the shape <S>. Writes the
+ //! Writes on <OS> the shape <S>. Writes the
//! orientation, the index of the TShape and the index
//! of the Location.
Standard_EXPORT void Write(const TopoDS_Shape& S, Standard_OStream& OS) const;
//! Dumps the geometry of me on the stream <OS>.
Standard_EXPORT virtual void DumpGeometry(Standard_OStream& OS) const;
- //! Writes the geometry of me on the stream <OS> in a
+ //! Writes the geometry of me on the stream <OS> in a
//! format that can be read back by Read.
Standard_EXPORT virtual void WriteGeometry(
Standard_OStream& OS,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Reads the geometry of me from the stream <IS>.
+ //! Reads the geometry of me from the stream <IS>.
Standard_EXPORT virtual void ReadGeometry(
Standard_IStream& IS,
const Message_ProgressRange& theProgress = Message_ProgressRange());
//! Dumps the geometry of <S> on the stream <OS>.
Standard_EXPORT virtual void DumpGeometry(const TopoDS_Shape& S, Standard_OStream& OS) const;
- //! Writes the geometry of <S> on the stream <OS> in a
+ //! Writes the geometry of <S> on the stream <OS> in a
//! format that can be read back by Read.
Standard_EXPORT virtual void WriteGeometry(const TopoDS_Shape& S, Standard_OStream& OS) const;
Standard_IStream& IS,
TopoDS_Shape& S);
- //! Inserts the shape <S2> in the shape <S1>. This
- //! method must be redefined to use the correct
+ //! Inserts the shape <S2> in the shape <S1>. This
+ //! method must be redefined to use the correct
//! builder.
Standard_EXPORT virtual void AddShapes(TopoDS_Shape& S1, const TopoDS_Shape& S2);
- //! This method is called after each new completed
- //! shape. <T> is the type. <S> is the shape. In this
+ //! This method is called after each new completed
+ //! shape. <T> is the type. <S> is the shape. In this
//! class it does nothing, but it gives the opportunity
- //! in derived classes to perform extra treatment on
+ //! in derived classes to perform extra treatment on
//! shapes.
Standard_EXPORT virtual void Check(const TopAbs_ShapeEnum T, TopoDS_Shape& S);
static const Standard_CString THE_ASCII_VERSIONS[TopTools_FormatVersion_VERSION_3 + 1];
private:
- //! Reads from <IS> a shape and returns it in S.
+ //! Reads from <IS> a shape and returns it in S.
//! <NbShapes> is the number of tshapes in the set.
Standard_EXPORT void Read(TopoDS_Shape& S,
Standard_IStream& IS,
class TopoDS_CompSolid;
class TopoDS_Compound;
-//! A Builder is used to create Topological Data
-//! Structures.It is the root of the Builder class hierarchy.
+//! A Builder is used to create Topological Data Structures.
+//! It is the root of the Builder class hierarchy.
//!
-//! There are three groups of methods in the Builder :
+//! There are three groups of methods in the Builder:
//!
//! The Make methods create Shapes.
//!
//! The Add method includes a Shape in another Shape.
//!
-//! The Remove method removes a Shape from an other
+//! The Remove method removes a Shape from an other
//! Shape.
//!
//! The methods in Builder are not static. They can be
//! redefined in inherited builders.
//!
-//! This Builder does not provide methods to Make
-//! Vertices, Edges, Faces, Shells or Solids. These
-//! methods are provided in the inherited Builders
+//! This Builder does not provide methods to Make
+//! Vertices, Edges, Faces, Shells or Solids. These
+//! methods are provided in the inherited Builders
//! as they must provide the geometry.
//!
-//! The Add method check for the following rules :
+//! The Add method check for the following rules:
//!
//! - Any SHAPE can be added in a COMPOUND.
//!
Standard_EXPORT void Remove(TopoDS_Shape& S, const TopoDS_Shape& C) const;
protected:
- //! The basic method to make a Shape, used by all the
+ //! The basic method to make a Shape, used by all the
//! Make methods.
Standard_EXPORT void MakeShape(TopoDS_Shape& S, const Handle(TopoDS_TShape)& T) const;
#include <Standard_SStream.hxx>
#include <Standard_DomainError.hxx>
-//! An attempt was made to modify a Shape already
+//! An attempt was made to modify a Shape already
//! shared or protected.
class TopoDS_FrozenShape;
class TopoDS_HShape;
DEFINE_STANDARD_HANDLE(TopoDS_HShape, Standard_Transient)
-//! Class to manipulate a Shape with handle.
+//! Class to manipulate a Shape with handle.
class TopoDS_HShape : public Standard_Transient
{
public:
- //! Constructs an empty shape object
+ //! Constructs an empty shape object.
TopoDS_HShape();
//! Constructs a shape object defined by the shape aShape.
TopoDS_HShape(const TopoDS_Shape& aShape);
- //! Loads this shape with the shape aShape
+ //! Loads this shape with the shape aShape.
void Shape(const TopoDS_Shape& aShape);
//! Returns a reference to a constant TopoDS_Shape based on this shape.
class TopoDS_TEdge;
DEFINE_STANDARD_HANDLE(TopoDS_TEdge, TopoDS_TShape)
-//! A topological part of a curve in 2D or 3D, the
-//! boundary is a set of oriented Vertices.
+//! A topological part of a curve in 2D or 3D, the
+//! boundary is a set of oriented Vertices.
class TopoDS_TEdge : public TopoDS_TShape
{
public:
- //! Returns EDGE.
+ //! Returns EDGE.
Standard_EXPORT TopAbs_ShapeEnum ShapeType() const Standard_OVERRIDE;
DEFINE_STANDARD_RTTIEXT(TopoDS_TEdge, TopoDS_TShape)
class TopoDS_TFace;
DEFINE_STANDARD_HANDLE(TopoDS_TFace, TopoDS_TShape)
-//! A topological part of a surface or of the 2D
-//! space. The boundary is a set of wires and
+//! A topological part of a surface or of the 2D
+//! space. The boundary is a set of wires and
//! vertices.
class TopoDS_TFace : public TopoDS_TShape
{
#undef Convex
#endif
-//! A TShape is a topological structure describing a
+//! A TShape is a topological structure describing a
//! set of points in a 2D or 3D space.
//!
//! A topological shape is a structure made from other
-//! shapes. This is a deferred class used to support
+//! shapes. This is a deferred class used to support
//! topological objects.
//!
-//! TShapes are defined by their optional domain
-//! (geometry) and their components (other TShapes
-//! with Locations and Orientations). The components
+//! TShapes are defined by their optional domain
+//! (geometry) and their components (other TShapes
+//! with Locations and Orientations). The components
//! are stored in a List of Shapes.
//!
-//! A TShape contains the following boolean flags :
+//! A TShape contains the following boolean flags:
//!
//! - Free : Free or Frozen.
//! - Modified : Has been modified.
//! - Convex : Is convex.
//!
//! Users have no direct access to the classes derived
-//! from TShape. They handle them with the classes
+//! from TShape. They handle them with the classes
//! derived from Shape.
class TopoDS_TShape : public Standard_Transient
{
class TopoDS_TVertex;
DEFINE_STANDARD_HANDLE(TopoDS_TVertex, TopoDS_TShape)
-//! A Vertex is a topological point in two or three
-//! dimensions.
+//! A Vertex is a topological point in two or three dimensions.
class TopoDS_TVertex : public TopoDS_TShape
{
public:
Standard_EXPORT virtual GeomAbs_Shape Continuity() const;
- //! 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.
Standard_EXPORT virtual Standard_Integer NbIntervals(const GeomAbs_Shape S) const;
//! for the parameters. i.e. T.Length() > NbIntervals()
Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T, const GeomAbs_Shape S) const;
- //! Returns a curve equivalent of <me> between
- //! parameters <First> and <Last>. <Tol> is used to
+ //! Returns a curve equivalent of <me> between
+ //! parameters <First> and <Last>. <Tol> is used to
//! test for 3d points confusion.
//! If <First> >= <Last>
Standard_EXPORT virtual Handle(Adaptor2d_Curve2d) Trim(const Standard_Real First,
//! to the real space resolution <R3d>.
Standard_EXPORT virtual Standard_Real Resolution(const Standard_Real R3d) const;
- //! Returns the type of the curve in the current
- //! interval : Line, Circle, Ellipse, Hyperbola,
+ //! Returns the type of the curve in the current
+ //! interval: Line, Circle, Ellipse, Hyperbola,
//! Parabola, BezierCurve, BSplineCurve, OtherCurve.
Standard_EXPORT virtual GeomAbs_CurveType GetType() const;
Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE;
- //! 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.
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
+ //! 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 Standard_OVERRIDE;
- //! Returns a curve equivalent of <me> between
- //! parameters <First> and <Last>. <Tol> is used to
+ //! Returns a curve equivalent of <me> between
+ //! parameters <First> and <Last>. <Tol> is used to
//! test for 3d points confusion.
//! If <First> >= <Last>
Standard_EXPORT Handle(Adaptor2d_Curve2d) Trim(const Standard_Real First,
//! The curve is loaded. The Offset is set to 0.
Standard_EXPORT Adaptor2d_OffsetCurve(const Handle(Adaptor2d_Curve2d)& C);
- //! Creates an OffsetCurve curve.
+ //! Creates an OffsetCurve curve.
//! The Offset is set to Offset.
Standard_EXPORT Adaptor2d_OffsetCurve(const Handle(Adaptor2d_Curve2d)& C,
const Standard_Real Offset);
const Standard_Real WFirst,
const Standard_Real WLast);
- //! Shallow copy of adaptor
+ //! Shallow copy of adaptor.
Standard_EXPORT virtual Handle(Adaptor2d_Curve2d) ShallowCopy() const Standard_OVERRIDE;
- //! Changes the curve. The Offset is reset to 0.
+ //! Changes the curve. The Offset is reset to 0.
Standard_EXPORT void Load(const Handle(Adaptor2d_Curve2d)& S);
//! Changes the Offset on the current Curve.
Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE;
- //! 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.
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
+ //! 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 Standard_OVERRIDE;
- //! Returns a curve equivalent of <me> between
- //! parameters <First> and <Last>. <Tol> is used to
+ //! Returns a curve equivalent of <me> between
+ //! parameters <First> and <Last>. <Tol> is used to
//! test for 3d points confusion.
//! If <First> >= <Last>
Standard_EXPORT Handle(Adaptor2d_Curve2d) Trim(const Standard_Real First,
Standard_EXPORT gp_Vec2d DN(const Standard_Real U,
const Standard_Integer N) const Standard_OVERRIDE;
- //! Returns the parametric resolution corresponding
+ //! Returns the parametric resolution corresponding
//! 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
- //! interval : Line, Circle, Ellipse, Hyperbola,
+ //! 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;
//! - Pole(i+p) = Pole(i)
//! Note: data structures of a periodic BSpline curve are
//! more complex than those of a non-periodic one.
-//! Warnings :
+//! Warnings:
//! In this class we consider that a weight value is zero if
//! Weight <= Resolution from package gp.
//! For two parametric values (or two knot values) U1, U2 we
//! consider that U1 = U2 if Abs (U2 - U1) <= Epsilon (U1).
//! For two weights values W1, W2 we consider that W1 = W2 if
-//! Abs (W2 - W1) <= Epsilon (W1). The method Epsilon is
+//! Abs (W2 - W1) <= Epsilon (W1). The method Epsilon is
//! defined in the class Real from package Standard.
//!
//! References :
{
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>.
//! The following conditions must be verified.
//! 0 < Degree <= MaxDegree.
//! may be Degree+1 (this is even recommended if you want the
//! curve to start and finish on the first and last pole).
//!
- //! On a periodic curve the first and the last multicities
+ //! On a periodic curve the first and the last multicities
//! must be the same.
//!
//! on non-periodic curves
//! Geom2d_BSplineCurve::MaxDegree().
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.
//! As a result, the poles and weights tables of this curve are modified.
//! Warning
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.
//! Warning
//! - If U is less than the first parameter or greater than
//! Parameter theTolerance defines the possible proximity of the segment
//! boundaries and B-spline knots to treat them as equal.
//!
- //! Warnings :
+ //! Warnings:
//! Even if <me> is not closed it can become closed after the
//! segmentation for example if U1 or U2 are out of the bounds
//! of the curve <me> or if the curve makes loop.
Geom2d_BezierCurve::Geom2d_BezierCurve(const TColgp_Array1OfPnt2d& Poles)
{
- // copy the poles
+ // copy the poles
Handle(TColgp_HArray1OfPnt2d) npoles = new TColgp_HArray1OfPnt2d(1, Poles.Length());
npoles->ChangeArray1() = Poles;
- // check the weights
+ // check the weights
Standard_Integer nbpoles = Poles.Length();
{
closed = (Abs(Value(U1).Distance(Value(U2))) <= gp::Resolution());
//
- // WARNING : when calling trimming be careful that the cache
+ // WARNING: when calling trimming be careful that the cache
// is computed regarding 0.0e0 and not 1.0e0
//
TColStd_Array1OfReal bidflatknots(BSplCLib::FlatBezierKnots(Degree()), 1, 2 * (Degree() + 1));
public:
//! Creates a non rational Bezier curve with a set of poles :
- //! CurvePoles. The weights are defaulted to all being 1.
+ //! CurvePoles. The weights are defaulted to all being 1.
//! Raises ConstructionError if the number of poles is greater than MaxDegree + 1
//! or lower than 2.
Standard_EXPORT Geom2d_BezierCurve(const TColgp_Array1OfPnt2d& CurvePoles);
//! Creates a rational Bezier curve with the set of poles
- //! CurvePoles and the set of weights PoleWeights .
+ //! CurvePoles and the set of weights PoleWeights.
//! If all the weights are identical the curve is considered
- //! as non rational. Raises ConstructionError if
- //! the number of poles is greater than MaxDegree + 1 or lower
- //! than 2 or CurvePoles and CurveWeights have not the same length
+ //! as non rational. Raises ConstructionError if the number
+ //! of poles is greater than MaxDegree + 1 or lower than 2
+ //! or CurvePoles and CurveWeights have not the same length
//! or one weight value is lower or equal to Resolution from
//! package gp.
Standard_EXPORT Geom2d_BezierCurve(const TColgp_Array1OfPnt2d& CurvePoles,
Standard_EXPORT void RemovePole(const Standard_Integer Index);
//! Reverses the direction of parametrization of <me>
- //! Value (NewU) = Value (1 - OldU)
+ //! Value (NewU) = Value (1 - OldU)
Standard_EXPORT void Reverse() Standard_OVERRIDE;
- //! Returns the parameter on the reversed curve for
+ //! Returns the parameter on the reversed curve for
//! the point of parameter U on <me>.
//!
//! returns 1-U
//! The control points are modified, the first and the last point
//! are not the same but the parametrization range is [0, 1]
//! else it could not be a Bezier curve.
- //! Warnings :
+ //! Warnings:
//! Even if <me> is not closed it can become closed after the
//! segmentation for example if U1 or U2 are out of the bounds
//! of the curve <me> or if the curve makes loop.
Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE;
//! Returns the polynomial degree of the curve. It is the number
- //! of poles less one. In this package the Degree of a Bezier
+ //! of poles less one. In this package the Degree of a Bezier
//! curve cannot be greater than "MaxDegree".
Standard_EXPORT Standard_Integer Degree() const;
//! Returns the end point or start point of this Bezier curve.
Standard_EXPORT gp_Pnt2d EndPoint() const Standard_OVERRIDE;
- //! Returns the value of the first parameter of this
- //! Bezier curve. This is 0.0, which gives the start point of this Bezier curve.
+ //! Returns the value of the first parameter of this Bezier curve.
+ //! This is 0.0, which gives the start point of this Bezier curve.
Standard_EXPORT Standard_Real FirstParameter() const Standard_OVERRIDE;
- //! Returns the value of the last parameter of this
- //! Bezier curve. This is 1.0, which gives the end point of this Bezier curve.
+ //! Returns the value of the last parameter of this Bezier curve.
+ //! This is 1.0, which gives the end point of this Bezier curve.
Standard_EXPORT Standard_Real LastParameter() const Standard_OVERRIDE;
//! Returns the number of poles for this Bezier curve.
protected:
private:
- //! Set poles to Poles, weights to Weights (not
- //! copied). If Weights is null the curve is non
- //! rational. Create the arrays of coefficients. Poles
- //! and Weights are assumed to have the first
+ //! Set poles to Poles, weights to Weights (not
+ //! copied). If Weights is null the curve is non
+ //! rational. Create the arrays of coefficients.
+ //! Poles and Weights are assumed to have the first
//! coefficient 1.
//!
//! Update rational and closed.
Standard_EXPORT Standard_Real TransformedParameter(const Standard_Real U,
const gp_Trsf2d& T) const Standard_OVERRIDE;
- //! Returns a coefficient to compute the parameter on
- //! the transformed curve for the transform of the
+ //! Returns a coefficient to compute the parameter on
+ //! the transformed curve for the transform of the
//! point on <me>.
//!
//! Transformed(T)->Value(U * ParametricTransformation(T))
//! and therefore change the real type of the object.
//! Such a transformation is forbidden in this
//! environment and cannot be a Geom2d_Transformation.
-//! The transformation can be represented as follow :
+//! The transformation can be represented as follows:
//!
//! V1 V2 T
//! | a11 a12 a14 | | x | | x'|
//! Computes the reverse transformation.
Standard_EXPORT Standard_Real Value(const Standard_Integer Row, const Standard_Integer Col) const;
- //! Computes the inverse of this transformation.
- //! and assigns the result to this transformatio
+ //! Computes the inverse of this transformation
+ //! and assigns the result to this transformation.
//!
//! Raised if the transformation is singular. This means that
//! the ScaleFactor is lower or equal to Resolution from
Standard_EXPORT void Invert();
//! Computes the inverse of this transformation and creates a new one.
- //! Raises ConstructionError if the transformation is singular. This means that
+ //! Raises ConstructionError if the transformation is singular. This means that
//! the ScaleFactor is lower or equal to Resolution from package gp.
Standard_NODISCARD Standard_EXPORT Handle(Geom2d_Transformation) Inverted() const;
//! and 1. - U1 (last parameter).
Standard_EXPORT void Reverse() Standard_OVERRIDE;
- //! Returns the parameter on the reversed curve for
+ //! Returns the parameter on the reversed curve for
//! the point of parameter U on <me>.
//!
//! returns UFirst + ULast - U
//! Warning The basis curve is also modified.
Standard_EXPORT void Transform(const gp_Trsf2d& T) Standard_OVERRIDE;
- //! Returns the parameter on the transformed curve for
+ //! Returns the parameter on the transformed curve for
//! the transform of the point of parameter U on <me>.
//!
//! me->Transformed(T)->Value(me->TransformedParameter(U,T))
const gp_Trsf2d& T) const
Standard_OVERRIDE;
- //! Returns a coefficient to compute the parameter on
- //! the transformed curve for the transform of the
+ //! Returns a coefficient to compute the parameter on
+ //! the transformed curve for the transform of the
//! point on <me>.
//!
//! Transformed(T)->Value(U * ParametricTransformation(T))
class Geom2d_Curve;
class Adaptor2d_Curve2d;
-//! this package contains the geometric definition of
-//! 2d curves compatible with the Adaptor package
+//! this package contains the geometric definition of
+//! 2d curves compatible with the Adaptor package
//! templates.
class Geom2dAdaptor
{
public:
DEFINE_STANDARD_ALLOC
- //! Inherited from GHCurve. Provides a curve
+ //! Inherited from GHCurve. Provides a curve
//! handled by reference.
- //! Creates a 2d curve from a HCurve2d. This
+ //! Creates a 2d curve from a HCurve2d. This
//! cannot process the OtherCurves.
Standard_EXPORT static Handle(Geom2d_Curve) MakeCurve(const Adaptor2d_Curve2d& HC);
};
Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE;
- //! 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.
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
+ //! 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 Standard_OVERRIDE;
- //! Returns a curve equivalent of <me> between
- //! parameters <First> and <Last>. <Tol> is used to
+ //! Returns a curve equivalent of <me> between
+ //! parameters <First> and <Last>. <Tol> is used to
//! test for 3d points confusion.
//! If <First> >= <Last>
Standard_EXPORT Handle(Adaptor2d_Curve2d) Trim(const Standard_Real First,
class gp_Pnt2d;
class gp_Vec2d;
-//! The Geom2dEvaluator package provides utilities for .
+//! The Geom2dEvaluator package provides utilities for
//! calculating value and derivatives of offset curve
-//! using corresponding values of base curve
+//! using corresponding values of base curve.
class Geom2dEvaluator
{
//! three first derivatives are all null.
Standard_EXPORT Standard_Boolean IsTangentDefined();
- //! output the tangent direction <D>
+ //! output the tangent direction <D>
Standard_EXPORT void Tangent(gp_Dir2d& D);
//! Returns the curvature.
const Standard_Real b,
Standard_Real& cuttingvalue) const
{
- // longueur minimum d'un intervalle pour F(U,V) : EPS1=1.e-9 (cf.MEPS1)
+ // longueur minimum d'un intervalle pour F(U,V) : EPS1=1.e-9 (cf.MEPS1)
constexpr Standard_Real lgmin = 10 * Precision::PConfusion();
cuttingvalue = (a + b) / 2;
return (Abs(b - a) >= 2 * lgmin);
{
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 Geom_BSplineCurve(const TColgp_Array1OfPnt& Poles,
const TColStd_Array1OfReal& Knots,
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>.
//! Raises ConstructionError subject to the following conditions
//! 0 < Degree <= MaxDegree.
//! may be Degree+1 (this is even recommended if you want the
//! curve to start and finish on the first and last pole).
//!
- //! On a periodic curve the first and the last multicities
+ //! On a periodic curve the first and the last multicities
//! must be the same.
//!
//! on non-periodic curves
//! Geom_BSplineCurve::MaxDegree().
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,
npoles->ChangeArray1() = Poles;
- // check the weights
+ // check the weights
if (Weights.Length() != nbpoles)
throw Standard_ConstructionError();
protected:
private:
- //! Set poles to Poles, weights to Weights (not
- //! copied). If Weights is null the curve is non
- //! rational. Create the arrays of coefficients. Poles
- //! and Weights are assumed to have the first
+ //! Set poles to Poles, weights to Weights (not copied).
+ //! If Weights is null the curve is non rational.
+ //! Create the arrays of coefficients.
+ //! Poles and Weights are assumed to have the first
//! coefficient 1.
//! Update rational and closed.
//!
projects / occt.git / commitdiff