Created on: 1993-10-14
Created by: Remi LEQUETTE
Copyright (c) 1993-1999 Matra Datavision
Copyright (c) 1999-2014 OPEN CASCADE SAS

This file is part of Open CASCADE Technology software library.

This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License version 2.1 as published
by the Free Software Foundation, with special exception defined in the file
OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
distribution for complete text of the license and disclaimer of any warranty.

Alternatively, this file may be used under the terms of Open CASCADE
commercial license or contractual agreement.
//! The class Cut provides a Boolean
cut operation on a pair of arguments (Boolean Subtraction).
The class Cut provides a framework for:
More...

#include <BRepAlgoAPI_Cut.hxx>

Inheritance diagram for BRepAlgoAPI_Cut:

[legend]

Public Member Functions
	BRepAlgoAPI_Cut (const TopoDS_Shape &S1, const TopoDS_Shape &S2)
	Shape aS2 cuts shape aS1. The <br> resulting shape is a new shape produced by the cut operation. More...

	BRepAlgoAPI_Cut (const TopoDS_Shape &S1, const TopoDS_Shape &S2, const BOPAlgo_PaveFiller &aDSF, const Standard_Boolean bFWD=Standard_True)
	Constructs a new shape cut from <br> shape aS1 by shape aS2 using aDSFiller (see BRepAlgoAPI_BooleanOperation Constructor). More...

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

Created on: 1993-10-14
Created by: Remi LEQUETTE
Copyright (c) 1993-1999 Matra Datavision
Copyright (c) 1999-2014 OPEN CASCADE SAS

This file is part of Open CASCADE Technology software library.

This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License version 2.1 as published
by the Free Software Foundation, with special exception defined in the file
OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
distribution for complete text of the license and disclaimer of any warranty.

Alternatively, this file may be used under the terms of Open CASCADE
commercial license or contractual agreement.
//! The class Cut provides a Boolean
cut operation on a pair of arguments (Boolean Subtraction).
The class Cut provides a framework for:

Defining the construction of a cut shape
Implementing the building algorithm
Consulting the result

Constructor & Destructor Documentation

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

 Shape aS2 cuts shape aS1. The <br>

resulting shape is a new shape produced by the cut operation.

BRepAlgoAPI_Cut::BRepAlgoAPI_Cut	(	const TopoDS_Shape &	S1,
		const TopoDS_Shape &	S2,
		const BOPAlgo_PaveFiller &	aDSF,
		const Standard_Boolean	bFWD = `Standard_True`
	)

 Constructs a new shape cut from <br>

shape aS1 by shape aS2 using aDSFiller (see
BRepAlgoAPI_BooleanOperation Constructor).

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

BRepAlgoAPI_Cut.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation