Open CASCADE Technology  7.7.0.dev
Public Member Functions | Protected Types | Protected Member Functions

BOPAlgo_Section Class Reference

The algorithm to build a Section between the arguments. The Section consists of vertices and edges. The Section contains: More...

#include <BOPAlgo_Section.hxx>

Inheritance diagram for BOPAlgo_Section:
Inheritance graph
[legend]

Public Member Functions

 BOPAlgo_Section ()
 Empty constructor. More...
 
virtual ~BOPAlgo_Section ()
 
 BOPAlgo_Section (const Handle< NCollection_BaseAllocator > &theAllocator)
 Constructor with allocator. More...
 
- Public Member Functions inherited from BOPAlgo_Builder
 BOPAlgo_Builder ()
 Empty constructor. More...
 
virtual ~BOPAlgo_Builder ()
 
 BOPAlgo_Builder (const Handle< NCollection_BaseAllocator > &theAllocator)
 
virtual void Clear () override
 Clears the content of the algorithm. More...
 
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_ContextContext () 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_ListOfShapeArguments () 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 Perform (const Message_ProgressRange &theRange=Message_ProgressRange()) override
 Performs the operation. The intersection will be performed also. More...
 
virtual void PerformWithFiller (const BOPAlgo_PaveFiller &theFiller, const Message_ProgressRange &theRange=Message_ProgressRange())
 Performs the operation with the prepared filler. The intersection will not be performed in this case. More...
 
virtual void BuildBOP (const TopTools_ListOfShape &theObjects, const TopAbs_State theObjState, const TopTools_ListOfShape &theTools, const TopAbs_State theToolsState, const Message_ProgressRange &theRange, Handle< Message_Report > theReport=NULL)
 Builds the result shape according to the given states for the objects and tools. These states can be unambiguously converted into the Boolean operation type. Thus, it performs the Boolean operation on the given groups of shapes. More...
 
void BuildBOP (const TopTools_ListOfShape &theObjects, const TopTools_ListOfShape &theTools, const BOPAlgo_Operation theOperation, const Message_ProgressRange &theRange, Handle< Message_Report > theReport=NULL)
 Builds the result of Boolean operation of given type basing on the result of Builder operation (GF or any other). More...
 
const TopTools_DataMapOfShapeListOfShapeImages () const
 Returns the map of images. More...
 
const TopTools_DataMapOfShapeListOfShapeOrigins () const
 Returns the map of origins. More...
 
const TopTools_DataMapOfShapeShapeShapesSD () const
 Returns the map of Same Domain (SD) shapes - coinciding shapes from different arguments. More...
 
- Public Member Functions inherited from BOPAlgo_BuilderShape
const TopoDS_ShapeShape () const
 Returns the result of algorithm. More...
 
const TopTools_ListOfShapeModified (const TopoDS_Shape &theS)
 Returns the list of shapes Modified from the shape theS. More...
 
const TopTools_ListOfShapeGenerated (const TopoDS_Shape &theS)
 Returns the list of shapes Generated from the shape theS. More...
 
Standard_Boolean IsDeleted (const TopoDS_Shape &theS)
 Returns true if the shape theS has been deleted. In this case the shape will have no Modified elements, but can have Generated elements. More...
 
Standard_Boolean HasModified () const
 Returns true if any of the input shapes has been modified during operation. More...
 
Standard_Boolean HasGenerated () const
 Returns true if any of the input shapes has generated shapes during operation. More...
 
Standard_Boolean HasDeleted () const
 Returns true if any of the input shapes has been deleted during operation. More...
 
Handle< BRepTools_HistoryHistory ()
 History Tool. More...
 
void SetToFillHistory (const Standard_Boolean theHistFlag)
 Allows disabling the history collection. More...
 
Standard_Boolean HasHistory () const
 Returns flag of history availability. More...
 
- 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 SetUseOBB (const Standard_Boolean theUseOBB)
 Enables/Disables the usage of OBB. More...
 
Standard_Boolean UseOBB () const
 Returns the flag defining usage of OBB. 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...
 

Protected Types

enum  BOPAlgo_PIOperation {
  PIOperation_TreatVertices = 0 , PIOperation_TreatEdges , PIOperation_BuildSection , PIOperation_FillHistory ,
  PIOperation_PostTreat , PIOperation_Last
}
 List of operations to be supported by the Progress Indicator. Override the whole enumeration here since the constant operations are also going to be overridden. More...
 
- Protected Types inherited from BOPAlgo_Builder
enum  BOPAlgo_PIOperation {
  PIOperation_TreatVertices = 0 , PIOperation_TreatEdges , PIOperation_TreatWires , PIOperation_TreatFaces ,
  PIOperation_TreatShells , PIOperation_TreatSolids , PIOperation_TreatCompsolids , PIOperation_TreatCompounds ,
  PIOperation_FillHistory , PIOperation_PostTreat , PIOperation_Last
}
 List of operations to be supported by the Progress Indicator. More...
 

Protected Member Functions

virtual void CheckData () override
 Checks the data before performing the operation. More...
 
virtual void BuildSection (const Message_ProgressRange &theRange)
 Combine the result of section operation. More...
 
virtual void PerformInternal1 (const BOPAlgo_PaveFiller &thePF, const Message_ProgressRange &theRange) override
 Performs calculations using prepared Filler object <thePF> More...
 
void fillPIConstants (const Standard_Real theWhole, BOPAlgo_PISteps &theSteps) const override
 Filling steps for constant operations. More...
 
void fillPISteps (BOPAlgo_PISteps &theSteps) const override
 Filling steps for all other operations. More...
 
- Protected Member Functions inherited from BOPAlgo_Builder
void PrepareHistory (const Message_ProgressRange &theRange)
 Prepare information for history support. More...
 
virtual const TopTools_ListOfShapeLocModified (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...
 
virtual const TopTools_ListOfShapeLocGenerated (const TopoDS_Shape &theS)
 Returns the list of shapes generated from the shape theS. Similarly to LocModified must be redefined for specific operations, obtaining Generated elements differently. More...
 
virtual void PerformInternal (const BOPAlgo_PaveFiller &thePF, const Message_ProgressRange &theRange)
 Performs the building of the result. The method calls the PerformInternal1() method surrounded by a try-catch block. 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 (const Message_ProgressRange &theRange)
 Fills the images of vertices. More...
 
void FillImagesEdges (const Message_ProgressRange &theRange)
 Fills the images of edges. More...
 
void FillImagesContainers (const TopAbs_ShapeEnum theType, const Message_ProgressRange &theRange)
 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 (const Message_ProgressRange &theRange)
 Fills the images of faces. The method consists of three steps: More...
 
virtual void BuildSplitFaces (const Message_ProgressRange &theRange)
 Builds the splits of faces using the information from the intersection stage stored in Data Structure. More...
 
void FillSameDomainFaces (const Message_ProgressRange &theRange)
 Looks for the same domain faces among the splits of the faces. Updates the map of images with SD faces. More...
 
void FillInternalVertices (const Message_ProgressRange &theRange)
 Classifies the alone vertices on faces relatively its splits and adds them as INTERNAL into the splits. More...
 
void FillImagesSolids (const Message_ProgressRange &theRange)
 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_DataMapOfShapeShape &theDraftSolids, const Message_ProgressRange &theRange)
 Finds faces located inside each solid. More...
 
void BuildSplitSolids (TopTools_DataMapOfShapeShape &theDraftSolids, const Message_ProgressRange &theRange)
 Builds the splits of the solids using their draft versions and faces located inside. More...
 
void FillInternalShapes (const Message_ProgressRange &theRange)
 Classifies the vertices and edges from the arguments relatively splits of solids and makes them INTERNAL for solids. More...
 
void FillImagesCompounds (const Message_ProgressRange &theRange)
 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 (const Message_ProgressRange &theRange)
 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...
 
NbShapes getNbShapes () const
 Compute number of shapes of certain type participating in operation. More...
 
- Protected Member Functions inherited from BOPAlgo_BuilderShape
 BOPAlgo_BuilderShape ()
 Empty constructor. More...
 
 BOPAlgo_BuilderShape (const Handle< NCollection_BaseAllocator > &theAllocator)
 Constructor with allocator. More...
 
- 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...
 
void analyzeProgress (const Standard_Real theWhole, BOPAlgo_PISteps &theSteps) const
 Analyze progress steps of the whole operation. More...
 
- Protected Member Functions inherited from BOPAlgo_Options
Standard_Boolean UserBreak (const Message_ProgressScope &thePS)
 Adds error to the report if the break signal was caught. Returns true in this case, false otherwise. 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_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_ContextmyContext
 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...
 
TopTools_DataMapOfShapeListOfShape myInParts
 InParts - map of own and acquired IN faces of the arguments solids. 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
 Result of the operation. More...
 
TopTools_ListOfShape myHistShapes
 Storer for the history shapes. More...
 
TopTools_MapOfShape myMapShape
 cached map of all arguments shapes More...
 
Standard_Boolean myFillHistory
 Controls the history filling. More...
 
Handle< BRepTools_HistorymyHistory
 History tool. More...
 
- Protected Attributes inherited from BOPAlgo_Options
Handle< NCollection_BaseAllocatormyAllocator
 Enables/Disables the usage of OBB. More...
 
Handle< Message_ReportmyReport
 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...
 
Standard_Boolean myUseOBB
 Enables/Disables the usage of OBB. More...
 

Detailed Description

The algorithm to build a Section between the arguments. The Section consists of vertices and edges. The Section contains:

  1. new vertices that are subjects of V/V, E/E, E/F, F/F interferences
  2. vertices that are subjects of V/E, V/F interferences
  3. new edges that are subjects of F/F interferences
  4. edges that are Common Blocks

Member Enumeration Documentation

◆ BOPAlgo_PIOperation

List of operations to be supported by the Progress Indicator. Override the whole enumeration here since the constant operations are also going to be overridden.

Enumerator
PIOperation_TreatVertices 
PIOperation_TreatEdges 
PIOperation_BuildSection 
PIOperation_FillHistory 
PIOperation_PostTreat 
PIOperation_Last 

Constructor & Destructor Documentation

◆ BOPAlgo_Section() [1/2]

BOPAlgo_Section::BOPAlgo_Section ( )

Empty constructor.

◆ ~BOPAlgo_Section()

virtual BOPAlgo_Section::~BOPAlgo_Section ( )
virtual

◆ BOPAlgo_Section() [2/2]

BOPAlgo_Section::BOPAlgo_Section ( const Handle< NCollection_BaseAllocator > &  theAllocator)

Constructor with allocator.

Member Function Documentation

◆ BuildSection()

virtual void BOPAlgo_Section::BuildSection ( const Message_ProgressRange theRange)
protectedvirtual

Combine the result of section operation.

◆ CheckData()

virtual void BOPAlgo_Section::CheckData ( )
overrideprotectedvirtual

Checks the data before performing the operation.

Reimplemented from BOPAlgo_Builder.

◆ fillPIConstants()

void BOPAlgo_Section::fillPIConstants ( const Standard_Real  theWhole,
BOPAlgo_PISteps theSteps 
) const
overrideprotectedvirtual

Filling steps for constant operations.

Reimplemented from BOPAlgo_Builder.

◆ fillPISteps()

void BOPAlgo_Section::fillPISteps ( BOPAlgo_PISteps theSteps) const
overrideprotectedvirtual

Filling steps for all other operations.

Reimplemented from BOPAlgo_Builder.

◆ PerformInternal1()

virtual void BOPAlgo_Section::PerformInternal1 ( const BOPAlgo_PaveFiller thePF,
const Message_ProgressRange theRange 
)
overrideprotectedvirtual

Performs calculations using prepared Filler object <thePF>

Reimplemented from BOPAlgo_Builder.


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