mirror of
https://github.com/Open-Cascade-SAS/OCCT.git
synced 2026-09-05 12:17:50 +08:00
Documentation - Fix whitespaces and typos (#821)
- Removed excessive whitespace between words in comments
- Removed <br> syntax
- Fixed spelling errors ("hilight" → "highlights", "texte" → "text")
- Improved comment formatting and structure
This commit is contained in:
luzpaz
@@ -39,7 +39,7 @@ class BRepPrim_Builder
|
||||
public:
|
||||
DEFINE_STANDARD_ALLOC
|
||||
|
||||
//! Creates an empty, useless Builder. Necesseray for
|
||||
//! Creates an empty, useless Builder. Necesseray for
|
||||
//! compilation.
|
||||
Standard_EXPORT BRepPrim_Builder();
|
||||
|
||||
@@ -51,7 +51,7 @@ public:
|
||||
//! Make a empty Shell.
|
||||
Standard_EXPORT void MakeShell(TopoDS_Shell& S) const;
|
||||
|
||||
//! Returns in <F> a Face built with the plane
|
||||
//! Returns in <F> a Face built with the plane
|
||||
//! equation <P>. Used by all primitives.
|
||||
Standard_EXPORT void MakeFace(TopoDS_Face& F, const gp_Pln& P) const;
|
||||
|
||||
@@ -61,12 +61,12 @@ public:
|
||||
//! Returns in <E> a degenerated edge.
|
||||
Standard_EXPORT void MakeDegeneratedEdge(TopoDS_Edge& E) const;
|
||||
|
||||
//! Returns in <E> an Edge built with the line
|
||||
//! equation <L>.
|
||||
//! Returns in <E> an Edge built with the line
|
||||
//! equation <L>.
|
||||
Standard_EXPORT void MakeEdge(TopoDS_Edge& E, const gp_Lin& L) const;
|
||||
|
||||
//! Returns in <E> an Edge built with the circle
|
||||
//! equation <C>.
|
||||
//! Returns in <E> an Edge built with the circle
|
||||
//! equation <C>.
|
||||
Standard_EXPORT void MakeEdge(TopoDS_Edge& E, const gp_Circ& C) const;
|
||||
|
||||
//! Sets the line <L> to be the curve representing the
|
||||
@@ -74,16 +74,16 @@ public:
|
||||
//! <F>.
|
||||
Standard_EXPORT void SetPCurve(TopoDS_Edge& E, const TopoDS_Face& F, const gp_Lin2d& L) const;
|
||||
|
||||
//! Sets the lines <L1,L2> to be the curves
|
||||
//! representing the edge <E> in the parametric space
|
||||
//! Sets the lines <L1,L2> to be the curves
|
||||
//! representing the edge <E> in the parametric space
|
||||
//! of the closed surface of <F>.
|
||||
Standard_EXPORT void SetPCurve(TopoDS_Edge& E,
|
||||
const TopoDS_Face& F,
|
||||
const gp_Lin2d& L1,
|
||||
const gp_Lin2d& L2) const;
|
||||
|
||||
//! Sets the circle <C> to be the curve representing
|
||||
//! the edge <E> in the parametric space of the
|
||||
//! Sets the circle <C> to be the curve representing
|
||||
//! the edge <E> in the parametric space of the
|
||||
//! surface of <F>.
|
||||
Standard_EXPORT void SetPCurve(TopoDS_Edge& E, const TopoDS_Face& F, const gp_Circ2d& C) const;
|
||||
|
||||
@@ -93,54 +93,54 @@ public:
|
||||
//! Reverses the Face <F>.
|
||||
Standard_EXPORT void ReverseFace(TopoDS_Face& F) const;
|
||||
|
||||
//! Adds the Vertex <V> in the Edge <E>. <P> is the
|
||||
//! parameter of the vertex on the edge. If direct
|
||||
//! Adds the Vertex <V> in the Edge <E>. <P> is the
|
||||
//! parameter of the vertex on the edge. If direct
|
||||
//! is False the Vertex is reversed.
|
||||
Standard_EXPORT void AddEdgeVertex(TopoDS_Edge& E,
|
||||
const TopoDS_Vertex& V,
|
||||
const Standard_Real P,
|
||||
const Standard_Boolean direct) const;
|
||||
|
||||
//! Adds the Vertex <V> in the Edge <E>. <P1,P2>
|
||||
//! are the parameters of the vertex on the closed
|
||||
//! Adds the Vertex <V> in the Edge <E>. <P1,P2>
|
||||
//! are the parameters of the vertex on the closed
|
||||
//! edge.
|
||||
Standard_EXPORT void AddEdgeVertex(TopoDS_Edge& E,
|
||||
const TopoDS_Vertex& V,
|
||||
const Standard_Real P1,
|
||||
const Standard_Real P2) const;
|
||||
|
||||
//! <P1,P2> are the parameters of the vertex on the
|
||||
//! edge. The edge is a closed curve.
|
||||
//! <P1,P2> are the parameters of the vertex on the
|
||||
//! edge. The edge is a closed curve.
|
||||
Standard_EXPORT void SetParameters(TopoDS_Edge& E,
|
||||
const TopoDS_Vertex& V,
|
||||
const Standard_Real P1,
|
||||
const Standard_Real P2) const;
|
||||
|
||||
//! Adds the Edge <E> in the Wire <W>, if direct is
|
||||
//! Adds the Edge <E> in the Wire <W>, if direct is
|
||||
//! False the Edge is reversed.
|
||||
Standard_EXPORT void AddWireEdge(TopoDS_Wire& W,
|
||||
const TopoDS_Edge& E,
|
||||
const Standard_Boolean direct) const;
|
||||
|
||||
//! Adds the Wire <W> in the Face <F>.
|
||||
//! Adds the Wire <W> in the Face <F>.
|
||||
Standard_EXPORT void AddFaceWire(TopoDS_Face& F, const TopoDS_Wire& W) const;
|
||||
|
||||
//! Adds the Face <F> in the Shell <Sh>.
|
||||
//! Adds the Face <F> in the Shell <Sh>.
|
||||
Standard_EXPORT void AddShellFace(TopoDS_Shell& Sh, const TopoDS_Face& F) const;
|
||||
|
||||
//! This is called once an edge is completed. It gives
|
||||
//! the opportunity to perform any post treatment.
|
||||
Standard_EXPORT void CompleteEdge(TopoDS_Edge& E) const;
|
||||
|
||||
//! This is called once a wire is completed. It gives
|
||||
//! This is called once a wire is completed. It gives
|
||||
//! the opportunity to perform any post treatment.
|
||||
Standard_EXPORT void CompleteWire(TopoDS_Wire& W) const;
|
||||
|
||||
//! This is called once a face is completed. It gives
|
||||
//! This is called once a face is completed. It gives
|
||||
//! the opportunity to perform any post treatment.
|
||||
Standard_EXPORT void CompleteFace(TopoDS_Face& F) const;
|
||||
|
||||
//! This is called once a shell is completed. It gives
|
||||
//! This is called once a shell is completed. It gives
|
||||
//! the opportunity to perform any post treatment.
|
||||
Standard_EXPORT void CompleteShell(TopoDS_Shell& S) const;
|
||||
|
||||
|
||||
@@ -57,12 +57,12 @@ public:
|
||||
//! infinite cone with Axes
|
||||
Standard_EXPORT BRepPrim_Cone(const Standard_Real Angle, const gp_Ax2& Axes);
|
||||
|
||||
//! create a Cone at origin on Z axis, of height H,
|
||||
//! radius R1 at Z = 0, R2 at Z = H, X is the origin
|
||||
//! of angles. If R1 or R2 is 0 there is an apex.
|
||||
//! create a Cone at origin on Z axis, of height H,
|
||||
//! radius R1 at Z = 0, R2 at Z = H, X is the origin
|
||||
//! of angles. If R1 or R2 is 0 there is an apex.
|
||||
//! Otherwise, it is a truncated cone.
|
||||
//!
|
||||
//! Error : R1 and R2 < Resolution
|
||||
//! Error : R1 and R2 < Resolution
|
||||
//! R1 or R2 negative
|
||||
//! Abs(R1-R2) < Resolution
|
||||
//! H < Resolution
|
||||
@@ -83,7 +83,7 @@ public:
|
||||
const Standard_Real R2,
|
||||
const Standard_Real H);
|
||||
|
||||
//! The surface normal should be directed towards the
|
||||
//! The surface normal should be directed towards the
|
||||
//! outside.
|
||||
Standard_EXPORT virtual TopoDS_Face MakeEmptyLateralFace() const Standard_OVERRIDE;
|
||||
|
||||
|
||||
@@ -53,9 +53,9 @@ public:
|
||||
//! infinite Cylinder at Axes on Z negative
|
||||
Standard_EXPORT BRepPrim_Cylinder(const gp_Ax2& Axes, const Standard_Real Radius);
|
||||
|
||||
//! create a Cylinder at origin on Z axis, of
|
||||
//! create a Cylinder at origin on Z axis, of
|
||||
//! height H and radius R
|
||||
//! Error : Radius < Resolution
|
||||
//! Error : Radius < Resolution
|
||||
//! H < Resolution
|
||||
//! H negative
|
||||
Standard_EXPORT BRepPrim_Cylinder(const Standard_Real R, const Standard_Real H);
|
||||
@@ -65,7 +65,7 @@ public:
|
||||
const Standard_Real R,
|
||||
const Standard_Real H);
|
||||
|
||||
//! The surface normal should be directed towards the
|
||||
//! The surface normal should be directed towards the
|
||||
//! outside.
|
||||
Standard_EXPORT virtual TopoDS_Face MakeEmptyLateralFace() const Standard_OVERRIDE;
|
||||
|
||||
|
||||
@@ -28,10 +28,10 @@
|
||||
class BRep_Builder;
|
||||
class Geom_Surface;
|
||||
|
||||
//! The FaceBuilder is an algorithm to build a BRep
|
||||
//! The FaceBuilder is an algorithm to build a BRep
|
||||
//! Face from a Geom Surface.
|
||||
//!
|
||||
//! The face covers the whole surface or the area
|
||||
//! The face covers the whole surface or the area
|
||||
//! delimited by UMin, UMax, VMin, VMax
|
||||
class BRepPrim_FaceBuilder
|
||||
{
|
||||
|
||||
@@ -38,14 +38,14 @@ class gp_Pnt;
|
||||
//!
|
||||
//! Axes: an Axis2 (coordinate system)
|
||||
//!
|
||||
//! YMin, YMax the coordinates of the ymin and ymax
|
||||
//! YMin, YMax the coordinates of the ymin and ymax
|
||||
//! rectangular faces parallel to the ZX plane (of the
|
||||
//! coordinate systems)
|
||||
//!
|
||||
//! ZMin,ZMax,XMin,XMax the rectangular
|
||||
//! ZMin, ZMax, XMin, XMax the rectangular
|
||||
//! left (YMin) face parallel to the Z and X axes.
|
||||
//!
|
||||
//! Z2Min,Z2Max,X2Min,X2Max the rectangular
|
||||
//! Z2Min, Z2Max, X2Min, X2Max the rectangular
|
||||
//! right (YMax) face parallel to the Z and X axes.
|
||||
//!
|
||||
//! For a box Z2Min = ZMin, Z2Max = ZMax,
|
||||
|
||||
@@ -30,15 +30,15 @@ class TopoDS_Face;
|
||||
class TopoDS_Edge;
|
||||
class gp_Pnt2d;
|
||||
|
||||
//! Implement the OneAxis algorithm for a revolution
|
||||
//! Implement the OneAxis algorithm for a revolution
|
||||
//! surface.
|
||||
class BRepPrim_Revolution : public BRepPrim_OneAxis
|
||||
{
|
||||
public:
|
||||
DEFINE_STANDARD_ALLOC
|
||||
|
||||
//! Create a revolution body <M> is the meridian nd
|
||||
//! must be in the XZ plane of <A>. <PM> is the
|
||||
//! Create a revolution body <M> is the meridian nd
|
||||
//! must be in the XZ plane of <A>. <PM> is the
|
||||
//! meridian in the XZ plane.
|
||||
Standard_EXPORT BRepPrim_Revolution(const gp_Ax2& A,
|
||||
const Standard_Real VMin,
|
||||
@@ -46,12 +46,12 @@ public:
|
||||
const Handle(Geom_Curve)& M,
|
||||
const Handle(Geom2d_Curve)& PM);
|
||||
|
||||
//! The surface normal should be directed towards the
|
||||
//! The surface normal should be directed towards the
|
||||
//! outside.
|
||||
Standard_EXPORT virtual TopoDS_Face MakeEmptyLateralFace() const;
|
||||
|
||||
//! Returns an edge with a 3D curve made from the
|
||||
//! meridian in the XZ plane rotated by <Ang> around
|
||||
//! Returns an edge with a 3D curve made from the
|
||||
//! meridian in the XZ plane rotated by <Ang> around
|
||||
//! the Z-axis. Ang may be 0 or myAngle.
|
||||
Standard_EXPORT virtual TopoDS_Edge MakeEmptyMeridianEdge(const Standard_Real Ang) const;
|
||||
|
||||
@@ -59,13 +59,13 @@ public:
|
||||
//! plane XZ.
|
||||
Standard_EXPORT virtual gp_Pnt2d MeridianValue(const Standard_Real V) const;
|
||||
|
||||
//! Sets the parametric urve of the edge <E> in the
|
||||
//! face <F> to be the 2d representation of the
|
||||
//! Sets the parametric urve of the edge <E> in the
|
||||
//! face <F> to be the 2d representation of the
|
||||
//! meridian.
|
||||
Standard_EXPORT virtual void SetMeridianPCurve(TopoDS_Edge& E, const TopoDS_Face& F) const;
|
||||
|
||||
protected:
|
||||
//! Create a revolution body. The meridian is set
|
||||
//! Create a revolution body. The meridian is set
|
||||
//! later. Reserved for derivated classes.
|
||||
Standard_EXPORT BRepPrim_Revolution(const gp_Ax2& A,
|
||||
const Standard_Real VMin,
|
||||
|
||||
@@ -32,8 +32,8 @@ class BRepPrim_Sphere : public BRepPrim_Revolution
|
||||
public:
|
||||
DEFINE_STANDARD_ALLOC
|
||||
|
||||
//! Creates a Sphere at origin with Radius. The axes
|
||||
//! of the sphere are the reference axes. An error is
|
||||
//! Creates a Sphere at origin with Radius. The axes
|
||||
//! of the sphere are the reference axes. An error is
|
||||
//! raised if the radius is < Resolution.
|
||||
Standard_EXPORT BRepPrim_Sphere(const Standard_Real Radius);
|
||||
|
||||
@@ -45,7 +45,7 @@ public:
|
||||
//! Creates a sphere with given axes system.
|
||||
Standard_EXPORT BRepPrim_Sphere(const gp_Ax2& Axes, const Standard_Real Radius);
|
||||
|
||||
//! The surface normal should be directed towards the
|
||||
//! The surface normal should be directed towards the
|
||||
//! outside.
|
||||
Standard_EXPORT virtual TopoDS_Face MakeEmptyLateralFace() const Standard_OVERRIDE;
|
||||
|
||||
|
||||
@@ -34,10 +34,10 @@ class gp_Ax1;
|
||||
//!
|
||||
//! * A basis topology which is swept.
|
||||
//!
|
||||
//! The basis topology must not contain solids
|
||||
//! The basis topology must not contain solids
|
||||
//! (neither composite solids.).
|
||||
//!
|
||||
//! The basis topology may be copied or shared in
|
||||
//! The basis topology may be copied or shared in
|
||||
//! the result.
|
||||
//!
|
||||
//! * A rotation axis and angle :
|
||||
@@ -56,22 +56,22 @@ class gp_Ax1;
|
||||
//! - Face -> Solid.
|
||||
//! - Shell -> CompSolid.
|
||||
//!
|
||||
//! Sweeping a Compound sweeps the elements of the
|
||||
//! compound and creates a compound with the
|
||||
//! Sweeping a Compound sweeps the elements of the
|
||||
//! compound and creates a compound with the
|
||||
//! results.
|
||||
class BRepPrimAPI_MakeRevol : public BRepPrimAPI_MakeSweep
|
||||
{
|
||||
public:
|
||||
DEFINE_STANDARD_ALLOC
|
||||
|
||||
//! Builds the Revol of base S, axis A and angle D. If C
|
||||
//! Builds the Revol of base S, axis A and angle D. If C
|
||||
//! is true, S is copied.
|
||||
Standard_EXPORT BRepPrimAPI_MakeRevol(const TopoDS_Shape& S,
|
||||
const gp_Ax1& A,
|
||||
const Standard_Real D,
|
||||
const Standard_Boolean Copy = Standard_False);
|
||||
|
||||
//! Builds the Revol of base S, axis A and angle 2*Pi. If
|
||||
//! Builds the Revol of base S, axis A and angle 2*Pi. If
|
||||
//! C is true, S is copied.
|
||||
Standard_EXPORT BRepPrimAPI_MakeRevol(const TopoDS_Shape& S,
|
||||
const gp_Ax1& A,
|
||||
@@ -84,7 +84,7 @@ public:
|
||||
Standard_EXPORT virtual void Build(
|
||||
const Message_ProgressRange& theRange = Message_ProgressRange()) Standard_OVERRIDE;
|
||||
|
||||
//! Returns the first shape of the revol (coinciding with
|
||||
//! Returns the first shape of the revol (coinciding with
|
||||
//! the generating shape).
|
||||
Standard_EXPORT TopoDS_Shape FirstShape() Standard_OVERRIDE;
|
||||
|
||||
@@ -101,11 +101,11 @@ public:
|
||||
Standard_EXPORT virtual Standard_Boolean IsDeleted(const TopoDS_Shape& S) Standard_OVERRIDE;
|
||||
|
||||
//! Returns the TopoDS Shape of the beginning of the revolution,
|
||||
//! generated with theShape (subShape of the generating shape).
|
||||
//! generated with theShape (subShape of the generating shape).
|
||||
Standard_EXPORT TopoDS_Shape FirstShape(const TopoDS_Shape& theShape);
|
||||
|
||||
//! Returns the TopoDS Shape of the end of the revolution,
|
||||
//! generated with theShape (subShape of the generating shape).
|
||||
//! generated with theShape (subShape of the generating shape).
|
||||
Standard_EXPORT TopoDS_Shape LastShape(const TopoDS_Shape& theShape);
|
||||
|
||||
//! Check if there are degenerated edges in the result.
|
||||
|
||||
@@ -28,8 +28,8 @@
|
||||
#include <TColStd_Array2OfBoolean.hxx>
|
||||
#include <TopAbs_Orientation.hxx>
|
||||
|
||||
//! This a generic class is used to build Sweept
|
||||
//! primitives with a generating "shape" and a
|
||||
//! This a generic class is used to build Sweept
|
||||
//! primitives with a generating "shape" and a
|
||||
//! directing "line".
|
||||
//!
|
||||
//! The indexation and type analysis services required
|
||||
@@ -41,13 +41,13 @@
|
||||
//! The iteration services required for the generatrix
|
||||
//! are given by <Iterator from BRepSweep>.
|
||||
//!
|
||||
//! The iteration services required for the directrix
|
||||
//! The iteration services required for the directrix
|
||||
//! are given by <NumShapeIterator from Sweep>.
|
||||
//!
|
||||
//! The topology is like a grid of shapes. Each shape
|
||||
//! of the grid must be addressable without confusion
|
||||
//! by one or two objects from the generating or
|
||||
//! directing shapes. Here are examples of correct
|
||||
//! The topology is like a grid of shapes. Each shape
|
||||
//! of the grid must be addressable without confusion
|
||||
//! by one or two objects from the generating or
|
||||
//! directing shapes. Here are examples of correct
|
||||
//! associations to address:
|
||||
//!
|
||||
//! - a vertex : GenVertex - DirVertex
|
||||
@@ -63,7 +63,7 @@
|
||||
//! types.
|
||||
//!
|
||||
//! The method Has... is given because in some special
|
||||
//! cases, a vertex, an edge or a face may be
|
||||
//! cases, a vertex, an edge or a face may be
|
||||
//! geometricaly nonexistent or not useful.
|
||||
class BRepSweep_NumLinearRegularSweep
|
||||
{
|
||||
@@ -86,8 +86,8 @@ public:
|
||||
Standard_EXPORT virtual TopoDS_Shape MakeEmptyGeneratingEdge(const TopoDS_Shape& aGenE,
|
||||
const Sweep_NumShape& aDirV) = 0;
|
||||
|
||||
//! Sets the parameters of the new vertex on the new
|
||||
//! face. The new face and new vertex where generated
|
||||
//! Sets the parameters of the new vertex on the new
|
||||
//! face. The new face and new vertex where generated
|
||||
//! from aGenF, aGenV and aDirV .
|
||||
Standard_EXPORT virtual void SetParameters(const TopoDS_Shape& aNewFace,
|
||||
TopoDS_Shape& aNewVertex,
|
||||
@@ -95,8 +95,8 @@ public:
|
||||
const TopoDS_Shape& aGenV,
|
||||
const Sweep_NumShape& aDirV) = 0;
|
||||
|
||||
//! Sets the parameter of the new vertex on the new
|
||||
//! edge. The new edge and new vertex where generated
|
||||
//! Sets the parameter of the new vertex on the new
|
||||
//! edge. The new edge and new vertex where generated
|
||||
//! from aGenV aDirE, and aDirV.
|
||||
Standard_EXPORT virtual void SetDirectingParameter(const TopoDS_Shape& aNewEdge,
|
||||
TopoDS_Shape& aNewVertex,
|
||||
@@ -104,8 +104,8 @@ public:
|
||||
const Sweep_NumShape& aDirE,
|
||||
const Sweep_NumShape& aDirV) = 0;
|
||||
|
||||
//! Sets the parameter of the new vertex on the new
|
||||
//! edge. The new edge and new vertex where generated
|
||||
//! Sets the parameter of the new vertex on the new
|
||||
//! edge. The new edge and new vertex where generated
|
||||
//! from aGenE, aGenV and aDirV .
|
||||
Standard_EXPORT virtual void SetGeneratingParameter(const TopoDS_Shape& aNewEdge,
|
||||
TopoDS_Shape& aNewVertex,
|
||||
@@ -113,16 +113,16 @@ public:
|
||||
const TopoDS_Shape& aGenV,
|
||||
const Sweep_NumShape& aDirV) = 0;
|
||||
|
||||
//! Builds the face addressed by [aGenS,aDirS], with
|
||||
//! Builds the face addressed by [aGenS,aDirS], with
|
||||
//! its geometric part, but without subcomponents. The
|
||||
//! couple aGenS, aDirS can be a "generating face and
|
||||
//! a directing vertex" or "a generating edge and a
|
||||
//! directing edge".
|
||||
//! couple aGenS, aDirS can be a "generating face and
|
||||
//! a directing vertex" or "a generating edge and a
|
||||
//! directing edge".
|
||||
Standard_EXPORT virtual TopoDS_Shape MakeEmptyFace(const TopoDS_Shape& aGenS,
|
||||
const Sweep_NumShape& aDirS) = 0;
|
||||
|
||||
//! Sets the PCurve for a new edge on a new face. The
|
||||
//! new edge and the new face were generated using
|
||||
//! new edge and the new face were generated using
|
||||
//! aGenF, aGenE and aDirV.
|
||||
Standard_EXPORT virtual void SetPCurve(const TopoDS_Shape& aNewFace,
|
||||
TopoDS_Shape& aNewEdge,
|
||||
@@ -132,7 +132,7 @@ public:
|
||||
const TopAbs_Orientation orien) = 0;
|
||||
|
||||
//! Sets the PCurve for a new edge on a new face. The
|
||||
//! new edge and the new face were generated using
|
||||
//! new edge and the new face were generated using
|
||||
//! aGenE, aDirE and aDirV.
|
||||
Standard_EXPORT virtual void SetGeneratingPCurve(const TopoDS_Shape& aNewFace,
|
||||
TopoDS_Shape& aNewEdge,
|
||||
@@ -142,7 +142,7 @@ public:
|
||||
const TopAbs_Orientation orien) = 0;
|
||||
|
||||
//! Sets the PCurve for a new edge on a new face. The
|
||||
//! new edge and the new face were generated using
|
||||
//! new edge and the new face were generated using
|
||||
//! aGenE, aDirE and aGenV.
|
||||
Standard_EXPORT virtual void SetDirectingPCurve(const TopoDS_Shape& aNewFace,
|
||||
TopoDS_Shape& aNewEdge,
|
||||
@@ -151,15 +151,15 @@ public:
|
||||
const Sweep_NumShape& aDirE,
|
||||
const TopAbs_Orientation orien) = 0;
|
||||
|
||||
//! Returns the Orientation of the shell in the solid
|
||||
//! generated by the face aGenS with the edge aDirS.
|
||||
//! It is REVERSED if the surface is swept in the
|
||||
//! Returns the Orientation of the shell in the solid
|
||||
//! generated by the face aGenS with the edge aDirS.
|
||||
//! It is REVERSED if the surface is swept in the
|
||||
//! direction of the normal.
|
||||
Standard_EXPORT virtual TopAbs_Orientation DirectSolid(const TopoDS_Shape& aGenS,
|
||||
const Sweep_NumShape& aDirS) = 0;
|
||||
|
||||
//! Returns true if aNewSubShape (addressed by
|
||||
//! aSubGenS and aDirS) must be added in aNewShape
|
||||
//! Returns true if aNewSubShape (addressed by
|
||||
//! aSubGenS and aDirS) must be added in aNewShape
|
||||
//! (addressed by aGenS and aDirS).
|
||||
Standard_EXPORT virtual Standard_Boolean GGDShapeIsToAdd(const TopoDS_Shape& aNewShape,
|
||||
const TopoDS_Shape& aNewSubShape,
|
||||
@@ -167,8 +167,8 @@ public:
|
||||
const TopoDS_Shape& aSubGenS,
|
||||
const Sweep_NumShape& aDirS) const = 0;
|
||||
|
||||
//! Returns true if aNewSubShape (addressed by
|
||||
//! aGenS and aSubDirS) must be added in aNewShape
|
||||
//! Returns true if aNewSubShape (addressed by
|
||||
//! aGenS and aSubDirS) must be added in aNewShape
|
||||
//! (addressed by aGenS and aDirS).
|
||||
Standard_EXPORT virtual Standard_Boolean GDDShapeIsToAdd(
|
||||
const TopoDS_Shape& aNewShape,
|
||||
@@ -177,9 +177,9 @@ public:
|
||||
const Sweep_NumShape& aDirS,
|
||||
const Sweep_NumShape& aSubDirS) const = 0;
|
||||
|
||||
//! In some particular cases the topology of a
|
||||
//! generated face must be composed of independent
|
||||
//! closed wires, in this case this function returns
|
||||
//! In some particular cases the topology of a
|
||||
//! generated face must be composed of independent
|
||||
//! closed wires, in this case this function returns
|
||||
//! true.
|
||||
Standard_EXPORT virtual Standard_Boolean SeparatedWires(const TopoDS_Shape& aNewShape,
|
||||
const TopoDS_Shape& aNewSubShape,
|
||||
@@ -187,21 +187,21 @@ public:
|
||||
const TopoDS_Shape& aSubGenS,
|
||||
const Sweep_NumShape& aDirS) const = 0;
|
||||
|
||||
//! In some particular cases the topology of a
|
||||
//! generated Shell must be composed of independent
|
||||
//! closed Shells, in this case this function returns
|
||||
//! In some particular cases the topology of a
|
||||
//! generated Shell must be composed of independent
|
||||
//! closed Shells, in this case this function returns
|
||||
//! a Compound of independent Shells.
|
||||
Standard_EXPORT virtual TopoDS_Shape SplitShell(const TopoDS_Shape& aNewShape) const;
|
||||
|
||||
//! Called to propagate the continuity of every vertex
|
||||
//! between two edges of the generating wire aGenS on
|
||||
//! Called to propagate the continuity of every vertex
|
||||
//! between two edges of the generating wire aGenS on
|
||||
//! the generated edge and faces.
|
||||
Standard_EXPORT virtual void SetContinuity(const TopoDS_Shape& aGenS,
|
||||
const Sweep_NumShape& aDirS) = 0;
|
||||
|
||||
//! Returns true if aDirS and aGenS addresses a
|
||||
//! resulting Shape. In some specific cases the shape
|
||||
//! can be geometrically inexsistant, then this
|
||||
//! Returns true if aDirS and aGenS addresses a
|
||||
//! resulting Shape. In some specific cases the shape
|
||||
//! can be geometrically inexsistant, then this
|
||||
//! function returns false.
|
||||
Standard_EXPORT virtual Standard_Boolean HasShape(const TopoDS_Shape& aGenS,
|
||||
const Sweep_NumShape& aDirS) const = 0;
|
||||
@@ -209,11 +209,11 @@ public:
|
||||
//! Returns true if aGenS cannot be transformed.
|
||||
Standard_EXPORT virtual Standard_Boolean IsInvariant(const TopoDS_Shape& aGenS) const = 0;
|
||||
|
||||
//! Returns the resulting Shape indexed by aDirS and
|
||||
//! Returns the resulting Shape indexed by aDirS and
|
||||
//! aGenS.
|
||||
Standard_EXPORT TopoDS_Shape Shape(const TopoDS_Shape& aGenS, const Sweep_NumShape& aDirS);
|
||||
|
||||
//! Returns the resulting Shape indexed by myDirWire
|
||||
//! Returns the resulting Shape indexed by myDirWire
|
||||
//! and aGenS.
|
||||
Standard_EXPORT TopoDS_Shape Shape(const TopoDS_Shape& aGenS);
|
||||
|
||||
@@ -225,30 +225,30 @@ public:
|
||||
//! is used in result shape
|
||||
Standard_EXPORT Standard_Boolean GenIsUsed(const TopoDS_Shape& theS) const;
|
||||
|
||||
//! Returns the resulting Shape indexed by myDirWire
|
||||
//! Returns the resulting Shape indexed by myDirWire
|
||||
//! and myGenShape.
|
||||
Standard_EXPORT TopoDS_Shape Shape();
|
||||
|
||||
//! Returns the resulting Shape indexed by the first
|
||||
//! Vertex of myDirWire and myGenShape.
|
||||
//! Returns the resulting Shape indexed by the first
|
||||
//! Vertex of myDirWire and myGenShape.
|
||||
Standard_EXPORT TopoDS_Shape FirstShape();
|
||||
|
||||
//! Returns the resulting Shape indexed by the last
|
||||
//! Returns the resulting Shape indexed by the last
|
||||
//! Vertex of myDirWire and myGenShape.
|
||||
Standard_EXPORT TopoDS_Shape LastShape();
|
||||
|
||||
//! Returns the resulting Shape indexed by the first
|
||||
//! Vertex of myDirWire and aGenS.
|
||||
//! Returns the resulting Shape indexed by the first
|
||||
//! Vertex of myDirWire and aGenS.
|
||||
Standard_EXPORT TopoDS_Shape FirstShape(const TopoDS_Shape& aGenS);
|
||||
|
||||
//! Returns the resulting Shape indexed by the last
|
||||
//! Returns the resulting Shape indexed by the last
|
||||
//! Vertex of myDirWire and aGenS.
|
||||
Standard_EXPORT TopoDS_Shape LastShape(const TopoDS_Shape& aGenS);
|
||||
|
||||
Standard_EXPORT Standard_Boolean Closed() const;
|
||||
|
||||
protected:
|
||||
//! Creates a NumLinearRegularSweep. <aBuilder> gives
|
||||
//! Creates a NumLinearRegularSweep. <aBuilder> gives
|
||||
//! basic topological services.
|
||||
Standard_EXPORT BRepSweep_NumLinearRegularSweep(const BRepSweep_Builder& aBuilder,
|
||||
const TopoDS_Shape& aGenShape,
|
||||
|
||||
@@ -45,8 +45,8 @@ public:
|
||||
const Standard_Boolean Canonize = Standard_True);
|
||||
|
||||
//! Builds a semi-infinite or an infinite prism of base S.
|
||||
//! If Copy is true S is copied. If Inf is true the prism
|
||||
//! is infinite, if Inf is false the prism is infinite in
|
||||
//! If Copy is true S is copied. If Inf is true the prism
|
||||
//! is infinite, if Inf is false the prism is infinite in
|
||||
//! the direction D. If Canonize is true then generated surfaces
|
||||
//! are attempted to be canonized in simple types
|
||||
Standard_EXPORT BRepSweep_Prism(const TopoDS_Shape& S,
|
||||
@@ -58,27 +58,27 @@ public:
|
||||
//! Returns the TopoDS Shape attached to the prism.
|
||||
Standard_EXPORT TopoDS_Shape Shape();
|
||||
|
||||
//! Returns the TopoDS Shape generated with aGenS
|
||||
//! (subShape of the generating shape).
|
||||
//! Returns the TopoDS Shape generated with aGenS
|
||||
//! (subShape of the generating shape).
|
||||
Standard_EXPORT TopoDS_Shape Shape(const TopoDS_Shape& aGenS);
|
||||
|
||||
//! Returns the TopoDS Shape of the bottom of the prism.
|
||||
//! Returns the TopoDS Shape of the bottom of the prism.
|
||||
Standard_EXPORT TopoDS_Shape FirstShape();
|
||||
|
||||
//! Returns the TopoDS Shape of the bottom of the prism.
|
||||
//! generated with aGenS (subShape of the generating
|
||||
//! Returns the TopoDS Shape of the bottom of the prism.
|
||||
//! generated with aGenS (subShape of the generating
|
||||
//! shape).
|
||||
Standard_EXPORT TopoDS_Shape FirstShape(const TopoDS_Shape& aGenS);
|
||||
|
||||
//! Returns the TopoDS Shape of the top of the prism.
|
||||
Standard_EXPORT TopoDS_Shape LastShape();
|
||||
|
||||
//! Returns the TopoDS Shape of the top of the prism.
|
||||
//! generated with aGenS (subShape of the generating
|
||||
//! Returns the TopoDS Shape of the top of the prism.
|
||||
//! generated with aGenS (subShape of the generating
|
||||
//! shape).
|
||||
Standard_EXPORT TopoDS_Shape LastShape(const TopoDS_Shape& aGenS);
|
||||
|
||||
//! Returns the Vector of the Prism, if it is an infinite
|
||||
//! Returns the Vector of the Prism, if it is an infinite
|
||||
//! prism the Vec is unitar.
|
||||
Standard_EXPORT gp_Vec Vec() const;
|
||||
|
||||
|
||||
@@ -35,14 +35,14 @@ class BRepSweep_Revol
|
||||
public:
|
||||
DEFINE_STANDARD_ALLOC
|
||||
|
||||
//! Builds the Revol of meridian S axis A and angle D. If
|
||||
//! Builds the Revol of meridian S axis A and angle D. If
|
||||
//! C is true S is copied.
|
||||
Standard_EXPORT BRepSweep_Revol(const TopoDS_Shape& S,
|
||||
const gp_Ax1& A,
|
||||
const Standard_Real D,
|
||||
const Standard_Boolean C = Standard_False);
|
||||
|
||||
//! Builds the Revol of meridian S axis A and angle 2*Pi.
|
||||
//! Builds the Revol of meridian S axis A and angle 2*Pi.
|
||||
//! If C is true S is copied.
|
||||
Standard_EXPORT BRepSweep_Revol(const TopoDS_Shape& S,
|
||||
const gp_Ax1& A,
|
||||
@@ -51,23 +51,23 @@ public:
|
||||
//! Returns the TopoDS Shape attached to the Revol.
|
||||
Standard_EXPORT TopoDS_Shape Shape();
|
||||
|
||||
//! Returns the TopoDS Shape generated with aGenS
|
||||
//! (subShape of the generating shape).
|
||||
//! Returns the TopoDS Shape generated with aGenS
|
||||
//! (subShape of the generating shape).
|
||||
Standard_EXPORT TopoDS_Shape Shape(const TopoDS_Shape& aGenS);
|
||||
|
||||
//! Returns the first shape of the revol (coinciding with
|
||||
//! Returns the first shape of the revol (coinciding with
|
||||
//! the generating shape).
|
||||
Standard_EXPORT TopoDS_Shape FirstShape();
|
||||
|
||||
//! Returns the first shape of the revol (coinciding with
|
||||
//! Returns the first shape of the revol (coinciding with
|
||||
//! the generating shape).
|
||||
Standard_EXPORT TopoDS_Shape FirstShape(const TopoDS_Shape& aGenS);
|
||||
|
||||
//! Returns the TopoDS Shape of the top of the prism.
|
||||
Standard_EXPORT TopoDS_Shape LastShape();
|
||||
|
||||
//! Returns the TopoDS Shape of the top of the prism.
|
||||
//! generated with aGenS (subShape of the generating
|
||||
//! Returns the TopoDS Shape of the top of the prism.
|
||||
//! generated with aGenS (subShape of the generating
|
||||
//! shape).
|
||||
Standard_EXPORT TopoDS_Shape LastShape(const TopoDS_Shape& aGenS);
|
||||
|
||||
|
||||
@@ -29,14 +29,14 @@ class TopoDS_Shape;
|
||||
class Sweep_NumShape;
|
||||
class TopLoc_Location;
|
||||
|
||||
//! Provides an algorithm to build object by
|
||||
//! Provides an algorithm to build object by
|
||||
//! Rotation sweep.
|
||||
class BRepSweep_Rotation : public BRepSweep_Trsf
|
||||
{
|
||||
public:
|
||||
DEFINE_STANDARD_ALLOC
|
||||
|
||||
//! Creates a topology by rotating <S> around A with the
|
||||
//! Creates a topology by rotating <S> around A with the
|
||||
//! angle D.
|
||||
Standard_EXPORT BRepSweep_Rotation(const TopoDS_Shape& S,
|
||||
const Sweep_NumShape& N,
|
||||
@@ -62,8 +62,8 @@ public:
|
||||
const Sweep_NumShape& aDirV)
|
||||
Standard_OVERRIDE;
|
||||
|
||||
//! Sets the parameters of the new vertex on the new
|
||||
//! face. The new face and new vertex where generated
|
||||
//! Sets the parameters of the new vertex on the new
|
||||
//! face. The new face and new vertex where generated
|
||||
//! from aGenF, aGenV and aDirV .
|
||||
Standard_EXPORT void SetParameters(const TopoDS_Shape& aNewFace,
|
||||
TopoDS_Shape& aNewVertex,
|
||||
@@ -71,8 +71,8 @@ public:
|
||||
const TopoDS_Shape& aGenV,
|
||||
const Sweep_NumShape& aDirV) Standard_OVERRIDE;
|
||||
|
||||
//! Sets the parameter of the new vertex on the new
|
||||
//! edge. The new edge and new vertex where generated
|
||||
//! Sets the parameter of the new vertex on the new
|
||||
//! edge. The new edge and new vertex where generated
|
||||
//! from aGenV aDirE, and aDirV.
|
||||
Standard_EXPORT void SetDirectingParameter(const TopoDS_Shape& aNewEdge,
|
||||
TopoDS_Shape& aNewVertex,
|
||||
@@ -80,8 +80,8 @@ public:
|
||||
const Sweep_NumShape& aDirE,
|
||||
const Sweep_NumShape& aDirV) Standard_OVERRIDE;
|
||||
|
||||
//! Sets the parameter of the new vertex on the new
|
||||
//! edge. The new edge and new vertex where generated
|
||||
//! Sets the parameter of the new vertex on the new
|
||||
//! edge. The new edge and new vertex where generated
|
||||
//! from aGenE, aGenV and aDirV .
|
||||
Standard_EXPORT void SetGeneratingParameter(const TopoDS_Shape& aNewEdge,
|
||||
TopoDS_Shape& aNewVertex,
|
||||
@@ -89,16 +89,16 @@ public:
|
||||
const TopoDS_Shape& aGenV,
|
||||
const Sweep_NumShape& aDirV) Standard_OVERRIDE;
|
||||
|
||||
//! Builds the face addressed by [aGenS,aDirS], with
|
||||
//! Builds the face addressed by [aGenS,aDirS], with
|
||||
//! its geometric part, but without subcomponents. The
|
||||
//! couple aGenS, aDirS can be a "generating face and
|
||||
//! a directing vertex" or "a generating edge and a
|
||||
//! couple aGenS, aDirS can be a "generating face and
|
||||
//! a directing vertex" or "a generating edge and a
|
||||
//! directing edge".
|
||||
Standard_EXPORT TopoDS_Shape MakeEmptyFace(const TopoDS_Shape& aGenS,
|
||||
const Sweep_NumShape& aDirS) Standard_OVERRIDE;
|
||||
|
||||
//! Sets the PCurve for a new edge on a new face. The
|
||||
//! new edge and the new face were generated using
|
||||
//! new edge and the new face were generated using
|
||||
//! aGenF, aGenE and aDirV.
|
||||
Standard_EXPORT void SetPCurve(const TopoDS_Shape& aNewFace,
|
||||
TopoDS_Shape& aNewEdge,
|
||||
@@ -108,7 +108,7 @@ public:
|
||||
const TopAbs_Orientation orien) Standard_OVERRIDE;
|
||||
|
||||
//! Sets the PCurve for a new edge on a new face. The
|
||||
//! new edge and the new face were generated using
|
||||
//! new edge and the new face were generated using
|
||||
//! aGenE, aDirE and aDirV.
|
||||
Standard_EXPORT void SetGeneratingPCurve(const TopoDS_Shape& aNewFace,
|
||||
TopoDS_Shape& aNewEdge,
|
||||
@@ -118,7 +118,7 @@ public:
|
||||
const TopAbs_Orientation orien) Standard_OVERRIDE;
|
||||
|
||||
//! Sets the PCurve for a new edge on a new face. The
|
||||
//! new edge and the new face were generated using
|
||||
//! new edge and the new face were generated using
|
||||
//! aGenE, aDirE and aGenV.
|
||||
Standard_EXPORT void SetDirectingPCurve(const TopoDS_Shape& aNewFace,
|
||||
TopoDS_Shape& aNewEdge,
|
||||
@@ -127,15 +127,15 @@ public:
|
||||
const Sweep_NumShape& aDirE,
|
||||
const TopAbs_Orientation orien) Standard_OVERRIDE;
|
||||
|
||||
//! Returns the Orientation of the shell in the solid
|
||||
//! generated by the face aGenS with the edge aDirS.
|
||||
//! It is REVERSED if the surface is swept in the
|
||||
//! Returns the Orientation of the shell in the solid
|
||||
//! generated by the face aGenS with the edge aDirS.
|
||||
//! It is REVERSED if the surface is swept in the
|
||||
//! direction of the normal.
|
||||
Standard_EXPORT TopAbs_Orientation DirectSolid(const TopoDS_Shape& aGenS,
|
||||
const Sweep_NumShape& aDirS) Standard_OVERRIDE;
|
||||
|
||||
//! Returns true if aNewSubShape (addressed by
|
||||
//! aSubGenS and aDirS) must be added in aNewShape
|
||||
//! Returns true if aNewSubShape (addressed by
|
||||
//! aSubGenS and aDirS) must be added in aNewShape
|
||||
//! (addressed by aGenS and aDirS).
|
||||
Standard_EXPORT Standard_Boolean
|
||||
GGDShapeIsToAdd(const TopoDS_Shape& aNewShape,
|
||||
@@ -144,8 +144,8 @@ public:
|
||||
const TopoDS_Shape& aSubGenS,
|
||||
const Sweep_NumShape& aDirS) const Standard_OVERRIDE;
|
||||
|
||||
//! Returns true if aNewSubShape (addressed by
|
||||
//! aGenS and aSubDirS) must be added in aNewShape
|
||||
//! Returns true if aNewSubShape (addressed by
|
||||
//! aGenS and aSubDirS) must be added in aNewShape
|
||||
//! (addressed by aGenS and aDirS).
|
||||
Standard_EXPORT Standard_Boolean
|
||||
GDDShapeIsToAdd(const TopoDS_Shape& aNewShape,
|
||||
@@ -154,10 +154,10 @@ public:
|
||||
const Sweep_NumShape& aDirS,
|
||||
const Sweep_NumShape& aSubDirS) const Standard_OVERRIDE;
|
||||
|
||||
//! In some particular cases the topology of a
|
||||
//! generated face must be composed of independent
|
||||
//! closed wires, in this case this function returns
|
||||
//! true. The only case in which the function may
|
||||
//! In some particular cases the topology of a
|
||||
//! generated face must be composed of independent
|
||||
//! closed wires, in this case this function returns
|
||||
//! true. The only case in which the function may
|
||||
//! return true is a planar face in a closed revol.
|
||||
Standard_EXPORT Standard_Boolean
|
||||
SeparatedWires(const TopoDS_Shape& aNewShape,
|
||||
@@ -166,22 +166,22 @@ public:
|
||||
const TopoDS_Shape& aSubGenS,
|
||||
const Sweep_NumShape& aDirS) const Standard_OVERRIDE;
|
||||
|
||||
//! In some particular cases the topology of a
|
||||
//! generated Shell must be composed of independent
|
||||
//! closed Shells, in this case this function returns
|
||||
//! In some particular cases the topology of a
|
||||
//! generated Shell must be composed of independent
|
||||
//! closed Shells, in this case this function returns
|
||||
//! a Compound of independent Shells.
|
||||
Standard_EXPORT virtual TopoDS_Shape SplitShell(const TopoDS_Shape& aNewShape) const
|
||||
Standard_OVERRIDE;
|
||||
|
||||
//! Returns true if aDirS and aGenS addresses a
|
||||
//! resulting Shape. In some specific cases the shape
|
||||
//! can be geometrically inexsistant, then this
|
||||
//! Returns true if aDirS and aGenS addresses a
|
||||
//! resulting Shape. In some specific cases the shape
|
||||
//! can be geometrically inexsistant, then this
|
||||
//! function returns false.
|
||||
Standard_EXPORT Standard_Boolean HasShape(const TopoDS_Shape& aGenS,
|
||||
const Sweep_NumShape& aDirS) const Standard_OVERRIDE;
|
||||
|
||||
//! Returns true when the geometry of aGenS is not
|
||||
//! modified by the rotation.
|
||||
//! Returns true when the geometry of aGenS is not
|
||||
//! modified by the rotation.
|
||||
Standard_EXPORT Standard_Boolean IsInvariant(const TopoDS_Shape& aGenS) const Standard_OVERRIDE;
|
||||
|
||||
//! returns the axis
|
||||
|
||||
@@ -26,15 +26,15 @@
|
||||
#include <TopAbs_Orientation.hxx>
|
||||
class TopoDS_Shape;
|
||||
|
||||
//! Provides the indexation and type analysis services
|
||||
//! Provides the indexation and type analysis services
|
||||
//! required by the TopoDS generating Shape of BRepSweep.
|
||||
class BRepSweep_Tool
|
||||
{
|
||||
public:
|
||||
DEFINE_STANDARD_ALLOC
|
||||
|
||||
//! Initialize the tool with <aShape>. The IndexTool
|
||||
//! must prepare an indexation for all the subshapes
|
||||
//! Initialize the tool with <aShape>. The IndexTool
|
||||
//! must prepare an indexation for all the subshapes
|
||||
//! of this shape.
|
||||
Standard_EXPORT BRepSweep_Tool(const TopoDS_Shape& aShape);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user