Documentation - Fix whitespaces (#809)

- Corrected spelling errors in comments (e.g., "od" to "of", "thr" to "the")
- Removed unnecessary `<br>` HTML tags from comment formatting
- Normalized whitespace in comments for consistency
- Fixed terminology (e.g., "3-d" to "3D")
This commit is contained in:
luzpaz
2025-11-08 09:11:10 -05:00
committed by GitHub
parent 98a4809dee
commit 7ef4b0f2a6
126 changed files with 653 additions and 663 deletions
@@ -63,17 +63,17 @@ public:
static Standard_EXPORT TopoDS_Face ConvertFace(const TopoDS_Face& theFace,
const Standard_Real theAngleTolerance);
//! Checks if the shape is "correct". If not, returns
//! Checks if the shape is "correct". If not, returns
//! <Standard_False>, else returns <Standard_True>.
Standard_EXPORT static Standard_Boolean IsValid(const TopoDS_Shape& S);
//! Checks if the Generated and Modified Faces from
//! the shapes <arguments> in the shape <result> are
//! "correct". The args may be empty, then all faces
//! Checks if the Generated and Modified Faces from
//! the shapes <arguments> in the shape <result> are
//! "correct". The args may be empty, then all faces
//! will be checked.
//! If <Closed> is True, only closed shape are valid.
//! If <GeomCtrl> is False the geometry of new
//! vertices and edges are not verified and the
//! If <Closed> is True, only closed shape are valid.
//! If <GeomCtrl> is False the geometry of new
//! vertices and edges are not verified and the
//! auto-intersection of new wires are not searched.
Standard_EXPORT static Standard_Boolean IsValid(
const TopTools_ListOfShape& theArgs,
@@ -63,8 +63,8 @@ public:
//! Remove theS from me.
Standard_EXPORT void Remove(const TopoDS_Shape& theS);
//! Returns True if (S1> and <S2> has common
//! Descendants. Stores in <LC> the Commons Descendants.
//! Returns True if (S1> and <S2> has common
//! Descendants. Stores in <LC> the Commons Descendants.
Standard_EXPORT Standard_Boolean HasCommonDescendant(const TopoDS_Shape& S1,
const TopoDS_Shape& S2,
TopTools_ListOfShape& LC) const;
@@ -24,10 +24,10 @@
#include <TopTools_DataMapOfShapeListOfShape.hxx>
class TopoDS_Wire;
//! Builds all the faces limited with a set of non
//! jointing and planars wires. if
//! <ControlOrientation> is false The Wires must have
//! correct orientations. Sinon orientation des wires
//! Builds all the faces limited with a set of non
//! jointing and planars wires.
//! if <ControlOrientation> is false The Wires must have
//! correct orientations. Sinon orientation des wires
//! de telle sorte que les faces ne soient pas infinies
//! et qu'elles soient disjointes.
class BRepAlgo_FaceRestrictor
@@ -81,7 +81,7 @@ public:
Standard_EXPORT const TopTools_ListOfShape& Image(const TopoDS_Shape& S) const;
//! Stores in <L> the images of images of...images of <S>.
//! <L> contains only <S> if HasImage(S) is false.
//! <L> contains only <S> if HasImage(S) is false.
Standard_EXPORT void LastImage(const TopoDS_Shape& S, TopTools_ListOfShape& L) const;
//! Keeps only the link between roots and lastimage.
@@ -89,7 +89,7 @@ public:
//! Deletes in the images the shape of type <ShapeType>
//! which are not in <S>.
//! Warning: Compact() must be call before.
//! Warning: Compact() must be call before.
Standard_EXPORT void Filter(const TopoDS_Shape& S, const TopAbs_ShapeEnum ShapeType);
protected:
@@ -58,7 +58,7 @@ public:
//! Update VE map according to Image Vertex - Vertex
Standard_EXPORT void UpdateVEmap(TopTools_IndexedDataMapOfShapeListOfShape& theVEmap);
//! Cut the edge <E> in several edges <NE> on the
//! Cut the edge <E> in several edges <NE> on the
//! vertices<VonE>.
Standard_EXPORT void CutEdge(const TopoDS_Edge& E,
const TopTools_ListOfShape& VonE,
@@ -29,7 +29,7 @@
class TopoDS_Edge;
class Adaptor3d_Curve;
//! This class makes the projection of a wire on a
//! This class makes the projection of a wire on a
//! shape.
class BRepAlgo_NormalProjection
{
@@ -45,11 +45,11 @@ public:
//! Add an edge or a wire to the list of shape to project
Standard_EXPORT void Add(const TopoDS_Shape& ToProj);
//! Set the parameters used for computation
//! Tol3d is the required tolerance between the 3d projected
//! curve and its 2d representation
//! InternalContinuity is the order of constraints
//! used for approximation.
//! Set the parameters used for computation
//! Tol3d is the required tolerance between the 3d projected
//! curve and its 2d representation
//! InternalContinuity is the order of constraints
//! used for approximation.
//! MaxDeg and MaxSeg are the maximum degree and the maximum
//! number of segment for BSpline resulting of an approximation.
Standard_EXPORT void SetParams(const Standard_Real Tol3D,
@@ -58,7 +58,7 @@ public:
const Standard_Integer MaxDegree,
const Standard_Integer MaxSeg);
//! Set the parameters used for computation
//! Set the parameters used for computation
//! in their default values
Standard_EXPORT void SetDefaultParams();
@@ -68,14 +68,14 @@ public:
//! if MaxDist < 0 then this method does not affect the algorithm
Standard_EXPORT void SetMaxDistance(const Standard_Real MaxDist);
//! if With3d = Standard_False the 3dcurve is not computed
//! the initial 3dcurve is kept to build the resulting edges.
//! if With3d = Standard_False the 3dcurve is not computed
//! the initial 3dcurve is kept to build the resulting edges.
Standard_EXPORT void Compute3d(const Standard_Boolean With3d = Standard_True);
//! Manage limitation of projected edges.
//! Manage limitation of projected edges.
Standard_EXPORT void SetLimit(const Standard_Boolean FaceBoundaries = Standard_True);
//! Builds the result as a compound.
//! Builds the result as a compound.
Standard_EXPORT void Build();
Standard_EXPORT Standard_Boolean IsDone() const;
@@ -89,7 +89,7 @@ public:
//! For a projected edge, returns the corresponding initial face.
Standard_EXPORT const TopoDS_Shape& Couple(const TopoDS_Edge& E) const;
//! Returns the list of shapes generated from the
//! Returns the list of shapes generated from the
//! shape <S>.
Standard_EXPORT const TopTools_ListOfShape& Generated(const TopoDS_Shape& S);
@@ -44,8 +44,8 @@ public:
//! The wires must have the same number of edges.
Standard_EXPORT static TopoDS_Shell Shell(const TopoDS_Wire& Wire1, const TopoDS_Wire& Wire2);
//! Computes <AxeProf> as Follow. <Location> is
//! the Position of the nearest vertex V of <Profile>
//! Computes <AxeProf> as Follow. <Location> is
//! the Position of the nearest vertex V of <Profile>
//! to <Spine>.<XDirection> is confused with the tangent
//! to <Spine> at the projected point of V on the Spine.
//! <Direction> is normal to <Spine>.
@@ -56,10 +56,10 @@ public:
Standard_Boolean& ProfOnSpine,
const Standard_Real Tol);
//! Compute ACR on a wire
//! Compute ACR on a wire
Standard_EXPORT static void ComputeACR(const TopoDS_Wire& wire, TColStd_Array1OfReal& ACR);
//! Insert ACR on a wire
//! Insert ACR on a wire
Standard_EXPORT static TopoDS_Wire InsertACR(const TopoDS_Wire& wire,
const TColStd_Array1OfReal& ACRcuts,
const Standard_Real prec);
@@ -28,7 +28,7 @@ class GeomFill_LocationGuide;
class BRepFill_ACRLaw;
DEFINE_STANDARD_HANDLE(BRepFill_ACRLaw, BRepFill_LocationLaw)
//! Build Location Law, with a Wire. In the case
//! Build Location Law, with a Wire. In the case
//! of guided contour and trihedron by reduced
//! curvilinear abscissa
class BRepFill_ACRLaw : public BRepFill_LocationLaw
@@ -29,7 +29,7 @@ class BOPAlgo_MakerVolume;
class TopoDS_Face;
//! Constructs an evolved volume from a spine (wire or face)
//! and a profile ( wire).
//! and a profile (wire).
class BRepFill_AdvancedEvolved
{
public:
@@ -44,11 +44,11 @@ public:
//! returns the approximation of the 3d Curve
Standard_EXPORT const Handle(Geom_Curve)& Curve() const;
//! returns the approximation of the PCurve on the
//! returns the approximation of the PCurve on the
//! first face of the MultiLine
Standard_EXPORT const Handle(Geom2d_Curve)& CurveOnF1() const;
//! returns the approximation of the PCurve on the
//! returns the approximation of the PCurve on the
//! first face of the MultiLine
Standard_EXPORT const Handle(Geom2d_Curve)& CurveOnF2() const;
@@ -42,8 +42,8 @@ public:
Standard_EXPORT void SetPercent(const Standard_Real percent = 0.01);
//! Performs CompatibleWires According to the orientation
//! and the origin of each other
//! Performs CompatibleWires According to the orientation
//! and the origin of each other
Standard_EXPORT void Perform(const Standard_Boolean WithRotation = Standard_True);
Standard_EXPORT Standard_Boolean IsDone() const;
@@ -53,7 +53,7 @@ public:
//! returns the generated sequence.
Standard_EXPORT const TopTools_SequenceOfShape& Shape() const;
//! Returns the shapes created from a subshape
//! Returns the shapes created from a subshape
//! <SubSection> of a section.
Standard_EXPORT const TopTools_ListOfShape& GeneratedShapes(const TopoDS_Edge& SubSection) const;
@@ -65,23 +65,23 @@ public:
protected:
private:
//! Insert cutting points on closed wires to have same
//! Insert cutting points on closed wires to have same
//! number of edges. The sequence of shapes must
//! be a sequence of wires.
Standard_EXPORT void SameNumberByPolarMethod(const Standard_Boolean WithRotation = Standard_True);
//! Insert cutting points on open wires to have same
//! Insert cutting points on open wires to have same
//! number of edges. The sequence of shapes must
//! be a sequence of wires.
Standard_EXPORT void SameNumberByACR(const Standard_Boolean report);
//! Computes origins and orientation on closed wires to
//! Computes origins and orientation on closed wires to
//! avoid twisted results. The sequence of shapes must
//! be a sequence of wires. <polar> must be true
//! if SameNumberByPolarMethod was used before.
Standard_EXPORT void ComputeOrigin(const Standard_Boolean polar);
//! Computes origins and orientation on open wires to
//! Computes origins and orientation on open wires to
//! avoid twisted results. The sequence of shapes must
//! be a sequence of wires.
Standard_EXPORT void SearchOrigin();
@@ -63,7 +63,7 @@ public:
//! you have to use the Shape() methode.
Standard_EXPORT TopoDS_Shell Shell() const;
//! Returns the list of shapes generated from the
//! Returns the list of shapes generated from the
//! shape <S>.
Standard_EXPORT const TopTools_ListOfShape& Generated(const TopoDS_Shape& S);
@@ -27,7 +27,7 @@ class GeomFill_LocationDraft;
class BRepFill_DraftLaw;
DEFINE_STANDARD_HANDLE(BRepFill_DraftLaw, BRepFill_Edge3DLaw)
//! Build Location Law, with a Wire.
//! Build Location Law, with a Wire.
class BRepFill_DraftLaw : public BRepFill_Edge3DLaw
{
@@ -27,7 +27,7 @@ class GeomFill_LocationLaw;
class BRepFill_Edge3DLaw;
DEFINE_STANDARD_HANDLE(BRepFill_Edge3DLaw, BRepFill_LocationLaw)
//! Build Location Law, with a Wire.
//! Build Location Law, with a Wire.
class BRepFill_Edge3DLaw : public BRepFill_LocationLaw
{
@@ -26,15 +26,15 @@ class TopoDS_Shape;
class BRepFill_EdgeOnSurfLaw;
DEFINE_STANDARD_HANDLE(BRepFill_EdgeOnSurfLaw, BRepFill_LocationLaw)
//! Build Location Law, with a Wire and a Surface.
//! Build Location Law, with a Wire and a Surface.
class BRepFill_EdgeOnSurfLaw : public BRepFill_LocationLaw
{
public:
Standard_EXPORT BRepFill_EdgeOnSurfLaw(const TopoDS_Wire& Path, const TopoDS_Shape& Surf);
//! returns <False> if one Edge of <Path> do not have
//! representation on <Surf>. In this case it is
//! returns <False> if one Edge of <Path> do not have
//! representation on <Surf>. In this case it is
//! impossible to use this object.
Standard_EXPORT Standard_Boolean HasResult() const;
@@ -36,7 +36,7 @@ class TopoDS_Edge;
class TopoDS_Vertex;
//! Constructs an evolved volume from a spine (wire or face)
//! and a profile ( wire).
//! and a profile ( wire).
class BRepFill_Evolved
{
public:
@@ -45,8 +45,8 @@ public:
Standard_EXPORT BRepFill_Evolved();
//! Creates an evolved shape by sweeping the <Profile>
//! along the <Spine>. <AxeProf> is used to set the
//! position of <Profile> along <Spine> as follows:
//! along the <Spine>. <AxeProf> is used to set the
//! position of <Profile> along <Spine> as follows:
//! <AxeProf> slides on the profile with direction
//! colinear to the normal to <Spine>, and its
//! <XDirection> mixed with the tangent to <Spine>.
@@ -56,7 +56,7 @@ public:
const GeomAbs_JoinType Join = GeomAbs_Arc,
const Standard_Boolean Solid = Standard_False);
//! Creates an evolved shape by sweeping the <Profile>
//! Creates an evolved shape by sweeping the <Profile>
//! along the <Spine>
Standard_EXPORT BRepFill_Evolved(const TopoDS_Face& Spine,
const TopoDS_Wire& Profile,
@@ -64,7 +64,7 @@ public:
const GeomAbs_JoinType Join = GeomAbs_Arc,
const Standard_Boolean Solid = Standard_False);
//! Performs an evolved shape by sweeping the <Profile>
//! Performs an evolved shape by sweeping the <Profile>
//! along the <Spine>
Standard_EXPORT void Perform(const TopoDS_Wire& Spine,
const TopoDS_Wire& Profile,
@@ -72,7 +72,7 @@ public:
const GeomAbs_JoinType Join = GeomAbs_Arc,
const Standard_Boolean Solid = Standard_False);
//! Performs an evolved shape by sweeping the <Profile>
//! Performs an evolved shape by sweeping the <Profile>
//! along the <Spine>
Standard_EXPORT void Perform(const TopoDS_Face& Spine,
const TopoDS_Wire& Profile,
@@ -85,8 +85,8 @@ public:
//! returns the generated shape.
Standard_EXPORT const TopoDS_Shape& Shape() const;
//! Returns the shapes created from a subshape
//! <SpineShape> of the spine and a subshape
//! Returns the shapes created from a subshape
//! <SpineShape> of the spine and a subshape
//! <ProfShape> on the profile.
Standard_EXPORT const TopTools_ListOfShape& GeneratedShapes(const TopoDS_Shape& SpineShape,
const TopoDS_Shape& ProfShape) const;
@@ -96,7 +96,7 @@ public:
//! Return the face Top if <Solid> is True in the constructor.
Standard_EXPORT const TopoDS_Shape& Top() const;
//! Return the face Bottom if <Solid> is True in the constructor.
//! Return the face Bottom if <Solid> is True in the constructor.
Standard_EXPORT const TopoDS_Shape& Bottom() const;
protected:
@@ -165,7 +165,7 @@ private:
//! if the Shape is not planar.
Standard_EXPORT TopLoc_Location FindLocation(const TopoDS_Face& Face) const;
//! Apply the Location <LS> to <mySpine> and <LP> to
//! Apply the Location <LS> to <mySpine> and <LP> to
//! <myProfil>
//! in order to set the Shapes in the work space.
Standard_EXPORT void TransformInitWork(const TopLoc_Location& LS, const TopLoc_Location& LP);
@@ -30,7 +30,7 @@
class TopoDS_Wire;
class TopoDS_Shape;
//! Compute a topological surface ( a shell) using
//! Compute a topological surface (a shell) using
//! generating wires. The face of the shell will be
//! ruled surfaces passing by the wires.
//! The wires must have the same number of edges.
@@ -43,16 +43,16 @@ public:
Standard_EXPORT void AddWire(const TopoDS_Wire& Wire);
//! Compute the shell.
//! Compute the shell.
Standard_EXPORT void Perform();
const TopoDS_Shell& Shell() const;
//! Returns all the shapes created
//! Returns all the shapes created
Standard_EXPORT const TopTools_DataMapOfShapeListOfShape& Generated() const;
//! Returns the shapes created from a subshape
//! <SSection> of a section.
//! Returns the shapes created from a subshape
//! <SSection> of a section.
Standard_EXPORT const TopTools_ListOfShape& GeneratedShapes(const TopoDS_Shape& SSection) const;
//! Returns a modified shape in the constructed shell,
@@ -37,21 +37,21 @@ class TopoDS_Shape;
class BRepFill_LocationLaw;
DEFINE_STANDARD_HANDLE(BRepFill_LocationLaw, Standard_Transient)
//! Location Law on a Wire.
//! Location Law on a Wire.
class BRepFill_LocationLaw : public Standard_Transient
{
public:
//! Return a error status, if the status is not PipeOk then
//! Return a error status, if the status is not PipeOk then
//! it exist a parameter tlike the law is not valuable for t.
Standard_EXPORT GeomFill_PipeError GetStatus() const;
//! Apply a linear transformation on each law, to have
//! Apply a linear transformation on each law, to have
//! continuity of the global law between the edges.
Standard_EXPORT virtual void TransformInG0Law();
//! Apply a linear transformation on each law, to reduce
//! the dicontinuities of law at one rotation.
//! the dicontinuities of law at one rotation.
Standard_EXPORT virtual void TransformInCompatibleLaw(const Standard_Real AngularTolerance);
Standard_EXPORT void DeleteTransform();
@@ -79,10 +79,10 @@ public:
Standard_EXPORT TopoDS_Vertex Vertex(const Standard_Integer Index) const;
//! Compute <OutputVertex> like a transformation of
//! <InputVertex> the transformation is given by
//! evaluation of the location law in the vertex of
//! rank <Index>.
//! <Location> is used to manage discontinuities :
//! <InputVertex> the transformation is given by
//! evaluation of the location law in the vertex of
//! rank <Index>.
//! <Location> is used to manage discontinuities:
//! - -1 : The law before the vertex is used.
//! - 1 : The law after the vertex is used.
//! - 0 : Average of the both laws is used.
@@ -116,9 +116,9 @@ public:
Standard_Integer& Index,
Standard_Real& Param);
//! Return the curvilinear abscissa corresponding to a point
//! of the path, defined by <Index> of Edge and a
//! parameter on the edge.
//! Return the curvilinear abscissa corresponding to a point
//! of the path, defined by <Index> of Edge and a parameter
//! on the edge.
Standard_EXPORT Standard_Real Abscissa(const Standard_Integer Index, const Standard_Real Param);
DEFINE_STANDARD_RTTIEXT(BRepFill_LocationLaw, Standard_Transient)
@@ -40,9 +40,9 @@ class gp_Pnt2d;
//! two 2d curves resulting from the intersection of a
//! surface of linear extrusion( Bissec, Dz) and the 2
//! faces.
//! This 3 curves will have the same parametrization
//! These 3 curves will have the same parametrization
//! as the Bissectrice.
//! This class is to be send to an approximation
//! This class is to be sent to an approximation
//! routine.
class BRepFill_MultiLine : public AppCont_Function
{
@@ -64,8 +64,8 @@ public:
//! Returns true if the approximation is not needed.
Standard_EXPORT Standard_Boolean IsParticularCase() const;
//! Returns the continuity between the two faces
//! seShape from GeomAbsparated by myBis.
//! Returns the continuity between the two faces
//! seShape from GeomAbsparated by myBis.
Standard_EXPORT GeomAbs_Shape Continuity() const;
//! raises if IsParticularCase is <False>.
@@ -52,10 +52,10 @@ public:
const Standard_Real VL,
const Standard_Boolean Build = Standard_True);
//! Say if the input shape is a vertex.
//! Say if the input shape is a vertex.
Standard_EXPORT virtual Standard_Boolean IsVertex() const Standard_OVERRIDE;
//! Say if the Law is Constant.
//! Say if the Law is Constant.
Standard_EXPORT virtual Standard_Boolean IsConstant() const Standard_OVERRIDE;
//! Give the law build on a concatenated section
@@ -61,12 +61,12 @@ public:
const GeomAbs_JoinType Join = GeomAbs_Arc,
const Standard_Boolean IsOpenResult = Standard_False);
//! Performs an OffsetWire at an altitude <Alt> from
//! the face ( According to the orientation of the
//! Performs an OffsetWire at an altitude <Alt> from
//! the face (According to the orientation of the
//! face)
Standard_EXPORT void Perform(const Standard_Real Offset, const Standard_Real Alt = 0.0);
//! Performs an OffsetWire
//! Performs an OffsetWire
Standard_EXPORT void PerformWithBiLo(const TopoDS_Face& WSP,
const Standard_Real Offset,
const BRepMAT2d_BisectingLocus& Locus,
@@ -81,7 +81,7 @@ public:
//! returns the generated shape.
Standard_EXPORT const TopoDS_Shape& Shape() const;
//! Returns the shapes created from a subshape
//! Returns the shapes created from a subshape
//! <SpineShape> of the spine.
//! Returns the last computed Offset.
Standard_EXPORT const TopTools_ListOfShape& GeneratedShapes(const TopoDS_Shape& SpineShape);
@@ -37,10 +37,10 @@ class TopoDS_Vertex;
class gp_Pnt;
class BRepFill_Sweep;
//! Create a shape by sweeping a shape (the profile)
//! Create a shape by sweeping a shape (the profile)
//! along a wire (the spine).
//!
//! For each edge or vertex from the spine the user
//! For each edge or vertex from the spine the user
//! may ask for the shape generated from each subshape
//! of the profile.
class BRepFill_Pipe
@@ -72,7 +72,7 @@ public:
Standard_EXPORT const TopoDS_Shape& LastShape() const;
//! Returns the list of shapes generated from the
//! Returns the list of shapes generated from the
//! shape <S>.
Standard_EXPORT void Generated(const TopoDS_Shape& S, TopTools_ListOfShape& L);
@@ -83,11 +83,11 @@ public:
//! Returns the edge created from an edge of the spine
//! and a vertex of the profile.
//! if the edge or the vertex are not in the spine or
//! if the edge or the vertex are not in the spine or
//! the profile.
Standard_EXPORT TopoDS_Edge Edge(const TopoDS_Edge& ESpine, const TopoDS_Vertex& VProfile);
//! Returns the shape created from the profile at the
//! Returns the shape created from the profile at the
//! position of the vertex VSpine.
//! if the vertex is not in the Spine
Standard_EXPORT TopoDS_Shape Section(const TopoDS_Vertex& VSpine) const;
@@ -98,8 +98,7 @@ public:
protected:
private:
//! Auxiliary recursive method used to build the
//! result.
//! Auxiliary recursive method used to build the result.
Standard_EXPORT TopoDS_Shape MakeShape(const TopoDS_Shape& S,
const TopoDS_Shape& theOriginalS,
const TopoDS_Shape& FirstShape,
@@ -58,34 +58,33 @@ public:
Standard_EXPORT BRepFill_PipeShell(const TopoDS_Wire& Spine);
//! Set an Frenet or an CorrectedFrenet trihedron
//! to perform the sweeping
//! to perform the sweeping
Standard_EXPORT void Set(const Standard_Boolean Frenet = Standard_False);
//! Set a Discrete trihedron
//! to perform the sweeping
//! Set a Discrete trihedron to perform the sweeping
Standard_EXPORT void SetDiscrete();
//! Set an fixed trihedron to perform the sweeping
//! Set an fixed trihedron to perform the sweeping
//! all sections will be parallel.
Standard_EXPORT void Set(const gp_Ax2& Axe);
//! Set an fixed BiNormal direction to perform
//! Set an fixed BiNormal direction to perform
//! the sweeping
Standard_EXPORT void Set(const gp_Dir& BiNormal);
//! Set support to the spine to define the BiNormal
//! at the spine, like the normal the surfaces.
//! Warning: To be effective, Each edge of the <spine> must
//! have an representation on one face of<SpineSupport>
//! at the spine, like the normal the surfaces.
//! Warning: To be effective, Each edge of the <spine> must
//! have an representation on one face of<SpineSupport>
Standard_EXPORT Standard_Boolean Set(const TopoDS_Shape& SpineSupport);
//! Set an auxiliary spine to define the Normal
//! For each Point of the Spine P, an Point Q is evalued
//! on <AuxiliarySpine>
//! Set an auxiliary spine to define the Normal
//! For each Point of the Spine P, an Point Q is evaluated
//! on <AuxiliarySpine>
//! If <CurvilinearEquivalence>
//! Q split <AuxiliarySpine> with the same length ratio
//! than P split <Spline>.
//! Else the plan define by P and the tangent to the <Spine>
//! Q split <AuxiliarySpine> with the same length ratio
//! than P split <Spline>.
//! Else the plan define by P and the tangent to the <Spine>
//! intersect <AuxiliarySpine> in Q.
//! If <KeepContact> equals BRepFill_NoContact: The Normal is defined
//! by the vector PQ.
@@ -114,7 +113,7 @@ public:
//! a C1-continuous surface if a swept surface proved
//! to be C0.
//! Give section to sweep.
//! Possibilities are :
//! Possibilities are:
//! - Give one or several profile
//! - Give one profile and an homotetic law.
//! - Automatic compute of correspondence between profile, and section on the sweeped shape
@@ -145,15 +144,15 @@ public:
const Standard_Boolean WithContact = Standard_False,
const Standard_Boolean WithCorrection = Standard_False);
//! Set an section and an homotetic law.
//! The homotetie's centers is given by point on the <Spine>.
//! Set an section and an homotetic law.
//! The homotetie's centers is given by point on the <Spine>.
Standard_EXPORT void SetLaw(const TopoDS_Shape& Profile,
const Handle(Law_Function)& L,
const Standard_Boolean WithContact = Standard_False,
const Standard_Boolean WithCorrection = Standard_False);
//! Set an section and an homotetic law.
//! The homotetie center is given by point on the <Spine>
//! Set an section and an homotetic law.
//! The homotetie center is given by point on the <Spine>
Standard_EXPORT void SetLaw(const TopoDS_Shape& Profile,
const Handle(Law_Function)& L,
const TopoDS_Vertex& Location,
@@ -174,13 +173,13 @@ public:
const Standard_Real BoundTol = 1.0e-4,
const Standard_Real TolAngular = 1.0e-2);
//! Set the Transition Mode to manage discontinuities
//! Set the Transition Mode to manage discontinuities
//! on the sweep.
Standard_EXPORT void SetTransition(const BRepFill_TransitionStyle Mode = BRepFill_Modified,
const Standard_Real Angmin = 1.0e-2,
const Standard_Real Angmax = 6.0);
//! Perform simulation of the sweep :
//! Perform simulation of the sweep:
//! Some Section are returned.
Standard_EXPORT void Simulate(const Standard_Integer NumberOfSection,
TopTools_ListOfShape& Sections);
@@ -197,7 +196,7 @@ public:
Standard_EXPORT Standard_Real ErrorOnSurface() const;
//! Returns the TopoDS Shape of the bottom of the sweep.
//! Returns the TopoDS Shape of the bottom of the sweep.
Standard_EXPORT const TopoDS_Shape& FirstShape() const;
//! Returns the TopoDS Shape of the top of the sweep.
@@ -213,7 +212,7 @@ public:
//! Returns the spine
const TopoDS_Wire& Spine() { return mySpine; }
//! Returns the list of shapes generated from the
//! Returns the list of shapes generated from the
//! shape <S>.
Standard_EXPORT void Generated(const TopoDS_Shape& S, TopTools_ListOfShape& L);
@@ -54,7 +54,7 @@ public:
Standard_EXPORT Standard_Boolean IsDone() const;
//! Say if the input shape is a vertex.
//! Say if the input shape is a vertex.
Standard_EXPORT virtual Standard_Boolean IsVertex() const = 0;
Standard_EXPORT virtual Handle(GeomFill_SectionLaw) ConcatenedLaw() const = 0;
@@ -52,10 +52,10 @@ public:
const Handle(Law_Function)& L,
const Standard_Boolean Build = Standard_True);
//! Say if the input shape is a vertex.
//! Say if the input shape is a vertex.
Standard_EXPORT virtual Standard_Boolean IsVertex() const Standard_OVERRIDE;
//! Say if the Law is Constant.
//! Say if the Law is Constant.
Standard_EXPORT virtual Standard_Boolean IsConstant() const Standard_OVERRIDE;
//! Give the law build on a concatenated section
@@ -36,7 +36,7 @@ class BRepFill_SectionLaw;
class TopoDS_Edge;
//! Topological Sweep Algorithm
//! Computes an Sweep shell using a generating
//! Computes an Sweep shell using a generating
//! wire, an SectionLaw and an LocationLaw.
class BRepFill_Sweep
{
@@ -101,10 +101,10 @@ public:
//! Say if the Shape is Build.
Standard_EXPORT Standard_Boolean IsDone() const;
//! returns the Sweeping Shape
//! Returns the Sweeping Shape
Standard_EXPORT TopoDS_Shape Shape() const;
//! Get the Approximation error.
//! Get the Approximation error.
Standard_EXPORT Standard_Real ErrorOnSurface() const;
Standard_EXPORT Handle(TopTools_HArray2OfShape) SubShape() const;
@@ -113,7 +113,7 @@ public:
Standard_EXPORT Handle(TopTools_HArray2OfShape) Sections() const;
//! returns the Tape corresponding to Index-th edge of section
//! Returns the Tape corresponding to Index-th edge of section
Standard_EXPORT TopoDS_Shape Tape(const Standard_Integer Index) const;
protected:
@@ -29,7 +29,7 @@ class Geom2d_Curve;
class gp_Pnt2d;
class Geom_Curve;
//! Compute the Pcurves and the 3d curves resulting
//! Compute the Pcurves and the 3d curves resulting
//! of the trimming of a face by an extruded surface.
class BRepFill_TrimSurfaceTool
{
@@ -44,7 +44,7 @@ public:
const Standard_Boolean Inv1,
const Standard_Boolean Inv2);
//! Intersect <Bis> with the projection of the edges
//! Intersect <Bis> with the projection of the edges
//! <EdgeOnFi> and returns the intersecting parameters
//! on Bis and on the edges
//! P.X() : Parameter on Bis
@@ -58,7 +58,7 @@ public:
//! returns True if the Line (P, DZ) intersect the Faces
Standard_EXPORT Standard_Boolean IsOnFace(const gp_Pnt2d& Point) const;
//! returns the parameter of the point <Point> on the
//! returns the parameter of the point <Point> on the
//! Edge <Edge>, assuming that the point is on the edge.
Standard_EXPORT Standard_Real ProjOn(const gp_Pnt2d& Point, const TopoDS_Edge& Edge) const;
@@ -29,10 +29,10 @@
class gp_Dir;
class gp_Pnt;
//! The Projection class provides conical and
//! cylindrical projections of Edge or Wire on
//! The Projection class provides conical and
//! cylindrical projections of Edge or Wire on
//! a Shape from TopoDS. The result will be a Edge
//! or Wire from TopoDS.
//! or Wire from TopoDS.
class BRepProj_Projection
{
public:
@@ -24,14 +24,14 @@
#include <Standard_OStream.hxx>
#include <TopOpeBRep_TypeLineCurve.hxx>
//! This package provides the topological operations
//! This package provides the topological operations
//! on the BRep data structure.
class TopOpeBRep
{
public:
DEFINE_STANDARD_ALLOC
//! Prints the name of <TLC> as a String on the
//! Prints the name of <TLC> as a String on the
//! Stream <S> and returns <S>.
Standard_EXPORT static Standard_OStream& Print(const TopOpeBRep_TypeLineCurve TLC,
Standard_OStream& OS);
@@ -31,17 +31,17 @@ class TopoDS_Shape;
class TopOpeBRepDS_HDataStructure;
class TopoDS_Face;
//! Provides class methods to fill a datastructure
//! with results of intersections.
//! Provides class methods to fill a datastructure
//! with results of intersections.
//!
//! 1. Use an Intersector to find pairs of
//! 1. Use an Intersector to find pairs of
//! intersecting GeomShapes
//!
//! 2. For each pair fill the DataStructure using the
//! 2. For each pair fill the DataStructure using the
//! appropriate Filler.
//!
//! 3. Complete the DataStructure to record shapes to
//! rebuild (shells, wires )
//! 3. Complete the DataStructure to record shapes to
//! rebuild (shells, wires)
class TopOpeBRep_DSFiller
{
public:
@@ -57,7 +57,7 @@ public:
//! Stores in <DS> the intersections of <S1> and <S2>.
//! if orientFORWARD = True
//! S FORWARD,REVERSED --> FORWARD
//! S FORWARD,REVERSED --> FORWARD
//! S EXTERNAL,INTERNAL --> EXTERNAL,INTERNAL
Standard_EXPORT void Insert(const TopoDS_Shape& S1,
const TopoDS_Shape& S2,
@@ -76,14 +76,14 @@ public:
Standard_EXPORT void Complete(const Handle(TopOpeBRepDS_HDataStructure)& HDS);
//! Stores in <DS> the intersections of <S1> and <S2>.
//! S1 et S2 contain only SameDomain Face
//! S1 and S2 contain only SameDomain Face
Standard_EXPORT void Insert2d(const TopoDS_Shape& S1,
const TopoDS_Shape& S2,
const Handle(TopOpeBRepDS_HDataStructure)& HDS);
//! S1, S2 set of tangent face
//! lance les intersections 2d pour coder correctement
//! les faces SameDomain.
//! Launches 2D intersection calculations to correctly
//! code the SameDomain faces.
Standard_EXPORT void InsertIntersection2d(const TopoDS_Shape& S1,
const TopoDS_Shape& S2,
const Handle(TopOpeBRepDS_HDataStructure)& HDS);
@@ -120,7 +120,7 @@ public:
Standard_EXPORT void GapFiller(const Handle(TopOpeBRepDS_HDataStructure)& HDS) const;
//! Update the data structure with relevant
//! Update the data structure with relevant
//! information deduced from the intersections.
//!
//! Shells containing an intersected face.
@@ -135,7 +135,7 @@ public:
Standard_EXPORT void Checker(const Handle(TopOpeBRepDS_HDataStructure)& HDS) const;
//! Update the data structure with relevant
//! Update the data structure with relevant
//! information deduced from the intersections 2d.
//!
//! Shells containing an intersected face.
@@ -44,7 +44,7 @@ class gp_Pnt;
//! Fills a DataStructure from TopOpeBRepDS with the result
//! of Face/Face intersection described by FacesIntersector from TopOpeBRep.
//! if the faces have same Domain, record it in the DS.
//! else record lines and points and attach list of interferences
//! else record lines and points and attach list of interferences
//! to the faces, the lines and the edges.
class TopOpeBRep_FacesFiller
{
@@ -99,13 +99,13 @@ public:
//! and computing face/edge interference.
Standard_EXPORT void ProcessRLine();
//! VP processing for restriction line and line sharing
//! same domain with section edges :
//! - if restriction :
//! Adds restriction edges as section edges and compute
//! face/edge interference.
//! - if same domain :
//! If line share same domain with section edges, compute
//! VP processing for restriction line and line sharing
//! same domain with section edges:
//! - if restriction:
//! Adds restriction edges as section edges and compute
//! face/edge interference.
//! - if same domain:
//! If line share same domain with section edges, compute
//! parts of line IN/IN the two faces, and compute curve/point
//! interference for VP boundaries.
Standard_EXPORT void FillLineVPonR();
@@ -129,7 +129,7 @@ public:
const TopoDS_Shape& F1,
const Standard_Integer ShapeIndex);
//! adds <VP>'s geometric point (if not stored) and
//! adds <VP>'s geometric point (if not stored) and
//! computes (curve or edge)/(point or vertex) interference.
Standard_EXPORT void ProcessVPonR(const TopOpeBRep_VPointInter& VP,
const TopOpeBRepDS_Transition& trans1,
@@ -159,7 +159,7 @@ public:
//! processing ProcessVPnotonR for VPI.
Standard_EXPORT void ProcessVPInotonR(TopOpeBRep_VPointInterIterator& VPI);
//! adds <VP>'s geometrical point to the DS (if not stored)
//! adds <VP>'s geometrical point to the DS (if not stored)
//! and computes curve point interference.
Standard_EXPORT void ProcessVPnotonR(const TopOpeBRep_VPointInter& VP);
@@ -184,14 +184,14 @@ public:
//! search for G = geometry of Point which is identical to <DSP>
//! among the DS Points created in the CURRENT face/face
//! intersection ( current Insert() call).
//! intersection (current Insert() call).
Standard_EXPORT Standard_Boolean GetFFGeometry(const TopOpeBRepDS_Point& DSP,
TopOpeBRepDS_Kind& K,
Standard_Integer& G) const;
//! search for G = geometry of Point which is identical to <VP>
//! among the DS Points created in the CURRENT face/face
//! intersection ( current Insert() call).
//! intersection (current Insert() call).
Standard_EXPORT Standard_Boolean GetFFGeometry(const TopOpeBRep_VPointInter& VP,
TopOpeBRepDS_Kind& K,
Standard_Integer& G) const;
@@ -237,8 +237,8 @@ public:
const Standard_Integer SI12,
TopOpeBRepDS_Transition& T);
//! Computes transition on line for VP<iVP> on edge
//! restriction of <SI>. If <isINOUT> : returns <true> if
//! Computes transition on line for VP<iVP> on edge
//! restriction of <SI>. If <isINOUT> : returns <true> if
//! transition computed is IN/OUT else : returns <true> if
//! transition computed is OUT/IN.
Standard_EXPORT static Standard_Boolean TransvpOK(const TopOpeBRep_LineInter& L,
@@ -270,8 +270,8 @@ private:
Standard_EXPORT TopAbs_State StateVPonFace(const TopOpeBRep_VPointInter& VP) const;
//! <VP> is of geometry <P>.
//! Looks after a VPoint on RESTRICTION <Lrest> with
//! geometric value <P>. If true, updates states ON for <VP>.
//! Looks after a VPoint on RESTRICTION <Lrest> with
//! geometric value <P>. If true, updates states ON for <VP>.
Standard_EXPORT Standard_Boolean PequalVPonR(const gp_Pnt& P3D,
const Standard_Integer VPshapeindex,
TopOpeBRep_VPointInter& VP,
@@ -34,7 +34,7 @@ class TopOpeBRep_GeomTool
public:
DEFINE_STANDARD_ALLOC
//! Make the DS curve <C> and the pcurves <PC1,PC2> from
//! Make the DS curve <C> and the pcurves <PC1,PC2> from
//! intersection line <L> lying on shapes <S1,S2>. <min,max> = <L> bounds
Standard_EXPORT static void MakeCurves(const Standard_Real min,
const Standard_Real max,
@@ -33,21 +33,21 @@ class TopOpeBRepTool_HBoxTool;
//! Intersect two shapes.
//!
//! A GeomShape is a shape with a geometric domain, i.e.
//! A GeomShape is a shape with a geometric domain, i.e.
//! a Face or an Edge.
//!
//! The purpose of the ShapeIntersector is to find
//! couples of intersecting GeomShape in two Shapes
//! (which can be any kind of topologies : Compound,
//! The purpose of the ShapeIntersector is to find
//! couples of intersecting GeomShape in two Shapes
//! (which can be any kind of topologies : Compound,
//! Solid, Shell, etc... )
//!
//! It is in charge of exploration of the shapes and
//! rejection. For this it is provided with two tools :
//! It is in charge of exploration of the shapes and
//! rejection. For this it is provided with two tools:
//!
//! - ShapeExplorer from TopOpeBRepTool.
//! - ShapeScanner from TopOpeBRep which implements bounding boxes.
//!
//! Let S1,S2 the shapes sent to InitIntersection(S1,S2) method :
//! Let S1,S2 the shapes sent to InitIntersection(S1,S2) method:
//! - S1 is always SCANNED by a ShapeScanner from TopOpeBRep.
//! - S2 is always EXPLORED by a ShapeExplorer from TopOpeBRepTool.
class TopOpeBRep_ShapeIntersector
@@ -66,7 +66,7 @@ public:
const TopoDS_Face& F1,
const TopoDS_Face& F2);
//! return the shape <Index> ( = 1 or 2) given to
//! return the shape <Index> ( = 1 or 2) given to
//! InitIntersection().
//! Index = 1 will return S1, Index = 2 will return S2.
Standard_EXPORT const TopoDS_Shape& Shape(const Standard_Integer Index) const;
@@ -87,11 +87,11 @@ public:
//! return the current intersection of a Face and an Edge.
Standard_EXPORT TopOpeBRep_FaceEdgeIntersector& ChangeFaceEdgeIntersector();
//! return geometric shape <Index> ( = 1 or 2 ) of
//! return geometric shape <Index> ( = 1 or 2 ) of
//! current intersection.
Standard_EXPORT const TopoDS_Shape& CurrentGeomShape(const Standard_Integer Index) const;
//! return MAX of intersection tolerances with
//! return MAX of intersection tolerances with
//! which FacesIntersector from TopOpeBRep was working.
Standard_EXPORT void GetTolerances(Standard_Real& tol1, Standard_Real& tol2) const;
@@ -31,21 +31,21 @@ class TopOpeBRepTool_HBoxTool;
//! Intersect two shapes.
//!
//! A GeomShape is a shape with a geometric domain, i.e.
//! A GeomShape is a shape with a geometric domain, i.e.
//! a Face or an Edge.
//!
//! The purpose of the ShapeIntersector2d is to find
//! couples of intersecting GeomShape in two Shapes
//! (which can be any kind of topologies : Compound,
//! The purpose of the ShapeIntersector2d is to find
//! couples of intersecting GeomShape in two Shapes
//! (which can be any kind of topologies: Compound,
//! Solid, Shell, etc... )
//!
//! It is in charge of exploration of the shapes and
//! rejection. For this it is provided with two tools :
//! It is in charge of exploration of the shapes and
//! rejection. For this it is provided with two tools:
//!
//! - ShapeExplorer from TopOpeBRepTool.
//! - ShapeScanner from TopOpeBRep which implements bounding boxes.
//!
//! Let S1,S2 the shapes sent to InitIntersection(S1,S2) method :
//! Let S1,S2 the shapes sent to InitIntersection(S1,S2) method:
//! - S1 is always SCANNED by a ShapeScanner from TopOpeBRep.
//! - S2 is always EXPLORED by a ShapeExplorer from TopOpeBRepTool.
class TopOpeBRep_ShapeIntersector2d
@@ -58,7 +58,7 @@ public:
//! Initialize the intersection of shapes S1,S2.
Standard_EXPORT void InitIntersection(const TopoDS_Shape& S1, const TopoDS_Shape& S2);
//! return the shape <Index> ( = 1 or 2) given to
//! return the shape <Index> ( = 1 or 2) given to
//! InitIntersection().
//! Index = 1 will return S1, Index = 2 will return S2.
Standard_EXPORT const TopoDS_Shape& Shape(const Standard_Integer Index) const;
@@ -73,7 +73,7 @@ public:
//! return the current intersection of two Edges.
Standard_EXPORT TopOpeBRep_EdgesIntersector& ChangeEdgesIntersector();
//! return geometric shape <Index> ( = 1 or 2 ) of
//! return geometric shape <Index> ( = 1 or 2 ) of
//! current intersection.
Standard_EXPORT const TopoDS_Shape& CurrentGeomShape(const Standard_Integer Index) const;
@@ -104,7 +104,7 @@ public:
//! domain <I> (= 1 or 2).
Standard_EXPORT TopAbs_State State(const Standard_Integer I) const;
//! Set the state of VPoint within the domain of
//! Set the state of VPoint within the domain of
//! the geometric shape <I> (= 1 or 2).
Standard_EXPORT void State(const TopAbs_State S, const Standard_Integer I);
@@ -30,8 +30,8 @@ class TopOpeBRepBuild_LoopClassifier;
//! where the Loop is the composite topological object of the boundary,
//! here wire or block of edges.
//! The LoopSet gives an iteration on Loops.
//! For each Loop it indicates if it is on the boundary (wire) or if it
//! results from an interference (block of edges).
//! For each Loop it indicates if it is on the boundary (wire) or if it
//! results from an interference (block of edges).
//! The result of the Area2dBuilder is an iteration on areas.
//! An area is described by a set of Loops.
class TopOpeBRepBuild_Area2dBuilder : public TopOpeBRepBuild_AreaBuilder
@@ -30,8 +30,8 @@ class TopOpeBRepBuild_LoopClassifier;
//! where the Loop is the composite topological object of the boundary,
//! here wire or block of edges.
//! The LoopSet gives an iteration on Loops.
//! For each Loop it indicates if it is on the boundary (wire) or if it
//! results from an interference (block of edges).
//! For each Loop it indicates if it is on the boundary (wire) or if it
//! results from an interference (block of edges).
//! The result of the Area3dBuilder is an iteration on areas.
//! An area is described by a set of Loops.
class TopOpeBRepBuild_Area3dBuilder : public TopOpeBRepBuild_AreaBuilder
@@ -32,21 +32,21 @@ class TopOpeBRepBuild_LoopSet;
class TopOpeBRepBuild_LoopClassifier;
class TopOpeBRepBuild_Loop;
//! The AreaBuilder algorithm is used to
//! reconstruct complex topological objects as Faces
//! The AreaBuilder algorithm is used to
//! reconstruct complex topological objects as Faces
//! or Solids.
//! * Loop is the composite topological object of
//! * Loop is the composite topological object of
//! the boundary. Wire for a Face. Shell for a Solid.
//! * LoopSet is a tool describing the object to
//! build. It gives an iteration on Loops. For each
//! * LoopSet is a tool describing the object to
//! build. It gives an iteration on Loops. For each
//! Loop it tells if it is on the boundary or if it is
//! an interference.
//! * LoopClassifier is an algorithm used to test
//! if a Loop is inside another Loop.
//! The result of the reconstruction is an iteration
//! on the reconstructed areas. An area is described
//! * LoopClassifier is an algorithm used to test
//! if a Loop is inside another Loop.
//! The result of the reconstruction is an iteration
//! on the reconstructed areas. An area is described
//! by a set of Loops.
//! A AreaBuilder is built with :
//! A AreaBuilder is built with:
//! - a LoopSet describing the object to reconstruct.
//! - a LoopClassifier providing the classification algorithm.
class TopOpeBRepBuild_AreaBuilder
@@ -67,12 +67,12 @@ class gp_Pnt;
#undef FillSolid
#endif
//! The Builder algorithm constructs topological
//! objects from an existing topology and new
//! The Builder algorithm constructs topological
//! objects from an existing topology and new
//! geometries attached to the topology. It is used to
//! construct the result of a topological operation;
//! the existing topologies are the parts involved in
//! the topological operation and the new geometries
//! the existing topologies are the parts involved in
//! the topological operation and the new geometries
//! are the intersection lines and points.
class TopOpeBRepBuild_Builder
{
@@ -106,7 +106,7 @@ public:
//! Does NOT clear the handled DS.
Standard_EXPORT virtual void Clear();
//! Merges the two edges <S1> and <S2> keeping the
//! Merges the two edges <S1> and <S2> keeping the
//! parts in each edge of states <TB1> and <TB2>.
//! Booleans onA, onB, onAB indicate whether parts of edges
//! found as state ON respectively on first, second, and both
@@ -119,7 +119,7 @@ public:
const Standard_Boolean onB = Standard_False,
const Standard_Boolean onAB = Standard_False);
//! Merges the two faces <S1> and <S2> keeping the
//! Merges the two faces <S1> and <S2> keeping the
//! parts in each face of states <TB1> and <TB2>.
Standard_EXPORT void MergeFaces(const TopTools_ListOfShape& S1,
const TopAbs_State TB1,
@@ -129,7 +129,7 @@ public:
const Standard_Boolean onB = Standard_False,
const Standard_Boolean onAB = Standard_False);
//! Merges the two solids <S1> and <S2> keeping the
//! Merges the two solids <S1> and <S2> keeping the
//! parts in each solid of states <TB1> and <TB2>.
Standard_EXPORT void MergeSolids(const TopoDS_Shape& S1,
const TopAbs_State TB1,
@@ -149,7 +149,7 @@ public:
Standard_EXPORT void ChangeClassify(const Standard_Boolean B);
//! Merges the solid <S> keeping the
//! Merges the solid <S> keeping the
//! parts of state <TB>.
Standard_EXPORT void MergeSolid(const TopoDS_Shape& S, const TopAbs_State TB);
@@ -750,8 +750,8 @@ protected:
const TopAbs_State TB1,
const TopAbs_State TB2);
//! Split <F1> keeping the parts of state <TB1>.
//! Merge faces with same domain, keeping parts of
//! Split <F1> keeping the parts of state <TB1>.
//! Merge faces with same domain, keeping parts of
//! state <TB2>.
Standard_EXPORT void SplitFace(const TopoDS_Shape& F1,
const TopAbs_State TB1,
@@ -770,8 +770,8 @@ protected:
const TopAbs_State TB1,
const TopAbs_State TB2);
//! Explore shapes of given by explorer <Ex> to split them.
//! Store new shapes in the set <SS>.
//! Explore shapes of given by explorer <Ex> to split them.
//! Store new shapes in the set <SS>.
//! According to RevOri, reverse or not their orientation.
Standard_EXPORT void SplitShapes(TopOpeBRepTool_ShapeExplorer& Ex,
const TopAbs_State TB1,
@@ -779,7 +779,7 @@ protected:
TopOpeBRepBuild_ShapeSet& SS,
const Standard_Boolean RevOri);
//! Split edges of <F1> and store wires and edges in
//! Split edges of <F1> and store wires and edges in
//! the set <WES>. According to RevOri, reverse (or not) orientation.
Standard_EXPORT void FillFace(const TopoDS_Shape& F1,
const TopAbs_State TB1,
@@ -788,7 +788,7 @@ protected:
TopOpeBRepBuild_WireEdgeSet& WES,
const Standard_Boolean RevOri);
//! Split faces of <S1> and store shells and faces in
//! Split faces of <S1> and store shells and faces in
//! the set <SS>. According to RevOri, reverse (or not) orientation.
Standard_EXPORT void FillSolid(const TopoDS_Shape& S1,
const TopAbs_State TB1,
@@ -816,7 +816,7 @@ protected:
//! fills vertex set PVS with the current value of IT.
//! I geometry is a point or a vertex.
//! TB indicates the orientation to give to geometries found I
//! TB indicates the orientation to give to geometries found I
Standard_EXPORT void FillVertexSetOnValue(const TopOpeBRepDS_PointIterator& IT,
const TopAbs_State TB,
TopOpeBRepBuild_PaveSet& PVS) const;
@@ -40,9 +40,9 @@ class TopOpeBRepBuild_PaveSet;
class TopoDS_Edge;
class TopoDS_Face;
//! extension of the class TopOpeBRepBuild_Builder dedicated
//! to avoid bugs in "Rebuilding Result" algorithm for the case of SOLID/SOLID Boolean
//! Operations
//! extension of the class TopOpeBRepBuild_Builder dedicated
//! to avoid bugs in "Rebuilding Result" algorithm for the
//! case of SOLID/SOLID Boolean Operations
class TopOpeBRepBuild_Builder1 : public TopOpeBRepBuild_Builder
{
public:
@@ -53,7 +53,7 @@ public:
Standard_EXPORT virtual ~TopOpeBRepBuild_Builder1();
//! Removes all splits and merges already performed.
//! Does NOT clear the handled DS (except ShapeWithStatesMaps).
//! Does NOT clear the handled DS (except ShapeWithStatesMaps).
Standard_EXPORT virtual void Clear() Standard_OVERRIDE;
Standard_EXPORT virtual void Perform(const Handle(TopOpeBRepDS_HDataStructure)& HDS)
@@ -30,8 +30,8 @@ class TopOpeBRepBuild_LoopClassifier;
//! where the Loop is the composite topological object of the boundary,
//! here wire or block of edges.
//! The LoopSet gives an iteration on Loops.
//! For each Loop it indicates if it is on the boundary (wire) or if it
//! results from an interference (block of edges).
//! For each Loop it indicates if it is on the boundary (wire) or if it
//! results from an interference (block of edges).
//! The result of the FaceAreaBuilder is an iteration on areas.
//! An area is described by a set of Loops.
class TopOpeBRepBuild_FaceAreaBuilder : public TopOpeBRepBuild_Area2dBuilder
@@ -50,8 +50,8 @@ public:
const TopoDS_Shape& F,
const Standard_Boolean ForceClass);
//! Removes are non 3d-closed wires.
//! Fills up maps <mapVVsameG> and <mapVon1Edge>, in order to
//! Removes are non 3d-closed wires.
//! Fills up maps <mapVVsameG> and <mapVon1Edge>, in order to
//! correct 3d-closed but unclosed (topologic connexity) wires.
//! modifies myBlockBuilder
Standard_EXPORT void DetectUnclosedWire(TopTools_IndexedDataMapOfShapeShape& mapVVsameG,
@@ -36,12 +36,12 @@ class TopOpeBRepBuild_Builder;
class TopOpeBRepBuild_HBuilder;
DEFINE_STANDARD_HANDLE(TopOpeBRepBuild_HBuilder, Standard_Transient)
//! The HBuilder algorithm constructs topological
//! objects from an existing topology and new
//! The HBuilder algorithm constructs topological
//! objects from an existing topology and new
//! geometries attached to the topology. It is used to
//! construct the result of a topological operation;
//! the existing topologies are the parts involved in
//! the topological operation and the new geometries
//! the existing topologies are the parts involved in
//! the topological operation and the new geometries
//! are the intersection lines and points.
class TopOpeBRepBuild_HBuilder : public Standard_Transient
{
@@ -77,14 +77,14 @@ public:
const TopoDS_Shape& S2,
const TopAbs_State TB2);
//! Merges the two solids <S1> and <S2> keeping the
//! Merges the two solids <S1> and <S2> keeping the
//! parts in each solid of states <TB1> and <TB2>.
Standard_EXPORT void MergeSolids(const TopoDS_Shape& S1,
const TopAbs_State TB1,
const TopoDS_Shape& S2,
const TopAbs_State TB2);
//! Merges the solid <S> keeping the
//! Merges the solid <S> keeping the
//! parts of state <TB>.
Standard_EXPORT void MergeSolid(const TopoDS_Shape& S, const TopAbs_State TB);
@@ -153,7 +153,7 @@ public:
//! search for the couple of face F1,F2
//! (from arguments of supra Perform(S1,S2,HDS)) method which
//! intersection gives section edge E built on at least one edge .
//! intersection gives section edge E built on at least one edge.
//! returns True if F1,F2 have been valued.
//! returns False if E is not a section edge built
//! on at least one edge of S1 and/or S2.
@@ -36,13 +36,13 @@
//! To build solids : shapes are shells, elements are faces.
//! The ShapeSet stores a list of shapes, a list of elements
//! to start reconstructions, and a map to search neighbours.
//! The map stores the connection between elements through
//! The map stores the connection between elements through
//! subshapes of type <SubShapeType> given in constructor.
//! <SubShapeType> is :
//! <SubShapeType> is:
//! - TopAbs_VERTEX to connect edges
//! - TopAbs_EDGE to connect faces
//!
//! Signature needed by the BlockBuilder :
//! Signature needed by the BlockBuilder:
//! InitStartElements(me : in out)
//! MoreStartElements(me) returns Boolean;
//! NextStartElement(me : in out);
@@ -56,8 +56,8 @@ class TopOpeBRepBuild_ShapeSet
public:
DEFINE_STANDARD_ALLOC
//! Creates a ShapeSet in order to build shapes connected
//! by <SubShapeType> shapes.
//! Creates a ShapeSet in order to build shapes connected
//! by <SubShapeType> shapes.
//! <checkshape>:check (or not) the shapes, startelements, elements added.
Standard_EXPORT TopOpeBRepBuild_ShapeSet(const TopAbs_ShapeEnum SubShapeType,
const Standard_Boolean checkshape = Standard_True);
@@ -28,8 +28,8 @@ class TopOpeBRepBuild_LoopClassifier;
//! where the Loop is the composite topological object of the boundary,
//! here wire or block of edges.
//! The LoopSet gives an iteration on Loops.
//! For each Loop it indicates if it is on the boundary (wire) or if it
//! results from an interference (block of edges).
//! For each Loop it indicates if it is on the boundary (wire) or if it
//! results from an interference (block of edges).
//! The result of the SolidAreaBuilder is an iteration on areas.
//! An area is described by a set of Loops.
class TopOpeBRepBuild_SolidAreaBuilder : public TopOpeBRepBuild_Area3dBuilder
@@ -37,7 +37,7 @@ class TopoDS_Edge;
class gp_Vec;
class TopoDS_Wire;
//! Auxiliary methods used in TopOpeBRepBuild_Builder1 class
//! Auxiliary methods used in TopOpeBRepBuild_Builder1 class
class TopOpeBRepBuild_Tools
{
public:
@@ -99,9 +99,9 @@ public:
const TopoDS_Edge& anEdgeObj,
gp_Vec& aDirNormal);
//! This function used to compute normal in point which is located
//! near the point with param UV (used for computation of normals where the normal
//! in the point UV equal to zero).
//! This function used to compute normal in point which is located
//! near the point with param UV (used for computation of normals where the normal
//! in the point UV equal to zero).
Standard_EXPORT static void GetNormalInNearestPoint(const TopoDS_Face& aFace,
const TopoDS_Edge& anEdge,
gp_Vec& aNormal);
@@ -114,17 +114,17 @@ public:
Standard_EXPORT static Standard_Boolean GetTangentToEdge(const TopoDS_Edge& anEdgeObj,
gp_Vec& aTangent);
//! Recompute PCurves of the all edges from the wire on the <toFace>
//! Recompute PCurves of the all edges from the wire on the <toFace>
Standard_EXPORT static void UpdatePCurves(const TopoDS_Wire& aWire,
const TopoDS_Face& fromFace,
const TopoDS_Face& toFace);
//! recompute PCurves of the closing (SIM , with 2 PCurves) edge on the NewFace
//! Recompute PCurves of the closing (SIM, with 2 PCurves) edge on the NewFace
Standard_EXPORT static void UpdateEdgeOnPeriodicalFace(const TopoDS_Edge& aEdgeToUpdate,
const TopoDS_Face& OldFace,
const TopoDS_Face& NewFace);
//! recompute PCurve of the edge on the NewFace
//! Recompute PCurve of the edge on the NewFace
Standard_EXPORT static void UpdateEdgeOnFace(const TopoDS_Edge& aEdgeToUpdate,
const TopoDS_Face& OldFace,
const TopoDS_Face& NewFace);
@@ -132,16 +132,16 @@ public:
Standard_EXPORT static Standard_Boolean IsDegEdgesTheSame(const TopoDS_Shape& anE1,
const TopoDS_Shape& anE2);
//! test if <oldFace> does not contain INTERNAL or EXTERNAL edges
//! and remove such edges in case of its presence. The result is stored in <corrFace>
//! test if <oldFace> does not contain INTERNAL or EXTERNAL edges
//! and remove such edges in case of its presence. The result is stored in <corrFace>
Standard_EXPORT static void NormalizeFace(const TopoDS_Shape& oldFace, TopoDS_Shape& corrFace);
//! test if UV representation of <oldFace> is good (i.e. face is closed in 2d).
//! if face is not closed , this method will try to close such face and will
//! return corrected edges in the <aMapOfCorrect2dEdges>. Parameter <aSourceShapes>
//! used to fix the edge (or wires) which should be correct (Corrector used it as a
//! start shapes). NOTE : Parameter corrFace doesn't mean anything. If you want to use
//! this method , rebuild resulting face after by yourself using corrected edges.
//! test if UV representation of <oldFace> is good (i.e. face is closed in 2d).
//! if face is not closed, this method will try to close such face and will
//! return corrected edges in the <aMapOfCorrect2dEdges>. Parameter <aSourceShapes>
//! used to fix the edge (or wires) which should be correct (Corrector used it as a
//! start shapes). NOTE: Parameter corrFace doesn't mean anything. If you want to use
//! this method, rebuild resulting face after by yourself using corrected edges.
Standard_EXPORT static void CorrectFace2d(
const TopoDS_Shape& oldFace,
TopoDS_Shape& corrFace,
@@ -24,7 +24,7 @@
class TopoDS_Wire;
class TopoDS_Face;
//! This class builds faces from a set of wires SW and a face F.
//! This class builds faces from a set of wires SW and a face F.
//! The face must have and underlying surface, say S.
//! All of the edges of all of the wires must have a 2d representation
//! on surface S (except if S is planar)