Provides the root interface for the API algorithms. More...

#include <BRepAlgoAPI_Algo.hxx>

Inheritance diagram for BRepAlgoAPI_Algo:

[legend]

Public Member Functions
virtual const TopoDS_Shape &	Shape () override
	Returns a shape built by the shape construction algorithm. Does not check if the shape is built.

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

void	ClearWarnings ()
	Clears the warnings of the algorithm.

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.

Standard_Real	FuzzyValue () const
	Returns the additional tolerance.

const Handle< Message_Report > &	GetReport () const
	Returns report collecting all errors and warnings.

Standard_Boolean	HasError (const Handle< Standard_Type > &theType) const
	Returns true if algorithm has generated error of specified type.

Standard_Boolean	HasErrors () const
	Returns true if algorithm has failed.

Standard_Boolean	HasWarning (const Handle< Standard_Type > &theType) const
	Returns true if algorithm has generated warning of specified type.

Standard_Boolean	HasWarnings () const
	Returns true if algorithm has generated some warning alerts.

Standard_Boolean	RunParallel () const
	Returns the flag of parallel processing.

void	SetFuzzyValue (const Standard_Real theFuzz)
	Sets the additional tolerance.

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.

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

Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual void	Build (const Message_ProgressRange &theRange=Message_ProgressRange())
	This is called by Shape(). It does nothing but may be redefined.

	operator TopoDS_Shape ()

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

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

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

Public Member Functions inherited from BRepBuilderAPI_Command
virtual	~BRepBuilderAPI_Command ()

virtual Standard_Boolean	IsDone () const

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

Protected Member Functions
	BRepAlgoAPI_Algo ()
	Empty constructor.

virtual	~BRepAlgoAPI_Algo ()
	Destructor.

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

Protected Member Functions inherited from BRepBuilderAPI_MakeShape
	BRepBuilderAPI_MakeShape ()

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

void	Done ()
	Set done to true.

void	NotDone ()
	Set done to false.

Standard_Boolean	UserBreak (const Message_ProgressScope &thePS)
	Adds error to the report if the break signal was caught. Returns true in this case, false otherwise.

	BOPAlgo_Options ()
	Empty constructor.

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

virtual	~BOPAlgo_Options ()
	Destructor.

const Handle< NCollection_BaseAllocator > &	Allocator () const
	Returns allocator.

void	AddError (const Handle< Message_Alert > &theAlert)
	Adds the alert as error (fail)

void	AddWarning (const Handle< Message_Alert > &theAlert)
	Adds the alert as warning.

Standard_Boolean	HasErrors () const
	Returns true if algorithm has failed.

Standard_Boolean	HasError (const Handle< Standard_Type > &theType) const
	Returns true if algorithm has generated error of specified type.

Standard_Boolean	HasWarnings () const
	Returns true if algorithm has generated some warning alerts.

Standard_Boolean	HasWarning (const Handle< Standard_Type > &theType) const
	Returns true if algorithm has generated warning of specified type.

const 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 Standard_Real theFuzz)
	Sets the additional tolerance.

Standard_Real	FuzzyValue () const
	Returns the additional tolerance.

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

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

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.

Standard_Boolean	RunParallel () const
	Returns the flag of parallel processing.

Additional Inherited Members
static Standard_Boolean	GetParallelMode ()
	Gets the global parallel mode.

static void	SetParallelMode (const Standard_Boolean theNewMode)
	Sets the global parallel mode.

Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape	myShape

TopTools_ListOfShape	myGenerated

Handle< NCollection_BaseAllocator >	myAllocator
	Enables/Disables the usage of OBB.

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

Standard_Boolean	myRunParallel
	Enables/Disables the usage of OBB.

Standard_Real	myFuzzyValue
	Enables/Disables the usage of OBB.

Standard_Boolean	myUseOBB
	Enables/Disables the usage of OBB.

Detailed Description

Provides the root interface for the API algorithms.

Constructor & Destructor Documentation

◆ BRepAlgoAPI_Algo() [1/2]

BRepAlgoAPI_Algo::BRepAlgoAPI_Algo ( )

protected

Empty constructor.

◆ ~BRepAlgoAPI_Algo()

virtual BRepAlgoAPI_Algo::~BRepAlgoAPI_Algo ( )

protectedvirtual

Destructor.

◆ BRepAlgoAPI_Algo() [2/2]

BRepAlgoAPI_Algo::BRepAlgoAPI_Algo ( const Handle< NCollection_BaseAllocator > & theAllocator )

protected

Empty constructor.

Member Function Documentation

◆ Clear()

virtual void BOPAlgo_Options::Clear ( )

inlinevirtual

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_BuilderAlgo, and BRepAlgoAPI_Defeaturing.

◆ ClearWarnings()

void BOPAlgo_Options::ClearWarnings ( )

inline

Clears the warnings of the algorithm.

◆ DumpErrors()

void BOPAlgo_Options::DumpErrors ( Standard_OStream & theOS ) const

Dumps the error status into the given stream.

◆ DumpWarnings()

void BOPAlgo_Options::DumpWarnings ( Standard_OStream & theOS ) const

Dumps the warning statuses into the given stream.

◆ FuzzyValue()

Standard_Real BOPAlgo_Options::FuzzyValue ( ) const

inline

Returns the additional tolerance.

◆ GetReport()

const Handle< Message_Report > & BOPAlgo_Options::GetReport ( ) const

inline

Returns report collecting all errors and warnings.

◆ HasError()

Standard_Boolean BOPAlgo_Options::HasError ( const Handle< Standard_Type > & theType ) const

inline

Returns true if algorithm has generated error of specified type.

◆ HasErrors()

Standard_Boolean BOPAlgo_Options::HasErrors ( ) const

inline

Returns true if algorithm has failed.

◆ HasWarning()

Standard_Boolean BOPAlgo_Options::HasWarning ( const Handle< Standard_Type > & theType ) const

inline

Returns true if algorithm has generated warning of specified type.

◆ HasWarnings()

Standard_Boolean BOPAlgo_Options::HasWarnings ( ) const

inline

Returns true if algorithm has generated some warning alerts.

◆ RunParallel()

Standard_Boolean BOPAlgo_Options::RunParallel ( ) const

inline

Returns the flag of parallel processing.

◆ SetFuzzyValue()

void BOPAlgo_Options::SetFuzzyValue ( const Standard_Real theFuzz )

Sets the additional tolerance.

◆ SetRunParallel()

void BOPAlgo_Options::SetRunParallel ( const Standard_Boolean theFlag )

inline

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.

◆ SetUseOBB()

void BOPAlgo_Options::SetUseOBB ( const Standard_Boolean theUseOBB )

inline

Enables/Disables the usage of OBB.

◆ Shape()

virtual const TopoDS_Shape & BRepAlgoAPI_Algo::Shape ( )

overridevirtual

Returns a shape built by the shape construction algorithm. Does not check if the shape is built.

Reimplemented from BRepBuilderAPI_MakeShape.

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

BRepAlgoAPI_Algo.hxx

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BRepAlgoAPI_Algo() [1/2]

◆ ~BRepAlgoAPI_Algo()

◆ BRepAlgoAPI_Algo() [2/2]

Member Function Documentation

◆ Clear()

◆ ClearWarnings()

◆ DumpErrors()

◆ DumpWarnings()

◆ FuzzyValue()

◆ GetReport()

◆ HasError()

◆ HasErrors()

◆ HasWarning()

◆ HasWarnings()

◆ RunParallel()

◆ SetFuzzyValue()

◆ SetRunParallel()

◆ SetUseOBB()

◆ Shape()