BOPAlgo_BuilderFace Class Reference

The algorithm to build new faces from the given faces and set of edges lying on this face. More...

#include <BOPAlgo_BuilderFace.hxx>

Inheritance diagram for BOPAlgo_BuilderFace:

Public Member Functions
	BOPAlgo_BuilderFace ()
virtual	~BOPAlgo_BuilderFace ()
	BOPAlgo_BuilderFace (const Handle< NCollection_BaseAllocator > &theAllocator)
void	SetFace (const TopoDS_Face &theFace)
	Sets the face generatix. More...
const TopoDS_Face &	Face () const
	Returns the face generatix. More...
virtual void	Perform () override
	Performs the algorithm. More...
TopAbs_Orientation	Orientation () const
Public Member Functions inherited from BOPAlgo_BuilderArea
void	SetContext (const Handle< IntTools_Context > &theContext)
	Sets the context for the algorithms. More...
const TopTools_ListOfShape &	Shapes () const
	Returns the input shapes. More...
void	SetShapes (const TopTools_ListOfShape &theLS)
	Sets the shapes for building areas. More...
const TopTools_ListOfShape &	Loops () const
	Returns the found loops. More...
const TopTools_ListOfShape &	Areas () const
	Returns the found areas. More...
void	SetAvoidInternalShapes (const Standard_Boolean theAvoidInternal)
	Defines the preventing of addition of internal parts into result. The default value is FALSE, i.e. the internal parts are added into result. More...
Standard_Boolean	IsAvoidInternalShapes () const
	Returns the AvoidInternalShapes flag. More...
Public Member Functions inherited from BOPAlgo_Options
	BOPAlgo_Options ()
	Empty constructor. More...
	BOPAlgo_Options (const Handle< NCollection_BaseAllocator > &theAllocator)
	Constructor with allocator. More...
virtual	~BOPAlgo_Options ()
	Destructor. More...
const Handle< NCollection_BaseAllocator > &	Allocator () const
	Returns allocator. More...
virtual void	Clear ()
	Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared. More...
void	AddError (const Handle< Message_Alert > &theAlert)
	Adds the alert as error (fail) More...
void	AddWarning (const Handle< Message_Alert > &theAlert)
	Adds the alert as warning. More...
Standard_Boolean	HasErrors () const
	Returns true if algorithm has failed. More...
Standard_Boolean	HasError (const Handle< Standard_Type > &theType) const
	Returns true if algorithm has generated error of specified type. More...
Standard_Boolean	HasWarnings () const
	Returns true if algorithm has generated some warning alerts. More...
Standard_Boolean	HasWarning (const Handle< Standard_Type > &theType) const
	Returns true if algorithm has generated warning of specified type. More...
const Handle< Message_Report > &	GetReport () const
	Returns report collecting all errors and warnings. More...
void	DumpErrors (Standard_OStream &theOS) const
	Dumps the error status into the given stream. More...
void	DumpWarnings (Standard_OStream &theOS) const
	Dumps the warning statuses into the given stream. More...
void	ClearWarnings ()
	Clears the warnings of the algorithm. More...
void	SetFuzzyValue (const Standard_Real theFuzz)
	Sets the additional tolerance. More...
Standard_Real	FuzzyValue () const
	Returns the additional tolerance. More...
void	SetProgressIndicator (const Message_ProgressScope &theProgress)
	Set the Progress Indicator object. More...
void	SetUseOBB (const Standard_Boolean theUseOBB)
	Enables/Disables the usage of OBB. More...
Standard_Boolean	UseOBB () const
	Returns the flag defining usage of OBB. More...
void	SetRunParallel (const Standard_Boolean theFlag)
	Set the flag of parallel processing if <theFlag> is true the parallel processing is switched on if <theFlag> is false the parallel processing is switched off. More...
Standard_Boolean	RunParallel () const
	Returns the flag of parallel processing. More...

Protected Member Functions
virtual void	PerformShapesToAvoid () override
	Collect the edges that a) are internal b) are the same and have different orientation. More...
virtual void	PerformLoops () override
	Build draft wires a)myLoops - draft wires that consist of boundary edges b)myLoopsInternal - draft wires that contains inner edges. More...
virtual void	PerformAreas () override
	Build draft faces that contains boundary edges. More...
virtual void	PerformInternalShapes () override
	Build finalized faces with internals. More...
virtual void	CheckData () override
	Checks input data. More...
Protected Member Functions inherited from BOPAlgo_BuilderArea
	BOPAlgo_BuilderArea ()
virtual	~BOPAlgo_BuilderArea ()
	BOPAlgo_BuilderArea (const Handle< NCollection_BaseAllocator > &theAllocator)
Protected Member Functions inherited from BOPAlgo_Algo
	BOPAlgo_Algo ()
	Default constructor. More...
virtual	~BOPAlgo_Algo ()
	BOPAlgo_Algo (const Handle< NCollection_BaseAllocator > &theAllocator)
virtual void	CheckResult ()
	Checks the obtained result. More...
Protected Member Functions inherited from BOPAlgo_Options
void	UserBreak () const
	Breaks the execution if the break signal is indicated by myProgressIndicator. More...

Protected Attributes
TopoDS_Face	myFace
TopAbs_Orientation	myOrientation
Protected Attributes inherited from BOPAlgo_BuilderArea
Handle< IntTools_Context >	myContext
TopTools_ListOfShape	myShapes
TopTools_ListOfShape	myLoops
TopTools_ListOfShape	myLoopsInternal
TopTools_ListOfShape	myAreas
TopTools_IndexedMapOfOrientedShape	myShapesToAvoid
Standard_Boolean	myAvoidInternalShapes
Protected Attributes inherited from BOPAlgo_Options
Handle< NCollection_BaseAllocator >	myAllocator
	Enables/Disables the usage of OBB. More...
Handle< Message_Report >	myReport
	Enables/Disables the usage of OBB. More...
Standard_Boolean	myRunParallel
	Enables/Disables the usage of OBB. More...
Standard_Real	myFuzzyValue
	Enables/Disables the usage of OBB. More...
const Message_ProgressScope *	myProgressScope
	Enables/Disables the usage of OBB. More...
Standard_Boolean	myUseOBB
	Enables/Disables the usage of OBB. More...

Additional Inherited Members
Static Public Member Functions inherited from BOPAlgo_Options
static Standard_Boolean	GetParallelMode ()
	Gets the global parallel mode. More...
static void	SetParallelMode (const Standard_Boolean theNewMode)
	Sets the global parallel mode. More...

Detailed Description

The algorithm to build new faces from the given faces and set of edges lying on this face.

The algorithm returns the following Error statuses:

• BOPAlgo_AlertNullInputShapes - in case the given face is a null shape.

Constructor & Destructor Documentation

BOPAlgo_BuilderFace() [1/2]

BOPAlgo_BuilderFace::BOPAlgo_BuilderFace

(

)

~BOPAlgo_BuilderFace()

virtual BOPAlgo_BuilderFace::~BOPAlgo_BuilderFace ( )

virtual

BOPAlgo_BuilderFace() [2/2]

BOPAlgo_BuilderFace::BOPAlgo_BuilderFace

(

const Handle< NCollection_BaseAllocator > &

theAllocator

)

Member Function Documentation

CheckData()

virtual void BOPAlgo_BuilderFace::CheckData ( )

overrideprotectedvirtual

Checks input data.

Reimplemented from BOPAlgo_Algo.

Face()

const TopoDS_Face& BOPAlgo_BuilderFace::Face

(

)

const

Returns the face generatix.

Orientation()

TopAbs_Orientation BOPAlgo_BuilderFace::Orientation

(

)

const

Perform()

virtual void BOPAlgo_BuilderFace::Perform ( )

overridevirtual

Performs the algorithm.

Implements BOPAlgo_Algo.

PerformAreas()

virtual void BOPAlgo_BuilderFace::PerformAreas ( )

overrideprotectedvirtual

Build draft faces that contains boundary edges.

Implements BOPAlgo_BuilderArea.

PerformInternalShapes()

virtual void BOPAlgo_BuilderFace::PerformInternalShapes ( )

overrideprotectedvirtual

Build finalized faces with internals.

Implements BOPAlgo_BuilderArea.

PerformLoops()

virtual void BOPAlgo_BuilderFace::PerformLoops ( )

overrideprotectedvirtual

Build draft wires a)myLoops - draft wires that consist of boundary edges b)myLoopsInternal - draft wires that contains inner edges.

Implements BOPAlgo_BuilderArea.

PerformShapesToAvoid()

virtual void BOPAlgo_BuilderFace::PerformShapesToAvoid ( )

overrideprotectedvirtual

Collect the edges that a) are internal b) are the same and have different orientation.

Implements BOPAlgo_BuilderArea.

SetFace()

void BOPAlgo_BuilderFace::SetFace

(

const TopoDS_Face &

theFace

)

Sets the face generatix.

Field Documentation

myFace

TopoDS_Face BOPAlgo_BuilderFace::myFace

protected

myOrientation

TopAbs_Orientation BOPAlgo_BuilderFace::myOrientation

protected

---

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

• BOPAlgo_BuilderFace.hxx