BRepPrimAPI_MakeBox Class Reference

Describes functions to build parallelepiped boxes. A MakeBox object provides a framework for: More...

#include <BRepPrimAPI_MakeBox.hxx>

Inheritance diagram for BRepPrimAPI_MakeBox:

Public Member Functions
	BRepPrimAPI_MakeBox ()=default
	Default constructor.
	BRepPrimAPI_MakeBox (const double dx, const double dy, const double dz)
	Make a box with a corner at 0,0,0 and the other dx,dy,dz.
	BRepPrimAPI_MakeBox (const gp_Pnt &P, const double dx, const double dy, const double dz)
	Make a box with a corner at P and size dx, dy, dz.
	BRepPrimAPI_MakeBox (const gp_Pnt &P1, const gp_Pnt &P2)
	Make a box with corners P1,P2.
	BRepPrimAPI_MakeBox (const gp_Ax2 &Axes, const double dx, const double dy, const double dz)
	Make a box with Ax2 (the left corner and the axis) and size dx, dy, dz.
void	Init (const double theDX, const double theDY, const double theDZ)
	Init a box with a corner at 0,0,0 and the other theDX, theDY, theDZ.
void	Init (const gp_Pnt &thePnt, const double theDX, const double theDY, const double theDZ)
	Init a box with a corner at thePnt and size theDX, theDY, theDZ.
void	Init (const gp_Pnt &thePnt1, const gp_Pnt &thePnt2)
	Init a box with corners thePnt1, thePnt2.
void	Init (const gp_Ax2 &theAxes, const double theDX, const double theDY, const double theDZ)
	Init a box with Ax2 (the left corner and the theAxes) and size theDX, theDY, theDZ.
BRepPrim_Wedge &	Wedge ()
	Returns the internal algorithm.
void	Build (const Message_ProgressRange &theRange=Message_ProgressRange()) override
	Stores the solid in myShape.
const TopoDS_Shell &	Shell ()
	Returns the constructed box as a shell.
	operator TopoDS_Shell ()
const TopoDS_Solid &	Solid ()
	Returns the constructed box as a solid.
	operator TopoDS_Solid ()
const TopoDS_Face &	BottomFace ()
	Returns ZMin face.
const TopoDS_Face &	BackFace ()
	Returns XMin face.
const TopoDS_Face &	FrontFace ()
	Returns XMax face.
const TopoDS_Face &	LeftFace ()
	Returns YMin face.
const TopoDS_Face &	RightFace ()
	Returns YMax face.
const TopoDS_Face &	TopFace ()
	Returns ZMax face.
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 const NCollection_List< TopoDS_Shape > &	Generated (const TopoDS_Shape &S)
	Returns the list of shapes generated from the shape .
virtual const NCollection_List< TopoDS_Shape > &	Modified (const TopoDS_Shape &S)
	Returns the list of shapes modified from the shape .
virtual bool	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 bool	IsDone () const
void	Check () const
	Raises NotDone if done is false.

Protected Attributes
BRepPrim_Wedge	myWedge
Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape	myShape
NCollection_List< TopoDS_Shape >	myGenerated

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.

Detailed Description

Describes functions to build parallelepiped boxes. A MakeBox object provides a framework for:

• defining the construction of a box,
• implementing the construction algorithm, and
• consulting the result. Constructs a box such that its sides are parallel to the axes of
• the global coordinate system, or
• the local coordinate system Axis. and
• with a corner at (0, 0, 0) and of size (dx, dy, dz), or
• with a corner at point P and of size (dx, dy, dz), or
• with corners at points P1 and P2. Exceptions Standard_DomainError if: dx, dy, dz are less than or equal to Precision::Confusion(), or
• the vector joining the points P1 and P2 has a component projected onto the global coordinate system less than or equal to Precision::Confusion(). In these cases, the box would be flat.

Constructor & Destructor Documentation

BRepPrimAPI_MakeBox() [1/5]

BRepPrimAPI_MakeBox::BRepPrimAPI_MakeBox ( )

default

Default constructor.

BRepPrimAPI_MakeBox() [2/5]

BRepPrimAPI_MakeBox::BRepPrimAPI_MakeBox	(	const double	dx,
		const double	dy,
		const double	dz )

Make a box with a corner at 0,0,0 and the other dx,dy,dz.

BRepPrimAPI_MakeBox() [3/5]

BRepPrimAPI_MakeBox::BRepPrimAPI_MakeBox	(	const gp_Pnt &	P,
		const double	dx,
		const double	dy,
		const double	dz )

Make a box with a corner at P and size dx, dy, dz.

BRepPrimAPI_MakeBox() [4/5]

BRepPrimAPI_MakeBox::BRepPrimAPI_MakeBox	(	const gp_Pnt &	P1,
		const gp_Pnt &	P2 )

Make a box with corners P1,P2.

BRepPrimAPI_MakeBox() [5/5]

BRepPrimAPI_MakeBox::BRepPrimAPI_MakeBox	(	const gp_Ax2 &	Axes,
		const double	dx,
		const double	dy,
		const double	dz )

Make a box with Ax2 (the left corner and the axis) and size dx, dy, dz.

Member Function Documentation

BackFace()

const TopoDS_Face & BRepPrimAPI_MakeBox::BackFace

(

)

Returns XMin face.

BottomFace()

const TopoDS_Face & BRepPrimAPI_MakeBox::BottomFace

(

)

Returns ZMin face.

Build()

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

overridevirtual

Stores the solid in myShape.

Reimplemented from BRepBuilderAPI_MakeShape.

FrontFace()

const TopoDS_Face & BRepPrimAPI_MakeBox::FrontFace

(

)

Returns XMax face.

Init() [1/4]

void BRepPrimAPI_MakeBox::Init	(	const double	theDX,
		const double	theDY,
		const double	theDZ )

Init a box with a corner at 0,0,0 and the other theDX, theDY, theDZ.

Init() [2/4]

void BRepPrimAPI_MakeBox::Init	(	const gp_Ax2 &	theAxes,
		const double	theDX,
		const double	theDY,
		const double	theDZ )

Init a box with Ax2 (the left corner and the theAxes) and size theDX, theDY, theDZ.

Init() [3/4]

void BRepPrimAPI_MakeBox::Init	(	const gp_Pnt &	thePnt,
		const double	theDX,
		const double	theDY,
		const double	theDZ )

Init a box with a corner at thePnt and size theDX, theDY, theDZ.

Init() [4/4]

void BRepPrimAPI_MakeBox::Init	(	const gp_Pnt &	thePnt1,
		const gp_Pnt &	thePnt2 )

Init a box with corners thePnt1, thePnt2.

LeftFace()

const TopoDS_Face & BRepPrimAPI_MakeBox::LeftFace

(

)

Returns YMin face.

operator TopoDS_Shell()

BRepPrimAPI_MakeBox::operator TopoDS_Shell

(

)

operator TopoDS_Solid()

BRepPrimAPI_MakeBox::operator TopoDS_Solid

(

)

RightFace()

const TopoDS_Face & BRepPrimAPI_MakeBox::RightFace

(

)

Returns YMax face.

Shell()

const TopoDS_Shell & BRepPrimAPI_MakeBox::Shell

(

)

Returns the constructed box as a shell.

Solid()

const TopoDS_Solid & BRepPrimAPI_MakeBox::Solid

(

)

Returns the constructed box as a solid.

TopFace()

const TopoDS_Face & BRepPrimAPI_MakeBox::TopFace

(

)

Returns ZMax face.

Wedge()

BRepPrim_Wedge & BRepPrimAPI_MakeBox::Wedge

(

)

Returns the internal algorithm.

Field Documentation

myWedge

BRepPrim_Wedge BRepPrimAPI_MakeBox::myWedge

protected

---

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

• BRepPrimAPI_MakeBox.hxx