The algorithm is to build solids from set of shapes. It uses the BOPAlgo_Builder algorithm to intersect the given shapes and build the images of faces (if needed) and BOPAlgo_BuilderSolid algorithm to build the solids. More...

#include <BOPAlgo_MakerVolume.hxx>

Inheritance diagram for BOPAlgo_MakerVolume:

[legend]

Public Member Functions
	BOPAlgo_MakerVolume ()
	Empty contructor. More...

virtual	~BOPAlgo_MakerVolume ()

	BOPAlgo_MakerVolume (const BOPCol_BaseAllocator &theAllocator)
	Empty contructor. More...

virtual void	Clear () override
	Clears the data. More...

void	SetIntersect (const Standard_Boolean bIntersect)
	Sets the flag myIntersect: if <bIntersect> is TRUE the shapes from <myArguments> will be intersected. if <bIntersect> is FALSE no intersection will be done. More...

Standard_Boolean	IsIntersect () const
	Returns the flag <myIntersect>. More...

const TopoDS_Solid &	Box () const
	Returns the solid box <mySBox>. More...

const BOPCol_ListOfShape &	Faces () const
	Returns the processed faces <myFaces>. More...

void	SetAvoidInternalShapes (const Standard_Boolean theAvoidInternal)
	Defines the preventing of addition of internal for solid parts into the result. By default the internal parts are added into result. More...

Standard_Boolean	IsAvoidInternalShapes () const
	Returns the AvoidInternalShapes flag. 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	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 the data. More...

virtual void	PerformInternal1 (const BOPAlgo_PaveFiller &thePF) override
	Performs the operation. More...

void	CollectFaces ()
	Collects all faces. More...

void	MakeBox (BOPCol_MapOfShape &theBoxFaces)
	Makes solid box. More...

void	BuildSolids (BOPCol_ListOfShape &theLSR)
	Builds solids. More...

void	RemoveBox (BOPCol_ListOfShape &theLSR, const BOPCol_MapOfShape &theBoxFaces)
	Removes the covering box. More...

void	FillInternalShapes (const BOPCol_ListOfShape &theLSR)
	Fills the solids with internal shapes. More...

void	BuildShape (const BOPCol_ListOfShape &theLSR)
	Builds the result. 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 ()

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
Standard_Boolean	myIntersect

Bnd_Box	myBBox

TopoDS_Solid	mySBox

BOPCol_ListOfShape	myFaces

Standard_Boolean	myAvoidInternalShapes

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 algorithm is to build solids from set of shapes. It uses the BOPAlgo_Builder algorithm to intersect the given shapes and build the images of faces (if needed) and BOPAlgo_BuilderSolid algorithm to build the solids.

Steps of the algorithm:

Collect all faces: intersect the shapes if necessary and collect the images of faces, otherwise just collect the faces to the <myFaces> list; All faces on this step added twice, with orientation FORWARD and REVERSED;
Create bounding box covering all the faces from <myFaces> and create solid box from corner points of that bounding box (myBBox, mySBox). Add faces from that box to <myFaces>;
Build solids from <myFaces> using BOPAlgo_BuilderSolid algorithm;
Treat the result: Eliminate solid containig faces from <mySBox>;
Fill internal shapes: add internal vertices and edges into created solids;
Prepare the history.

Fields: <myIntersect> - boolean flag. It defines whether intersect shapes from <myArguments> (if set to TRUE) or not (FALSE). The default value is TRUE. By setting it to FALSE the user should guarantee that shapes in <myArguments> do not interfere with each other, otherwise the result is unpredictable.

<myBBox> - bounding box, covering all faces from <myFaces>.

<mySBox> - Solid box created from the corner points of <myBBox>.

<myFaces> - the list is to keep the "final" faces, that will be given to the BOPAlgo_BuilderSolid algorithm. If the shapes have been interfered it should contain the images of the source shapes, otherwise its just the original faces. It also contains the faces from <mySBox>.

Fields inherited from BOPAlgo_Builder:

<myArguments> - list of the source shapes. The source shapes can have any type, but each shape must not be self-interfered.

<myShape> - Result shape:

empty compound - if no solids were created;
solid - if created only one solid;
compound of solids - if created more than one solid.

Fields inherited from BOPAlgo_Algo:

<myRunParallel> - Defines whether the parallel processing is switched on or not. <myReport> - Error status of the operation. Additionally to the errors of the parent algorithm it can have the following values:

BOPAlgo_AlertSolidBuilderFailed - BOPAlgo_BuilderSolid algorithm has failed.

Example:

BOPAlgo_MakerVolume aMV; // aMV.SetArguments(aLS); //source shapes aMV.SetRunParallel(bRunParallel); //parallel or single mode aMV.SetIntersect(bIntersect); //intersect or not the shapes from <aLS> // aMV.Perform(); //perform the operation if (aMV.HasErrors()) { //check error status return; } // const TopoDS_Shape& aResult = aMV.Shape(); //result of the operation

Constructor & Destructor Documentation

◆ BOPAlgo_MakerVolume() [1/2]

BOPAlgo_MakerVolume::BOPAlgo_MakerVolume ( )

Empty contructor.

◆ ~BOPAlgo_MakerVolume()

virtual BOPAlgo_MakerVolume::~BOPAlgo_MakerVolume ( )

virtual

◆ BOPAlgo_MakerVolume() [2/2]

BOPAlgo_MakerVolume::BOPAlgo_MakerVolume ( const BOPCol_BaseAllocator & theAllocator )

Empty contructor.

Member Function Documentation

◆ Box()

const TopoDS_Solid& BOPAlgo_MakerVolume::Box ( ) const

Returns the solid box <mySBox>.

◆ BuildShape()

void BOPAlgo_MakerVolume::BuildShape ( const BOPCol_ListOfShape & theLSR )

protected

Builds the result.

◆ BuildSolids()

void BOPAlgo_MakerVolume::BuildSolids ( BOPCol_ListOfShape & theLSR )

protected

Builds solids.

◆ CheckData()

virtual void BOPAlgo_MakerVolume::CheckData ( )

overrideprotectedvirtual

Checks the data.

Reimplemented from BOPAlgo_Builder.

◆ Clear()

virtual void BOPAlgo_MakerVolume::Clear ( )

overridevirtual

Clears the data.

Reimplemented from BOPAlgo_Builder.

◆ CollectFaces()

void BOPAlgo_MakerVolume::CollectFaces ( )

protected

Collects all faces.

◆ Faces()

const BOPCol_ListOfShape& BOPAlgo_MakerVolume::Faces ( ) const

Returns the processed faces <myFaces>.

◆ FillInternalShapes()

void BOPAlgo_MakerVolume::FillInternalShapes ( const BOPCol_ListOfShape & theLSR )

protected

Fills the solids with internal shapes.

◆ IsAvoidInternalShapes()

Standard_Boolean BOPAlgo_MakerVolume::IsAvoidInternalShapes ( ) const

inline

Returns the AvoidInternalShapes flag.

◆ IsIntersect()

Standard_Boolean BOPAlgo_MakerVolume::IsIntersect ( ) const

Returns the flag <myIntersect>.

◆ MakeBox()

void BOPAlgo_MakerVolume::MakeBox ( BOPCol_MapOfShape & theBoxFaces )

protected

Makes solid box.

◆ Perform()

virtual void BOPAlgo_MakerVolume::Perform ( )

overridevirtual

Performs the operation.

Reimplemented from BOPAlgo_Builder.

◆ PerformInternal1()

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

overrideprotectedvirtual

Performs the operation.

Reimplemented from BOPAlgo_Builder.

◆ RemoveBox()

void BOPAlgo_MakerVolume::RemoveBox	(	BOPCol_ListOfShape &	theLSR,
		const BOPCol_MapOfShape &	theBoxFaces
	)

protected

Removes the covering box.

◆ SetAvoidInternalShapes()

void BOPAlgo_MakerVolume::SetAvoidInternalShapes ( const Standard_Boolean theAvoidInternal )

inline

Defines the preventing of addition of internal for solid parts into the result. By default the internal parts are added into result.

◆ SetIntersect()

void BOPAlgo_MakerVolume::SetIntersect ( const Standard_Boolean bIntersect )

Sets the flag myIntersect: if <bIntersect> is TRUE the shapes from <myArguments> will be intersected. if <bIntersect> is FALSE no intersection will be done.

Field Documentation

◆ myAvoidInternalShapes

Standard_Boolean BOPAlgo_MakerVolume::myAvoidInternalShapes

protected

◆ myBBox

Bnd_Box BOPAlgo_MakerVolume::myBBox

protected

◆ myFaces

BOPCol_ListOfShape BOPAlgo_MakerVolume::myFaces

protected

◆ myIntersect

Standard_Boolean BOPAlgo_MakerVolume::myIntersect

protected

◆ mySBox

TopoDS_Solid BOPAlgo_MakerVolume::mySBox

protected

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

BOPAlgo_MakerVolume.hxx

BOPAlgo_MakerVolume Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BOPAlgo_MakerVolume() [1/2]

◆ ~BOPAlgo_MakerVolume()

◆ BOPAlgo_MakerVolume() [2/2]

Member Function Documentation

◆ Box()

◆ BuildShape()

◆ BuildSolids()

◆ CheckData()

◆ Clear()

◆ CollectFaces()

◆ Faces()

◆ FillInternalShapes()

◆ IsAvoidInternalShapes()

◆ IsIntersect()

◆ MakeBox()

◆ Perform()

◆ PerformInternal1()

◆ RemoveBox()

◆ SetAvoidInternalShapes()

◆ SetIntersect()

Field Documentation

◆ myAvoidInternalShapes

◆ myBBox

◆ myFaces

◆ myIntersect

◆ mySBox