OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    BRepMesh_IncrementalMesh Class Reference

    Builds the mesh of a shape with respect of their correctly triangulated parts. More...

    #include <BRepMesh_IncrementalMesh.hxx>

    Inheritance diagram for BRepMesh_IncrementalMesh:

    Public Member Functions

    mesher API

    Default constructor

     BRepMesh_IncrementalMesh ()
     Destructor.
     ~BRepMesh_IncrementalMesh () override
     Destructor.
     BRepMesh_IncrementalMesh (const TopoDS_Shape &theShape, const double theLinDeflection, const bool isRelative=false, const double theAngDeflection=0.5, const bool isInParallel=false)
     Constructor. Automatically calls method Perform.
     BRepMesh_IncrementalMesh (const TopoDS_Shape &theShape, const IMeshTools_Parameters &theParameters, const Message_ProgressRange &theRange=Message_ProgressRange())
     Constructor. Automatically calls method Perform.
    void Perform (const Message_ProgressRange &theRange=Message_ProgressRange()) override
     Performs meshing of the shape.
    void Perform (const occ::handle< IMeshTools_Context > &theContext, const Message_ProgressRange &theRange=Message_ProgressRange())
     Performs meshing using custom context;.
    Public Member Functions inherited from BRepMesh_DiscretRoot
     ~BRepMesh_DiscretRoot () override
     Destructor.
    void SetShape (const TopoDS_Shape &theShape)
     Set the shape to triangulate.
    const TopoDS_Shape & Shape () const
    bool IsDone () const
     Returns true if triangualtion was performed and has success.
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transient & operator= (const Standard_Transient &)
     Assignment operator, needed to avoid copying reference counter.
    virtual ~Standard_Transient ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool IsKind (const opencascade::handle< Standard_Type > &theType) const
     Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    bool IsKind (const char *const theTypeName) const
     Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    Standard_Transient * This () const
     Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    plugin API

    Plugin interface for the Mesh Factories. Initializes meshing algorithm with the given parameters.

    Parameters
    theShapeshape to be meshed.
    theLinDeflectionlinear deflection.
    theAngDeflectionangular deflection.
    [out]theAlgopointer to initialized algorithm.
    IMeshTools_Parameters myParameters
     Returns multi-threading usage flag set by default in Discret() static method (thus applied only to Mesh Factories).
    bool myModified
     Returns multi-threading usage flag set by default in Discret() static method (thus applied only to Mesh Factories).
    int myStatus
     Returns multi-threading usage flag set by default in Discret() static method (thus applied only to Mesh Factories).
    static int Discret (const TopoDS_Shape &theShape, const double theLinDeflection, const double theAngDeflection, BRepMesh_DiscretRoot *&theAlgo)
     Returns multi-threading usage flag set by default in Discret() static method (thus applied only to Mesh Factories).
    static bool IsParallelDefault ()
     Returns multi-threading usage flag set by default in Discret() static method (thus applied only to Mesh Factories).
    static void SetParallelDefault (const bool isInParallel)
     Setup multi-threading usage flag set by default in Discret() static method (thus applied only to Mesh Factories).

    accessing to parameters.

    Returns meshing parameters

    const IMeshTools_Parameters & Parameters () const
     Returns modifiable meshing parameters.
    IMeshTools_Parameters & ChangeParameters ()
     Returns modifiable meshing parameters.
    bool IsModified () const
     Returns modified flag.
    int GetStatusFlags () const
     Returns accumulated status flags faced during meshing.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    static constexpr const char * get_type_name ()
     Returns a type descriptor about this object.
    static const opencascade::handle< Standard_Type > & get_type_descriptor ()
     Returns type descriptor of Standard_Transient class.
    Protected Member Functions inherited from BRepMesh_DiscretRoot
     BRepMesh_DiscretRoot ()
     Constructor.
    void setDone ()
     Sets IsDone flag.
    void setNotDone ()
     Clears IsDone flag.
    virtual void init ()
    Protected Attributes inherited from BRepMesh_DiscretRoot
    TopoDS_Shape myShape
    bool myIsDone

    Detailed Description

    Builds the mesh of a shape with respect of their correctly triangulated parts.

    Constructor & Destructor Documentation

    ◆ BRepMesh_IncrementalMesh() [1/3]

    BRepMesh_IncrementalMesh::BRepMesh_IncrementalMesh ( )

    Destructor.

    ◆ ~BRepMesh_IncrementalMesh()

    BRepMesh_IncrementalMesh::~BRepMesh_IncrementalMesh ( )
    override

    Destructor.

    ◆ BRepMesh_IncrementalMesh() [2/3]

    BRepMesh_IncrementalMesh::BRepMesh_IncrementalMesh ( const TopoDS_Shape & theShape,
    const double theLinDeflection,
    const bool isRelative = false,
    const double theAngDeflection = 0.5,
    const bool isInParallel = false )

    Constructor. Automatically calls method Perform.

    Parameters
    theShapeshape to be meshed.
    theLinDeflectionlinear deflection.
    isRelativeif TRUE deflection used for discretization of each edge will be <theLinDeflection> * <size of edge>. Deflection used for the faces will be the maximum deflection of their edges.
    theAngDeflectionangular deflection.
    isInParallelif TRUE shape will be meshed in parallel.

    ◆ BRepMesh_IncrementalMesh() [3/3]

    BRepMesh_IncrementalMesh::BRepMesh_IncrementalMesh ( const TopoDS_Shape & theShape,
    const IMeshTools_Parameters & theParameters,
    const Message_ProgressRange & theRange = Message_ProgressRange() )

    Constructor. Automatically calls method Perform.

    Parameters
    theShapeshape to be meshed.
    theParameters- parameters of meshing

    Member Function Documentation

    ◆ ChangeParameters()

    IMeshTools_Parameters & BRepMesh_IncrementalMesh::ChangeParameters ( )
    inline

    Returns modifiable meshing parameters.

    ◆ Discret()

    int BRepMesh_IncrementalMesh::Discret ( const TopoDS_Shape & theShape,
    const double theLinDeflection,
    const double theAngDeflection,
    BRepMesh_DiscretRoot *& theAlgo )
    static

    Returns multi-threading usage flag set by default in Discret() static method (thus applied only to Mesh Factories).

    ◆ GetStatusFlags()

    int BRepMesh_IncrementalMesh::GetStatusFlags ( ) const
    inline

    Returns accumulated status flags faced during meshing.

    ◆ IsModified()

    bool BRepMesh_IncrementalMesh::IsModified ( ) const
    inline

    Returns modified flag.

    ◆ IsParallelDefault()

    bool BRepMesh_IncrementalMesh::IsParallelDefault ( )
    static

    Returns multi-threading usage flag set by default in Discret() static method (thus applied only to Mesh Factories).

    ◆ Parameters()

    const IMeshTools_Parameters & BRepMesh_IncrementalMesh::Parameters ( ) const
    inline

    Returns modifiable meshing parameters.

    ◆ Perform() [1/2]

    void BRepMesh_IncrementalMesh::Perform ( const Message_ProgressRange & theRange = Message_ProgressRange())
    overridevirtual

    Performs meshing of the shape.

    Implements BRepMesh_DiscretRoot.

    ◆ Perform() [2/2]

    void BRepMesh_IncrementalMesh::Perform ( const occ::handle< IMeshTools_Context > & theContext,
    const Message_ProgressRange & theRange = Message_ProgressRange() )

    Performs meshing using custom context;.

    ◆ SetParallelDefault()

    void BRepMesh_IncrementalMesh::SetParallelDefault ( const bool isInParallel)
    static

    Setup multi-threading usage flag set by default in Discret() static method (thus applied only to Mesh Factories).

    Field Documentation

    ◆ myModified

    bool BRepMesh_IncrementalMesh::myModified
    protected

    Returns multi-threading usage flag set by default in Discret() static method (thus applied only to Mesh Factories).

    ◆ myParameters

    IMeshTools_Parameters BRepMesh_IncrementalMesh::myParameters
    protected

    Returns multi-threading usage flag set by default in Discret() static method (thus applied only to Mesh Factories).

    ◆ myStatus

    int BRepMesh_IncrementalMesh::myStatus
    protected

    Returns multi-threading usage flag set by default in Discret() static method (thus applied only to Mesh Factories).


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