Open CASCADE Technology
7.2.0
|
The class Cut provides Boolean cut operation between arguments and tools (Boolean Subtraction). More...
#include <BRepAlgoAPI_Cut.hxx>
Public Member Functions | |
BRepAlgoAPI_Cut () | |
Empty constructor. More... | |
virtual | ~BRepAlgoAPI_Cut () |
BRepAlgoAPI_Cut (const BOPAlgo_PaveFiller &PF) | |
Empty constructor <PF> - PaveFiller object that is carried out. More... | |
BRepAlgoAPI_Cut (const TopoDS_Shape &S1, const TopoDS_Shape &S2) | |
Constructor with two shapes <S1> -argument <S2> -tool <anOperation> - the type of the operation Obsolete. More... | |
BRepAlgoAPI_Cut (const TopoDS_Shape &S1, const TopoDS_Shape &S2, const BOPAlgo_PaveFiller &aDSF, const Standard_Boolean bFWD=Standard_True) | |
Constructor with two shapes <S1> -argument <S2> -tool <anOperation> - the type of the operation <PF> - PaveFiller object that is carried out Obsolete. More... | |
Public Member Functions inherited from BRepAlgoAPI_BooleanOperation | |
const TopoDS_Shape & | Shape1 () const |
Returns the first argument involved in this Boolean operation. Obsolete. More... | |
const TopoDS_Shape & | Shape2 () const |
Returns the second argument involved in this Boolean operation. Obsolete. More... | |
void | SetTools (const TopTools_ListOfShape &theLS) |
Sets the tools. More... | |
const TopTools_ListOfShape & | Tools () 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 () override |
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_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. More... | |
virtual const TopTools_ListOfShape & | Modified (const TopoDS_Shape &aS) override |
Returns the list of shapes modified from the shape <S>. More... | |
virtual Standard_Boolean | IsDeleted (const TopoDS_Shape &aS) override |
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) override |
Returns the list of shapes generated from the shape <S>. For use in BRepNaming. More... | |
virtual Standard_Boolean | HasModified () const override |
Returns true if there is at least one modified shape. For use in BRepNaming. More... | |
virtual Standard_Boolean | HasGenerated () const override |
Returns true if there is at least one generated shape. For use in BRepNaming. More... | |
virtual Standard_Boolean | HasDeleted () const override |
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 | SetNonDestructive (const Standard_Boolean theFlag) |
Sets the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated. More... | |
Standard_Boolean | NonDestructive () const |
Returns the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated. More... | |
void | SetGlue (const BOPAlgo_GlueEnum theGlue) |
Sets the glue option for the algorithm. More... | |
BOPAlgo_GlueEnum | Glue () const |
Returns the glue option of the algorithm. More... | |
void | SetArguments (const TopTools_ListOfShape &theLS) |
Sets the arguments. More... | |
const TopTools_ListOfShape & | Arguments () const |
Gets the arguments. More... | |
const BOPAlgo_PPaveFiller & | DSFiller () const |
Returns the Intersection tool. More... | |
const BOPAlgo_PBuilder & | Builder () const |
Returns the Building tool. More... | |
Public Member Functions inherited from BRepAlgoAPI_Algo | |
virtual const TopoDS_Shape & | Shape () override |
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 | |
operator TopoDS_Shape () | |
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 () | |
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 () override |
Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared. More... | |
virtual void | SetAttributes () |
const TopTools_ListOfShape & | RefinedList (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 () |
Destructor. More... | |
BRepAlgoAPI_Algo (const BOPCol_BaseAllocator &theAllocator) | |
Empty constructor. 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 Member Functions inherited from BOPAlgo_Options | |
void | UserBreak () const |
Breaks the execution if the break signal is indicated by myProgressIndicator. More... | |
BOPAlgo_Options () | |
Empty constructor. More... | |
BOPAlgo_Options (const BOPCol_BaseAllocator &theAllocator) | |
Constructor with allocator. More... | |
virtual | ~BOPAlgo_Options () |
Destructor. More... | |
const BOPCol_BaseAllocator & | Allocator () const |
Returns allocator. More... | |
void | AddError (const Handle< Message_Alert > &theAlert) |
Adds the alert as error (fail) More... | |
void | AddWarning (const Handle< Message_Alert > &theAlert) |
Adds the alert as warning. More... | |
Standard_Boolean | HasErrors () const |
Returns true if algorithm has failed. More... | |
Standard_Boolean | HasError (const Handle< Standard_Type > &theType) const |
Returns true if algorithm has generated error of specified type. More... | |
Standard_Boolean | HasWarnings () const |
Returns true if algorithm has generated some warning alerts. More... | |
Standard_Boolean | HasWarning (const Handle< Standard_Type > &theType) const |
Returns true if algorithm has generated warning of specified type. More... | |
const Handle< Message_Report > & | GetReport () const |
Returns report collecting all errors and warnings. More... | |
void | DumpErrors (Standard_OStream &theOS) const |
Dumps the error status into the given stream. More... | |
void | DumpWarnings (Standard_OStream &theOS) const |
Dumps the warning statuses into the given stream. More... | |
void | ClearWarnings () |
Clears the warnings of the algorithm. More... | |
void | SetFuzzyValue (const Standard_Real theFuzz) |
Sets the additional tolerance. More... | |
Standard_Real | FuzzyValue () const |
Returns the additional tolerance. More... | |
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... | |
Static Protected Member Functions inherited from BOPAlgo_Options | |
static Standard_Boolean | GetParallelMode () |
Gets the global parallel mode. More... | |
static void | SetParallelMode (const Standard_Boolean theNewMode) |
Sets the global parallel mode. More... | |
Protected Attributes inherited from BRepAlgoAPI_BooleanOperation | |
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_Boolean | myNonDestructive |
TopTools_ListOfShape | myArguments |
BOPAlgo_GlueEnum | myGlue |
Protected Attributes inherited from BRepBuilderAPI_MakeShape | |
TopoDS_Shape | myShape |
TopTools_ListOfShape | myGenerated |
Protected Attributes inherited from BOPAlgo_Options | |
BOPCol_BaseAllocator | myAllocator |
Set the Progress Indicator object. More... | |
Handle< Message_Report > | myReport |
Set the Progress Indicator object. More... | |
Standard_Boolean | myRunParallel |
Set the Progress Indicator object. More... | |
Standard_Real | myFuzzyValue |
Set the Progress Indicator object. More... | |
Handle< Message_ProgressIndicator > | myProgressIndicator |
Set the Progress Indicator object. More... | |
The class Cut provides Boolean cut operation between arguments and tools (Boolean Subtraction).
BRepAlgoAPI_Cut::BRepAlgoAPI_Cut | ( | ) |
Empty constructor.
|
virtual |
BRepAlgoAPI_Cut::BRepAlgoAPI_Cut | ( | const BOPAlgo_PaveFiller & | PF | ) |
Empty constructor <PF> - PaveFiller object that is carried out.
BRepAlgoAPI_Cut::BRepAlgoAPI_Cut | ( | const TopoDS_Shape & | S1, |
const TopoDS_Shape & | S2 | ||
) |
Constructor with two shapes <S1> -argument <S2> -tool <anOperation> - the type of the operation Obsolete.
BRepAlgoAPI_Cut::BRepAlgoAPI_Cut | ( | const TopoDS_Shape & | S1, |
const TopoDS_Shape & | S2, | ||
const BOPAlgo_PaveFiller & | aDSF, | ||
const Standard_Boolean | bFWD = Standard_True |
||
) |
Constructor with two shapes <S1> -argument <S2> -tool <anOperation> - the type of the operation <PF> - PaveFiller object that is carried out Obsolete.