BRepAlgoAPI_Common Class Reference

The class Common provides a
Boolean common operation on a pair of arguments (Boolean Intersection).
The class Common provides a framework for:
More...

#include <BRepAlgoAPI_Common.hxx>

Inheritance diagram for BRepAlgoAPI_Common:

Public Member Functions
	BRepAlgoAPI_Common (const TopoDS_Shape &S1, const TopoDS_Shape &S2)
	Constructs a common part for shapes aS1 and aS2 . More...
	BRepAlgoAPI_Common (const TopoDS_Shape &S1, const TopoDS_Shape &S2, const BOPAlgo_PaveFiller &aDSF)
Public Member Functions inherited from BRepAlgoAPI_BooleanOperation
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...

Additional Inherited Members
Protected Member Functions inherited from BRepAlgoAPI_BooleanOperation
	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 inherited from BRepAlgoAPI_BooleanOperation
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 class Common provides a
Boolean common operation on a pair of arguments (Boolean Intersection).
The class Common provides a framework for:

• Defining the construction of a common shape;
  
• Implementing the building algorithm
  
• Consulting the result.
  

Constructor & Destructor Documentation

BRepAlgoAPI_Common::BRepAlgoAPI_Common	(	const TopoDS_Shape &	S1,
		const TopoDS_Shape &	S2
	)

Constructs a common part for shapes aS1 and aS2 .

BRepAlgoAPI_Common::BRepAlgoAPI_Common	(	const TopoDS_Shape &	S1,
		const TopoDS_Shape &	S2,
		const BOPAlgo_PaveFiller &	aDSF
	)

---

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

• BRepAlgoAPI_Common.hxx