Open CASCADE Technology  7.2.0
Public Member Functions | Protected Attributes

BRepAlgoAPI_Splitter Class Reference

The class contains API level of the Splitter algorithm, which allows splitting a group of arbitrary shapes by the other group of arbitrary shapes.
The arguments of the operation are divided on two groups:
Objects - shapes that will be split;
Tools - shapes by which the Objects will be split.
The result of the operation contains only the split parts of the shapes from the group of Objects.
The split parts of the shapes from the group of Tools are excluded from the result.
The shapes can be split by the other shapes from the same group (in case these shapes are interfering). More...

#include <BRepAlgoAPI_Splitter.hxx>

Inheritance diagram for BRepAlgoAPI_Splitter:
Inheritance graph
[legend]

Public Member Functions

 BRepAlgoAPI_Splitter ()
 Empty constructor. More...
 
virtual ~BRepAlgoAPI_Splitter ()
 
 BRepAlgoAPI_Splitter (const BOPAlgo_PaveFiller &thePF)
 Constructor with already filled PaveFiller. More...
 
virtual void Build () override
 Performs the algorithm.
Performs the intersection of the objects with tools and build the result of the operation. More...
 
void SetTools (const TopTools_ListOfShape &theLS)
 Sets the tools. More...
 
const TopTools_ListOfShapeTools () const
 Gets the tools. 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_ListOfShapeArguments () const
 Gets the arguments. More...
 
virtual const TopTools_ListOfShapeModified (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_ListOfShapeGenerated (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
 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...
 
const BOPAlgo_PPaveFillerDSFiller () const
 Returns the Intersection tool. More...
 
const BOPAlgo_PBuilderBuilder () const
 Returns the Building tool. More...
 
- Public Member Functions inherited from BRepAlgoAPI_Algo
virtual const TopoDS_ShapeShape () 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...
 

Protected Attributes

TopTools_ListOfShape myTools
 Tools arguments of the operation. More...
 
- 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_ReportmyReport
 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_ProgressIndicatormyProgressIndicator
 Set the Progress Indicator object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from BRepAlgoAPI_BuilderAlgo
virtual void Clear () override
 Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared. 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_BaseAllocatorAllocator () 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...
 

Detailed Description

The class contains API level of the Splitter algorithm, which allows splitting a group of arbitrary shapes by the other group of arbitrary shapes.
The arguments of the operation are divided on two groups:
Objects - shapes that will be split;
Tools - shapes by which the Objects will be split.
The result of the operation contains only the split parts of the shapes from the group of Objects.
The split parts of the shapes from the group of Tools are excluded from the result.
The shapes can be split by the other shapes from the same group (in case these shapes are interfering).

The class is a General Fuse based algorithm. Thus, all options of the General Fuse algorithm such as Fuzzy mode, safe processing mode, parallel processing mode, gluing mode and history support are also available in this algorithm.
There is no requirement on the existence of the Tools shapes. And if there are no Tools shapes, the result of the splitting operation will be equivalent to the General Fuse result.

The algorithm returns the following Error statuses:

Constructor & Destructor Documentation

◆ BRepAlgoAPI_Splitter() [1/2]

BRepAlgoAPI_Splitter::BRepAlgoAPI_Splitter ( )

Empty constructor.

◆ ~BRepAlgoAPI_Splitter()

virtual BRepAlgoAPI_Splitter::~BRepAlgoAPI_Splitter ( )
virtual

◆ BRepAlgoAPI_Splitter() [2/2]

BRepAlgoAPI_Splitter::BRepAlgoAPI_Splitter ( const BOPAlgo_PaveFiller thePF)

Constructor with already filled PaveFiller.

Member Function Documentation

◆ Build()

virtual void BRepAlgoAPI_Splitter::Build ( )
overridevirtual

Performs the algorithm.
Performs the intersection of the objects with tools and build the result of the operation.

Reimplemented from BRepAlgoAPI_BuilderAlgo.

◆ SetTools()

void BRepAlgoAPI_Splitter::SetTools ( const TopTools_ListOfShape theLS)

Sets the tools.

◆ Tools()

const TopTools_ListOfShape& BRepAlgoAPI_Splitter::Tools ( ) const

Gets the tools.

Field Documentation

◆ myTools

TopTools_ListOfShape BRepAlgoAPI_Splitter::myTools
protected

Tools arguments of the operation.


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