Open CASCADE Technology  6.9.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 ()
 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_ListOfShape
Modified (const TopoDS_Shape &aS)
 Returns the list of shapes modified from the shape <S>. More...
 
virtual Standard_Boolean IsDeleted (const TopoDS_Shape &aS)
 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)
 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_BuilderAlgo
 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 SetArguments (const TopTools_ListOfShape &theLS)
 Sets the arguments. More...
 
const TopTools_ListOfShapeArguments () const
 Gets the arguments. 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 () const
 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
virtual void Delete ()
 
virtual ~BRepBuilderAPI_MakeShape ()
 
 operator TopoDS_Shape () const
 
- 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 ()
 
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 ()
 
 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

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_Real myFuzzyValue
 
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 abstract class BooleanOperation is the root class of Boolean Operations (see Overview). Boolean Operations algorithm is divided onto two parts.

Constructor & Destructor Documentation

virtual BRepAlgoAPI_BooleanOperation::~BRepAlgoAPI_BooleanOperation ( )
virtual
BRepAlgoAPI_BooleanOperation::BRepAlgoAPI_BooleanOperation ( )
protected

Empty constructor.

BRepAlgoAPI_BooleanOperation::BRepAlgoAPI_BooleanOperation ( const BOPAlgo_PaveFiller PF)
protected

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

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::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

virtual void BRepAlgoAPI_BooleanOperation::Build ( )
virtual

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

Standard_Boolean BRepAlgoAPI_BooleanOperation::BuilderCanWork ( ) const

Returns True if there was no errors occured obsolete.

virtual void BRepAlgoAPI_BooleanOperation::Clear ( )
protectedvirtual

Reimplemented from BRepAlgoAPI_BuilderAlgo.

Standard_Boolean BRepAlgoAPI_BooleanOperation::FuseEdges ( ) const

Returns the flag of edge refining.

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

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

Reimplemented from BRepAlgoAPI_BuilderAlgo.

Reimplemented in QANewModTopOpe_Glue, and QANewModTopOpe_Intersection.

virtual Standard_Boolean BRepAlgoAPI_BooleanOperation::HasDeleted ( ) const
virtual

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

Reimplemented from BRepAlgoAPI_BuilderAlgo.

Reimplemented in QANewModTopOpe_Glue, and QANewModTopOpe_Intersection.

virtual Standard_Boolean BRepAlgoAPI_BooleanOperation::HasGenerated ( ) const
virtual

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

Reimplemented from BRepAlgoAPI_BuilderAlgo.

Reimplemented in QANewModTopOpe_Glue, and QANewModTopOpe_Intersection.

virtual Standard_Boolean BRepAlgoAPI_BooleanOperation::HasModified ( ) const
virtual

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

Reimplemented from BRepAlgoAPI_BuilderAlgo.

Reimplemented in QANewModTopOpe_Glue.

virtual Standard_Boolean BRepAlgoAPI_BooleanOperation::IsDeleted ( const TopoDS_Shape aS)
virtual

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.

Reimplemented in QANewModTopOpe_Glue, and QANewModTopOpe_Intersection.

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

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

Reimplemented from BRepAlgoAPI_BuilderAlgo.

Reimplemented in QANewModTopOpe_Glue.

BOPAlgo_Operation BRepAlgoAPI_BooleanOperation::Operation ( ) const

Returns the type of Boolean Operation.

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.

void BRepAlgoAPI_BooleanOperation::RefineEdges ( )

Fuse C1 edges.

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.

virtual void BRepAlgoAPI_BooleanOperation::SetAttributes ( )
protectedvirtual

Reimplemented in BRepAlgoAPI_Section.

void BRepAlgoAPI_BooleanOperation::SetOperation ( const BOPAlgo_Operation  anOp)

Sets the type of Boolean operation.

void BRepAlgoAPI_BooleanOperation::SetTools ( const TopTools_ListOfShape theLS)

Sets the tools.

const TopoDS_Shape& BRepAlgoAPI_BooleanOperation::Shape1 ( ) const

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

const TopoDS_Shape& BRepAlgoAPI_BooleanOperation::Shape2 ( ) const

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

const TopTools_ListOfShape& BRepAlgoAPI_BooleanOperation::Tools ( ) const

Gets the tools.

Field Documentation

Standard_Boolean BRepAlgoAPI_BooleanOperation::myBuilderCanWork
protected
BOPAlgo_Operation BRepAlgoAPI_BooleanOperation::myOperation
protected
TopTools_ListOfShape BRepAlgoAPI_BooleanOperation::myTools
protected

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