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
	~BOPAlgo_ShellSplitter () override
	BOPAlgo_ShellSplitter (const occ::handle< NCollection_BaseAllocator > &theAllocator)
	constructor
void	AddStartElement (const TopoDS_Shape &theS)
	adds a face <theS> to process
const NCollection_List< TopoDS_Shape > &	StartElements () const
	return the faces to process
void	Perform (const Message_ProgressRange &theRange=Message_ProgressRange()) override
	performs the algorithm
const NCollection_List< TopoDS_Shape > &	Shells () const
	returns the loops
Public Member Functions inherited from BOPAlgo_Options
	BOPAlgo_Options ()
	Empty constructor.
	BOPAlgo_Options (const occ::handle< NCollection_BaseAllocator > &theAllocator)
	Constructor with allocator.
virtual	~BOPAlgo_Options ()
	Destructor.
const occ::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 occ::handle< Message_Alert > &theAlert)
	Adds the alert as error (fail).
void	AddWarning (const occ::handle< Message_Alert > &theAlert)
	Adds the alert as warning.
bool	HasErrors () const
	Returns true if algorithm has failed.
bool	HasError (const occ::handle< Standard_Type > &theType) const
	Returns true if algorithm has generated error of specified type.
bool	HasWarnings () const
	Returns true if algorithm has generated some warning alerts.
bool	HasWarning (const occ::handle< Standard_Type > &theType) const
	Returns true if algorithm has generated warning of specified type.
const occ::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 double theFuzz)
	Sets the additional tolerance.
double	FuzzyValue () const
	Returns the additional tolerance.
void	SetUseOBB (const bool theUseOBB)
	Enables/Disables the usage of OBB.
bool	UseOBB () const
	Returns the flag defining usage of OBB.
void	SetRunParallel (const bool 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.
bool	RunParallel () const
	Returns the flag of parallel processing.

Static Public Member Functions
static void	SplitBlock (BOPTools_ConnexityBlock &theCB)
static bool	GetParallelMode ()
	Gets the global parallel mode.
static void	SetParallelMode (const bool 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.
	~BOPAlgo_Algo () override
	BOPAlgo_Algo (const occ::handle< NCollection_BaseAllocator > &theAllocator)
virtual void	CheckData ()
	Checks input data.
virtual void	CheckResult ()
	Checks the obtained result.
void	analyzeProgress (const double theWhole, BOPAlgo_PISteps &theSteps) const
	Fills the values for constant operations - the operations having constant relative running time.
virtual void	fillPIConstants (const double 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.
bool	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
NCollection_List< TopoDS_Shape >	myStartShapes
NCollection_List< TopoDS_Shape >	myShells
NCollection_List< BOPTools_ConnexityBlock >	myLCB
occ::handle< NCollection_BaseAllocator >	myAllocator
	Enables/Disables the usage of OBB.
occ::handle< Message_Report >	myReport
	Enables/Disables the usage of OBB.
bool	myRunParallel
	Enables/Disables the usage of OBB.
double	myFuzzyValue
	Enables/Disables the usage of OBB.
bool	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()

BOPAlgo_ShellSplitter::~BOPAlgo_ShellSplitter ( )

override

BOPAlgo_ShellSplitter() [2/2]

BOPAlgo_ShellSplitter::BOPAlgo_ShellSplitter

(

const occ::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()

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

overridevirtual

performs the algorithm

Implements BOPAlgo_Algo.

Shells()

const NCollection_List< TopoDS_Shape > & BOPAlgo_ShellSplitter::Shells

(

)

const

returns the loops

SplitBlock()

void BOPAlgo_ShellSplitter::SplitBlock ( BOPTools_ConnexityBlock & theCB )

static

StartElements()

const NCollection_List< TopoDS_Shape > & BOPAlgo_ShellSplitter::StartElements

(

)

const

return the faces to process

Field Documentation

myLCB

NCollection_List<BOPTools_ConnexityBlock> BOPAlgo_ShellSplitter::myLCB

protected

myShells

NCollection_List<TopoDS_Shape> BOPAlgo_ShellSplitter::myShells

protected

myStartShapes

NCollection_List<TopoDS_Shape> BOPAlgo_ShellSplitter::myStartShapes

protected

---

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

• BOPAlgo_ShellSplitter.hxx