BRepFeat_MakePrism Class Reference

Describes functions to build prism features. These can be depressions or protrusions. The semantics of prism feature creation is based on the construction of shapes: More...

#include <BRepFeat_MakePrism.hxx>

Inheritance diagram for BRepFeat_MakePrism:

Public Member Functions
	BRepFeat_MakePrism ()
	Builds a prism by projecting a wire along the face of a shape. Initializes the prism class.
	BRepFeat_MakePrism (const TopoDS_Shape &Sbase, const TopoDS_Shape &Pbase, const TopoDS_Face &Skface, const gp_Dir &Direction, const int Fuse, const bool Modify)
	Builds a prism by projecting a wire along the face of a shape. a face Pbase is selected in the shape Sbase to serve as the basis for the prism. The orientation of the prism will be defined by the vector Direction. Fuse offers a choice between:
void	Init (const TopoDS_Shape &Sbase, const TopoDS_Shape &Pbase, const TopoDS_Face &Skface, const gp_Dir &Direction, const int Fuse, const bool Modify)
	Initializes this algorithm for building prisms along surfaces. A face Pbase is selected in the shape Sbase to serve as the basis for the prism. The orientation of the prism will be defined by the vector Direction. Fuse offers a choice between:
void	Add (const TopoDS_Edge &E, const TopoDS_Face &OnFace)
	Indicates that the edge <E> will slide on the face <OnFace>. Raises ConstructionError if the face does not belong to the basis shape, or the edge to the prismed shape.
void	Perform (const double Length)
void	Perform (const TopoDS_Shape &Until)
void	Perform (const TopoDS_Shape &From, const TopoDS_Shape &Until)
	Assigns one of the following semantics.
void	PerformUntilEnd ()
	Realizes a semi-infinite prism, limited by the position of the prism base. All other faces extend infinitely.
void	PerformFromEnd (const TopoDS_Shape &FUntil)
	Realizes a semi-infinite prism, limited by the face Funtil.
void	PerformThruAll ()
	Builds an infinite prism. The infinite descendants will not be kept in the result.
void	PerformUntilHeight (const TopoDS_Shape &Until, const double Length)
	Assigns both a limiting shape, Until from TopoDS_Shape, and a height, Length at which to stop generation of the prism feature.
void	Curves (NCollection_Sequence< occ::handle< Geom_Curve > > &S) override
	Returns the list of curves S parallel to the axis of the prism.
occ::handle< Geom_Curve >	BarycCurve () override
	Generates a curve along the center of mass of the primitive.
Public Member Functions inherited from BRepFeat_Form
const NCollection_List< TopoDS_Shape > &	Modified (const TopoDS_Shape &F) override
	returns the list of generated Faces.
const NCollection_List< TopoDS_Shape > &	Generated (const TopoDS_Shape &S) override
	returns a list of the created faces from the shape .
bool	IsDeleted (const TopoDS_Shape &S) override
	Returns true if the shape S has been deleted.
const NCollection_List< TopoDS_Shape > &	FirstShape () const
	Returns the list of shapes created at the bottom of the created form. It may be an empty list.
const NCollection_List< TopoDS_Shape > &	LastShape () const
	Returns the list of shapes created at the top of the created form. It may be an empty list.
const NCollection_List< TopoDS_Shape > &	NewEdges () const
	Returns a list of the limiting and glueing edges generated by the feature. These edges did not originally exist in the basis shape. The list provides the information necessary for subsequent addition of fillets. It may be an empty list.
const NCollection_List< TopoDS_Shape > &	TgtEdges () const
	Returns a list of the tangent edges among the limiting and glueing edges generated by the feature. These edges did not originally exist in the basis shape and are tangent to the face against which the feature is built. The list provides the information necessary for subsequent addition of fillets. It may be an empty list. If an edge is tangent, no fillet is possible, and the edge must subsequently be removed if you want to add a fillet.
void	BasisShapeValid ()
	Initializes the topological construction if the basis shape is present.
void	GeneratedShapeValid ()
	Initializes the topological construction if the generated shape S is present.
void	ShapeFromValid ()
	Initializes the topological construction if the shape is present from the specified integer on.
void	ShapeUntilValid ()
	Initializes the topological construction if the shape is present until the specified integer.
void	GluedFacesValid ()
	Initializes the topological construction if the glued face is present.
void	SketchFaceValid ()
	Initializes the topological construction if the sketch face is present. If the sketch face is inside the basis shape, local operations such as glueing can be performed.
void	PerfSelectionValid ()
	Initializes the topological construction if the selected face is present.
BRepFeat_StatusError	CurrentStatusError () const
Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual void	Build (const Message_ProgressRange &theRange=Message_ProgressRange())
	This is called by Shape(). It does nothing but may be redefined.
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 BRepFeat_Form
	BRepFeat_Form ()
	Redefines the empty constructor.
void	GlobalPerform ()
	General perform method...
void	UpdateDescendants (const LocOpe_Gluer &G)
void	UpdateDescendants (const BRepAlgoAPI_BooleanOperation &aBOP, const TopoDS_Shape &SResult, const bool SkipFace=false)
bool	TransformShapeFU (const int flag)
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 BRepFeat_Form
bool	myFuse
bool	myModify
NCollection_DataMap< TopoDS_Shape, NCollection_List< TopoDS_Shape >, TopTools_ShapeMapHasher >	myMap
TopoDS_Shape	myFShape
TopoDS_Shape	myLShape
NCollection_List< TopoDS_Shape >	myNewEdges
NCollection_List< TopoDS_Shape >	myTgtEdges
BRepFeat_PerfSelection	myPerfSelection
bool	myJustGluer
bool	myJustFeat
TopoDS_Shape	mySbase
TopoDS_Face	mySkface
TopoDS_Shape	myGShape
TopoDS_Shape	mySFrom
TopoDS_Shape	mySUntil
NCollection_DataMap< TopoDS_Shape, TopoDS_Shape, TopTools_ShapeMapHasher >	myGluedF
Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape	myShape
NCollection_List< TopoDS_Shape >	myGenerated

Detailed Description

Describes functions to build prism features. These can be depressions or protrusions. The semantics of prism feature creation is based on the construction of shapes:

• along a length
• up to a limiting face
• from a limiting face to a height. The shape defining construction of the prism feature can be either the supporting edge or the concerned area of a face. In case of the supporting edge, this contour can be attached to a face of the basis shape by binding. When the contour is bound to this face, the information that the contour will slide on the face becomes available to the relevant class methods. In case of the concerned area of a face, you could, for example, cut it out and move it to a different height which will define the limiting face of a protrusion or depression.

Constructor & Destructor Documentation

BRepFeat_MakePrism() [1/2]

BRepFeat_MakePrism::BRepFeat_MakePrism

(

)

Builds a prism by projecting a wire along the face of a shape. Initializes the prism class.

BRepFeat_MakePrism() [2/2]

BRepFeat_MakePrism::BRepFeat_MakePrism	(	const TopoDS_Shape &	Sbase,
		const TopoDS_Shape &	Pbase,
		const TopoDS_Face &	Skface,
		const gp_Dir &	Direction,
		const int	Fuse,
		const bool	Modify )

Builds a prism by projecting a wire along the face of a shape. a face Pbase is selected in the shape Sbase to serve as the basis for the prism. The orientation of the prism will be defined by the vector Direction. Fuse offers a choice between:

• removing matter with a Boolean cut using the setting 0
• adding matter with Boolean fusion using the setting 1. The sketch face Skface serves to determine the type of operation. If it is inside the basis shape, a local operation such as glueing can be performed. Exceptions Standard_ConstructionError if the face does not belong to the basis or the prism shape.

Member Function Documentation

Add()

void BRepFeat_MakePrism::Add	(	const TopoDS_Edge &	E,
		const TopoDS_Face &	OnFace )

Indicates that the edge <E> will slide on the face <OnFace>. Raises ConstructionError if the face does not belong to the basis shape, or the edge to the prismed shape.

BarycCurve()

occ::handle< Geom_Curve > BRepFeat_MakePrism::BarycCurve ( )

overridevirtual

Generates a curve along the center of mass of the primitive.

Implements BRepFeat_Form.

Curves()

void BRepFeat_MakePrism::Curves ( NCollection_Sequence< occ::handle< Geom_Curve > > & S )

overridevirtual

Returns the list of curves S parallel to the axis of the prism.

Implements BRepFeat_Form.

Init()

void BRepFeat_MakePrism::Init	(	const TopoDS_Shape &	Sbase,
		const TopoDS_Shape &	Pbase,
		const TopoDS_Face &	Skface,
		const gp_Dir &	Direction,
		const int	Fuse,
		const bool	Modify )

Initializes this algorithm for building prisms along surfaces. A face Pbase is selected in the shape Sbase to serve as the basis for the prism. The orientation of the prism will be defined by the vector Direction. Fuse offers a choice between:

• removing matter with a Boolean cut using the setting 0
• adding matter with Boolean fusion using the setting 1. The sketch face Skface serves to determine the type of operation. If it is inside the basis shape, a local operation such as glueing can be performed.

Perform() [1/3]

void BRepFeat_MakePrism::Perform

(

const double

Length

)

Perform() [2/3]

void BRepFeat_MakePrism::Perform	(	const TopoDS_Shape &	From,
		const TopoDS_Shape &	Until )

Assigns one of the following semantics.

• to a height Length
• to a face Until
• from a face From to a height Until. Reconstructs the feature topologically according to the semantic option chosen.

Perform() [3/3]

void BRepFeat_MakePrism::Perform

(

const TopoDS_Shape &

Until

)

PerformFromEnd()

void BRepFeat_MakePrism::PerformFromEnd

(

const TopoDS_Shape &

FUntil

)

Realizes a semi-infinite prism, limited by the face Funtil.

PerformThruAll()

void BRepFeat_MakePrism::PerformThruAll

(

)

Builds an infinite prism. The infinite descendants will not be kept in the result.

PerformUntilEnd()

void BRepFeat_MakePrism::PerformUntilEnd

(

)

Realizes a semi-infinite prism, limited by the position of the prism base. All other faces extend infinitely.

PerformUntilHeight()

void BRepFeat_MakePrism::PerformUntilHeight	(	const TopoDS_Shape &	Until,
		const double	Length )

Assigns both a limiting shape, Until from TopoDS_Shape, and a height, Length at which to stop generation of the prism feature.

---

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

• BRepFeat_MakePrism.hxx