The class contains API level of the General Fuse algorithm.
More...

#include <BRepAlgoAPI_BuilderAlgo.hxx>

Inheritance diagram for BRepAlgoAPI_BuilderAlgo:

[legend]

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

virtual	~BRepAlgoAPI_BuilderAlgo ()

	BRepAlgoAPI_BuilderAlgo (const BOPAlgo_PaveFiller &thePF)
	Empty constructor. 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. 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...

void	SetCheckInverted (const Standard_Boolean theCheck)
	Enables/Disables the check of the input solids for inverted status. More...

Standard_Boolean	CheckInverted () const
	Returns the flag defining whether the check for input solids on inverted status should be performed or not. More...

void	SetArguments (const TopTools_ListOfShape &theLS)
	Sets the arguments. More...

const TopTools_ListOfShape &	Arguments () const
	Gets the arguments. More...

virtual void	Build () override
	Performs the algorithm. More...

virtual const TopTools_ListOfShape &	Modified (const TopoDS_Shape &aS) override
	Returns the list of shapes modified from the shape <S>. More...

virtual Standard_Boolean	IsDeleted (const TopoDS_Shape &aS) override
	Returns true if the shape S has been deleted. The result shape of the operation does not contain the shape S. More...

virtual const TopTools_ListOfShape &	Generated (const TopoDS_Shape &S) override
	Returns the list of shapes generated from the shape <S>. For use in BRepNaming. More...

virtual Standard_Boolean	HasModified () const
	Returns true if there is at least one modified shape. For use in BRepNaming. More...

virtual Standard_Boolean	HasGenerated () const
	Returns true if there is at least one generated shape. For use in BRepNaming. More...

virtual Standard_Boolean	HasDeleted () const
	Returns true if there is at least one deleted shape. For use in BRepNaming. More...

const BOPAlgo_PPaveFiller &	DSFiller () const
	Returns the Intersection tool. More...

const BOPAlgo_PBuilder &	Builder () const
	Returns the Building tool. More...

Public Member Functions inherited from BRepAlgoAPI_Algo
virtual const TopoDS_Shape &	Shape () override
	Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built. More...

Public Member Functions inherited from BRepBuilderAPI_MakeShape
	operator TopoDS_Shape ()

Public Member Functions inherited from BRepBuilderAPI_Command
virtual	~BRepBuilderAPI_Command ()

virtual Standard_Boolean	IsDone () const

void	Check () const
	Raises NotDone if done is false. More...

Protected Member Functions
virtual void	Clear () override
	Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared. More...

Protected Member Functions inherited from BRepAlgoAPI_Algo
	BRepAlgoAPI_Algo ()
	Empty constructor. More...

virtual	~BRepAlgoAPI_Algo ()
	Destructor. More...

	BRepAlgoAPI_Algo (const Handle< NCollection_BaseAllocator > &theAllocator)
	Empty constructor. More...

Protected Member Functions inherited from BRepBuilderAPI_MakeShape
	BRepBuilderAPI_MakeShape ()

Protected Member Functions inherited from BRepBuilderAPI_Command
	BRepBuilderAPI_Command ()
	Set done to False. More...

void	Done ()
	Set done to true. More...

void	NotDone ()
	Set done to false. More...

Protected Member Functions inherited from BOPAlgo_Options
void	UserBreak () const
	Breaks the execution if the break signal is indicated by myProgressIndicator. More...

	BOPAlgo_Options ()
	Empty constructor. More...

	BOPAlgo_Options (const Handle< NCollection_BaseAllocator > &theAllocator)
	Constructor with allocator. More...

virtual	~BOPAlgo_Options ()
	Destructor. More...

const Handle< NCollection_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...

void	SetUseOBB (const Standard_Boolean theUseOBB)
	Enables/Disables the usage of OBB. More...

Standard_Boolean	UseOBB () const
	Returns the flag defining usage of OBB. More...

Protected Attributes
Standard_Integer	myEntryType

BOPAlgo_PPaveFiller	myDSFiller

BOPAlgo_PBuilder	myBuilder

Standard_Boolean	myNonDestructive

TopTools_ListOfShape	myArguments

BOPAlgo_GlueEnum	myGlue

Standard_Boolean	myCheckInverted

Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape	myShape

TopTools_ListOfShape	myGenerated

Protected Attributes inherited from BOPAlgo_Options
Handle< NCollection_BaseAllocator >	myAllocator
	Enables/Disables the usage of OBB. More...

Handle< Message_Report >	myReport
	Enables/Disables the usage of OBB. More...

Standard_Boolean	myRunParallel
	Enables/Disables the usage of OBB. More...

Standard_Real	myFuzzyValue
	Enables/Disables the usage of OBB. More...

Handle< Message_ProgressIndicator >	myProgressIndicator
	Enables/Disables the usage of OBB. More...

Standard_Boolean	myUseOBB
	Enables/Disables the usage of OBB. More...

Additional Inherited Members
Static Protected 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 contains API level of the General Fuse algorithm.

Additionally to the options defined in the base class, the algorithm has the following options:

Safe processing mode - allows to avoid modification of the input shapes during the operation (by default it is off);
Gluing options - allows to speed up the calculation of the intersections on the special cases, in which some sub-shapes are coinciding.
Disabling the check for inverted solids - Disables/Enables the check of the input solids for inverted status (holes in the space). The default value is TRUE, i.e. the check is performed. Setting this flag to FALSE for inverted solids, most likely will lead to incorrect results.

It returns the following Error statuses:

0 - in case of success;
BOPAlgo_AlertTooFewArguments - in case there are no enough arguments to perform the operation;
BOPAlgo_AlertIntersectionFailed - in case the intersection of the arguments has failed;
BOPAlgo_AlertBuilderFailed - in case building of the result shape has failed.

Warnings statuses from underlying DS Filler and Builder algorithms are collected in the report.

Constructor & Destructor Documentation

◆ BRepAlgoAPI_BuilderAlgo() [1/2]

BRepAlgoAPI_BuilderAlgo::BRepAlgoAPI_BuilderAlgo ( )

Empty constructor.

◆ ~BRepAlgoAPI_BuilderAlgo()

virtual BRepAlgoAPI_BuilderAlgo::~BRepAlgoAPI_BuilderAlgo ( )

virtual

◆ BRepAlgoAPI_BuilderAlgo() [2/2]

BRepAlgoAPI_BuilderAlgo::BRepAlgoAPI_BuilderAlgo ( const BOPAlgo_PaveFiller & thePF )

Empty constructor.

Member Function Documentation

◆ Arguments()

const TopTools_ListOfShape& BRepAlgoAPI_BuilderAlgo::Arguments ( ) const

Gets the arguments.

◆ Build()

virtual void BRepAlgoAPI_BuilderAlgo::Build ( )

overridevirtual

Performs the algorithm.

H I S T O R Y

Reimplemented from BRepBuilderAPI_MakeShape.

Reimplemented in BRepAlgoAPI_Section, BRepAlgoAPI_BooleanOperation, and BRepAlgoAPI_Splitter.

◆ Builder()

const BOPAlgo_PBuilder& BRepAlgoAPI_BuilderAlgo::Builder ( ) const

inline

Returns the Building tool.

◆ CheckInverted()

Standard_Boolean BRepAlgoAPI_BuilderAlgo::CheckInverted ( ) const

inline

Returns the flag defining whether the check for input solids on inverted status should be performed or not.

◆ Clear()

virtual void BRepAlgoAPI_BuilderAlgo::Clear ( )

overrideprotectedvirtual

Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared.

Reimplemented from BOPAlgo_Options.

Reimplemented in BRepAlgoAPI_BooleanOperation.

◆ DSFiller()

const BOPAlgo_PPaveFiller& BRepAlgoAPI_BuilderAlgo::DSFiller ( ) const

inline

Returns the Intersection tool.

◆ Generated()

virtual const TopTools_ListOfShape& BRepAlgoAPI_BuilderAlgo::Generated ( const TopoDS_Shape & S )

overridevirtual

Returns the list of shapes generated from the shape <S>. For use in BRepNaming.

Reimplemented from BRepBuilderAPI_MakeShape.

Reimplemented in BRepAlgoAPI_BooleanOperation.

◆ Glue()

BOPAlgo_GlueEnum BRepAlgoAPI_BuilderAlgo::Glue ( ) const

Returns the glue option of the algorithm.

◆ HasDeleted()

virtual Standard_Boolean BRepAlgoAPI_BuilderAlgo::HasDeleted ( ) const

virtual

Returns true if there is at least one deleted shape. For use in BRepNaming.

protected methods

Reimplemented in BRepAlgoAPI_BooleanOperation.

◆ HasGenerated()

virtual Standard_Boolean BRepAlgoAPI_BuilderAlgo::HasGenerated ( ) const

virtual

Returns true if there is at least one generated shape. For use in BRepNaming.

Reimplemented in BRepAlgoAPI_BooleanOperation.

◆ HasModified()

virtual Standard_Boolean BRepAlgoAPI_BuilderAlgo::HasModified ( ) const

virtual

Returns true if there is at least one modified shape. For use in BRepNaming.

Reimplemented in BRepAlgoAPI_BooleanOperation.

◆ IsDeleted()

virtual Standard_Boolean BRepAlgoAPI_BuilderAlgo::IsDeleted ( const TopoDS_Shape & aS )

overridevirtual

Returns true if the shape S has been deleted. The result shape of the operation does not contain the shape S.

Reimplemented from BRepBuilderAPI_MakeShape.

Reimplemented in BRepAlgoAPI_BooleanOperation.

◆ Modified()

virtual const TopTools_ListOfShape& BRepAlgoAPI_BuilderAlgo::Modified ( const TopoDS_Shape & aS )

overridevirtual

Returns the list of shapes modified from the shape <S>.

Reimplemented from BRepBuilderAPI_MakeShape.

Reimplemented in BRepAlgoAPI_BooleanOperation.

◆ NonDestructive()

Standard_Boolean BRepAlgoAPI_BuilderAlgo::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.

◆ SetArguments()

void BRepAlgoAPI_BuilderAlgo::SetArguments ( const TopTools_ListOfShape & theLS )

Sets the arguments.

◆ SetCheckInverted()

void BRepAlgoAPI_BuilderAlgo::SetCheckInverted ( const Standard_Boolean theCheck )

inline

Enables/Disables the check of the input solids for inverted status.

◆ SetGlue()

void BRepAlgoAPI_BuilderAlgo::SetGlue ( const BOPAlgo_GlueEnum theGlue )

Sets the glue option for the algorithm.

◆ SetNonDestructive()

void BRepAlgoAPI_BuilderAlgo::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.

Field Documentation

◆ myArguments

TopTools_ListOfShape BRepAlgoAPI_BuilderAlgo::myArguments

protected

◆ myBuilder

BOPAlgo_PBuilder BRepAlgoAPI_BuilderAlgo::myBuilder

protected

◆ myCheckInverted

Standard_Boolean BRepAlgoAPI_BuilderAlgo::myCheckInverted

protected

◆ myDSFiller

BOPAlgo_PPaveFiller BRepAlgoAPI_BuilderAlgo::myDSFiller

protected

◆ myEntryType

Standard_Integer BRepAlgoAPI_BuilderAlgo::myEntryType

protected

◆ myGlue

BOPAlgo_GlueEnum BRepAlgoAPI_BuilderAlgo::myGlue

protected

◆ myNonDestructive

Standard_Boolean BRepAlgoAPI_BuilderAlgo::myNonDestructive

protected

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

BRepAlgoAPI_BuilderAlgo.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BRepAlgoAPI_BuilderAlgo() [1/2]

◆ ~BRepAlgoAPI_BuilderAlgo()

◆ BRepAlgoAPI_BuilderAlgo() [2/2]

Member Function Documentation

◆ Arguments()

◆ Build()

◆ Builder()

◆ CheckInverted()

◆ Clear()

◆ DSFiller()

◆ Generated()

◆ Glue()

◆ HasDeleted()

◆ HasGenerated()

◆ HasModified()

◆ IsDeleted()

◆ Modified()

◆ NonDestructive()

◆ SetArguments()

◆ SetCheckInverted()

◆ SetGlue()

◆ SetNonDestructive()

Field Documentation

◆ myArguments

◆ myBuilder

◆ myCheckInverted

◆ myDSFiller

◆ myEntryType

◆ myGlue

◆ myNonDestructive