The Splitter algorithm is the algorithm for splitting a group of arbitrary shapes by the other group of arbitrary shapes.
The arguments of the operation are divided on two groups:
Objects - shapes that will be split;
Tools - shapes by which the Objects will be split.
The result of the operation contains only the split parts of the shapes from the group of Objects.
The split parts of the shapes from the group of Tools are excluded from the result.
The shapes can be split by the other shapes from the same group (in case these shapes are interfering). More...

#include <BOPAlgo_Splitter.hxx>

Inheritance diagram for BOPAlgo_Splitter:

[legend]

Public Member Functions
	BOPAlgo_Splitter ()
	Empty constructor. More...

virtual	~BOPAlgo_Splitter ()

	BOPAlgo_Splitter (const BOPCol_BaseAllocator &theAllocator)

virtual void	Clear () override
	Clears internal fields and arguments. More...

virtual void	AddTool (const TopoDS_Shape &theShape)
	Adds Tool argument of the operation. More...

virtual void	SetTools (const BOPCol_ListOfShape &theShapes)
	Adds the Tool arguments of the operation. More...

const BOPCol_ListOfShape &	Tools () const
	Returns the Tool arguments of the operation. More...

virtual void	Perform () override
	Performs the operation. More...

Public Member Functions inherited from BOPAlgo_Builder
	BOPAlgo_Builder ()

virtual	~BOPAlgo_Builder ()

	BOPAlgo_Builder (const BOPCol_BaseAllocator &theAllocator)

BOPAlgo_PPaveFiller	PPaveFiller ()

BOPDS_PDS	PDS ()

virtual void	AddArgument (const TopoDS_Shape &theShape)

virtual void	SetArguments (const BOPCol_ListOfShape &theLS)

const BOPCol_ListOfShape &	Arguments () const

virtual void	PerformWithFiller (const BOPAlgo_PaveFiller &theFiller)

virtual const TopTools_ListOfShape &	Generated (const TopoDS_Shape &theS) override
	Returns the list of shapes generated from the shape theS. More...

virtual const TopTools_ListOfShape &	Modified (const TopoDS_Shape &theS) override
	Returns the list of shapes modified from the shape theS. More...

virtual Standard_Boolean	IsDeleted (const TopoDS_Shape &theS) override
	Returns true if the shape theS has been deleted. More...

const BOPCol_DataMapOfShapeListOfShape &	Images () const

Standard_Boolean	IsInterferred (const TopoDS_Shape &theS) const

const BOPCol_DataMapOfShapeListOfShape &	Origins () const
	Returns myOrigins. More...

const BOPCol_DataMapOfShapeShape &	ShapesSD () const
	Returns myShapesSD. More...

const BOPCol_DataMapOfShapeListOfShape &	Splits () const
	Returns mySplits. More...

void	SetNonDestructive (const Standard_Boolean theFlag)
	Sets the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated. This flag is taken into account if internal PaveFiller is used only. In the case of calling PerformWithFiller the corresponding flag of that PaveFiller is in force. More...

Standard_Boolean	NonDestructive () const
	Returns the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated. More...

void	SetGlue (const BOPAlgo_GlueEnum theGlue)
	Sets the glue option for the algorithm. More...

BOPAlgo_GlueEnum	Glue () const
	Returns the glue option of the algorithm. More...

Public Member Functions inherited from BOPAlgo_BuilderShape
const TopoDS_Shape &	Shape () const
	Returns the result of algorithm. More...

Standard_Boolean	HasDeleted () const
	Returns true if the at least one shape(or subshape) of arguments has been deleted. More...

Standard_Boolean	HasGenerated () const
	Returns true if the at least one shape(or subshape) of arguments has generated shapes. More...

Standard_Boolean	HasModified () const
	Returns true if the at least one shape(or subshape) of arguments has modified shapes. More...

const BOPCol_IndexedDataMapOfShapeListOfShape &	ImagesResult () const

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

	BOPAlgo_Options (const BOPCol_BaseAllocator &theAllocator)
	Constructor with allocator. More...

virtual	~BOPAlgo_Options ()
	Destructor. More...

const BOPCol_BaseAllocator &	Allocator () const
	Returns allocator. 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	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...

void	SetProgressIndicator (const Handle< Message_ProgressIndicator > &theObj)
	Set the Progress Indicator object. More...

Protected Member Functions
virtual void	CheckData () override
	Checks the input data. More...

Protected Member Functions inherited from BOPAlgo_Builder
virtual void	PrepareHistory () override
	Prepare information for history support. More...

virtual void	PerformInternal (const BOPAlgo_PaveFiller &thePF)

virtual void	PerformInternal1 (const BOPAlgo_PaveFiller &thePF)

void	CheckFiller ()
	Checks if the intersection algorithm has Errors/Warnings. More...

virtual void	Prepare ()

void	FillImagesVertices ()

void	FillImagesEdges ()

virtual void	BuildResult (const TopAbs_ShapeEnum theType)

void	FillImagesContainers (const TopAbs_ShapeEnum theType)

void	FillImagesCompounds ()

void	FillImagesContainer (const TopoDS_Shape &theS, const TopAbs_ShapeEnum theType)

void	FillImagesCompound (const TopoDS_Shape &theS, BOPCol_MapOfShape &theMF)

void	FillImagesFaces ()

virtual void	BuildSplitFaces ()

void	FillSameDomainFaces ()

void	FillImagesFaces1 ()

void	FillImagesSolids ()

void	BuildDraftSolid (const TopoDS_Shape &theSolid, TopoDS_Shape &theDraftSolid, BOPCol_ListOfShape &theLIF)

virtual void	FillIn3DParts (BOPCol_DataMapOfShapeListOfShape &theInParts, BOPCol_DataMapOfShapeShape &theDraftSolids, const BOPCol_BaseAllocator &theAllocator)

void	BuildSplitSolids (BOPCol_DataMapOfShapeListOfShape &theInParts, BOPCol_DataMapOfShapeShape &theDraftSolids, const BOPCol_BaseAllocator &theAllocator)

void	FillInternalShapes ()

virtual void	PostTreat ()

Protected Member Functions inherited from BOPAlgo_BuilderShape
	BOPAlgo_BuilderShape ()

virtual	~BOPAlgo_BuilderShape ()

	BOPAlgo_BuilderShape (const BOPCol_BaseAllocator &theAllocator)

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

virtual	~BOPAlgo_Algo ()

	BOPAlgo_Algo (const BOPCol_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
BOPCol_ListOfShape	myTools

BOPCol_MapOfShape	myMapTools

Protected Attributes inherited from BOPAlgo_Builder
BOPCol_ListOfShape	myArguments

BOPCol_MapOfShape	myMapFence

BOPAlgo_PPaveFiller	myPaveFiller

BOPDS_PDS	myDS

Handle< IntTools_Context >	myContext

Standard_Integer	myEntryPoint

BOPCol_DataMapOfShapeListOfShape	myImages

BOPCol_DataMapOfShapeShape	myShapesSD

BOPCol_DataMapOfShapeListOfShape	mySplits

BOPCol_DataMapOfShapeListOfShape	myOrigins

Standard_Boolean	myNonDestructive

BOPAlgo_GlueEnum	myGlue

Protected Attributes inherited from BOPAlgo_BuilderShape
TopoDS_Shape	myShape

TopTools_ListOfShape	myHistShapes

BOPCol_MapOfShape	myMapShape

Standard_Boolean	myHasDeleted

Standard_Boolean	myHasGenerated

Standard_Boolean	myHasModified

BOPCol_IndexedDataMapOfShapeListOfShape	myImagesResult

Standard_Boolean	myFlagHistory

Protected Attributes inherited from BOPAlgo_Options
BOPCol_BaseAllocator	myAllocator
	Set the Progress Indicator object. More...

Handle< Message_Report >	myReport
	Set the Progress Indicator object. More...

Standard_Boolean	myRunParallel
	Set the Progress Indicator object. More...

Standard_Real	myFuzzyValue
	Set the Progress Indicator object. More...

Handle< Message_ProgressIndicator >	myProgressIndicator
	Set the Progress Indicator object. 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 Splitter algorithm is the algorithm for splitting a group of arbitrary shapes by the other group of arbitrary shapes.
The arguments of the operation are divided on two groups:
Objects - shapes that will be split;
Tools - shapes by which the Objects will be split.
The result of the operation contains only the split parts of the shapes from the group of Objects.
The split parts of the shapes from the group of Tools are excluded from the result.
The shapes can be split by the other shapes from the same group (in case these shapes are interfering).

The class is a General Fuse based algorithm. Thus, all options of the General Fuse algorithm such as Fuzzy mode, safe processing mode, parallel processing mode, gluing mode and history support are also available in this algorithm.
There is no requirement on the existence of the Tools shapes. And if there are no Tools shapes, the result of the splitting operation will be equivalent to the General Fuse result.

The implementation of the algorithm is minimal - only the methods CheckData() and Perform() have been overridden.
The method BOPAlgo_Builder::BuildResult(), which adds the split parts of the arguments into result, does not have to be overridden, because its native implementation performs the necessary actions for the Splitter algorithm - it adds the split parts of only Objects into result, avoiding the split parts of Tools.

Constructor & Destructor Documentation

◆ BOPAlgo_Splitter() [1/2]

BOPAlgo_Splitter::BOPAlgo_Splitter ( )

Empty constructor.

◆ ~BOPAlgo_Splitter()

virtual BOPAlgo_Splitter::~BOPAlgo_Splitter ( )

virtual

◆ BOPAlgo_Splitter() [2/2]

BOPAlgo_Splitter::BOPAlgo_Splitter ( const BOPCol_BaseAllocator & theAllocator )

Member Function Documentation

◆ AddTool()

virtual void BOPAlgo_Splitter::AddTool ( const TopoDS_Shape & theShape )

virtual

Adds Tool argument of the operation.

◆ CheckData()

virtual void BOPAlgo_Splitter::CheckData ( )

overrideprotectedvirtual

Checks the input data.

Reimplemented from BOPAlgo_Builder.

◆ Clear()

virtual void BOPAlgo_Splitter::Clear ( )

overridevirtual

Clears internal fields and arguments.

Reimplemented from BOPAlgo_Builder.

◆ Perform()

virtual void BOPAlgo_Splitter::Perform ( )

overridevirtual

Performs the operation.

Reimplemented from BOPAlgo_Builder.

◆ SetTools()

virtual void BOPAlgo_Splitter::SetTools ( const BOPCol_ListOfShape & theShapes )

virtual

Adds the Tool arguments of the operation.

◆ Tools()

const BOPCol_ListOfShape& BOPAlgo_Splitter::Tools ( ) const

inline

Returns the Tool arguments of the operation.

Field Documentation

◆ myMapTools

BOPCol_MapOfShape BOPAlgo_Splitter::myMapTools

protected

◆ myTools

BOPCol_ListOfShape BOPAlgo_Splitter::myTools

protected

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

BOPAlgo_Splitter.hxx

BOPAlgo_Splitter Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BOPAlgo_Splitter() [1/2]

◆ ~BOPAlgo_Splitter()

◆ BOPAlgo_Splitter() [2/2]

Member Function Documentation

◆ AddTool()

◆ CheckData()

◆ Clear()

◆ Perform()

◆ SetTools()

◆ Tools()

Field Documentation

◆ myMapTools

◆ myTools