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:

[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) 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.

void	Add (const double 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.

void	SetDist (const double Dis, const int 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 int IC, double &Dis) const

void	Add (const double Dis1, const double 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.

void	SetDists (const double Dis1, const double Dis2, const int 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 int IC, double &Dis1, double &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.

void	AddDA (const double Dis, const double 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 double Dis, const double Angle, const int 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 int IC, double &Dis, double &Angle) const
	gives the distances <Dis> and <Angle> of the fillet contour of index <IC> in the DS

void	SetMode (const ChFiDS_ChamfMode theMode)
	Sets the mode of chamfer.

bool	IsSymetric (const int IC) const
	return True if chamfer symmetric false else.

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

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

void	ResetContour (const int 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.

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

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

int	NbEdges (const int 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.

const TopoDS_Edge &	Edge (const int I, const int 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:

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.

double	Length (const int 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.

TopoDS_Vertex	FirstVertex (const int 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.

TopoDS_Vertex	LastVertex (const int 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.

double	Abscissa (const int 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:

double	RelativeAbscissa (const int 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:

bool	ClosedAndTangent (const int 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.

bool	Closed (const int 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.

void	Build (const Message_ProgressRange &theRange=Message_ProgressRange()) 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:

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.

occ::handle< TopOpeBRepBuild_HBuilder >	Builder () const
	Returns the internal filleting algorithm.

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

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

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

void	Simulate (const int IC) override

int	NbSurf (const int IC) const override

occ::handle< NCollection_HArray1< ChFiDS_CircSection > >	Sect (const int IC, const int IS) const override

Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual const TopoDS_Shape &	Shape ()
	Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built.

	operator TopoDS_Shape ()

Public Member Functions inherited from BRepBuilderAPI_Command
virtual	~BRepBuilderAPI_Command ()

virtual bool	IsDone () const

void	Check () const
	Raises NotDone if done is false.

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.

void	Done ()
	Set done to true.

void	NotDone ()
	Set done to false.

Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape	myShape

NCollection_List< TopoDS_Shape >	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:

initializing the construction algorithm with a given shape,
acquiring the data characterizing the chamfers,
building the chamfers and constructing the resulting shape, and
consulting the result.

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()

double BRepFilletAPI_MakeChamfer::Abscissa	(	const int	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 double	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() [2/3]

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

◆ Add() [3/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.

◆ AddDA()

void BRepFilletAPI_MakeChamfer::AddDA	(	const double	Dis,
		const double	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()

void BRepFilletAPI_MakeChamfer::Build ( const Message_ProgressRange & theRange = Message_ProgressRange() )

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()

occ::handle< TopOpeBRepBuild_HBuilder > BRepFilletAPI_MakeChamfer::Builder ( ) const

Returns the internal filleting algorithm.

◆ Closed()

bool BRepFilletAPI_MakeChamfer::Closed ( const int 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()

bool BRepFilletAPI_MakeChamfer::ClosedAndTangent ( const int 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()

int 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 int	IC,
		double &	Dis1,
		double &	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 int	I,
		const int	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 int 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()

const NCollection_List< TopoDS_Shape > & 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 int	IC,
		double &	Dis ) const

◆ GetDistAngle()

void BRepFilletAPI_MakeChamfer::GetDistAngle	(	const int	IC,
		double &	Dis,
		double &	Angle ) const

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

◆ IsDeleted()

bool BRepFilletAPI_MakeChamfer::IsDeleted ( const TopoDS_Shape & S )

overridevirtual

Returns true if the shape S has been deleted.

Reimplemented from BRepBuilderAPI_MakeShape.

◆ IsDistanceAngle()

bool BRepFilletAPI_MakeChamfer::IsDistanceAngle ( const int IC ) const

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

◆ IsSymetric()

bool BRepFilletAPI_MakeChamfer::IsSymetric ( const int IC ) const

return True if chamfer symmetric false else.

◆ IsTwoDistances()

bool BRepFilletAPI_MakeChamfer::IsTwoDistances ( const int IC ) const

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

◆ LastVertex()

TopoDS_Vertex BRepFilletAPI_MakeChamfer::LastVertex ( const int 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()

double BRepFilletAPI_MakeChamfer::Length ( const int 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()

const NCollection_List< TopoDS_Shape > & BRepFilletAPI_MakeChamfer::Modified ( const TopoDS_Shape & F )

overridevirtual

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

Reimplemented from BRepBuilderAPI_MakeShape.

◆ NbContours()

int 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()

int BRepFilletAPI_MakeChamfer::NbEdges ( const int 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()

int BRepFilletAPI_MakeChamfer::NbSurf ( const int IC ) const

overridevirtual

Implements BRepFilletAPI_LocalOperation.

◆ RelativeAbscissa()

double BRepFilletAPI_MakeChamfer::RelativeAbscissa	(	const int	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 int 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()

occ::handle< NCollection_HArray1< ChFiDS_CircSection > > BRepFilletAPI_MakeChamfer::Sect	(	const int	IC,
		const int	IS ) const

overridevirtual

Implements BRepFilletAPI_LocalOperation.

◆ SetDist()

void BRepFilletAPI_MakeChamfer::SetDist	(	const double	Dis,
		const int	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 double	Dis,
		const double	Angle,
		const int	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 double	Dis1,
		const double	Dis2,
		const int	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 int IC )

overridevirtual

Implements BRepFilletAPI_LocalOperation.

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

BRepFilletAPI_MakeChamfer.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BRepFilletAPI_MakeChamfer()

Member Function Documentation

◆ Abscissa()

◆ Add() [1/3]

◆ Add() [2/3]

◆ Add() [3/3]

◆ AddDA()

◆ Build()

◆ Builder()

◆ Closed()

◆ ClosedAndTangent()

◆ Contour()

◆ Dists()

◆ Edge()

◆ FirstVertex()

◆ Generated()

◆ GetDist()

◆ GetDistAngle()

◆ IsDeleted()

◆ IsDistanceAngle()

◆ IsSymetric()

◆ IsTwoDistances()

◆ LastVertex()

◆ Length()

◆ Modified()

◆ NbContours()

◆ NbEdges()

◆ NbSurf()

◆ RelativeAbscissa()

◆ Remove()

◆ Reset()

◆ ResetContour()

◆ Sect()

◆ SetDist()

◆ SetDistAngle()

◆ SetDists()

◆ SetMode()

◆ Simulate()