Open CASCADE Technology 7.8.0
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:
Inheritance graph
[legend]

Public Member Functions

mesher API
 BRepMesh_IncrementalMesh ()
 Default constructor.
 
virtual ~BRepMesh_IncrementalMesh ()
 Destructor.
 
 BRepMesh_IncrementalMesh (const TopoDS_Shape &theShape, const Standard_Real theLinDeflection, const Standard_Boolean isRelative=Standard_False, const Standard_Real theAngDeflection=0.5, const Standard_Boolean isInParallel=Standard_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.
 
virtual void Perform (const Message_ProgressRange &theRange=Message_ProgressRange()) override
 Performs meshing of the shape.
 
void Perform (const Handle< IMeshTools_Context > &theContext, const Message_ProgressRange &theRange=Message_ProgressRange())
 Performs meshing using custom context;.
 
- Public Member Functions inherited from BRepMesh_DiscretRoot
virtual ~BRepMesh_DiscretRoot ()
 Destructor.
 
void SetShape (const TopoDS_Shape &theShape)
 Set the shape to triangulate.
 
const TopoDS_ShapeShape () const
 
Standard_Boolean 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_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter.
 
virtual ~Standard_Transient ()
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
Standard_Boolean 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.
 
Standard_Boolean IsKind (const Standard_CString 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_TransientThis () 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.
 
Standard_Integer GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object.
 
Standard_Integer DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

plugin API

IMeshTools_Parameters myParameters
 Plugin interface for the Mesh Factories. Initializes meshing algorithm with the given parameters.
 
Standard_Boolean myModified
 Plugin interface for the Mesh Factories. Initializes meshing algorithm with the given parameters.
 
Standard_Integer myStatus
 Plugin interface for the Mesh Factories. Initializes meshing algorithm with the given parameters.
 
static Standard_Integer Discret (const TopoDS_Shape &theShape, const Standard_Real theLinDeflection, const Standard_Real theAngDeflection, BRepMesh_DiscretRoot *&theAlgo)
 Plugin interface for the Mesh Factories. Initializes meshing algorithm with the given parameters.
 
static Standard_Boolean IsParallelDefault ()
 Returns multi-threading usage flag set by default in Discret() static method (thus applied only to Mesh Factories).
 
static void SetParallelDefault (const Standard_Boolean isInParallel)
 Setup multi-threading usage flag set by default in Discret() static method (thus applied only to Mesh Factories).
 

accessing to parameters.

const IMeshTools_ParametersParameters () const
 Returns meshing parameters.
 
IMeshTools_ParametersChangeParameters ()
 Returns modifiable meshing parameters.
 
Standard_Boolean IsModified () const
 Returns modified flag.
 
Standard_Integer GetStatusFlags () const
 Returns accumulated status flags faced during meshing.
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_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
 
Standard_Boolean 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 ( )

Default constructor.

◆ ~BRepMesh_IncrementalMesh()

virtual BRepMesh_IncrementalMesh::~BRepMesh_IncrementalMesh ( )
virtual

Destructor.

◆ BRepMesh_IncrementalMesh() [2/3]

BRepMesh_IncrementalMesh::BRepMesh_IncrementalMesh ( const TopoDS_Shape theShape,
const Standard_Real  theLinDeflection,
const Standard_Boolean  isRelative = Standard_False,
const Standard_Real  theAngDeflection = 0.5,
const Standard_Boolean  isInParallel = Standard_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()

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

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.

◆ GetStatusFlags()

Standard_Integer BRepMesh_IncrementalMesh::GetStatusFlags ( ) const
inline

Returns accumulated status flags faced during meshing.

◆ IsModified()

Standard_Boolean BRepMesh_IncrementalMesh::IsModified ( ) const
inline

Returns modified flag.

◆ IsParallelDefault()

static Standard_Boolean 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 meshing parameters.

◆ Perform() [1/2]

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

Performs meshing using custom context;.

◆ Perform() [2/2]

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

Performs meshing of the shape.

Implements BRepMesh_DiscretRoot.

◆ SetParallelDefault()

static void BRepMesh_IncrementalMesh::SetParallelDefault ( const Standard_Boolean  isInParallel)
static

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

Field Documentation

◆ myModified

Standard_Boolean BRepMesh_IncrementalMesh::myModified
protected

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.

◆ myParameters

IMeshTools_Parameters BRepMesh_IncrementalMesh::myParameters
protected

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.

◆ myStatus

Standard_Integer BRepMesh_IncrementalMesh::myStatus
protected

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.

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