Open CASCADE Technology  7.0.0
Public Member Functions | Protected Member Functions | Protected Attributes
BRepAlgoAPI_BuilderAlgo Class Reference

The clsss contains API level of General Fuse algorithm. More...

#include <BRepAlgoAPI_BuilderAlgo.hxx>

Inheritance diagram for BRepAlgoAPI_BuilderAlgo:
Inheritance graph
[legend]

Public Member Functions

 BRepAlgoAPI_BuilderAlgo ()
 Empty constructor. More...
 
virtual ~BRepAlgoAPI_BuilderAlgo ()
 
 BRepAlgoAPI_BuilderAlgo (const BOPAlgo_PaveFiller &thePF)
 Empty constructor. More...
 
void SetFuzzyValue (const Standard_Real theFuzz)
 Sets the additional tolerance. More...
 
Standard_Real FuzzyValue () const
 Returns the additional tolerance. 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 SetArguments (const TopTools_ListOfShape &theLS)
 Sets the arguments. More...
 
const TopTools_ListOfShapeArguments () const
 Gets the arguments. More...
 
virtual void Build () override
 Performs the algorithm. More...
 
virtual const TopTools_ListOfShapeModified (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_ListOfShapeGenerated (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...
 
- Public Member Functions inherited from BRepAlgoAPI_Algo
Standard_Integer ErrorStatus () const
 Returns error status of the algorithm ==0 - no errors occured !=0 - is in the event of various error conditions. More...
 
Standard_Integer WarningStatus () const
 Returns warning status of the algorithm ==0 - no warning occured !=0 - is in the event of various warning conditions. More...
 
const BOPCol_BaseAllocatorAllocator () const
 
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...
 
virtual const TopoDS_ShapeShape () 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
 
- Protected Member Functions inherited from BRepAlgoAPI_Algo
 BRepAlgoAPI_Algo ()
 Empty constructor. More...
 
virtual ~BRepAlgoAPI_Algo ()
 
 BRepAlgoAPI_Algo (const BOPCol_BaseAllocator &theAllocator)
 Empty constructor. More...
 
void UserBreak () const
 Breaks the execution if the break signal is indicated by myProgressIndicator. 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 Attributes

Standard_Integer myEntryType
 
BOPAlgo_PPaveFiller myDSFiller
 
BOPAlgo_PBuilder myBuilder
 
Standard_Real myFuzzyValue
 
Standard_Boolean myNonDestructive
 
TopTools_ListOfShape myArguments
 
- Protected Attributes inherited from BRepAlgoAPI_Algo
BOPCol_BaseAllocator myAllocator
 
Standard_Integer myErrorStatus
 
Standard_Integer myWarningStatus
 
Standard_Boolean myRunParallel
 
Handle< Message_ProgressIndicatormyProgressIndicator
 
- Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape myShape
 
TopTools_ListOfShape myGenerated
 

Detailed Description

The clsss contains API level of General Fuse algorithm.

Constructor & Destructor Documentation

BRepAlgoAPI_BuilderAlgo::BRepAlgoAPI_BuilderAlgo ( )

Empty constructor.

virtual BRepAlgoAPI_BuilderAlgo::~BRepAlgoAPI_BuilderAlgo ( )
virtual
BRepAlgoAPI_BuilderAlgo::BRepAlgoAPI_BuilderAlgo ( const BOPAlgo_PaveFiller thePF)

Empty constructor.

Member Function Documentation

const TopTools_ListOfShape& BRepAlgoAPI_BuilderAlgo::Arguments ( ) const

Gets the arguments.

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 QANewModTopOpe_Glue.

virtual void BRepAlgoAPI_BuilderAlgo::Clear ( )
overrideprotectedvirtual

Reimplemented from BRepAlgoAPI_Algo.

Reimplemented in BRepAlgoAPI_BooleanOperation.

Standard_Real BRepAlgoAPI_BuilderAlgo::FuzzyValue ( ) const

Returns the additional tolerance.

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, QANewModTopOpe_Glue, and QANewModTopOpe_Intersection.

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, QANewModTopOpe_Glue, and QANewModTopOpe_Intersection.

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, QANewModTopOpe_Glue, and QANewModTopOpe_Intersection.

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, and QANewModTopOpe_Glue.

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, QANewModTopOpe_Glue, and QANewModTopOpe_Intersection.

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, and QANewModTopOpe_Glue.

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.

void BRepAlgoAPI_BuilderAlgo::SetArguments ( const TopTools_ListOfShape theLS)

Sets the arguments.

void BRepAlgoAPI_BuilderAlgo::SetFuzzyValue ( const Standard_Real  theFuzz)

Sets the additional tolerance.

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

TopTools_ListOfShape BRepAlgoAPI_BuilderAlgo::myArguments
protected
BOPAlgo_PBuilder BRepAlgoAPI_BuilderAlgo::myBuilder
protected
BOPAlgo_PPaveFiller BRepAlgoAPI_BuilderAlgo::myDSFiller
protected
Standard_Integer BRepAlgoAPI_BuilderAlgo::myEntryType
protected
Standard_Real BRepAlgoAPI_BuilderAlgo::myFuzzyValue
protected
Standard_Boolean BRepAlgoAPI_BuilderAlgo::myNonDestructive
protected

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