The class represents the Building part of the Boolean Operations algorithm.
The arguments of the algorithms are divided in two groups - Objects and Tools.
The algorithm builds the splits of the given arguments using the intersection results and combines the result of Boolean Operation of given type:
More...

#include <BOPAlgo_BOP.hxx>

Inheritance diagram for BOPAlgo_BOP:

[legend]

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

virtual	~BOPAlgo_BOP ()

	BOPAlgo_BOP (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)

void	SetOperation (const BOPAlgo_Operation theOperation)

BOPAlgo_Operation	Operation () const

virtual void	Perform () override

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	SetProgressIndicator (const Handle< Message_ProgressIndicator > &theObj)
	Set the Progress Indicator object. 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
virtual void	CheckData () override
	Checks input data. More...

virtual void	PerformInternal1 (const BOPAlgo_PaveFiller &thePF) override
	Performs calculations using prepared Filler object <thePF> More...

virtual void	BuildResult (const TopAbs_ShapeEnum theType) override

void	BuildShape ()

void	BuildRC ()

void	BuildSolid ()

Standard_Boolean	IsBoundSplits (const TopoDS_Shape &theS, BOPCol_IndexedDataMapOfShapeListOfShape &theMEF)

Standard_Boolean	TreatEmptyShape ()
	Treatment of the cases with empty shapes. It returns TRUE if there is nothing to do, i.e. all shapes in one of the groups are empty shapes. 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)

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

virtual void	Prepare ()

void	FillImagesVertices ()

void	FillImagesEdges ()

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
BOPAlgo_Operation	myOperation

Standard_Integer	myDims [2]

TopoDS_Shape	myRC

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 class represents the Building part of the Boolean Operations algorithm.
The arguments of the algorithms are divided in two groups - Objects and Tools.
The algorithm builds the splits of the given arguments using the intersection results and combines the result of Boolean Operation of given type:

FUSE - union of two groups of objects;
COMMON - intersection of two groups of objects;
CUT - subtraction of one group from the other.

The rules for the arguments and type of the operation are the following:

For Boolean operation FUSE all arguments should have equal dimensions;
For Boolean operation CUT the minimal dimension of Tools should not be less than the maximal dimension of Objects;
For Boolean operation COMMON the arguments can have any dimension.

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.

Additionally to the Warnings of the parent class the algorithm returns the following warnings:

BOPAlgo_AlertEmptyShape - in case some of the input shapes are empty shapes.

Additionally to Errors of the parent class the algorithm returns the following Error statuses:

BOPAlgo_AlertBOPIsNotSet - in case the type of Boolean operation is not set;
BOPAlgo_AlertBOPNotAllowed - in case the operation of given type is not allowed on given inputs;
BOPAlgo_AlertSolidBuilderFailed - in case the BuilderSolid algorithm failed to produce the Fused solid.

Constructor & Destructor Documentation

◆ BOPAlgo_BOP() [1/2]

BOPAlgo_BOP::BOPAlgo_BOP ( )

Empty constructor.

◆ ~BOPAlgo_BOP()

virtual BOPAlgo_BOP::~BOPAlgo_BOP ( )

virtual

◆ BOPAlgo_BOP() [2/2]

BOPAlgo_BOP::BOPAlgo_BOP ( const BOPCol_BaseAllocator & theAllocator )

Member Function Documentation

◆ AddTool()

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

virtual

Adds Tool argument of the operation.

◆ BuildRC()

void BOPAlgo_BOP::BuildRC ( )

protected

◆ BuildResult()

virtual void BOPAlgo_BOP::BuildResult ( const TopAbs_ShapeEnum theType )

overrideprotectedvirtual

Reimplemented from BOPAlgo_Builder.

◆ BuildShape()

void BOPAlgo_BOP::BuildShape ( )

protected

◆ BuildSolid()

void BOPAlgo_BOP::BuildSolid ( )

protected

◆ CheckData()

virtual void BOPAlgo_BOP::CheckData ( )

overrideprotectedvirtual

Checks input data.

Reimplemented from BOPAlgo_Builder.

◆ Clear()

virtual void BOPAlgo_BOP::Clear ( )

overridevirtual

Clears internal fields and arguments.

Reimplemented from BOPAlgo_Builder.

Reimplemented in BRepFeat_Builder.

◆ IsBoundSplits()

Standard_Boolean BOPAlgo_BOP::IsBoundSplits	(	const TopoDS_Shape &	theS,
		BOPCol_IndexedDataMapOfShapeListOfShape &	theMEF
	)

protected

◆ Operation()

BOPAlgo_Operation BOPAlgo_BOP::Operation ( ) const

◆ Perform()

virtual void BOPAlgo_BOP::Perform ( )

overridevirtual

Reimplemented from BOPAlgo_Builder.

◆ PerformInternal1()

virtual void BOPAlgo_BOP::PerformInternal1 ( const BOPAlgo_PaveFiller & thePF )

overrideprotectedvirtual

Performs calculations using prepared Filler object <thePF>

Reimplemented from BOPAlgo_Builder.

◆ SetOperation()

void BOPAlgo_BOP::SetOperation ( const BOPAlgo_Operation theOperation )

◆ SetTools()

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

virtual

◆ TreatEmptyShape()

Standard_Boolean BOPAlgo_BOP::TreatEmptyShape ( )

protected

Treatment of the cases with empty shapes.
It returns TRUE if there is nothing to do, i.e. all shapes in one of the groups are empty shapes.

Field Documentation

◆ myDims

Standard_Integer BOPAlgo_BOP::myDims[2]

protected

◆ myMapTools

BOPCol_MapOfShape BOPAlgo_BOP::myMapTools

protected

◆ myOperation

BOPAlgo_Operation BOPAlgo_BOP::myOperation

protected

◆ myRC

TopoDS_Shape BOPAlgo_BOP::myRC

protected

◆ myTools

BOPCol_ListOfShape BOPAlgo_BOP::myTools

protected

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

BOPAlgo_BOP.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BOPAlgo_BOP() [1/2]

◆ ~BOPAlgo_BOP()

◆ BOPAlgo_BOP() [2/2]

Member Function Documentation

◆ AddTool()

◆ BuildRC()

◆ BuildResult()

◆ BuildShape()

◆ BuildSolid()

◆ CheckData()

◆ Clear()

◆ IsBoundSplits()

◆ Operation()

◆ Perform()

◆ PerformInternal1()

◆ SetOperation()

◆ SetTools()

◆ TreatEmptyShape()

Field Documentation

◆ myDims

◆ myMapTools

◆ myOperation

◆ myRC

◆ myTools