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:

Public Member Functions
void *	operator new (size_t, void *anAddress)
void *	operator new (size_t size)
void	operator delete (void *anAddress)
void	SetOperation (const BOP_Operation anOp)
	Sets the type of Boolean operation to perform It can be BOP_SECTION BOP_COMMON BOP_FUSE BOP_CUT BOP_CUT21
virtual void	Build ()
	Provides the algorithm of Boolean Operations
const TopoDS_Shape &	Shape1 () const
	Returns the first shape involved in this Boolean operation.
const TopoDS_Shape &	Shape2 () const
	Returns the second shape involved in this Boolean operation.
BOP_Operation	Operation () const
	Returns the type of Boolean Operation that has been performed.
Standard_Boolean	FuseEdges () const
	Returns the flag of edge refining
void	RefineEdges ()
	Fuse C1 edges
Standard_Boolean	BuilderCanWork () const
Standard_Integer	ErrorStatus () const
	Returns the error status of operation. 0 - Ok 1 - The Object is created but Nothing is Done 2 - Null source shapes is not allowed 3 - Check types of the arguments 4 - Can not allocate memory for the DSFiller 5 - The Builder can not work with such types of arguments 6 - Unknown operation is not allowed 7 - Can not allocate memory for the Builder > 100 - See the Builder's ErrorStatus
virtual const TopTools_ListOfShape &	Modified (const TopoDS_Shape &aS)
	Returns the list of shapes modified from the shape <S>.
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.
virtual const TopTools_ListOfShape &	Modified2 (const TopoDS_Shape &aS)
	Returns the list of shapes modified from the shape <S>. For use in BRepNaming.
virtual const TopTools_ListOfShape &	Generated (const TopoDS_Shape &S)
	Returns the list of shapes generated from the shape <S>. For use in BRepNaming.
virtual Standard_Boolean	HasModified () const
	Returns true if there is at least one modified shape. For use in BRepNaming.
virtual Standard_Boolean	HasGenerated () const
	Returns true if there is at least one generated shape. For use in BRepNaming.
virtual Standard_Boolean	HasDeleted () const
	Returns true if there is at least one deleted shape. For use in BRepNaming.
void	Destroy ()
virtual	~BRepAlgoAPI_BooleanOperation ()
const TopTools_ListOfShape &	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.
Protected Member Functions
	BRepAlgoAPI_BooleanOperation (const TopoDS_Shape &S1, const TopoDS_Shape &S2, const BOP_Operation anOperation)
	Prepares the operations for S1 and S2.
	BRepAlgoAPI_BooleanOperation (const TopoDS_Shape &S1, const TopoDS_Shape &S2, const BOPTools_DSFiller &aDSF, const BOP_Operation anOperation)
	Prepares the operations for S1 and S2.
Standard_Boolean	PrepareFiller ()
Protected Attributes
TopoDS_Shape	myS1
TopoDS_Shape	myS2
Standard_Boolean	myBuilderCanWork
BOP_Operation	myOperation
Standard_Integer	myErrorStatus
BOPTools_PDSFiller	myDSFiller
BOP_PBuilder	myBuilder
Handle_BOP_HistoryCollector	myHistory

---

Detailed Description

• The first one is computing interference between arguments.
  
• The second one is building the result of operation.
  The BooleanOperation class provides execution of both parts
  of the Boolean Operations algorithm. The second part
  (building the result) depends on given type of the Boolean
  Operation (see Constructor).
  

---

Constructor & Destructor Documentation

virtual BRepAlgoAPI_BooleanOperation::~BRepAlgoAPI_BooleanOperation

(

)

[inline, virtual]

BRepAlgoAPI_BooleanOperation::BRepAlgoAPI_BooleanOperation	(	const TopoDS_Shape &	S1,
		const TopoDS_Shape &	S2,
		const BOP_Operation	anOperation
	)		[protected]

BRepAlgoAPI_BooleanOperation::BRepAlgoAPI_BooleanOperation	(	const TopoDS_Shape &	S1,
		const TopoDS_Shape &	S2,
		const BOPTools_DSFiller &	aDSF,
		const BOP_Operation	anOperation
	)		[protected]

---

Member Function Documentation

virtual void BRepAlgoAPI_BooleanOperation::Build

(

)

[virtual]

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

Reimplemented from BRepBuilderAPI_MakeShape.

Reimplemented in BRepAlgoAPI_Section.

Standard_Boolean BRepAlgoAPI_BooleanOperation::BuilderCanWork

(

)

const

void BRepAlgoAPI_BooleanOperation::Destroy

(

)

Standard_Integer BRepAlgoAPI_BooleanOperation::ErrorStatus

(

)

const

Standard_Boolean BRepAlgoAPI_BooleanOperation::FuseEdges

(

)

const

virtual const TopTools_ListOfShape& BRepAlgoAPI_BooleanOperation::Generated

(

const TopoDS_Shape &

S

)

[virtual]

Reimplemented from BRepBuilderAPI_MakeShape.

virtual Standard_Boolean BRepAlgoAPI_BooleanOperation::HasDeleted

(

)

const [virtual]

virtual Standard_Boolean BRepAlgoAPI_BooleanOperation::HasGenerated

(

)

const [virtual]

virtual Standard_Boolean BRepAlgoAPI_BooleanOperation::HasModified

(

)

const [virtual]

virtual Standard_Boolean BRepAlgoAPI_BooleanOperation::IsDeleted

(

const TopoDS_Shape &

aS

)

[virtual]

Reimplemented from BRepBuilderAPI_MakeShape.

virtual const TopTools_ListOfShape& BRepAlgoAPI_BooleanOperation::Modified

(

const TopoDS_Shape &

aS

)

[virtual]

Reimplemented from BRepBuilderAPI_MakeShape.

virtual const TopTools_ListOfShape& BRepAlgoAPI_BooleanOperation::Modified2

(

const TopoDS_Shape &

aS

)

[virtual]

BOP_Operation BRepAlgoAPI_BooleanOperation::Operation

(

)

const

void BRepAlgoAPI_BooleanOperation::operator delete

(

void *

anAddress

)

[inline]

Reimplemented from BRepBuilderAPI_MakeShape.

Reimplemented in BRepAlgoAPI_Fuse, BRepAlgoAPI_Common, BRepAlgoAPI_Cut, and BRepAlgoAPI_Section.

void* BRepAlgoAPI_BooleanOperation::operator new

(

size_t

size

)

[inline]

Reimplemented from BRepBuilderAPI_MakeShape.

Reimplemented in BRepAlgoAPI_Fuse, BRepAlgoAPI_Common, BRepAlgoAPI_Cut, and BRepAlgoAPI_Section.

void* BRepAlgoAPI_BooleanOperation::operator new	(	size_t	,
		void *	anAddress
	)		[inline]

Reimplemented from BRepBuilderAPI_MakeShape.

Reimplemented in BRepAlgoAPI_Fuse, BRepAlgoAPI_Common, BRepAlgoAPI_Cut, and BRepAlgoAPI_Section.

Standard_Boolean BRepAlgoAPI_BooleanOperation::PrepareFiller

(

)

[protected]

void BRepAlgoAPI_BooleanOperation::RefineEdges

(

)

const TopTools_ListOfShape& BRepAlgoAPI_BooleanOperation::SectionEdges

(

)

void BRepAlgoAPI_BooleanOperation::SetOperation

(

const BOP_Operation

anOp

)

const TopoDS_Shape& BRepAlgoAPI_BooleanOperation::Shape1

(

)

const

const TopoDS_Shape& BRepAlgoAPI_BooleanOperation::Shape2

(

)

const

---

Field Documentation

BOP_PBuilder BRepAlgoAPI_BooleanOperation::myBuilder [protected]

Standard_Boolean BRepAlgoAPI_BooleanOperation::myBuilderCanWork [protected]

BOPTools_PDSFiller BRepAlgoAPI_BooleanOperation::myDSFiller [protected]

Standard_Integer BRepAlgoAPI_BooleanOperation::myErrorStatus [protected]

Handle_BOP_HistoryCollector BRepAlgoAPI_BooleanOperation::myHistory [protected]

BOP_Operation BRepAlgoAPI_BooleanOperation::myOperation [protected]

TopoDS_Shape BRepAlgoAPI_BooleanOperation::myS1 [protected]

TopoDS_Shape BRepAlgoAPI_BooleanOperation::myS2 [protected]

---

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

• BRepAlgoAPI_BooleanOperation.hxx