BRepOffsetAPI_MakeDraft Class Reference

Build a draft surface along a wire
More...

#include <BRepOffsetAPI_MakeDraft.hxx>

Inheritance diagram for BRepOffsetAPI_MakeDraft:

Public Member Functions
	BRepOffsetAPI_MakeDraft (const TopoDS_Shape &Shape, const gp_Dir &Dir, const Standard_Real Angle)
	Constructs the draft surface object defined by the shape <br> Shape, the direction Dir, and the angle Angle. Shape must be a TopoDS_Wire, Topo_DS_Face or TopoDS_Shell with free boundaries. Exceptions Standard_NotDone if Shape is not a TopoDS_Wire, Topo_DS_Face or TopoDS_Shell with free boundaries. More...
void	SetOptions (const BRepBuilderAPI_TransitionMode Style=BRepBuilderAPI_RightCorner, const Standard_Real AngleMin=0.01, const Standard_Real AngleMax=3.0)
	Sets the options of this draft tool. <br> If a transition has to be performed, it can be defined by the mode Style as RightCorner or RoundCorner, RightCorner being a corner defined by a sharp angle, and RoundCorner being a rounded corner. AngleMin is an angular tolerance used to detect whether a transition has to be performed or not. AngleMax sets the maximum value within which a RightCorner transition can be performed. AngleMin and AngleMax are expressed in radians. More...
void	SetDraft (const Standard_Boolean IsInternal=Standard_False)
	Sets the direction of the draft for this object. <br> If IsInternal is true, the draft is internal to the argument Shape used in the constructor. More...
void	Perform (const Standard_Real LengthMax)
	Performs the draft using the length LengthMax as the <br> maximum length for the corner edge between two draft faces. More...
void	Perform (const Handle< Geom_Surface > &Surface, const Standard_Boolean KeepInsideSurface=Standard_True)
	Performs the draft up to the surface Surface. <br> If KeepInsideSurface is true, the part of Surface inside the draft is kept in the result. More...
void	Perform (const TopoDS_Shape &StopShape, const Standard_Boolean KeepOutSide=Standard_True)
	Performs the draft up to the shape StopShape. <br> If KeepOutSide is true, the part of StopShape which is outside the Draft is kept in the result. More...
TopoDS_Shell	Shell () const
	Returns the shell resulting from performance of the <br> draft along the wire. More...
virtual const TopTools_ListOfShape &	Generated (const TopoDS_Shape &S)
	Returns the list of shapes generated from the shape <S>. More...
Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual void	Delete ()
virtual	~BRepBuilderAPI_MakeShape ()
virtual void	Build ()
	This is called by Shape(). It does nothing but may be redefined. More...
const TopoDS_Shape &	Shape () const
	Returns a shape built by the shape construction algorithm. <br> Raises exception StdFail_NotDone if the shape was not built. More...
	operator TopoDS_Shape () const
virtual const TopTools_ListOfShape &	Modified (const TopoDS_Shape &S)
	Returns the list of shapes modified from the shape <S>. More...
virtual Standard_Boolean	IsDeleted (const TopoDS_Shape &S)
	Returns true if the shape S has been deleted. More...
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

Build a draft surface along a wire

Constructor & Destructor Documentation

BRepOffsetAPI_MakeDraft::BRepOffsetAPI_MakeDraft	(	const TopoDS_Shape &	Shape,
		const gp_Dir &	Dir,
		const Standard_Real	Angle
	)

 Constructs the draft surface object defined by the shape <br>

Shape, the direction Dir, and the angle Angle.
Shape must be a TopoDS_Wire, Topo_DS_Face or
TopoDS_Shell with free boundaries.
Exceptions
Standard_NotDone if Shape is not a TopoDS_Wire,
Topo_DS_Face or TopoDS_Shell with free boundaries.

Member Function Documentation

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

virtual

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

Reimplemented from BRepBuilderAPI_MakeShape.

void BRepOffsetAPI_MakeDraft::Perform

(

const Standard_Real

LengthMax

)

 Performs the draft using the length LengthMax as the <br>

maximum length for the corner edge between two draft faces.

void BRepOffsetAPI_MakeDraft::Perform	(	const Handle< Geom_Surface > &	Surface,
		const Standard_Boolean	KeepInsideSurface = Standard_True
	)

 Performs the draft up to the surface Surface. <br>

If KeepInsideSurface is true, the part of Surface inside
the draft is kept in the result.

void BRepOffsetAPI_MakeDraft::Perform	(	const TopoDS_Shape &	StopShape,
		const Standard_Boolean	KeepOutSide = Standard_True
	)

 Performs the draft up to the shape StopShape. <br>

If KeepOutSide is true, the part of StopShape which is
outside the Draft is kept in the result.

void BRepOffsetAPI_MakeDraft::SetDraft

(

const Standard_Boolean

IsInternal = Standard_False

)

 Sets the direction of the draft for this object. <br>

If IsInternal is true, the draft is internal to the argument
Shape used in the constructor.

void BRepOffsetAPI_MakeDraft::SetOptions	(	const BRepBuilderAPI_TransitionMode	Style = BRepBuilderAPI_RightCorner,
		const Standard_Real	AngleMin = 0.01,
		const Standard_Real	AngleMax = 3.0
	)

 Sets the options of this draft tool. <br>

If a transition has to be performed, it can be defined by
the mode Style as RightCorner or RoundCorner,
RightCorner being a corner defined by a sharp angle,
and RoundCorner being a rounded corner.
AngleMin is an angular tolerance used to detect
whether a transition has to be performed or not.
AngleMax sets the maximum value within which a
RightCorner transition can be performed.
AngleMin and AngleMax are expressed in radians.

TopoDS_Shell BRepOffsetAPI_MakeDraft::Shell

(

)

const

 Returns the shell resulting from performance of the <br>

draft along the wire.

---

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

• BRepOffsetAPI_MakeDraft.hxx