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:

[legend]

Public Member Functions
void	SetOperation (const BOPAlgo_Operation anOp)
	Sets the type of Boolean operation to perform <br> It can be BOPAlgo_SECTION <br> BOPAlgo_COMMON <br> BOPAlgo_FUSE <br> BOPAlgo_CUT <br> BOPAlgo_CUT21 <br> More...

virtual void	Build ()
	Provides the algorithm of Boolean Operations More...

const TopoDS_Shape &	Shape1 () const
	Returns the first shape involved in this Boolean operation. More...

const TopoDS_Shape &	Shape2 () const
	Returns the second shape involved in this Boolean operation. More...

BOPAlgo_Operation	Operation () const
	Returns the type of Boolean Operation that has been performed. More...

Standard_Boolean	FuseEdges () const
	Returns the flag of edge refining More...

void	RefineEdges ()
	Fuse C1 edges More...

Standard_Boolean	BuilderCanWork () const

Standard_Integer	ErrorStatus () const
	Returns the error status of operation. <br> 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 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 <br> 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...

void	Destroy ()

virtual	~BRepAlgoAPI_BooleanOperation ()

const TopTools_ListOfShape &	SectionEdges ()
	Returns a list of section edges. <br> The edges represent the result of intersection between arguments of Boolean Operation. They are computed during operation execution. More...

Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual void	Delete ()

virtual	~BRepBuilderAPI_MakeShape ()

const TopoDS_Shape &	Shape () const
	Returns a shape built by the shape construction algorithm. <br> Raises exception StdFail_NotDone if the shape was not built. More...

	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 (const TopoDS_Shape &S1, const TopoDS_Shape &S2, const BOPAlgo_Operation anOperation)
	Prepares the operations for S1 and S2. More...

	BRepAlgoAPI_BooleanOperation (const TopoDS_Shape &S1, const TopoDS_Shape &S2, const BOPAlgo_PaveFiller &aDSF, const BOPAlgo_Operation anOperation)
	Prepares the operations for S1 and S2. More...

Standard_Boolean	PrepareFiller ()

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
TopoDS_Shape	myS1

TopoDS_Shape	myS2

Standard_Boolean	myBuilderCanWork

BOPAlgo_Operation	myOperation

Standard_Integer	myErrorStatus

BOPAlgo_PPaveFiller	myDSFiller

BOPAlgo_PBOP	myBuilder

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.

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 ( )

inlinevirtual

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

protected

Prepares the operations for S1 and S2.

BRepAlgoAPI_BooleanOperation::BRepAlgoAPI_BooleanOperation	(	const TopoDS_Shape &	S1,
		const TopoDS_Shape &	S2,
		const BOPAlgo_PaveFiller &	aDSF,
		const BOPAlgo_Operation	anOperation
	)

protected

Prepares the operations for S1 and S2.

Member Function Documentation

virtual void BRepAlgoAPI_BooleanOperation::Build ( )

virtual

Provides the algorithm of Boolean Operations

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

Reimplemented from BRepBuilderAPI_MakeShape.

Reimplemented in BRepAlgoAPI_Section, and QANewModTopOpe_Glue.

Standard_Boolean BRepAlgoAPI_BooleanOperation::BuilderCanWork ( ) const

void BRepAlgoAPI_BooleanOperation::Destroy ( )

Standard_Integer BRepAlgoAPI_BooleanOperation::ErrorStatus ( ) const

  Returns the error status of operation. <br>

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

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

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

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

virtual

 Returns true if the shape S has been deleted. The <br>

result shape of the operation does not contain the shape S.

Reimplemented from BRepBuilderAPI_MakeShape.

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

Reimplemented in QANewModTopOpe_Glue.

BOPAlgo_Operation BRepAlgoAPI_BooleanOperation::Operation ( ) const

Returns the type of Boolean Operation that has been performed.

Standard_Boolean BRepAlgoAPI_BooleanOperation::PrepareFiller ( )

protected

void BRepAlgoAPI_BooleanOperation::RefineEdges ( )

Fuse C1 edges

const TopTools_ListOfShape& BRepAlgoAPI_BooleanOperation::SectionEdges ( )

 Returns a list of section edges. <br>

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

void BRepAlgoAPI_BooleanOperation::SetOperation ( const BOPAlgo_Operation anOp )

  Sets the type of Boolean operation to perform <br>
     It can be BOPAlgo_SECTION <br>
               BOPAlgo_COMMON <br>
               BOPAlgo_FUSE <br>
               BOPAlgo_CUT <br>
               BOPAlgo_CUT21 <br>

const TopoDS_Shape& BRepAlgoAPI_BooleanOperation::Shape1 ( ) const

Returns the first shape involved in this Boolean operation.

const TopoDS_Shape& BRepAlgoAPI_BooleanOperation::Shape2 ( ) const

Returns the second shape involved in this Boolean operation.

Field Documentation

BOPAlgo_PBOP BRepAlgoAPI_BooleanOperation::myBuilder

protected

Standard_Boolean BRepAlgoAPI_BooleanOperation::myBuilderCanWork

protected

BOPAlgo_PPaveFiller BRepAlgoAPI_BooleanOperation::myDSFiller

protected

Standard_Integer BRepAlgoAPI_BooleanOperation::myErrorStatus

protected

BOPAlgo_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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation