Open CASCADE Technology  7.3.1.dev
Public Member Functions | Protected Member Functions | Protected Attributes
BOPAlgo_BuilderArea Class Referenceabstract

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

#include <BOPAlgo_BuilderArea.hxx>

Inheritance diagram for BOPAlgo_BuilderArea:
Inheritance graph
[legend]

Public Member Functions

void SetContext (const Handle< IntTools_Context > &theContext)
 Sets the context for the algorithms. More...
 
const TopTools_ListOfShapeShapes () const
 Returns the input shapes. More...
 
void SetShapes (const TopTools_ListOfShape &theLS)
 Sets the shapes for building areas. More...
 
const TopTools_ListOfShapeLoops () const
 Returns the found loops. More...
 
const TopTools_ListOfShapeAreas () 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_Algo
virtual void Perform ()=0
 
- 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 Handle< Message_ProgressIndicator > &theObj)
 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

 BOPAlgo_BuilderArea ()
 
virtual ~BOPAlgo_BuilderArea ()
 
 BOPAlgo_BuilderArea (const Handle< NCollection_BaseAllocator > &theAllocator)
 
virtual void PerformShapesToAvoid ()=0
 
virtual void PerformLoops ()=0
 
virtual void PerformAreas ()=0
 
virtual void PerformInternalShapes ()=0
 
- Protected Member Functions inherited from BOPAlgo_Algo
 BOPAlgo_Algo ()
 Default constructor. More...
 
virtual ~BOPAlgo_Algo ()
 
 BOPAlgo_Algo (const Handle< NCollection_BaseAllocator > &theAllocator)
 
virtual void CheckData ()
 Checks input data. More...
 
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

Handle< IntTools_ContextmyContext
 
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_BaseAllocatormyAllocator
 Enables/Disables the usage of OBB. More...
 
Handle< Message_ReportmyReport
 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...
 
Handle< Message_ProgressIndicatormyProgressIndicator
 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 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 ( )
protectedpure virtual

◆ PerformInternalShapes()

virtual void BOPAlgo_BuilderArea::PerformInternalShapes ( )
protectedpure virtual

◆ PerformLoops()

virtual void BOPAlgo_BuilderArea::PerformLoops ( )
protectedpure virtual

◆ PerformShapesToAvoid()

virtual void BOPAlgo_BuilderArea::PerformShapesToAvoid ( )
protectedpure virtual

◆ 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: