The root class for algorithms to build faces/solids from set of edges/faces. More...

#include <BOPAlgo_BuilderArea.hxx>

Inheritance diagram for BOPAlgo_BuilderArea:

[legend]

Public Member Functions
void	SetContext (const Handle< IntTools_Context > &theContext)
	Sets the context for the algorithms.

const TopTools_ListOfShape &	Shapes () const
	Returns the input shapes.

void	SetShapes (const TopTools_ListOfShape &theLS)
	Sets the shapes for building areas.

const TopTools_ListOfShape &	Loops () const
	Returns the found loops.

const TopTools_ListOfShape &	Areas () const
	Returns the found areas.

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.

Standard_Boolean	IsAvoidInternalShapes () const
	Returns the AvoidInternalShapes flag.

Public Member Functions inherited from BOPAlgo_Algo
virtual void	Perform (const Message_ProgressRange &theRange=Message_ProgressRange())=0
	The main method to implement the operation Providing the range allows to enable Progress indicator User break functionalities.

Public Member Functions inherited from BOPAlgo_Options
	BOPAlgo_Options ()
	Empty constructor.

	BOPAlgo_Options (const Handle< NCollection_BaseAllocator > &theAllocator)
	Constructor with allocator.

virtual	~BOPAlgo_Options ()
	Destructor.

const Handle< NCollection_BaseAllocator > &	Allocator () const
	Returns allocator.

virtual void	Clear ()
	Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared.

void	AddError (const Handle< Message_Alert > &theAlert)
	Adds the alert as error (fail)

void	AddWarning (const Handle< Message_Alert > &theAlert)
	Adds the alert as warning.

Standard_Boolean	HasErrors () const
	Returns true if algorithm has failed.

Standard_Boolean	HasError (const Handle< Standard_Type > &theType) const
	Returns true if algorithm has generated error of specified type.

Standard_Boolean	HasWarnings () const
	Returns true if algorithm has generated some warning alerts.

Standard_Boolean	HasWarning (const Handle< Standard_Type > &theType) const
	Returns true if algorithm has generated warning of specified type.

const Handle< Message_Report > &	GetReport () const
	Returns report collecting all errors and warnings.

void	DumpErrors (Standard_OStream &theOS) const
	Dumps the error status into the given stream.

void	DumpWarnings (Standard_OStream &theOS) const
	Dumps the warning statuses into the given stream.

void	ClearWarnings ()
	Clears the warnings of the algorithm.

void	SetFuzzyValue (const Standard_Real theFuzz)
	Sets the additional tolerance.

Standard_Real	FuzzyValue () const
	Returns the additional tolerance.

void	SetUseOBB (const Standard_Boolean theUseOBB)
	Enables/Disables the usage of OBB.

Standard_Boolean	UseOBB () const
	Returns the flag defining usage of OBB.

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.

Standard_Boolean	RunParallel () const
	Returns the flag of parallel processing.

Protected Member Functions
	BOPAlgo_BuilderArea ()

virtual	~BOPAlgo_BuilderArea ()

	BOPAlgo_BuilderArea (const Handle< NCollection_BaseAllocator > &theAllocator)

virtual void	PerformShapesToAvoid (const Message_ProgressRange &theRange)=0

virtual void	PerformLoops (const Message_ProgressRange &theRange)=0

virtual void	PerformAreas (const Message_ProgressRange &theRange)=0

virtual void	PerformInternalShapes (const Message_ProgressRange &theRange)=0

Protected Member Functions inherited from BOPAlgo_Algo
	BOPAlgo_Algo ()
	Default constructor.

virtual	~BOPAlgo_Algo ()

	BOPAlgo_Algo (const Handle< NCollection_BaseAllocator > &theAllocator)

virtual void	CheckData ()
	Checks input data.

virtual void	CheckResult ()
	Checks the obtained result.

void	analyzeProgress (const Standard_Real theWhole, BOPAlgo_PISteps &theSteps) const
	Analyze progress steps of the whole operation.

virtual void	fillPIConstants (const Standard_Real theWhole, BOPAlgo_PISteps &theSteps) const
	Fills the values for constant operations - the operations having constant relative running time.

virtual void	fillPISteps (BOPAlgo_PISteps &theSteps) const
	Fills the values for the operations dependent on the inputs. Filled values may not be normalized to represent percentage of total running time. The values should just correlate to each other. E.g. if progress depends on the number of input shapes, the values may look like this: step1 = number_of_input_vertices; step2 = 2 * number_of_input_edges; step3 = 10 * number_of_input_faces. Normalization of these values will be done automatically in analyzeProgress() method.

Protected Member Functions inherited from BOPAlgo_Options
Standard_Boolean	UserBreak (const Message_ProgressScope &thePS)
	Adds error to the report if the break signal was caught. Returns true in this case, false otherwise.

Protected Attributes
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.

Handle< Message_Report >	myReport
	Enables/Disables the usage of OBB.

Standard_Boolean	myRunParallel
	Enables/Disables the usage of OBB.

Standard_Real	myFuzzyValue
	Enables/Disables the usage of OBB.

Standard_Boolean	myUseOBB
	Enables/Disables the usage of OBB.

Additional Inherited Members
Static Public Member Functions inherited from BOPAlgo_Options
static Standard_Boolean	GetParallelMode ()
	Gets the global parallel mode.

static void	SetParallelMode (const Standard_Boolean theNewMode)
	Sets the global parallel mode.

Detailed Description

The root class for algorithms to build faces/solids from set of edges/faces.

Constructor & Destructor Documentation

◆ BOPAlgo_BuilderArea() [1/2]

BOPAlgo_BuilderArea::BOPAlgo_BuilderArea ( )

protected

◆ ~BOPAlgo_BuilderArea()

virtual BOPAlgo_BuilderArea::~BOPAlgo_BuilderArea ( )

protectedvirtual

◆ BOPAlgo_BuilderArea() [2/2]

BOPAlgo_BuilderArea::BOPAlgo_BuilderArea ( const Handle< NCollection_BaseAllocator > & theAllocator )

protected

Member Function Documentation

◆ Areas()

const TopTools_ListOfShape & BOPAlgo_BuilderArea::Areas ( ) const

inline

Returns the found areas.

◆ IsAvoidInternalShapes()

Standard_Boolean BOPAlgo_BuilderArea::IsAvoidInternalShapes ( ) const

inline

Returns the AvoidInternalShapes flag.

◆ Loops()

const TopTools_ListOfShape & BOPAlgo_BuilderArea::Loops ( ) const

inline

Returns the found loops.

◆ PerformAreas()

virtual void BOPAlgo_BuilderArea::PerformAreas ( const Message_ProgressRange & theRange )

protectedpure virtual

Implemented in BOPAlgo_BuilderFace, and BOPAlgo_BuilderSolid.

◆ PerformInternalShapes()

virtual void BOPAlgo_BuilderArea::PerformInternalShapes ( const Message_ProgressRange & theRange )

protectedpure virtual

Implemented in BOPAlgo_BuilderFace, and BOPAlgo_BuilderSolid.

◆ PerformLoops()

virtual void BOPAlgo_BuilderArea::PerformLoops ( const Message_ProgressRange & theRange )

protectedpure virtual

Implemented in BOPAlgo_BuilderFace, and BOPAlgo_BuilderSolid.

◆ PerformShapesToAvoid()

virtual void BOPAlgo_BuilderArea::PerformShapesToAvoid ( const Message_ProgressRange & theRange )

protectedpure virtual

Implemented in BOPAlgo_BuilderFace, and BOPAlgo_BuilderSolid.

◆ SetAvoidInternalShapes()

void BOPAlgo_BuilderArea::SetAvoidInternalShapes ( const Standard_Boolean theAvoidInternal )

inline

Defines the preventing of addition of internal parts into result. The default value is FALSE, i.e. the internal parts are added into result.

◆ SetContext()

void BOPAlgo_BuilderArea::SetContext ( const Handle< IntTools_Context > & theContext )

inline

Sets the context for the algorithms.

◆ SetShapes()

void BOPAlgo_BuilderArea::SetShapes ( const TopTools_ListOfShape & theLS )

inline

Sets the shapes for building areas.

◆ Shapes()

const TopTools_ListOfShape & BOPAlgo_BuilderArea::Shapes ( ) const

inline

Returns the input shapes.

Field Documentation

◆ myAreas

TopTools_ListOfShape BOPAlgo_BuilderArea::myAreas

protected

◆ myAvoidInternalShapes

Standard_Boolean BOPAlgo_BuilderArea::myAvoidInternalShapes

protected

◆ myContext

Handle< IntTools_Context > BOPAlgo_BuilderArea::myContext

protected

◆ myLoops

TopTools_ListOfShape BOPAlgo_BuilderArea::myLoops

protected

◆ myLoopsInternal

TopTools_ListOfShape BOPAlgo_BuilderArea::myLoopsInternal

protected

◆ myShapes

TopTools_ListOfShape BOPAlgo_BuilderArea::myShapes

protected

◆ myShapesToAvoid

TopTools_IndexedMapOfOrientedShape BOPAlgo_BuilderArea::myShapesToAvoid

protected

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

BOPAlgo_BuilderArea.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BOPAlgo_BuilderArea() [1/2]

◆ ~BOPAlgo_BuilderArea()

◆ BOPAlgo_BuilderArea() [2/2]

Member Function Documentation

◆ Areas()

◆ IsAvoidInternalShapes()

◆ Loops()

◆ PerformAreas()

◆ PerformInternalShapes()

◆ PerformLoops()

◆ PerformShapesToAvoid()

◆ SetAvoidInternalShapes()

◆ SetContext()

◆ SetShapes()

◆ Shapes()

Field Documentation

◆ myAreas

◆ myAvoidInternalShapes

◆ myContext

◆ myLoops

◆ myLoopsInternal

◆ myShapes

◆ myShapesToAvoid