IMeshTools — OpenCascade.js

OCCT package IMeshTools: IMeshTools_Context, IMeshTools_CurveTessellator, IMeshTools_MeshAlgo, IMeshTools_MeshAlgoFactory, and 7 more bound classes.

IMeshTools_Context

IMeshData_ShapeStandard_Transient

Interface class representing context of BRepMesh algorithm. Intended to cache discrete model and instances of tools for its processing.

Constructors(1)

constructor(): IMeshTools_Context
Constructor.

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(23)

BuildModel(): boolean
Builds model using assigned model builder.
Returns
True on success, False elsewhere.
DiscretizeEdges(): boolean
Performs discretization of model edges using assigned edge discret algorithm.
Returns
True on success, False elsewhere.
HealModel(): boolean
Performs healing of discrete model built by DiscretizeEdges() method using assigned healing algorithm.
Returns
True on success, False elsewhere.
PreProcessModel(): boolean
Performs pre-processing of discrete model using assigned algorithm. Performs auxiliary actions such as cleaning shape from old triangulation.
Returns
True on success, False elsewhere.
DiscretizeFaces(theRange: Message_ProgressRange): boolean
Performs meshing of faces of discrete model using assigned meshing algorithm.
Parameters (1)
- theRange
Returns
True on success, False elsewhere.
PostProcessModel(): boolean
Performs post-processing of discrete model using assigned algorithm.
Returns
True on success, False elsewhere.
Clean(): void
Cleans temporary context data.
GetModelBuilder(): IMeshTools_ModelBuilder
Gets instance of a tool to be used to build discrete model.
SetModelBuilder(theBuilder: IMeshTools_ModelBuilder): void
Sets instance of a tool to be used to build discrete model.
Parameters (1)
- theBuilder
GetEdgeDiscret(): IMeshTools_ModelAlgo
Gets instance of a tool to be used to discretize edges of a model.
SetEdgeDiscret(theEdgeDiscret: IMeshTools_ModelAlgo): void
Sets instance of a tool to be used to discretize edges of a model.
Parameters (1)
- theEdgeDiscret
GetModelHealer(): IMeshTools_ModelAlgo
Gets instance of a tool to be used to heal discrete model.
SetModelHealer(theModelHealer: IMeshTools_ModelAlgo): void
Sets instance of a tool to be used to heal discrete model.
Parameters (1)
- theModelHealer
GetPreProcessor(): IMeshTools_ModelAlgo
Gets instance of pre-processing algorithm.
SetPreProcessor(thePreProcessor: IMeshTools_ModelAlgo): void
Sets instance of pre-processing algorithm.
Parameters (1)
- thePreProcessor
GetFaceDiscret(): IMeshTools_ModelAlgo
Gets instance of meshing algorithm.
SetFaceDiscret(theFaceDiscret: IMeshTools_ModelAlgo): void
Sets instance of meshing algorithm.
Parameters (1)
- theFaceDiscret
GetPostProcessor(): IMeshTools_ModelAlgo
Gets instance of post-processing algorithm.
SetPostProcessor(thePostProcessor: IMeshTools_ModelAlgo): void
Sets instance of post-processing algorithm.
Parameters (1)
- thePostProcessor
GetParameters(): IMeshTools_Parameters
Gets parameters to be used for meshing.
ChangeParameters(): IMeshTools_Parameters
Gets reference to parameters to be used for meshing.
GetModel(): IMeshData_Model
Returns discrete model of a shape.
DynamicType(): Standard_Type

IMeshTools_CurveTessellator

Standard_Transient

Interface class providing API for edge tessellation tools.

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(3)

PointsNb(): number
Returns number of tessellation points.
Value(theIndex: number, thePoint: gp_Pnt, theParameter: number): { returnValue: boolean; theParameter: number }
Returns parameters of solution with the given index.
Parameters (3)
- theIndex —
  index of tessellation point.
- thePoint —
  tessellation point. Mutated in place; read the updated value from this argument after the call.
- theParameter —
  parameters on PCurve corresponded to the solution.
Returns
A result object with fields:
- returnValue: True in case of valid result, false elewhere.
- theParameter: parameters on PCurve corresponded to the solution.
DynamicType(): Standard_Type

IMeshTools_MeshAlgo

Standard_Transient

Interface class providing API for algorithms intended to create mesh for discrete face.

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(2)

Perform(theDFace: IFaceHandle, theParameters: IMeshTools_Parameters, theRange: Message_ProgressRange): void
Performs processing of the given face.
Parameters (3)
- theDFace
- theParameters
- theRange
DynamicType(): Standard_Type

IMeshTools_MeshAlgoFactory

Standard_Transient

Base interface for factories producing instances of triangulation algorithms taking into account type of surface of target face.

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(2)

GetAlgo(theSurfaceType: GeomAbs_SurfaceType, theParameters: IMeshTools_Parameters): IMeshTools_MeshAlgo
Creates instance of meshing algorithm for the given type of surface.
Parameters (2)
- theSurfaceType
- theParameters
DynamicType(): Standard_Type

IMeshTools_MeshAlgoType

Properties(3)

IMeshTools_MeshAlgoType_DEFAULT:'IMeshTools_MeshAlgoType_DEFAULT'readonly
IMeshTools_MeshAlgoType_Watson:'IMeshTools_MeshAlgoType_Watson'readonly
IMeshTools_MeshAlgoType_Delabella:'IMeshTools_MeshAlgoType_Delabella'readonly

Builds mesh for each face of shape without triangulation. In case if some faces of shape have already been triangulated checks deflection of existing polygonal model and re-uses it if deflection satisfies the specified parameter. Otherwise nullifies existing triangulation and build triangulation anew.
The following statuses are used: Message_Done1 - algorithm has finished without errors. Message_Fail1 - invalid context. Message_Fail2 - algorithm has faced unexpected error. Message_Fail3 - fail to discretize edges. Message_Fail4 - can't heal discrete model. Message_Fail5 - fail to pre-process model. Message_Fail6 - fail to discretize faces. Message_Fail7 - fail to post-process model. Message_Warn1 - shape contains no objects to mesh.

Constructors(2)

constructor(): IMeshTools_MeshBuilder
Constructor.
constructor(theContext: IMeshTools_Context): IMeshTools_MeshBuilder
Constructor.
Parameters (1)
- theContext

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(4)

SetContext(theContext: IMeshTools_Context): void
Sets context for algorithm.
Parameters (1)
- theContext
GetContext(): IMeshTools_Context
Gets context of algorithm.
Perform(theRange: Message_ProgressRange): void
Performs meshing to the shape using current context.
Parameters (1)
- theRange
DynamicType(): Standard_Type

IMeshTools_ModelAlgo

Standard_Transient

Interface class providing API for algorithms intended to update or modify discrete model.

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(2)

Perform(theModel: IMeshData_Model, theParameters: IMeshTools_Parameters, theRange: Message_ProgressRange): boolean
Exceptions protected processing of the given model.
Parameters (3)
- theModel
- theParameters
- theRange
DynamicType(): Standard_Type

IMeshTools_ModelBuilder

Message_AlgorithmStandard_Transient

Interface class represents API for tool building discrete model.
The following statuses should be used by default: Message_Done1 - model has been successfully built. Message_Fail1 - empty shape. Message_Fail2 - model has not been build due to unexpected reason.

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(2)

Perform(theShape: TopoDS_Shape, theParameters: IMeshTools_Parameters): IMeshData_Model
Exceptions protected method to create discrete model for the given shape. Returns nullptr in case of failure.
Parameters (2)
- theShape
- theParameters
DynamicType(): Standard_Type

IMeshTools_Parameters

Structure storing meshing parameters.

Constructors(1)

constructor(): IMeshTools_Parameters
Default constructor.

Static methods(1)

RelMinSize(): number
Returns factor used to compute default value of MinSize (minimum mesh edge length) from deflection.

Properties(15)

MeshAlgo:IMeshTools_MeshAlgoType
Angle:number
Deflection:number
AngleInterior:number
DeflectionInterior:number
MinSize:number
InParallel:boolean
Relative:boolean
InternalVerticesMode:boolean
ControlSurfaceDeflection:boolean
EnableControlSurfaceDeflectionAllSurfaces:boolean
CleanModel:boolean
AdjustMinSize:boolean
ForceFaceDeflection:boolean
AllowQualityDecrease:boolean

IMeshTools_ShapeExplorer

IMeshData_ShapeStandard_Transient

Explores TopoDS_Shape for parts to be meshed - faces and free edges.

Constructors(1)

constructor(theShape: TopoDS_Shape): IMeshTools_ShapeExplorer
Constructor.
Parameters (1)
- theShape

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(2)

Accept(theVisitor: IMeshTools_ShapeVisitor): void
Starts exploring of a shape.
Parameters (1)
- theVisitor
DynamicType(): Standard_Type

IMeshTools_ShapeVisitor

Standard_Transient

Interface class for shape visitor.

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(3)

Visit(theFace: TopoDS_Face): void
Handles TopoDS_Face object.
Parameters (1)
- theFace
Visit(theEdge: TopoDS_Edge): void
Handles TopoDS_Edge object.
Parameters (1)
- theEdge
DynamicType(): Standard_Type