Open CASCADE Technology 6.6.0
Public Member Functions
BRepFilletAPI_MakeChamfer Class Reference

Describes functions to build chamfers on edges of a shell or solid.
Chamfered Edge of a Shell or Solid
A MakeChamfer object provides a framework for:
More...

#include <BRepFilletAPI_MakeChamfer.hxx>

Inheritance diagram for BRepFilletAPI_MakeChamfer:
Inheritance graph
[legend]

Public Member Functions

 BRepFilletAPI_MakeChamfer (const TopoDS_Shape &S)
 Initializes an algorithm for computing chamfers on the shape S.
The edges on which chamfers are built are defined using the Add function.

void Add (const TopoDS_Edge &E)
 Adds edge E to the table of edges used by this
algorithm to build chamfers, where the parameters
of the chamfer must be set after the

void Add (const Standard_Real Dis, const TopoDS_Edge &E, const TopoDS_Face &F)
 Adds edge E to the table of edges used by this
algorithm to build chamfers, where
the parameters of the chamfer are given by the two
distances Dis1 and Dis2; the face F identifies the side
where Dis1 is measured.
The Add function results in a contour being built by
propagation from the edge E (i.e. the contour contains at
least this edge). This contour is composed of edges of
the shape which are tangential to one another and
which delimit two series of tangential faces, with one
series of faces being located on either side of the contour.
Warning
Nothing is done if edge E or the face F does not belong to the initial shape.

void SetDist (const Standard_Real Dis, const Standard_Integer IC, const TopoDS_Face &F)
 Sets the distances Dis1 and Dis2 which give the
parameters of the chamfer along the contour of index
IC generated using the Add function in the internal
data structure of this algorithm. The face F identifies
the side where Dis1 is measured.
Warning
Nothing is done if either the edge E or the face F
does not belong to the initial shape.

void GetDist (const Standard_Integer IC, Standard_Real &Dis) const
void Add (const Standard_Real Dis1, const Standard_Real Dis2, const TopoDS_Edge &E, const TopoDS_Face &F)
 Adds a fillet contour in the builder (builds a
contour of tangent edges to <E> and sets the two
distances <Dis1> and <Dis2> ( parameters of the chamfer ) ).

void SetDists (const Standard_Real Dis1, const Standard_Real Dis2, const Standard_Integer IC, const TopoDS_Face &F)
 Sets the distances Dis1 and Dis2 which give the
parameters of the chamfer along the contour of index
IC generated using the Add function in the internal
data structure of this algorithm. The face F identifies
the side where Dis1 is measured.
Warning
Nothing is done if either the edge E or the face F
does not belong to the initial shape.

void Dists (const Standard_Integer IC, Standard_Real &Dis1, Standard_Real &Dis2) const
 Returns the distances Dis1 and Dis2 which give the
parameters of the chamfer along the contour of index IC
in the internal data structure of this algorithm.
Warning

void AddDA (const Standard_Real Dis, const Standard_Real Angle, const TopoDS_Edge &E, const TopoDS_Face &F)
 Adds a fillet contour in the builder (builds a
contour of tangent edges to <E> and sets the
distance <Dis1> and angle <Angle> ( parameters of the chamfer ) ).

void SetDistAngle (const Standard_Real Dis, const Standard_Real Angle, const Standard_Integer IC, const TopoDS_Face &F)
 set the distance <Dis> and <Angle> of the fillet
contour of index <IC> in the DS with <Dis> on <F>.
//! if the face <F> is not one of common faces
of an edge of the contour <IC>

void GetDistAngle (const Standard_Integer IC, Standard_Real &Dis, Standard_Real &Angle, Standard_Boolean &DisOnFace1) const
 gives the distances <Dis> and <Angle> of the fillet
contour of index <IC> in the DS

Standard_Boolean IsSymetric (const Standard_Integer IC) const
 return True if chamfer symetric false else.

Standard_Boolean IsTwoDistances (const Standard_Integer IC) const
 return True if chamfer is made with two distances false else.

Standard_Boolean IsDistanceAngle (const Standard_Integer IC) const
 return True if chamfer is made with distance and angle false else.

void ResetContour (const Standard_Integer IC)
 Erases the chamfer parameters on the contour of
index IC in the internal data structure of this algorithm.
Use the SetDists function to reset this data.
Warning
Nothing is done if IC is outside the bounds of the table of contours.

Standard_Integer NbContours () const
 Returns the number of contours generated using the
Add function in the internal data structure of this algorithm.

Standard_Integer Contour (const TopoDS_Edge &E) const
 Returns the index of the contour in the internal data
structure of this algorithm, which contains the edge E of the shape.
This function returns 0 if the edge E does not belong to any contour.
Warning
This index can change if a contour is removed from the
internal data structure of this algorithm using the function Remove.

Standard_Integer NbEdges (const Standard_Integer I) const
 Returns the number of edges in the contour of index I in
the internal data structure of this algorithm.
Warning
Returns 0 if I is outside the bounds of the table of contours.

const TopoDS_EdgeEdge (const Standard_Integer I, const Standard_Integer J) const
 Returns the edge of index J in the contour of index I in
the internal data structure of this algorithm.
Warning
Returns a null shape if:

void Remove (const TopoDS_Edge &E)
 Removes the contour in the internal data structure of
this algorithm which contains the edge E of the shape.
Warning
Nothing is done if the edge E does not belong to the
contour in the internal data structure of this algorithm.

Standard_Real Length (const Standard_Integer IC) const
 Returns the length of the contour of index IC in the
internal data structure of this algorithm.
Warning
Returns -1. if IC is outside the bounds of the table of contours.

TopoDS_Vertex FirstVertex (const Standard_Integer IC) const
 Returns the first vertex of the contour of index IC
in the internal data structure of this algorithm.
Warning
Returns a null shape if IC is outside the bounds of the table of contours.

TopoDS_Vertex LastVertex (const Standard_Integer IC) const
 Returns the last vertex of the contour of index IC
in the internal data structure of this algorithm.
Warning
Returns a null shape if IC is outside the bounds of the table of contours.

Standard_Real Abscissa (const Standard_Integer IC, const TopoDS_Vertex &V) const
 Returns the curvilinear abscissa of the vertex V on the
contour of index IC in the internal data structure of this algorithm.
Warning
Returns -1. if:

Standard_Real RelativeAbscissa (const Standard_Integer IC, const TopoDS_Vertex &V) const
 Returns the relative curvilinear abscissa (i.e. between 0
and 1) of the vertex V on the contour of index IC in the
internal data structure of this algorithm.
Warning
Returns -1. if:

Standard_Boolean ClosedAndTangent (const Standard_Integer IC) const
 eturns true if the contour of index IC in the internal
data structure of this algorithm is closed and tangential at the point of closure.
Warning
Returns false if IC is outside the bounds of the table of contours.

Standard_Boolean Closed (const Standard_Integer IC) const
 Returns true if the contour of index IC in the internal
data structure of this algorithm is closed.
Warning
Returns false if IC is outside the bounds of the table of contours.

virtual void Build ()
 Builds the chamfers on all the contours in the internal
data structure of this algorithm and constructs the resulting shape.
Use the function IsDone to verify that the chamfered
shape is built. Use the function Shape to retrieve the chamfered shape.
Warning
The construction of chamfers implements highly complex
construction algorithms. Consequently, there may be
instances where the algorithm fails, for example if the
data defining the parameters of the chamfer is not
compatible with the geometry of the initial shape. There
is no initial analysis of errors and these only become
evident at the construction stage.
Additionally, in the current software release, the following
cases are not handled:

void Reset ()
 Reinitializes this algorithm, thus canceling the effects of the Build function.
This function allows modifications to be made to the
contours and chamfer parameters in order to rebuild the shape.

Handle_TopOpeBRepBuild_HBuilder Builder () const
 Returns the internal filleting algorithm.

virtual const
TopTools_ListOfShape
Generated (const TopoDS_Shape &EorV)
 Returns the list of shapes generated from the
shape <EorV>.

virtual const
TopTools_ListOfShape
Modified (const TopoDS_Shape &F)
 Returns the list of shapes modified from the shape
<F>.

virtual Standard_Boolean IsDeleted (const TopoDS_Shape &F)
 Returns true if the shape S has been deleted.

void Simulate (const Standard_Integer IC)
Standard_Integer NbSurf (const Standard_Integer IC) const
Handle_ChFiDS_SecHArray1 Sect (const Standard_Integer IC, const Standard_Integer IS) const

Detailed Description


Constructor & Destructor Documentation

BRepFilletAPI_MakeChamfer::BRepFilletAPI_MakeChamfer ( const TopoDS_Shape S)

Member Function Documentation

Standard_Real BRepFilletAPI_MakeChamfer::Abscissa ( const Standard_Integer  IC,
const TopoDS_Vertex V 
) const [virtual]
  • IC is outside the bounds of the table of contours, or
  • V is not on the contour of index IC.

Implements BRepFilletAPI_LocalOperation.

void BRepFilletAPI_MakeChamfer::Add ( const TopoDS_Edge E) [virtual]
void BRepFilletAPI_MakeChamfer::Add ( const Standard_Real  Dis,
const TopoDS_Edge E,
const TopoDS_Face F 
)
void BRepFilletAPI_MakeChamfer::Add ( const Standard_Real  Dis1,
const Standard_Real  Dis2,
const TopoDS_Edge E,
const TopoDS_Face F 
)
void BRepFilletAPI_MakeChamfer::AddDA ( const Standard_Real  Dis,
const Standard_Real  Angle,
const TopoDS_Edge E,
const TopoDS_Face F 
)
virtual void BRepFilletAPI_MakeChamfer::Build ( ) [virtual]
  • the end point of the contour is the point of
    intersection of 4 or more edges of the shape, or
  • the intersection of the chamfer with a face which
    limits the contour is not fully contained in this face.

Reimplemented from BRepBuilderAPI_MakeShape.

Handle_TopOpeBRepBuild_HBuilder BRepFilletAPI_MakeChamfer::Builder ( ) const
Standard_Boolean BRepFilletAPI_MakeChamfer::Closed ( const Standard_Integer  IC) const [virtual]
Standard_Boolean BRepFilletAPI_MakeChamfer::ClosedAndTangent ( const Standard_Integer  IC) const [virtual]
Standard_Integer BRepFilletAPI_MakeChamfer::Contour ( const TopoDS_Edge E) const [virtual]
void BRepFilletAPI_MakeChamfer::Dists ( const Standard_Integer  IC,
Standard_Real Dis1,
Standard_Real Dis2 
) const

-1. is returned if IC is outside the bounds of the table of contours.

const TopoDS_Edge& BRepFilletAPI_MakeChamfer::Edge ( const Standard_Integer  I,
const Standard_Integer  J 
) const [virtual]
  • I is outside the bounds of the table of contours, or
  • J is outside the bounds of the table of edges of the contour of index I.

Implements BRepFilletAPI_LocalOperation.

TopoDS_Vertex BRepFilletAPI_MakeChamfer::FirstVertex ( const Standard_Integer  IC) const [virtual]
virtual const TopTools_ListOfShape& BRepFilletAPI_MakeChamfer::Generated ( const TopoDS_Shape EorV) [virtual]

Reimplemented from BRepBuilderAPI_MakeShape.

void BRepFilletAPI_MakeChamfer::GetDist ( const Standard_Integer  IC,
Standard_Real Dis 
) const
void BRepFilletAPI_MakeChamfer::GetDistAngle ( const Standard_Integer  IC,
Standard_Real Dis,
Standard_Real Angle,
Standard_Boolean DisOnFace1 
) const
virtual Standard_Boolean BRepFilletAPI_MakeChamfer::IsDeleted ( const TopoDS_Shape S) [virtual]

Reimplemented from BRepBuilderAPI_MakeShape.

Standard_Boolean BRepFilletAPI_MakeChamfer::IsDistanceAngle ( const Standard_Integer  IC) const
Standard_Boolean BRepFilletAPI_MakeChamfer::IsSymetric ( const Standard_Integer  IC) const
Standard_Boolean BRepFilletAPI_MakeChamfer::IsTwoDistances ( const Standard_Integer  IC) const
TopoDS_Vertex BRepFilletAPI_MakeChamfer::LastVertex ( const Standard_Integer  IC) const [virtual]
Standard_Real BRepFilletAPI_MakeChamfer::Length ( const Standard_Integer  IC) const [virtual]
virtual const TopTools_ListOfShape& BRepFilletAPI_MakeChamfer::Modified ( const TopoDS_Shape F) [virtual]

Reimplemented from BRepBuilderAPI_MakeShape.

Standard_Integer BRepFilletAPI_MakeChamfer::NbContours ( ) const [virtual]
Standard_Integer BRepFilletAPI_MakeChamfer::NbEdges ( const Standard_Integer  I) const [virtual]
Standard_Integer BRepFilletAPI_MakeChamfer::NbSurf ( const Standard_Integer  IC) const [virtual]
Standard_Real BRepFilletAPI_MakeChamfer::RelativeAbscissa ( const Standard_Integer  IC,
const TopoDS_Vertex V 
) const [virtual]
  • IC is outside the bounds of the table of contours, or
  • V is not on the contour of index IC.

Implements BRepFilletAPI_LocalOperation.

void BRepFilletAPI_MakeChamfer::Remove ( const TopoDS_Edge E) [virtual]
void BRepFilletAPI_MakeChamfer::Reset ( ) [virtual]
void BRepFilletAPI_MakeChamfer::ResetContour ( const Standard_Integer  IC) [virtual]
Handle_ChFiDS_SecHArray1 BRepFilletAPI_MakeChamfer::Sect ( const Standard_Integer  IC,
const Standard_Integer  IS 
) const [virtual]
void BRepFilletAPI_MakeChamfer::SetDist ( const Standard_Real  Dis,
const Standard_Integer  IC,
const TopoDS_Face F 
)
void BRepFilletAPI_MakeChamfer::SetDistAngle ( const Standard_Real  Dis,
const Standard_Real  Angle,
const Standard_Integer  IC,
const TopoDS_Face F 
)
void BRepFilletAPI_MakeChamfer::SetDists ( const Standard_Real  Dis1,
const Standard_Real  Dis2,
const Standard_Integer  IC,
const TopoDS_Face F 
)
void BRepFilletAPI_MakeChamfer::Simulate ( const Standard_Integer  IC) [virtual]

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines