BRepPrimAPI_MakePrism Class Reference

Describes functions to build linear swept topologies, called prisms. A prism is defined by: More...

#include <BRepPrimAPI_MakePrism.hxx>

Inheritance diagram for BRepPrimAPI_MakePrism:

Public Member Functions
	BRepPrimAPI_MakePrism (const TopoDS_Shape &S, const gp_Vec &V, const Standard_Boolean Copy=Standard_False, const Standard_Boolean Canonize=Standard_True)
	Builds the prism of base S and vector V. If C is true, S is copied. If Canonize is true then generated surfaces are attempted to be canonized in simple types.
	BRepPrimAPI_MakePrism (const TopoDS_Shape &S, const gp_Dir &D, const Standard_Boolean Inf=Standard_True, const Standard_Boolean Copy=Standard_False, const Standard_Boolean Canonize=Standard_True)
	Builds a semi-infinite or an infinite prism of base S. If Inf is true the prism is infinite, if Inf is false the prism is semi-infinite (in the direction D). If C is true S is copied (for semi-infinite prisms). If Canonize is true then generated surfaces are attempted to be canonized in simple types.
const BRepSweep_Prism &	Prism () const
	Returns the internal sweeping algorithm.
virtual void	Build (const Message_ProgressRange &theRange=Message_ProgressRange()) override
	Builds the resulting shape (redefined from MakeShape).
TopoDS_Shape	FirstShape () override
	Returns the TopoDS Shape of the bottom of the prism.
TopoDS_Shape	LastShape () override
	Returns the TopoDS Shape of the top of the prism. In the case of a finite prism, FirstShape returns the basis of the prism, in other words, S if Copy is false; otherwise, the copy of S belonging to the prism. LastShape returns the copy of S translated by V at the time of construction.
virtual const TopTools_ListOfShape &	Generated (const TopoDS_Shape &S) override
	Returns ListOfShape from TopTools.
virtual Standard_Boolean	IsDeleted (const TopoDS_Shape &S) override
	Returns true if the shape S has been deleted.
TopoDS_Shape	FirstShape (const TopoDS_Shape &theShape)
	Returns the TopoDS Shape of the bottom of the prism. generated with theShape (subShape of the generating shape).
TopoDS_Shape	LastShape (const TopoDS_Shape &theShape)
	Returns the TopoDS Shape of the top of the prism. generated with theShape (subShape of the generating shape).
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 TopTools_ListOfShape &	Modified (const TopoDS_Shape &S)
	Returns the list of shapes modified from the 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.

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
TopTools_ListOfShape	myGenerated

Detailed Description

Describes functions to build linear swept topologies, called prisms. A prism is defined by:

• a basis shape, which is swept, and
• a sweeping direction, which is:
• a vector for finite prisms, or
• a direction for infinite or semi-infinite prisms. The basis shape must not contain any solids. The profile generates objects according to the following rules:
• Vertices generate Edges
• Edges generate Faces.
• Wires generate Shells.
• Faces generate Solids.
• Shells generate Composite Solids A MakePrism object provides a framework for:
• defining the construction of a prism,
• implementing the construction algorithm, and
• consulting the result.

Constructor & Destructor Documentation

BRepPrimAPI_MakePrism() [1/2]

BRepPrimAPI_MakePrism::BRepPrimAPI_MakePrism	(	const TopoDS_Shape &	S,
		const gp_Vec &	V,
		const Standard_Boolean	Copy = Standard_False,
		const Standard_Boolean	Canonize = Standard_True
	)

Builds the prism of base S and vector V. If C is true, S is copied. If Canonize is true then generated surfaces are attempted to be canonized in simple types.

BRepPrimAPI_MakePrism() [2/2]

BRepPrimAPI_MakePrism::BRepPrimAPI_MakePrism	(	const TopoDS_Shape &	S,
		const gp_Dir &	D,
		const Standard_Boolean	Inf = Standard_True,
		const Standard_Boolean	Copy = Standard_False,
		const Standard_Boolean	Canonize = Standard_True
	)

Builds a semi-infinite or an infinite prism of base S. If Inf is true the prism is infinite, if Inf is false the prism is semi-infinite (in the direction D). If C is true S is copied (for semi-infinite prisms). If Canonize is true then generated surfaces are attempted to be canonized in simple types.

Member Function Documentation

Build()

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

overridevirtual

Builds the resulting shape (redefined from MakeShape).

Reimplemented from BRepBuilderAPI_MakeShape.

FirstShape() [1/2]

TopoDS_Shape BRepPrimAPI_MakePrism::FirstShape ( )

overridevirtual

Returns the TopoDS Shape of the bottom of the prism.

Implements BRepPrimAPI_MakeSweep.

FirstShape() [2/2]

TopoDS_Shape BRepPrimAPI_MakePrism::FirstShape

(

const TopoDS_Shape &

theShape

)

Returns the TopoDS Shape of the bottom of the prism. generated with theShape (subShape of the generating shape).

Generated()

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

overridevirtual

Returns ListOfShape from TopTools.

Reimplemented from BRepBuilderAPI_MakeShape.

IsDeleted()

virtual Standard_Boolean BRepPrimAPI_MakePrism::IsDeleted ( const TopoDS_Shape &  S )

overridevirtual

Returns true if the shape S has been deleted.

Reimplemented from BRepBuilderAPI_MakeShape.

LastShape() [1/2]

TopoDS_Shape BRepPrimAPI_MakePrism::LastShape ( )

overridevirtual

Returns the TopoDS Shape of the top of the prism. In the case of a finite prism, FirstShape returns the basis of the prism, in other words, S if Copy is false; otherwise, the copy of S belonging to the prism. LastShape returns the copy of S translated by V at the time of construction.

Implements BRepPrimAPI_MakeSweep.

LastShape() [2/2]

TopoDS_Shape BRepPrimAPI_MakePrism::LastShape

(

const TopoDS_Shape &

theShape

)

Returns the TopoDS Shape of the top of the prism. generated with theShape (subShape of the generating shape).

Prism()

const BRepSweep_Prism & BRepPrimAPI_MakePrism::Prism

(

)

const

Returns the internal sweeping algorithm.

---

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

• BRepPrimAPI_MakePrism.hxx