BRepOffsetAPI_DraftAngle Class Reference

Taper-adding transformations on a shape. The resulting shape is constructed by defining one face to be tapered after another one, as well as the geometric properties of their tapered transformation. Each tapered transformation is propagated along the series of faces which are tangential to one another and which contains the face to be tapered. This algorithm is useful in the construction of molds or dies. It facilitates the removal of the article being produced. A DraftAngle object provides a framework for: More...

#include <BRepOffsetAPI_DraftAngle.hxx>

Inheritance diagram for BRepOffsetAPI_DraftAngle:

Public Member Functions
	BRepOffsetAPI_DraftAngle ()
	Constructs an empty algorithm to perform taper-adding transformations on faces of a shape. Use the Init function to define the shape to be tapered.
	BRepOffsetAPI_DraftAngle (const TopoDS_Shape &S)
	Initializes an algorithm to perform taper-adding transformations on faces of the shape S. S will be referred to as the initial shape of the algorithm.
void	Clear ()
	Cancels the results of all taper-adding transformations performed by this algorithm on the initial shape. These results will have been defined by successive calls to the function Add.
void	Init (const TopoDS_Shape &S)
	Initializes, or reinitializes this taper-adding algorithm with the shape S. S will be referred to as the initial shape of this algorithm.
void	Add (const TopoDS_Face &F, const gp_Dir &Direction, const Standard_Real Angle, const gp_Pln &NeutralPlane, const Standard_Boolean Flag=Standard_True)
	Adds the face F, the direction Direction, the angle Angle, the plane NeutralPlane, and the flag Flag to the framework created at construction time, and with this data, defines the taper-adding transformation. F is a face, which belongs to the initial shape of this algorithm or to the shape loaded by the function Init. Only planar, cylindrical or conical faces can be tapered:
Standard_Boolean	AddDone () const
	Returns true if the previous taper-adding transformation performed by this algorithm in the last call to Add, was successful. If AddDone returns false:
void	Remove (const TopoDS_Face &F)
	Cancels the taper-adding transformation previously performed by this algorithm on the face F and the series of tangential faces which contain F, and retrieves the shape before the last taper-adding transformation. Warning You will have to use this function if the previous call to Add fails. Use the function AddDone to check it. Exceptions.
const TopoDS_Shape &	ProblematicShape () const
	Returns the shape on which an error occurred after an unsuccessful call to Add or when IsDone returns false. Exceptions Standard_NullObject if the initial shape has not been defined, i.e. if this algorithm has not been initialized with the non-empty constructor or the Init function.
Draft_ErrorStatus	Status () const
	Returns an error status when an error has occurred (Face, Edge or Vertex recomputation problem). Otherwise returns Draft_NoError. The method may be called if AddDone returns Standard_False, or when IsDone returns Standard_False.
const TopTools_ListOfShape &	ConnectedFaces (const TopoDS_Face &F) const
	Returns all the faces which have been added together with the face <F>.
const TopTools_ListOfShape &	ModifiedFaces () const
	Returns all the faces on which a modification has been given.
virtual void	Build (const Message_ProgressRange &theRange=Message_ProgressRange()) override
	Builds the resulting shape (redefined from MakeShape).
void	CorrectWires ()
virtual const TopTools_ListOfShape &	Generated (const TopoDS_Shape &S) override
	Returns the list of shapes generated from the shape .
virtual const TopTools_ListOfShape &	Modified (const TopoDS_Shape &S) override
	Returns the list of shapes modified from the shape .
virtual TopoDS_Shape	ModifiedShape (const TopoDS_Shape &S) const override
	Returns the modified shape corresponding to . S can correspond to the entire initial shape or to its subshape. Raises exceptions Standard_NoSuchObject if S is not the initial shape or a subshape of the initial shape to which the transformation has been applied.
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 ()
virtual Standard_Boolean	IsDeleted (const TopoDS_Shape &S)
	Returns true if the shape S has been deleted.
Public Member Functions inherited from BRepBuilderAPI_Command
virtual	~BRepBuilderAPI_Command ()
virtual Standard_Boolean	IsDone () const
void	Check () const
	Raises NotDone if done is false.

Additional Inherited Members
Protected Member Functions inherited from BRepBuilderAPI_ModifyShape
	BRepBuilderAPI_ModifyShape ()
	Empty constructor.
	BRepBuilderAPI_ModifyShape (const TopoDS_Shape &S)
	Initializes the modifier with the Shape , and set the field <myInitialShape> to .
	BRepBuilderAPI_ModifyShape (const Handle< BRepTools_Modification > &M)
	Set the field <myModification> with <M>.
	BRepBuilderAPI_ModifyShape (const TopoDS_Shape &S, const Handle< BRepTools_Modification > &M)
	Initializes the modifier with the Shape , and set the field <myInitialShape> to , and set the field <myModification> with <M>, the performs the modification.
void	DoModif (const TopoDS_Shape &S)
	Performs the previously given modification on the shape .
void	DoModif (const Handle< BRepTools_Modification > &M)
	Performs the modification <M> on a previously given shape.
void	DoModif (const TopoDS_Shape &S, const Handle< BRepTools_Modification > &M)
	Performs the modification <M> on the shape .
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_ModifyShape
BRepTools_Modifier	myModifier
TopoDS_Shape	myInitialShape
Handle< BRepTools_Modification >	myModification
Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape	myShape
TopTools_ListOfShape	myGenerated

Detailed Description

Taper-adding transformations on a shape. The resulting shape is constructed by defining one face to be tapered after another one, as well as the geometric properties of their tapered transformation. Each tapered transformation is propagated along the series of faces which are tangential to one another and which contains the face to be tapered. This algorithm is useful in the construction of molds or dies. It facilitates the removal of the article being produced. A DraftAngle object provides a framework for:

• initializing the construction algorithm with a given shape,
• acquiring the data characterizing the faces to be tapered,
• implementing the construction algorithm, and
• consulting the results. Warning
• This algorithm treats planar, cylindrical and conical faces.
• Do not use shapes, which with a draft angle added to a face would modify the topology. This would, for example, involve creation of new vertices, edges or faces, or suppression of existing vertices, edges or faces.
• Any face, which is continuous in tangency with the face to be tapered, will also be tapered. These connected faces must also respect the above criteria.

Constructor & Destructor Documentation

BRepOffsetAPI_DraftAngle() [1/2]

BRepOffsetAPI_DraftAngle::BRepOffsetAPI_DraftAngle

(

)

Constructs an empty algorithm to perform taper-adding transformations on faces of a shape. Use the Init function to define the shape to be tapered.

BRepOffsetAPI_DraftAngle() [2/2]

BRepOffsetAPI_DraftAngle::BRepOffsetAPI_DraftAngle

(

const TopoDS_Shape &

S

)

Initializes an algorithm to perform taper-adding transformations on faces of the shape S. S will be referred to as the initial shape of the algorithm.

Member Function Documentation

Add()

void BRepOffsetAPI_DraftAngle::Add	(	const TopoDS_Face &	F,
		const gp_Dir &	Direction,
		const Standard_Real	Angle,
		const gp_Pln &	NeutralPlane,
		const Standard_Boolean	Flag = Standard_True
	)

Adds the face F, the direction Direction, the angle Angle, the plane NeutralPlane, and the flag Flag to the framework created at construction time, and with this data, defines the taper-adding transformation. F is a face, which belongs to the initial shape of this algorithm or to the shape loaded by the function Init. Only planar, cylindrical or conical faces can be tapered:

• If the face F is planar, it is tapered by inclining it through the angle Angle about the line of intersection between the plane NeutralPlane and F. Direction indicates the side of NeutralPlane from which matter is removed if Angle is positive or added if Angle is negative.
• If F is cylindrical or conical, it is transformed in the same way on a single face, resulting in a conical face if F is cylindrical, and a conical or cylindrical face if it is already conical. The taper-adding transformation is propagated from the face F along the series of planar, cylindrical or conical faces containing F, which are tangential to one another. Use the function AddDone to check if this taper-adding transformation is successful. Warning Nothing is done if:
• the face F does not belong to the initial shape of this algorithm, or
• the face F is not planar, cylindrical or conical. Exceptions
• Standard_NullObject if the initial shape is not defined, i.e. if this algorithm has not been initialized with the non-empty constructor or the Init function.
• Standard_ConstructionError if the previous call to Add has failed. The function AddDone ought to have been used to check for this, and the function Remove to cancel the results of the unsuccessful taper-adding transformation and to retrieve the previous shape.

AddDone()

Standard_Boolean BRepOffsetAPI_DraftAngle::AddDone

(

)

const

Returns true if the previous taper-adding transformation performed by this algorithm in the last call to Add, was successful. If AddDone returns false:

• the function ProblematicShape returns the face on which the error occurred,
• the function Remove has to be used to cancel the results of the unsuccessful taper-adding transformation and to retrieve the previous shape. Exceptions Standard_NullObject if the initial shape has not been defined, i.e. if this algorithm has not been initialized with the non-empty constructor or the .Init function.

Build()

virtual void BRepOffsetAPI_DraftAngle::Build ( const Message_ProgressRange &  theRange = Message_ProgressRange() )

overridevirtual

Builds the resulting shape (redefined from MakeShape).

Reimplemented from BRepBuilderAPI_MakeShape.

Clear()

void BRepOffsetAPI_DraftAngle::Clear

(

)

Cancels the results of all taper-adding transformations performed by this algorithm on the initial shape. These results will have been defined by successive calls to the function Add.

ConnectedFaces()

const TopTools_ListOfShape & BRepOffsetAPI_DraftAngle::ConnectedFaces

(

const TopoDS_Face &

F

)

const

Returns all the faces which have been added together with the face <F>.

CorrectWires()

void BRepOffsetAPI_DraftAngle::CorrectWires

(

)

Generated()

virtual const TopTools_ListOfShape & BRepOffsetAPI_DraftAngle::Generated ( const TopoDS_Shape &  S )

overridevirtual

Returns the list of shapes generated from the shape .

Reimplemented from BRepBuilderAPI_MakeShape.

Init()

void BRepOffsetAPI_DraftAngle::Init

(

const TopoDS_Shape &

S

)

Initializes, or reinitializes this taper-adding algorithm with the shape S. S will be referred to as the initial shape of this algorithm.

Modified()

virtual const TopTools_ListOfShape & BRepOffsetAPI_DraftAngle::Modified ( const TopoDS_Shape &  S )

overridevirtual

Returns the list of shapes modified from the shape .

Reimplemented from BRepBuilderAPI_ModifyShape.

ModifiedFaces()

const TopTools_ListOfShape & BRepOffsetAPI_DraftAngle::ModifiedFaces

(

)

const

Returns all the faces on which a modification has been given.

ModifiedShape()

virtual TopoDS_Shape BRepOffsetAPI_DraftAngle::ModifiedShape ( const TopoDS_Shape &  S ) const

overridevirtual

Returns the modified shape corresponding to . S can correspond to the entire initial shape or to its subshape. Raises exceptions Standard_NoSuchObject if S is not the initial shape or a subshape of the initial shape to which the transformation has been applied.

Reimplemented from BRepBuilderAPI_ModifyShape.

ProblematicShape()

const TopoDS_Shape & BRepOffsetAPI_DraftAngle::ProblematicShape

(

)

const

Returns the shape on which an error occurred after an unsuccessful call to Add or when IsDone returns false. Exceptions Standard_NullObject if the initial shape has not been defined, i.e. if this algorithm has not been initialized with the non-empty constructor or the Init function.

Remove()

void BRepOffsetAPI_DraftAngle::Remove

(

const TopoDS_Face &

F

)

Cancels the taper-adding transformation previously performed by this algorithm on the face F and the series of tangential faces which contain F, and retrieves the shape before the last taper-adding transformation. Warning You will have to use this function if the previous call to Add fails. Use the function AddDone to check it. Exceptions.

• Standard_NullObject if the initial shape has not been defined, i.e. if this algorithm has not been initialized with the non-empty constructor or the Init function.
• Standard_NoSuchObject if F has not been added or has already been removed.

Status()

Draft_ErrorStatus BRepOffsetAPI_DraftAngle::Status

(

)

const

Returns an error status when an error has occurred (Face, Edge or Vertex recomputation problem). Otherwise returns Draft_NoError. The method may be called if AddDone returns Standard_False, or when IsDone returns Standard_False.

---

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

• BRepOffsetAPI_DraftAngle.hxx