Open CASCADE Technology  7.2.0
Public Member Functions | Protected Member Functions | Protected Attributes
BRepAlgoAPI_BooleanOperation Class Reference

The abstract class BooleanOperation is the root class of Boolean Operations (see Overview). Boolean Operations algorithm is divided onto two parts:
More...

#include <BRepAlgoAPI_BooleanOperation.hxx>

Inheritance diagram for BRepAlgoAPI_BooleanOperation:
Inheritance graph
[legend]

Public Member Functions

const TopoDS_ShapeShape1 () const
 Returns the first argument involved in this Boolean operation. Obsolete. More...
 
const TopoDS_ShapeShape2 () const
 Returns the second argument involved in this Boolean operation. Obsolete. More...
 
void SetTools (const TopTools_ListOfShape &theLS)
 Sets the tools. More...
 
const TopTools_ListOfShapeTools () const
 Gets the tools. More...
 
void SetOperation (const BOPAlgo_Operation anOp)
 Sets the type of Boolean operation. More...
 
BOPAlgo_Operation Operation () const
 Returns the type of Boolean Operation. More...
 
virtual ~BRepAlgoAPI_BooleanOperation ()
 
virtual void Build () override
 Performs the algorithm Filling interference Data Structure (if it is necessary) Building the result of the operation. More...
 
Standard_Boolean BuilderCanWork () const
 Returns True if there was no errors occured obsolete. More...
 
Standard_Boolean FuseEdges () const
 Returns the flag of edge refining. More...
 
void RefineEdges ()
 Fuse C1 edges. More...
 
const TopTools_ListOfShapeSectionEdges ()
 Returns a list of section edges. The edges represent the result of intersection between arguments of Boolean Operation. They are computed during operation execution. 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 override
 Returns true if there is at least one modified shape. For use in BRepNaming. More...
 
virtual Standard_Boolean HasGenerated () const override
 Returns true if there is at least one generated shape. For use in BRepNaming. More...
 
virtual Standard_Boolean HasDeleted () const override
 Returns true if there is at least one deleted shape. For use in BRepNaming. More...
 
- Public Member Functions inherited from BRepAlgoAPI_BuilderAlgo
 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 SetArguments (const TopTools_ListOfShape &theLS)
 Sets the arguments. More...
 
const TopTools_ListOfShapeArguments () const
 Gets the arguments. More...
 
const BOPAlgo_PPaveFillerDSFiller () const
 Returns the Intersection tool. More...
 
const BOPAlgo_PBuilderBuilder () const
 Returns the Building tool. More...
 
- Public Member Functions inherited from BRepAlgoAPI_Algo
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

 BRepAlgoAPI_BooleanOperation ()
 Empty constructor. More...
 
 BRepAlgoAPI_BooleanOperation (const BOPAlgo_PaveFiller &PF)
 Empty constructor <PF> - PaveFiller object that is carried out. More...
 
 BRepAlgoAPI_BooleanOperation (const TopoDS_Shape &S1, const TopoDS_Shape &S2, const BOPAlgo_Operation anOperation)
 Constructor with two arguments <S1>, <S2> -arguments <anOperation> - the type of the operation Obsolete. More...
 
 BRepAlgoAPI_BooleanOperation (const TopoDS_Shape &S1, const TopoDS_Shape &S2, const BOPAlgo_PaveFiller &PF, const BOPAlgo_Operation anOperation)
 Constructor with two arguments <S1>, <S2> -arguments <anOperation> - the type of the operation <PF> - PaveFiller object that is carried out Obsolete. More...
 
virtual void Clear () override
 Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared. More...
 
virtual void SetAttributes ()
 
const TopTools_ListOfShapeRefinedList (const TopTools_ListOfShape &theL)
 Returns the list of shapes generated from the shape <S>. For use in BRepNaming. More...
 
- Protected Member Functions inherited from BRepAlgoAPI_Algo
 BRepAlgoAPI_Algo ()
 Empty constructor. More...
 
virtual ~BRepAlgoAPI_Algo ()
 Destructor. More...
 
 BRepAlgoAPI_Algo (const BOPCol_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 BOPCol_BaseAllocator &theAllocator)
 Constructor with allocator. More...
 
virtual ~BOPAlgo_Options ()
 Destructor. More...
 
const BOPCol_BaseAllocatorAllocator () 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 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...
 

Protected Attributes

TopTools_ListOfShape myTools
 
BOPAlgo_Operation myOperation
 
Standard_Boolean myBuilderCanWork
 
- Protected Attributes inherited from BRepAlgoAPI_BuilderAlgo
Standard_Integer myEntryType
 
BOPAlgo_PPaveFiller myDSFiller
 
BOPAlgo_PBuilder myBuilder
 
Standard_Boolean myNonDestructive
 
TopTools_ListOfShape myArguments
 
BOPAlgo_GlueEnum myGlue
 
- Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape myShape
 
TopTools_ListOfShape myGenerated
 
- Protected Attributes inherited from BOPAlgo_Options
BOPCol_BaseAllocator myAllocator
 Set the Progress Indicator object. More...
 
Handle< Message_ReportmyReport
 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_ProgressIndicatormyProgressIndicator
 Set the Progress Indicator object. 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 abstract class BooleanOperation is the root class of Boolean Operations (see Overview). Boolean Operations algorithm is divided onto two parts:

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

Constructor & Destructor Documentation

◆ ~BRepAlgoAPI_BooleanOperation()

virtual BRepAlgoAPI_BooleanOperation::~BRepAlgoAPI_BooleanOperation ( )
virtual

◆ BRepAlgoAPI_BooleanOperation() [1/4]

BRepAlgoAPI_BooleanOperation::BRepAlgoAPI_BooleanOperation ( )
protected

Empty constructor.

◆ BRepAlgoAPI_BooleanOperation() [2/4]

BRepAlgoAPI_BooleanOperation::BRepAlgoAPI_BooleanOperation ( const BOPAlgo_PaveFiller PF)
protected

Empty constructor <PF> - PaveFiller object that is carried out.

◆ BRepAlgoAPI_BooleanOperation() [3/4]

BRepAlgoAPI_BooleanOperation::BRepAlgoAPI_BooleanOperation ( const TopoDS_Shape S1,
const TopoDS_Shape S2,
const BOPAlgo_Operation  anOperation 
)
protected

Constructor with two arguments <S1>, <S2> -arguments <anOperation> - the type of the operation Obsolete.

◆ BRepAlgoAPI_BooleanOperation() [4/4]

BRepAlgoAPI_BooleanOperation::BRepAlgoAPI_BooleanOperation ( const TopoDS_Shape S1,
const TopoDS_Shape S2,
const BOPAlgo_PaveFiller PF,
const BOPAlgo_Operation  anOperation 
)
protected

Constructor with two arguments <S1>, <S2> -arguments <anOperation> - the type of the operation <PF> - PaveFiller object that is carried out Obsolete.

Member Function Documentation

◆ Build()

virtual void BRepAlgoAPI_BooleanOperation::Build ( )
overridevirtual

Performs the algorithm Filling interference Data Structure (if it is necessary) Building the result of the operation.

Reimplemented from BRepAlgoAPI_BuilderAlgo.

Reimplemented in BRepAlgoAPI_Section.

◆ BuilderCanWork()

Standard_Boolean BRepAlgoAPI_BooleanOperation::BuilderCanWork ( ) const

Returns True if there was no errors occured obsolete.

◆ Clear()

virtual void BRepAlgoAPI_BooleanOperation::Clear ( )
overrideprotectedvirtual

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

Reimplemented from BRepAlgoAPI_BuilderAlgo.

◆ FuseEdges()

Standard_Boolean BRepAlgoAPI_BooleanOperation::FuseEdges ( ) const

Returns the flag of edge refining.

◆ Generated()

virtual const TopTools_ListOfShape& BRepAlgoAPI_BooleanOperation::Generated ( const TopoDS_Shape S)
overridevirtual

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

Reimplemented from BRepAlgoAPI_BuilderAlgo.

◆ HasDeleted()

virtual Standard_Boolean BRepAlgoAPI_BooleanOperation::HasDeleted ( ) const
overridevirtual

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

Reimplemented from BRepAlgoAPI_BuilderAlgo.

◆ HasGenerated()

virtual Standard_Boolean BRepAlgoAPI_BooleanOperation::HasGenerated ( ) const
overridevirtual

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

Reimplemented from BRepAlgoAPI_BuilderAlgo.

◆ HasModified()

virtual Standard_Boolean BRepAlgoAPI_BooleanOperation::HasModified ( ) const
overridevirtual

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

Reimplemented from BRepAlgoAPI_BuilderAlgo.

◆ IsDeleted()

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

◆ Modified()

virtual const TopTools_ListOfShape& BRepAlgoAPI_BooleanOperation::Modified ( const TopoDS_Shape aS)
overridevirtual

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

Reimplemented from BRepAlgoAPI_BuilderAlgo.

◆ Operation()

BOPAlgo_Operation BRepAlgoAPI_BooleanOperation::Operation ( ) const

Returns the type of Boolean Operation.

◆ RefinedList()

const TopTools_ListOfShape& BRepAlgoAPI_BooleanOperation::RefinedList ( const TopTools_ListOfShape theL)
protected

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

◆ RefineEdges()

void BRepAlgoAPI_BooleanOperation::RefineEdges ( )

Fuse C1 edges.

◆ SectionEdges()

const TopTools_ListOfShape& BRepAlgoAPI_BooleanOperation::SectionEdges ( )

Returns a list of section edges. The edges represent the result of intersection between arguments of Boolean Operation. They are computed during operation execution.

◆ SetAttributes()

virtual void BRepAlgoAPI_BooleanOperation::SetAttributes ( )
protectedvirtual

Reimplemented in BRepAlgoAPI_Section.

◆ SetOperation()

void BRepAlgoAPI_BooleanOperation::SetOperation ( const BOPAlgo_Operation  anOp)

Sets the type of Boolean operation.

◆ SetTools()

void BRepAlgoAPI_BooleanOperation::SetTools ( const TopTools_ListOfShape theLS)

Sets the tools.

◆ Shape1()

const TopoDS_Shape& BRepAlgoAPI_BooleanOperation::Shape1 ( ) const

Returns the first argument involved in this Boolean operation. Obsolete.

◆ Shape2()

const TopoDS_Shape& BRepAlgoAPI_BooleanOperation::Shape2 ( ) const

Returns the second argument involved in this Boolean operation. Obsolete.

◆ Tools()

const TopTools_ListOfShape& BRepAlgoAPI_BooleanOperation::Tools ( ) const

Gets the tools.

Field Documentation

◆ myBuilderCanWork

Standard_Boolean BRepAlgoAPI_BooleanOperation::myBuilderCanWork
protected

◆ myOperation

BOPAlgo_Operation BRepAlgoAPI_BooleanOperation::myOperation
protected

◆ myTools

TopTools_ListOfShape BRepAlgoAPI_BooleanOperation::myTools
protected

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