The Splitter algorithm is the algorithm for 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 <BOPAlgo_Splitter.hxx>
Inheritance diagram for BOPAlgo_Splitter:
Public Member Functions | |
| BOPAlgo_Splitter () | |
| Empty constructor. More... | |
| virtual | ~BOPAlgo_Splitter () |
| BOPAlgo_Splitter (const Handle< NCollection_BaseAllocator > &theAllocator) | |
| virtual void | Perform () override |
| Performs the operation. More... | |
 Public Member Functions inherited from BOPAlgo_ToolsProvider | |
| BOPAlgo_ToolsProvider () | |
| Empty constructor. More... | |
| BOPAlgo_ToolsProvider (const Handle< NCollection_BaseAllocator > &theAllocator) | |
| virtual void | Clear () override |
| Clears internal fields and arguments. More... | |
| virtual void | AddTool (const TopoDS_Shape &theShape) |
| Adds Tool argument of the operation. More... | |
| virtual void | SetTools (const TopTools_ListOfShape &theShapes) |
| Adds the Tool arguments of the operation. More... | |
| const TopTools_ListOfShape & | Tools () const |
| Returns the Tool arguments of the operation. More... | |
| Public Member Functions inherited from BOPAlgo_Builder | |
| BOPAlgo_Builder () | |
| Empty constructor. More... | |
| virtual | ~BOPAlgo_Builder () |
| BOPAlgo_Builder (const Handle< NCollection_BaseAllocator > &theAllocator) | |
| BOPAlgo_PPaveFiller | PPaveFiller () |
| Returns the PaveFiller, algorithm for sub-shapes intersection. More... | |
| BOPDS_PDS | PDS () |
| Returns the Data Structure, holder of intersection information. More... | |
| Handle< IntTools_Context > | Context () const |
| Returns the Context, tool for cashing heavy algorithms. More... | |
| virtual void | AddArgument (const TopoDS_Shape &theShape) |
| Adds the argument to the operation. More... | |
| virtual void | SetArguments (const TopTools_ListOfShape &theLS) |
| Sets the list of arguments for the operation. More... | |
| const TopTools_ListOfShape & | Arguments () const |
| Returns the list of arguments. 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. This flag is taken into account if internal PaveFiller is used only. In the case of calling PerformWithFiller the corresponding flag of that PaveFiller is in force. 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 | SetCheckInverted (const Standard_Boolean theCheck) |
| Enables/Disables the check of the input solids for inverted status. More... | |
| Standard_Boolean | CheckInverted () const |
| Returns the flag defining whether the check for input solids on inverted status should be performed or not. More... | |
| virtual void | PerformWithFiller (const BOPAlgo_PaveFiller &theFiller) |
| Performs the operation with the prepared filler. The intersection will not be performed in this case. More... | |
| const TopTools_DataMapOfShapeListOfShape & | Images () const |
| Returns the map of images. More... | |
| const TopTools_DataMapOfShapeListOfShape & | Origins () const |
| Returns the map of origins. More... | |
| const TopTools_DataMapOfShapeShape & | ShapesSD () const |
| Returns the map of Same Domain (SD) shapes - coinciding shapes from different arguments. More... | |
| virtual const TopTools_ListOfShape & | Generated (const TopoDS_Shape &theS) override |
| Returns the list of shapes generated from the shape theS. More... | |
| virtual const TopTools_ListOfShape & | Modified (const TopoDS_Shape &theS) override |
| Returns the list of shapes modified from the shape theS. More... | |
| virtual Standard_Boolean | IsDeleted (const TopoDS_Shape &theS) override |
| Returns true if the shape theS has been deleted. More... | |
| Public Member Functions inherited from BOPAlgo_BuilderShape | |
| const TopoDS_Shape & | Shape () const |
| Returns the result of algorithm. More... | |
| Standard_Boolean | HasDeleted () const |
| Returns true if the at least one shape(or subshape) of arguments has been deleted. More... | |
| Standard_Boolean | HasGenerated () const |
| Returns true if the at least one shape(or subshape) of arguments has generated shapes. More... | |
| Standard_Boolean | HasModified () const |
| Returns true if the at least one shape(or subshape) of arguments has modified shapes. More... | |
| const TopTools_IndexedDataMapOfShapeListOfShape & | ImagesResult () const |
| Public Member Functions inherited from BOPAlgo_Options | |
| BOPAlgo_Options () | |
| Empty constructor. More... | |
| BOPAlgo_Options (const Handle< NCollection_BaseAllocator > &theAllocator) | |
| Constructor with allocator. More... | |
| virtual | ~BOPAlgo_Options () |
| Destructor. More... | |
| const Handle< NCollection_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 | SetProgressIndicator (const Handle< Message_ProgressIndicator > &theObj) |
| Set the Progress Indicator object. 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 | SetUseOBB (const Standard_Boolean theUseOBB) |
| Enables/Disables the usage of OBB. More... | |
| Standard_Boolean | UseOBB () const |
| Returns the flag defining usage of OBB. More... | |
Protected Member Functions | |
| virtual void | CheckData () override |
| Checks the input data. More... | |
| Protected Member Functions inherited from BOPAlgo_Builder | |
| virtual void | PerformInternal (const BOPAlgo_PaveFiller &thePF) |
| Performs the building of the result. The method calls the PerfromInternal1() method surrounded by a try-catch block. More... | |
| virtual void | PerformInternal1 (const BOPAlgo_PaveFiller &thePF) |
| Performs the building of the result. To build the result of any other operation it will be necessary to override this method. More... | |
| virtual void | BuildResult (const TopAbs_ShapeEnum theType) |
| Builds the result of operation. The method is called for each of the arguments type and adds into the result the splits of the arguments of that type. More... | |
| void | CheckFiller () |
| Checks if the intersection algorithm has Errors/Warnings. More... | |
| virtual void | Prepare () |
| Prepares the result shape by making it empty compound. More... | |
| void | FillImagesVertices () |
| Fills the images of vertices. More... | |
| void | FillImagesEdges () |
| Fills the images of edges. More... | |
| void | FillImagesContainers (const TopAbs_ShapeEnum theType) |
| Fills the images of containers (WIRES/SHELLS/COMPSOLID). More... | |
| void | FillImagesContainer (const TopoDS_Shape &theS, const TopAbs_ShapeEnum theType) |
| Builds the image of the given container using the splits of its sub-shapes. More... | |
| void | FillImagesFaces () |
| Fills the images of faces. The method consists of three steps: More... | |
| virtual void | BuildSplitFaces () |
| Builds the splits of faces using the information from the intersection stage stored in Data Structure. More... | |
| void | FillSameDomainFaces () |
| Looks for the same domain faces among the splits of the faces. Updates the map of images with SD faces. More... | |
| void | FillInternalVertices () |
| Classifies the alone vertices on faces relatively its splits and adds them as INTERNAL into the splits. More... | |
| void | FillImagesSolids () |
| Fills the images of solids. The method consists of four steps: More... | |
| void | BuildDraftSolid (const TopoDS_Shape &theSolid, TopoDS_Shape &theDraftSolid, TopTools_ListOfShape &theLIF) |
| Builds the draft solid by rebuilding the shells of the solid with the splits of faces. More... | |
| virtual void | FillIn3DParts (TopTools_DataMapOfShapeListOfShape &theInParts, TopTools_DataMapOfShapeShape &theDraftSolids, const Handle< NCollection_BaseAllocator > &theAllocator) |
| Finds faces located inside each solid. More... | |
| void | BuildSplitSolids (TopTools_DataMapOfShapeListOfShape &theInParts, TopTools_DataMapOfShapeShape &theDraftSolids, const Handle< NCollection_BaseAllocator > &theAllocator) |
| Builds the splits of the solids using their draft versions and faces located inside. More... | |
| void | FillInternalShapes () |
| Classifies the vertices and edges from the arguments relatively splits of solids and makes them INTERNAL for solids. More... | |
| void | FillImagesCompounds () |
| Fills the images of compounds. More... | |
| void | FillImagesCompound (const TopoDS_Shape &theS, TopTools_MapOfShape &theMF) |
| Builds the image of the given compound. More... | |
| virtual void | PostTreat () |
| Post treatment of the result of the operation. The method checks validity of the sub-shapes of the result and updates the tolerances to make them valid. More... | |
| virtual void | PrepareHistory () override |
| Prepare information for history support. More... | |
| virtual const TopTools_ListOfShape * | LocModified (const TopoDS_Shape &theS) |
| Prepare history information for the input shapes taking into account possible operation-specific modifications. For instance, in the CellsBuilder operation, additionally to splitting input shapes the splits of the shapes (or the shapes themselves) may be unified during removal of internal boundaries. In this case each split should be linked to the unified shape. More... | |
| Protected Member Functions inherited from BOPAlgo_BuilderShape | |
| BOPAlgo_BuilderShape () | |
| virtual | ~BOPAlgo_BuilderShape () |
| BOPAlgo_BuilderShape (const Handle< NCollection_BaseAllocator > &theAllocator) | |
| Protected Member Functions inherited from BOPAlgo_Algo | |
| BOPAlgo_Algo () | |
| Default constructor. More... | |
| virtual | ~BOPAlgo_Algo () |
| BOPAlgo_Algo (const Handle< NCollection_BaseAllocator > &theAllocator) | |
| virtual void | CheckResult () |
| Checks the obtained result. More... | |
| Protected Member Functions inherited from BOPAlgo_Options | |
| void | UserBreak () const |
| Breaks the execution if the break signal is indicated by myProgressIndicator. More... | |
Additional Inherited Members | |
| Static Public 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 BOPAlgo_ToolsProvider | |
| TopTools_ListOfShape | myTools |
| TopTools_MapOfShape | myMapTools |
| Protected Attributes inherited from BOPAlgo_Builder | |
| TopTools_ListOfShape | myArguments |
| Arguments of the operation. More... | |
| TopTools_MapOfShape | myMapFence |
| Fence map providing the uniqueness of the shapes in the list of arguments. More... | |
| BOPAlgo_PPaveFiller | myPaveFiller |
| Pave Filler - algorithm for sub-shapes intersection. More... | |
| BOPDS_PDS | myDS |
| Data Structure - holder of intersection information. More... | |
| Handle< IntTools_Context > | myContext |
| Context - tool for cashing heavy algorithms such as Projectors and Classifiers. More... | |
| Standard_Integer | myEntryPoint |
| EntryPoint - controls the deletion of the PaveFiller, which could live longer than the Builder. More... | |
| TopTools_DataMapOfShapeListOfShape | myImages |
| Images - map of Images of the sub-shapes of arguments. More... | |
| TopTools_DataMapOfShapeShape | myShapesSD |
| ShapesSD - map of SD Shapes. More... | |
| TopTools_DataMapOfShapeListOfShape | myOrigins |
| Origins - map of Origins, back map of Images. More... | |
| Standard_Boolean | myNonDestructive |
| Safe processing option allows avoiding modification of the input shapes. More... | |
| BOPAlgo_GlueEnum | myGlue |
| Gluing option allows speeding up the intersection of the input shapes. More... | |
| Standard_Boolean | myCheckInverted |
| Check inverted option allows disabling the check of input solids on inverted status. More... | |
| Protected Attributes inherited from BOPAlgo_BuilderShape | |
| TopoDS_Shape | myShape |
| TopTools_ListOfShape | myHistShapes |
| TopTools_MapOfShape | myMapShape |
| Standard_Boolean | myHasDeleted |
| Standard_Boolean | myHasGenerated |
| Standard_Boolean | myHasModified |
| TopTools_IndexedDataMapOfShapeListOfShape | myImagesResult |
| Standard_Boolean | myFlagHistory |
| Protected Attributes inherited from BOPAlgo_Options | |
| Handle< NCollection_BaseAllocator > | myAllocator |
| Enables/Disables the usage of OBB. More... | |
| Handle< Message_Report > | myReport |
| Enables/Disables the usage of OBB. More... | |
| Standard_Boolean | myRunParallel |
| Enables/Disables the usage of OBB. More... | |
| Standard_Real | myFuzzyValue |
| Enables/Disables the usage of OBB. More... | |
| Handle< Message_ProgressIndicator > | myProgressIndicator |
| Enables/Disables the usage of OBB. More... | |
| Standard_Boolean | myUseOBB |
| Enables/Disables the usage of OBB. More... | |
Detailed Description
The Splitter algorithm is the algorithm for 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 implementation of the algorithm is minimal - only the methods CheckData() and Perform() have been overridden.
The method BOPAlgo_Builder::BuildResult(), which adds the split parts of the arguments into result, does not have to be overridden, because its native implementation performs the necessary actions for the Splitter algorithm - it adds the split parts of only Objects into result, avoiding the split parts of Tools.
Constructor & Destructor Documentation
◆ BOPAlgo_Splitter() [1/2]
| BOPAlgo_Splitter::BOPAlgo_Splitter | ( | ) |
Empty constructor.
◆ ~BOPAlgo_Splitter()
|
virtual |
◆ BOPAlgo_Splitter() [2/2]
| BOPAlgo_Splitter::BOPAlgo_Splitter | ( | const Handle< NCollection_BaseAllocator > & | theAllocator | ) |
Member Function Documentation
◆ CheckData()
|
overrideprotectedvirtual |
Checks the input data.
Reimplemented from BOPAlgo_Builder.
◆ Perform()
|
overridevirtual |
Performs the operation.
Reimplemented from BOPAlgo_Builder.
The documentation for this class was generated from the following file:
