Open CASCADE Technology
7.7.0
|
Root class for algorithms that has shape as result. More...
#include <BOPAlgo_BuilderShape.hxx>
Public Member Functions | |
Getting the result | |
const TopoDS_Shape & | Shape () const |
Returns the result of algorithm. More... | |
History methods | |
const TopTools_ListOfShape & | Modified (const TopoDS_Shape &theS) |
Returns the list of shapes Modified from the shape theS. More... | |
const TopTools_ListOfShape & | Generated (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_History > | History () |
History Tool. More... | |
Enabling/Disabling the history collection. | |
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_Algo | |
virtual void | Perform (const Message_ProgressRange &theRange=Message_ProgressRange())=0 |
The main method to implement the operation Providing the range allows to enable Progress indicator User break functionalities. 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 Member Functions | |
Constructors | |
BOPAlgo_BuilderShape () | |
Empty constructor. More... | |
BOPAlgo_BuilderShape (const Handle< NCollection_BaseAllocator > &theAllocator) | |
Constructor with allocator. More... | |
Clearing | |
virtual void | Clear () override |
Clears the content of the algorithm. 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 | CheckData () |
Checks input data. More... | |
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... | |
virtual void | fillPIConstants (const Standard_Real theWhole, BOPAlgo_PISteps &theSteps) const |
Fills the values for constant operations - the operations having constant relative running time. More... | |
virtual void | fillPISteps (BOPAlgo_PISteps &theSteps) const |
Fills the values for the operations dependent on the inputs. Filled values may not be normalized to represent percentage of total running time. The values should just correlate to each other. E.g. if progress depends on the number of input shapes, the values may look like this: step1 = number_of_input_vertices; step2 = 2 * number_of_input_edges; step3 = 10 * number_of_input_faces. Normalization of these values will be done automatically in analyzeProgress() method. 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... | |
Protected Attributes | |
Fields | |
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_History > | myHistory |
History tool. More... | |
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... | |
Standard_Boolean | myUseOBB |
Enables/Disables the usage of OBB. 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... | |
Root class for algorithms that has shape as result.
The class provides the History mechanism, which allows tracking the modification of the input shapes during the operation. It uses the BRepTools_History tool as a storer for history objects.
|
inlineprotected |
Empty constructor.
|
inlineprotected |
Constructor with allocator.
|
inlineoverrideprotectedvirtual |
Clears the content of the algorithm.
Reimplemented from BOPAlgo_Options.
Reimplemented in BOPAlgo_RemoveFeatures, BOPAlgo_CellsBuilder, BOPAlgo_MakerVolume, BOPAlgo_Builder, BOPAlgo_BOP, BRepFeat_Builder, and BOPAlgo_ToolsProvider.
|
inline |
Returns the list of shapes Generated from the shape theS.
|
inline |
Returns true if any of the input shapes has been deleted during operation.
|
inline |
Returns true if any of the input shapes has generated shapes during operation.
|
inline |
Returns flag of history availability.
|
inline |
Returns true if any of the input shapes has been modified during operation.
|
inline |
History Tool.
|
inline |
Returns true if the shape theS has been deleted. In this case the shape will have no Modified elements, but can have Generated elements.
|
inline |
Returns the list of shapes Modified from the shape theS.
|
inline |
Allows disabling the history collection.
|
inline |
Returns the result of algorithm.
|
protected |
Controls the history filling.
|
protected |
History tool.
|
protected |
Storer for the history shapes.
|
protected |
cached map of all arguments shapes
|
protected |
Result of the operation.