BOPAlgo_ShellSplitter Class Reference

The class provides the splitting of the set of connected faces on separate loops. More...

#include <BOPAlgo_ShellSplitter.hxx>

Inheritance diagram for BOPAlgo_ShellSplitter:

Public Member Functions
	BOPAlgo_ShellSplitter ()
	empty constructor
virtual	~BOPAlgo_ShellSplitter ()
	BOPAlgo_ShellSplitter (const Handle< NCollection_BaseAllocator > &theAllocator)
	constructor
void	AddStartElement (const TopoDS_Shape &theS)
	adds a face <theS> to process
const TopTools_ListOfShape &	StartElements () const
	return the faces to process
virtual void	Perform (const Message_ProgressRange &theRange=Message_ProgressRange()) override
	performs the algorithm
const TopTools_ListOfShape &	Shells () const
	returns the loops
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.

Static Public Member Functions
static void	SplitBlock (BOPTools_ConnexityBlock &theCB)
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.

Protected Member Functions
void	MakeShells (const Message_ProgressRange &theRange)
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
TopTools_ListOfShape	myStartShapes
TopTools_ListOfShape	myShells
BOPTools_ListOfConnexityBlock	myLCB
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.

Detailed Description

The class provides the splitting of the set of connected faces on separate loops.

Constructor & Destructor Documentation

BOPAlgo_ShellSplitter() [1/2]

BOPAlgo_ShellSplitter::BOPAlgo_ShellSplitter

(

)

empty constructor

~BOPAlgo_ShellSplitter()

virtual BOPAlgo_ShellSplitter::~BOPAlgo_ShellSplitter ( )

virtual

BOPAlgo_ShellSplitter() [2/2]

BOPAlgo_ShellSplitter::BOPAlgo_ShellSplitter

(

const Handle< NCollection_BaseAllocator > &

theAllocator

)

constructor

Member Function Documentation

AddStartElement()

void BOPAlgo_ShellSplitter::AddStartElement

(

const TopoDS_Shape &

theS

)

adds a face <theS> to process

MakeShells()

void BOPAlgo_ShellSplitter::MakeShells ( const Message_ProgressRange &  theRange )

protected

Perform()

virtual void BOPAlgo_ShellSplitter::Perform ( const Message_ProgressRange &  theRange = Message_ProgressRange() )

overridevirtual

performs the algorithm

Implements BOPAlgo_Algo.

Shells()

const TopTools_ListOfShape & BOPAlgo_ShellSplitter::Shells

(

)

const

returns the loops

SplitBlock()

static void BOPAlgo_ShellSplitter::SplitBlock ( BOPTools_ConnexityBlock &  theCB )

static

StartElements()

const TopTools_ListOfShape & BOPAlgo_ShellSplitter::StartElements

(

)

const

return the faces to process

Field Documentation

myLCB

BOPTools_ListOfConnexityBlock BOPAlgo_ShellSplitter::myLCB

protected

myShells

TopTools_ListOfShape BOPAlgo_ShellSplitter::myShells

protected

myStartShapes

TopTools_ListOfShape BOPAlgo_ShellSplitter::myStartShapes

protected

---

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

• BOPAlgo_ShellSplitter.hxx