Open CASCADE Technology  7.3.1.dev
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. More...
 
void Add (const TopoDS_Edge &E) override
 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. More...
 
void Add (const Standard_Real Dis, 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 are given by the distance Dis (symmetric chamfer). 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. More...
 
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. More...
 
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 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. More...
 
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. More...
 
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 -1. is returned if IC is outside the bounds of the table of contours. More...
 
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 ) ). More...
 
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> More...
 
void GetDistAngle (const Standard_Integer IC, Standard_Real &Dis, Standard_Real &Angle) const
 gives the distances <Dis> and <Angle> of the fillet contour of index <IC> in the DS More...
 
void SetMode (const ChFiDS_ChamfMode theMode)
 Sets the mode of chamfer. More...
 
Standard_Boolean IsSymetric (const Standard_Integer IC) const
 return True if chamfer symetric false else. More...
 
Standard_Boolean IsTwoDistances (const Standard_Integer IC) const
 return True if chamfer is made with two distances false else. More...
 
Standard_Boolean IsDistanceAngle (const Standard_Integer IC) const
 return True if chamfer is made with distance and angle false else. More...
 
void ResetContour (const Standard_Integer IC) override
 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. More...
 
Standard_Integer NbContours () const override
 Returns the number of contours generated using the Add function in the internal data structure of this algorithm. More...
 
Standard_Integer Contour (const TopoDS_Edge &E) const override
 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. More...
 
Standard_Integer NbEdges (const Standard_Integer I) const override
 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. More...
 
const TopoDS_EdgeEdge (const Standard_Integer I, const Standard_Integer J) const override
 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: More...
 
void Remove (const TopoDS_Edge &E) override
 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. More...
 
Standard_Real Length (const Standard_Integer IC) const override
 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. More...
 
TopoDS_Vertex FirstVertex (const Standard_Integer IC) const override
 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. More...
 
TopoDS_Vertex LastVertex (const Standard_Integer IC) const override
 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. More...
 
Standard_Real Abscissa (const Standard_Integer IC, const TopoDS_Vertex &V) const override
 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: More...
 
Standard_Real RelativeAbscissa (const Standard_Integer IC, const TopoDS_Vertex &V) const override
 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: More...
 
Standard_Boolean ClosedAndTangent (const Standard_Integer IC) const override
 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. More...
 
Standard_Boolean Closed (const Standard_Integer IC) const override
 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. More...
 
virtual void Build () override
 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: More...
 
void Reset () override
 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. More...
 
Handle< TopOpeBRepBuild_HBuilderBuilder () const
 Returns the internal filleting algorithm. More...
 
virtual const TopTools_ListOfShapeGenerated (const TopoDS_Shape &EorV) override
 Returns the list of shapes generated from the shape <EorV>. More...
 
virtual const TopTools_ListOfShapeModified (const TopoDS_Shape &F) override
 Returns the list of shapes modified from the shape <F>. More...
 
virtual Standard_Boolean IsDeleted (const TopoDS_Shape &F) override
 Returns true if the shape S has been deleted. More...
 
void Simulate (const Standard_Integer IC) override
 
Standard_Integer NbSurf (const Standard_Integer IC) const override
 
Handle< ChFiDS_SecHArray1 > Sect (const Standard_Integer IC, const Standard_Integer IS) const override
 
- Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual const TopoDS_ShapeShape ()
 Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built. More...
 
 operator TopoDS_Shape ()
 
- Public Member Functions inherited from BRepBuilderAPI_Command
virtual ~BRepBuilderAPI_Command ()
 
virtual Standard_Boolean IsDone () const
 
void Check () const
 Raises NotDone if done is false. More...
 

Additional Inherited Members

- Protected Member Functions inherited from BRepBuilderAPI_MakeShape
 BRepBuilderAPI_MakeShape ()
 
- Protected Member Functions inherited from BRepBuilderAPI_Command
 BRepBuilderAPI_Command ()
 Set done to False. More...
 
void Done ()
 Set done to true. More...
 
void NotDone ()
 Set done to false. More...
 
- Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape myShape
 
TopTools_ListOfShape myGenerated
 

Detailed Description

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:

Constructor & Destructor Documentation

◆ BRepFilletAPI_MakeChamfer()

BRepFilletAPI_MakeChamfer::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.

Member Function Documentation

◆ Abscissa()

Standard_Real BRepFilletAPI_MakeChamfer::Abscissa ( const Standard_Integer  IC,
const TopoDS_Vertex V 
) const
overridevirtual

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:

  • IC is outside the bounds of the table of contours, or
  • V is not on the contour of index IC.

Implements BRepFilletAPI_LocalOperation.

◆ Add() [1/3]

void BRepFilletAPI_MakeChamfer::Add ( const TopoDS_Edge E)
overridevirtual

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.

Implements BRepFilletAPI_LocalOperation.

◆ Add() [2/3]

void BRepFilletAPI_MakeChamfer::Add ( const Standard_Real  Dis,
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 are given by the distance Dis (symmetric chamfer). 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.

◆ Add() [3/3]

void BRepFilletAPI_MakeChamfer::Add ( const Standard_Real  Dis1,
const Standard_Real  Dis2,
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.

◆ AddDA()

void BRepFilletAPI_MakeChamfer::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 ) ).

◆ Build()

virtual void BRepFilletAPI_MakeChamfer::Build ( )
overridevirtual

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:

  • 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.

◆ Builder()

Handle< TopOpeBRepBuild_HBuilder > BRepFilletAPI_MakeChamfer::Builder ( ) const

Returns the internal filleting algorithm.

◆ Closed()

Standard_Boolean BRepFilletAPI_MakeChamfer::Closed ( const Standard_Integer  IC) const
overridevirtual

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.

Implements BRepFilletAPI_LocalOperation.

◆ ClosedAndTangent()

Standard_Boolean BRepFilletAPI_MakeChamfer::ClosedAndTangent ( const Standard_Integer  IC) const
overridevirtual

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.

Implements BRepFilletAPI_LocalOperation.

◆ Contour()

Standard_Integer BRepFilletAPI_MakeChamfer::Contour ( const TopoDS_Edge E) const
overridevirtual

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.

Implements BRepFilletAPI_LocalOperation.

◆ Dists()

void BRepFilletAPI_MakeChamfer::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 -1. is returned if IC is outside the bounds of the table of contours.

◆ Edge()

const TopoDS_Edge& BRepFilletAPI_MakeChamfer::Edge ( const Standard_Integer  I,
const Standard_Integer  J 
) const
overridevirtual

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:

  • 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.

◆ FirstVertex()

TopoDS_Vertex BRepFilletAPI_MakeChamfer::FirstVertex ( const Standard_Integer  IC) const
overridevirtual

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.

Implements BRepFilletAPI_LocalOperation.

◆ Generated()

virtual const TopTools_ListOfShape& BRepFilletAPI_MakeChamfer::Generated ( const TopoDS_Shape EorV)
overridevirtual

Returns the list of shapes generated from the shape <EorV>.

Reimplemented from BRepBuilderAPI_MakeShape.

◆ GetDist()

void BRepFilletAPI_MakeChamfer::GetDist ( const Standard_Integer  IC,
Standard_Real Dis 
) const

◆ GetDistAngle()

void BRepFilletAPI_MakeChamfer::GetDistAngle ( const Standard_Integer  IC,
Standard_Real Dis,
Standard_Real Angle 
) const

gives the distances <Dis> and <Angle> of the fillet contour of index <IC> in the DS

◆ IsDeleted()

virtual Standard_Boolean BRepFilletAPI_MakeChamfer::IsDeleted ( const TopoDS_Shape S)
overridevirtual

Returns true if the shape S has been deleted.

Reimplemented from BRepBuilderAPI_MakeShape.

◆ IsDistanceAngle()

Standard_Boolean BRepFilletAPI_MakeChamfer::IsDistanceAngle ( const Standard_Integer  IC) const

return True if chamfer is made with distance and angle false else.

◆ IsSymetric()

Standard_Boolean BRepFilletAPI_MakeChamfer::IsSymetric ( const Standard_Integer  IC) const

return True if chamfer symetric false else.

◆ IsTwoDistances()

Standard_Boolean BRepFilletAPI_MakeChamfer::IsTwoDistances ( const Standard_Integer  IC) const

return True if chamfer is made with two distances false else.

◆ LastVertex()

TopoDS_Vertex BRepFilletAPI_MakeChamfer::LastVertex ( const Standard_Integer  IC) const
overridevirtual

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.

Implements BRepFilletAPI_LocalOperation.

◆ Length()

Standard_Real BRepFilletAPI_MakeChamfer::Length ( const Standard_Integer  IC) const
overridevirtual

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.

Implements BRepFilletAPI_LocalOperation.

◆ Modified()

virtual const TopTools_ListOfShape& BRepFilletAPI_MakeChamfer::Modified ( const TopoDS_Shape F)
overridevirtual

Returns the list of shapes modified from the shape <F>.

Reimplemented from BRepBuilderAPI_MakeShape.

◆ NbContours()

Standard_Integer BRepFilletAPI_MakeChamfer::NbContours ( ) const
overridevirtual

Returns the number of contours generated using the Add function in the internal data structure of this algorithm.

Implements BRepFilletAPI_LocalOperation.

◆ NbEdges()

Standard_Integer BRepFilletAPI_MakeChamfer::NbEdges ( const Standard_Integer  I) const
overridevirtual

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.

Implements BRepFilletAPI_LocalOperation.

◆ NbSurf()

Standard_Integer BRepFilletAPI_MakeChamfer::NbSurf ( const Standard_Integer  IC) const
overridevirtual

◆ RelativeAbscissa()

Standard_Real BRepFilletAPI_MakeChamfer::RelativeAbscissa ( const Standard_Integer  IC,
const TopoDS_Vertex V 
) const
overridevirtual

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:

  • IC is outside the bounds of the table of contours, or
  • V is not on the contour of index IC.

Implements BRepFilletAPI_LocalOperation.

◆ Remove()

void BRepFilletAPI_MakeChamfer::Remove ( const TopoDS_Edge E)
overridevirtual

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.

Implements BRepFilletAPI_LocalOperation.

◆ Reset()

void BRepFilletAPI_MakeChamfer::Reset ( )
overridevirtual

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.

Implements BRepFilletAPI_LocalOperation.

◆ ResetContour()

void BRepFilletAPI_MakeChamfer::ResetContour ( const Standard_Integer  IC)
overridevirtual

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.

Implements BRepFilletAPI_LocalOperation.

◆ Sect()

Handle< ChFiDS_SecHArray1 > BRepFilletAPI_MakeChamfer::Sect ( const Standard_Integer  IC,
const Standard_Integer  IS 
) const
overridevirtual

◆ SetDist()

void BRepFilletAPI_MakeChamfer::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.

◆ SetDistAngle()

void BRepFilletAPI_MakeChamfer::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>

◆ SetDists()

void BRepFilletAPI_MakeChamfer::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.

◆ SetMode()

void BRepFilletAPI_MakeChamfer::SetMode ( const ChFiDS_ChamfMode  theMode)

Sets the mode of chamfer.

◆ Simulate()

void BRepFilletAPI_MakeChamfer::Simulate ( const Standard_Integer  IC)
overridevirtual

The documentation for this class was generated from the following file: