OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.
    Open CASCADE Technology Reference Manual 8.0.1
    BOPAlgo_BuilderArea Class Referenceabstract

    The root class for algorithms to build faces/solids from set of edges/faces. More...

    #include <BOPAlgo_BuilderArea.hxx>

    Inheritance diagram for BOPAlgo_BuilderArea:
    Inheritance graph
    [legend]

    Public Member Functions

    void SetContext (const occ::handle< IntTools_Context > &theContext)
     Sets the context for the algorithms.
    const NCollection_List< TopoDS_Shape > & Shapes () const
     Returns the input shapes.
    void SetShapes (const NCollection_List< TopoDS_Shape > &theLS)
     Sets the shapes for building areas.
    const NCollection_List< TopoDS_Shape > & Loops () const
     Returns the found loops.
    const NCollection_List< TopoDS_Shape > & Areas () const
     Returns the found areas.
    void SetAvoidInternalShapes (const bool theAvoidInternal)
     Defines the preventing of addition of internal parts into result. The default value is FALSE, i.e. the internal parts are added into result.
    bool IsAvoidInternalShapes () const
     Returns the AvoidInternalShapes flag.
    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.
    Public Member Functions inherited from BOPAlgo_Options
     BOPAlgo_Options ()
     Empty constructor.
     BOPAlgo_Options (const occ::handle< NCollection_BaseAllocator > &theAllocator)
     Constructor with allocator.
    virtual ~BOPAlgo_Options ()
     Destructor.
    const occ::handle< NCollection_BaseAllocator > & Allocator () const
     Returns allocator.
    virtual void Clear ()
     Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared.
    void AddError (const occ::handle< Message_Alert > &theAlert)
     Adds the alert as error (fail).
    void AddWarning (const occ::handle< Message_Alert > &theAlert)
     Adds the alert as warning.
    bool HasErrors () const
     Returns true if algorithm has failed.
    bool HasError (const occ::handle< Standard_Type > &theType) const
     Returns true if algorithm has generated error of specified type.
    bool HasWarnings () const
     Returns true if algorithm has generated some warning alerts.
    bool HasWarning (const occ::handle< Standard_Type > &theType) const
     Returns true if algorithm has generated warning of specified type.
    const occ::handle< Message_Report > & GetReport () const
     Returns report collecting all errors and warnings.
    void DumpErrors (Standard_OStream &theOS) const
     Dumps the error status into the given stream.
    void DumpWarnings (Standard_OStream &theOS) const
     Dumps the warning statuses into the given stream.
    void ClearWarnings ()
     Clears the warnings of the algorithm.
    void SetFuzzyValue (const double theFuzz)
     Sets the additional tolerance.
    double FuzzyValue () const
     Returns the additional tolerance.
    void SetUseOBB (const bool theUseOBB)
     Enables/Disables the usage of OBB.
    bool UseOBB () const
     Returns the flag defining usage of OBB.
    void SetRunParallel (const bool 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.
    bool RunParallel () const
     Returns the flag of parallel processing.

    Protected Member Functions

     BOPAlgo_BuilderArea ()
     ~BOPAlgo_BuilderArea () override
     BOPAlgo_BuilderArea (const occ::handle< NCollection_BaseAllocator > &theAllocator)
    virtual void PerformShapesToAvoid (const Message_ProgressRange &theRange)=0
    virtual void PerformLoops (const Message_ProgressRange &theRange)=0
    virtual void PerformAreas (const Message_ProgressRange &theRange)=0
    virtual void PerformInternalShapes (const Message_ProgressRange &theRange)=0
    Protected Member Functions inherited from BOPAlgo_Algo
     BOPAlgo_Algo ()
     Default constructor.
     ~BOPAlgo_Algo () override
     BOPAlgo_Algo (const occ::handle< NCollection_BaseAllocator > &theAllocator)
    virtual void CheckData ()
     Checks input data.
    virtual void CheckResult ()
     Checks the obtained result.
    void analyzeProgress (const double theWhole, BOPAlgo_PISteps &theSteps) const
     Fills the values for constant operations - the operations having constant relative running time.
    virtual void fillPIConstants (const double theWhole, BOPAlgo_PISteps &theSteps) const
     Fills the values for constant operations - the operations having constant relative running time.
    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.
    bool UserBreak (const Message_ProgressScope &thePS)
     Adds error to the report if the break signal was caught. Returns true in this case, false otherwise.

    Protected Attributes

    occ::handle< IntTools_Context > myContext
    NCollection_List< TopoDS_Shape > myShapes
    NCollection_List< TopoDS_Shape > myLoops
    NCollection_List< TopoDS_Shape > myLoopsInternal
    NCollection_List< TopoDS_Shape > myAreas
    NCollection_IndexedMap< TopoDS_Shape > myShapesToAvoid
    bool myAvoidInternalShapes
    occ::handle< NCollection_BaseAllocator > myAllocator
     Enables/Disables the usage of OBB.
    occ::handle< Message_Report > myReport
     Enables/Disables the usage of OBB.
    bool myRunParallel
     Enables/Disables the usage of OBB.
    double myFuzzyValue
     Enables/Disables the usage of OBB.
    bool myUseOBB
     Enables/Disables the usage of OBB.

    Additional Inherited Members

    static bool GetParallelMode ()
     Gets the global parallel mode.
    static void SetParallelMode (const bool theNewMode)
     Sets the global parallel mode.

    Detailed Description

    The root class for algorithms to build faces/solids from set of edges/faces.

    Constructor & Destructor Documentation

    ◆ BOPAlgo_BuilderArea() [1/2]

    BOPAlgo_BuilderArea::BOPAlgo_BuilderArea ( )
    		protected

    ◆ ~BOPAlgo_BuilderArea()

    BOPAlgo_BuilderArea::~BOPAlgo_BuilderArea ( )
    		overrideprotected

    ◆ BOPAlgo_BuilderArea() [2/2]

    BOPAlgo_BuilderArea::BOPAlgo_BuilderArea ( const occ::handle< NCollection_BaseAllocator > & theAllocator)
    		protected

    Member Function Documentation

    ◆ Areas()

    const NCollection_List< TopoDS_Shape > & BOPAlgo_BuilderArea::Areas ( ) const
    		inline

    Returns the found areas.

    ◆ IsAvoidInternalShapes()

    bool BOPAlgo_BuilderArea::IsAvoidInternalShapes ( ) const
    		inline

    Returns the AvoidInternalShapes flag.

    ◆ Loops()

    const NCollection_List< TopoDS_Shape > & BOPAlgo_BuilderArea::Loops ( ) const
    		inline

    Returns the found loops.

    ◆ PerformAreas()

    virtual void BOPAlgo_BuilderArea::PerformAreas ( const Message_ProgressRange & theRange)
    		protectedpure virtual

    Implemented in BOPAlgo_BuilderFace, and BOPAlgo_BuilderSolid.

    ◆ PerformInternalShapes()

    virtual void BOPAlgo_BuilderArea::PerformInternalShapes ( const Message_ProgressRange & theRange)
    		protectedpure virtual

    Implemented in BOPAlgo_BuilderFace, and BOPAlgo_BuilderSolid.

    ◆ PerformLoops()

    virtual void BOPAlgo_BuilderArea::PerformLoops ( const Message_ProgressRange & theRange)
    		protectedpure virtual

    Implemented in BOPAlgo_BuilderFace, and BOPAlgo_BuilderSolid.

    ◆ PerformShapesToAvoid()

    virtual void BOPAlgo_BuilderArea::PerformShapesToAvoid ( const Message_ProgressRange & theRange)
    		protectedpure virtual

    Implemented in BOPAlgo_BuilderFace, and BOPAlgo_BuilderSolid.

    ◆ SetAvoidInternalShapes()

    void BOPAlgo_BuilderArea::SetAvoidInternalShapes ( const bool theAvoidInternal)
    		inline

    Defines the preventing of addition of internal parts into result. The default value is FALSE, i.e. the internal parts are added into result.

    ◆ SetContext()

    void BOPAlgo_BuilderArea::SetContext ( const occ::handle< IntTools_Context > & theContext)
    		inline

    Sets the context for the algorithms.

    ◆ SetShapes()

    void BOPAlgo_BuilderArea::SetShapes ( const NCollection_List< TopoDS_Shape > & theLS)
    		inline

    Sets the shapes for building areas.

    ◆ Shapes()

    const NCollection_List< TopoDS_Shape > & BOPAlgo_BuilderArea::Shapes ( ) const
    		inline

    Returns the input shapes.

    Field Documentation

    ◆ myAreas

    NCollection_List<TopoDS_Shape> BOPAlgo_BuilderArea::myAreas
    		protected

    ◆ myAvoidInternalShapes

    bool BOPAlgo_BuilderArea::myAvoidInternalShapes
    		protected

    ◆ myContext

    occ::handle<IntTools_Context> BOPAlgo_BuilderArea::myContext
    		protected

    ◆ myLoops

    NCollection_List<TopoDS_Shape> BOPAlgo_BuilderArea::myLoops
    		protected

    ◆ myLoopsInternal

    NCollection_List<TopoDS_Shape> BOPAlgo_BuilderArea::myLoopsInternal
    		protected

    ◆ myShapes

    NCollection_List<TopoDS_Shape> BOPAlgo_BuilderArea::myShapes
    		protected

    ◆ myShapesToAvoid

    NCollection_IndexedMap<TopoDS_Shape> BOPAlgo_BuilderArea::myShapesToAvoid
    		protected
    The documentation for this class was generated from the following file: