MeshLink
Computational geometry access
MeshAssociativity_c.h File Reference

Go to the source code of this file.

Functions

MLSTATUS ML_checkDataSizes (size_t size_of_MLINT, size_t size_of_MLINT32, size_t size_of_MLFLOAT, size_t size_of_MLREAL)
 Checks MeshLink Caller data sizes against MeshLink library. More...
 
MLSTATUS ML_createMeshAssociativityObj (MeshAssociativityObj *meshAssocObj)
 Allocates a new MeshAssociativity Object. More...
 
void ML_freeMeshAssociativityObj (MeshAssociativityObj *meshAssocObj)
 Frees a MeshAssociativity Object. More...
 
MLSTATUS ML_parserValidateFile (MeshLinkParserObj parseObj, const char *meshlinkFilename, const char *schemaFilename)
 Validate a MeshLink XML file against the schema. More...
 
MLSTATUS ML_parserReadMeshLinkFile (MeshLinkParserObj parseObj, const char *meshlinkFilename, MeshAssociativityObj meshAssocObj)
 Read a MeshLink XML file into a MeshAssociativity object. More...
 
MLSTATUS ML_parserGetMeshLinkAttributes (MeshLinkParserObj parseObj, char *xmlns, MLINT xmlnsBufLen, char *xmlns_xsi, MLINT xmlns_xsiBufLen, char *schemaLocation, MLINT schemaBufLen)
 Get MeshLink schema attributes. More...
 
MLSTATUS ML_writerWriteMeshLinkFile (MeshLinkWriterObj writeObj, MeshAssociativityObj meshAssocObj, const char *meshlinkFilename, const char *xmlns, const char *xmlns_xsi, const char *schemaLocation)
 Write MeshAssociativity data to XML file. More...
 
MLSTATUS ML_getMeshModelByName (MeshAssociativityObj meshAssocObj, const char *modelname, MeshModelObj *meshModel)
 Get MeshModel object by name. More...
 
MLSTATUS ML_getMeshSheetByName (MeshAssociativityObj meshAssocObj, const char *sheetname, MeshModelObj *meshModel, MeshSheetObj *meshSheet)
 Get MeshSheet object by name. More...
 
MLSTATUS ML_getMeshStringByName (MeshAssociativityObj meshAssocObj, const char *stringname, MeshModelObj *meshModel, MeshStringObj *meshString)
 Get MeshString object by name. More...
 
MLSTATUS ML_addGeometryKernel (MeshAssociativityObj meshAssocObj, GeometryKernelObj geomKernelObj)
 Add GeometryKernel object to MeshAssociativity. More...
 
MLSTATUS ML_removeGeometryKernel (MeshAssociativityObj meshAssocObj, GeometryKernelObj geomKernelObj)
 Remove GeometryKernel object from MeshAssociativity. More...
 
MLSTATUS ML_setActiveGeometryKernelByName (MeshAssociativityObj meshAssocObj, const char *kernelname)
 Set MeshAssociativity active Geometry Kernel by name. More...
 
MLSTATUS ML_getActiveGeometryKernel (MeshAssociativityObj meshAssocObj, GeometryKernelObj *geomKernelObj)
 Get MeshAssociativity active Geometry Kernel object. More...
 
MLINT ML_getNumGeometryFiles (MeshAssociativityObj meshAssocObj)
 Get number of geometry files referenced by the MeshAssociativity. More...
 
MLSTATUS ML_getGeometryFileObj (MeshAssociativityObj meshAssocObj, MLINT index, MeshLinkFileConstObj *fileObj)
 Get GeometryFile refereneced in MeshAssociativity by index. More...
 
MLSTATUS ML_getFilename (MeshLinkFileConstObj fileObj, char *filenameBuf, MLINT filenameBufLen)
 Get file name for a generic MeshLinkFile. More...
 
MLSTATUS ML_setGeomModelSize (GeometryKernelObj geomKernelObj, MLREAL modelSize)
 Set the model size attribute in the GeometryKernel. Model size (extents) is used to define tolerances related to model closure, e.g. same point tolerance. More...
 
MLSTATUS ML_getGeomModelSize (GeometryKernelObj geomKernelObj, MLREAL *modelSize)
 Get the model size attribute in the GeometryKernel. Model size is used to define tolerances related to model closure, e.g. same point tolerance. More...
 
MLSTATUS ML_readGeomFile (GeometryKernelObj geomKernelObj, const char *geomFilename)
 Read a GeometryFile into the GeometryKernel. More...
 
MLSTATUS ML_getFileAttIDs (MeshAssociativityObj meshAssocObj, MeshLinkFileConstObj fileObj, MLINT attIDs[], MLINT sizeAttIDs, MLINT *numAttIDs)
 Get array of attribute IDs for a generic MeshLinkFile. More...
 
MLSTATUS ML_getAttribute (MeshAssociativityObj meshAssocObj, MLINT attID, char *attNameBuf, MLINT attNameBufLen, char *attValueBuf, MLINT attValueBufLen)
 Get attribute name-value pair by ID. More...
 
MLINT ML_getNumMeshModels (MeshAssociativityObj meshAssocObj)
 Get number of MeshModels in the MeshAssociativity. More...
 
MLSTATUS ML_getMeshModels (MeshAssociativityObj meshAssocObj, MeshTopoObj *modelObjs, MLINT sizeModelObj, MLINT *numModelObjs)
 Get array of MeshModels in the MeshAssociativity. More...
 
MLINT ML_getNumParamVerts (MeshTopoObj meshTopoObj)
 Get number of ParamVertex objects in the MeshTopo. More...
 
MLINT ML_getNumMeshSheets (MeshModelObj meshModelObj)
 Get number of MeshSheets in the MeshModel. More...
 
MLSTATUS ML_getMeshSheets (MeshModelObj meshModelObj, MeshSheetObj *sheetObjs, MLINT sizeSheetObj, MLINT *numSheetObjs)
 Get array of MeshSheets in the MeshModel. More...
 
MLSTATUS ML_getModelMeshSheetByName (MeshModelObj meshModelObj, const char *sheetname, MeshSheetObj *meshSheetObj)
 Get a MeshSheet in the MeshModel by name. More...
 
MLSTATUS ML_getModelMeshStringByName (MeshModelObj meshModelObj, const char *stringname, MeshStringObj *meshStringObj)
 Get a MeshString in the MeshModel by name. More...
 
MLINT ML_getNumSheetMeshFaces (MeshSheetObj meshSheetObj)
 Get number of MeshFaces in the MeshSheet. More...
 
MLSTATUS ML_getSheetMeshFaces (MeshSheetObj meshSheetObj, MeshTopoObj *faceObjs, MLINT sizeFaceObj, MLINT *numFaceObjs)
 Get array of MeshFaces in the MeshSheet. More...
 
MLINT ML_getNumSheetMeshFaceEdges (MeshSheetObj meshSheetObj)
 Get number of MeshFaceEdges in the MeshSheet. More...
 
MLSTATUS ML_getSheetMeshFaceEdges (MeshSheetObj meshSheetObj, MeshTopoObj *faceEdgeObjs, MLINT sizeFaceEdgeObj, MLINT *numFaceEdgeObjs)
 Get array of MeshFaceEdges in the MeshSheet. More...
 
MLINT ML_getNumMeshStrings (MeshModelObj meshModelObj)
 Get number of MeshStrings in the MeshModel. More...
 
MLSTATUS ML_getMeshStrings (MeshModelObj meshModelObj, MeshTopoObj stringObjs[], MLINT sizeStringObj, MLINT *numStringObjs)
 Get array of MeshStrings in the MeshModel. More...
 
MLINT ML_getNumStringMeshEdges (MeshSheetObj meshStringObj)
 Get number of MeshEdges in the MeshString. More...
 
MLSTATUS ML_getStringMeshEdges (MeshSheetObj meshStringObj, MeshTopoObj edgeObjs[], MLINT sizeEdgeObj, MLINT *numEdgeObjs)
 Get array of MeshEdges in the MeshString. More...
 
MLSTATUS ML_getMeshElementLinkages (MeshAssociativityObj meshAssocObj, MeshElementLinkageObj *linkageObjs, MLINT sizeLinkageObj, MLINT *numLinkageObjs)
 Get array of MeshElementLinkages in the MeshAssociativity database. More...
 
MLINT ML_getNumMeshElementLinkages (MeshAssociativityObj meshAssocObj)
 Get number of MeshElementLinkages in the MeshAssociativity database. More...
 
MLSTATUS ML_getTransform (MeshAssociativityObj meshAssocObj, MeshElementLinkageObj linkageObj, MeshLinkTransformConstObj *xformObj)
 Get MeshLinkTransform associated with a MeshElementLinkage. More...
 
MLSTATUS ML_getMeshElementLinkageInfo (MeshAssociativityObj meshAssocObj, MeshElementLinkageObj linkageObj, char *nameBuf, MLINT nameBufLen, char *sourceEntityRefBuf, MLINT sourceEntityRefBufLen, char *targetEntityRefBuf, MLINT targetEntityRefBufLen, MLINT attIDs[], MLINT sizeAttIDs, MLINT *numAttIDs)
 Get info associated with a MeshElementLinkage. More...
 
MLSTATUS ML_getMeshLinkTransformInfo (MeshAssociativityObj meshAssocObj, MeshLinkTransformConstObj xformObj, char *nameBuf, MLINT nameBufLen, MLINT attIDs[], MLINT sizeAttIDs, MLINT *numAttIDs)
 Get info associated with a MeshLinkTransform. More...
 
MLSTATUS ML_getTransformQuaternion (MeshLinkTransformConstObj xformObj, MLREAL quat[4][4])
 Get the quaternion matrix associated with a MeshLinkTransform. More...
 
MLSTATUS ML_findLowestTopoPointByInd (MeshModelObj meshModelObj, MLINT pointIndex, MeshPointObj *meshPointObj)
 Find a point index's lowest topological reference. Returns first usage in the order MeshString, MeshSheet, MeshModel. More...
 
MLSTATUS ML_findHighestTopoPointByInd (MeshModelObj meshModelObj, MLINT pointIndex, MeshPointObj *meshPointObj)
 Find a point index's highest topological reference. Returns first usage in the order MeshModel, MeshSheet, MeshString. More...
 
MLSTATUS ML_findMeshEdgePointByInd (MeshModelObj meshModelObj, MLINT pointIndex, MeshPointObj *meshPointObj)
 Find a point index reference in a MeshString's MeshEdge. Returns first occurance of index in a MeshString's MeshEdge array. More...
 
MLSTATUS ML_findMeshFacePointByInd (MeshModelObj meshModelObj, MLINT pointIndex, MeshPointObj *meshPointObj)
 Find a point index reference in a MeshSheet's MeshFace. Returns first occurance of index in a MeshSheet's MeshFace array. More...
 
MLSTATUS ML_getFaceInds (MeshFaceObj meshFaceObj, MLINT inds[], MLINT *numInds)
 Return array of MeshFace point indices. More...
 
MLSTATUS ML_getEdgeInds (MeshEdgeObj meshEdgeObj, MLINT inds[], MLINT *numInds)
 Return array of MeshEdge point indices. More...
 
MLSTATUS ML_findFaceByInds (MeshModelObj meshModelObj, MLINT *indices, MLINT numIndices, MeshFaceObj *meshFaceObj)
 Find a MeshFace in a MeshModel by point indices. Returns first occurance of indices in a MeshSheet's MeshFace. More...
 
MLSTATUS ML_findLowestTopoEdgeByInds (MeshModelObj meshModelObj, MLINT *indices, MLINT numIndices, MeshEdgeObj *meshEdgeObj)
 Find a MeshEdge's lowest topological reference by point indices. Returns first usage in the order MeshString, MeshSheet, MeshModel. More...
 
MLSTATUS ML_getParamVerts (MeshTopoConstObj meshTopoObj, ParamVertexConstObj pvObjsArr[], MLINT pvObjsArrLen, MLINT *num_pvObjs)
 Return array of Parametric Vertices for a MeshTopo object. MeshTopo object may be any MeshTopo derived object, e.g. MeshSheet, MeshFace. More...
 
MLSTATUS ML_getParamVertInfo (ParamVertexConstObj pvObj, char *vrefBuf, MLINT vrefBufLen, MLINT *gref, MLINT *mid, MLVector2D UV)
 Get Parametric Vertex information. More...
 
MLSTATUS ML_getMeshTopoGref (MeshTopoObj meshTopoObj, MLINT *gref)
 Get GeometryGroup ID for a MeshTopo object. MeshTopo object may be a MeshPoint, MeshEdge, MeshFace object. More...
 
MLSTATUS ML_getMeshTopoInfo (MeshAssociativityObj meshAssocObj, MeshTopoObj meshTopoObj, char *refBuf, MLINT refBufLen, char *nameBuf, MLINT nameBufLen, MLINT *gref, MLINT *mid, MLINT attIDs[], MLINT sizeAttIDs, MLINT *numAttIDs)
 Get MeshTopo information. MeshTopo object may be a MeshPoint, MeshEdge, MeshFace object. More...
 
MLSTATUS ML_getMeshPointInfo (MeshAssociativityObj meshAssocObj, MeshPointObj meshPointObj, char *refBuf, MLINT refBufLen, char *nameBuf, MLINT nameBufLen, MLINT *gref, MLINT *mid, MLINT attIDs[], MLINT sizeAttIDs, MLINT *numAttIDs, ParamVertexConstObj *pvObj)
 Get MeshPoint information. More...
 
MLSTATUS ML_getMeshEdgeInfo (MeshAssociativityObj meshAssocObj, MeshEdgeObj meshEdgeObj, char *refBuf, MLINT refBufLen, char *nameBuf, MLINT nameBufLen, MLINT *gref, MLINT *mid, MLINT attIDs[], MLINT sizeAttIDs, MLINT *numAttIDs, ParamVertexConstObj pvObjs[], MLINT sizepvObjs, MLINT *numpvObjs)
 Get MeshEdge information. More...
 
MLSTATUS ML_getMeshFaceInfo (MeshAssociativityObj meshAssocObj, MeshEdgeObj meshFaceObj, char *refBuf, MLINT refBufLen, char *nameBuf, MLINT nameBufLen, MLINT *gref, MLINT *mid, MLINT attIDs[], MLINT sizeAttIDs, MLINT *numAttIDs, ParamVertexConstObj pvObjs[], MLINT sizepvObjs, MLINT *numpvObjs)
 Get MeshFace information. More...
 
MLINT ML_getNumGeometryGroups (MeshAssociativityObj meshAssocObj)
 Get number of GeometryGroups in the MeshAssociativity database. More...
 
MLSTATUS ML_getGeometryGroupIDs (MeshAssociativityObj meshAssocObj, MLINT IDs[], MLINT sizeIDs, MLINT *numIDs)
 Get array of GeometryGroup IDs in the MeshAssociativity database. More...
 
MLSTATUS ML_getGeometryGroupByID (MeshAssociativityObj meshAssocObj, MLINT gid, GeometryGroupObj *geomGroupObj)
 Get GeometryGroup by ID. More...
 
MLSTATUS ML_getEntityNames (GeometryGroupObj geomGroupObj, char *entityNamesBufArr, MLINT entityNamesArrLen, MLINT entityNameBufLen, MLINT *num_entityNames)
 Get array of entity names referenced by GeometryGroup. More...
 
MLSTATUS ML_evalXYZ (GeometryKernelObj geomKernelObj, MLVector2D UV, const char *entityName, MLVector3D XYZ)
 Evaluate XYZ at parametric coordinates on geometric entity. More...
 
MLSTATUS ML_evalRadiusOfCurvature (GeometryKernelObj geomKernelObj, MLVector2D UV, const char *entityName, MLREAL *minRradOfCurvature, MLREAL *maxRradOfCurvature)
 Evaluate radius of curvature at parametric coordinates on geometric entity. More...
 
MLSTATUS ML_evalCurvatureOnCurve (GeometryKernelObj geomKernelObj, MLVector2D UV, const char *entityName, MLVector3D XYZ, MLVector3D Tangent, MLVector3D PrincipalNormal, MLVector3D Binormal, MLREAL *Curvature, MLINT *Linear)
 Evaluate curvature at parametric coordinate on geometric curve. More...
 
MLSTATUS ML_evalDerivativesOnCurve (GeometryKernelObj geomKernelObj, MLVector2D UV, const char *entityName, MLVector3D XYZ, MLVector3D dXYZdU, MLVector3D d2XYZdU2)
 Evaluate parametric derivatives on curve. More...
 
MLSTATUS ML_evalCurvatureOnSurface (GeometryKernelObj geomKernelObj, MLVector2D UV, const char *entityName, MLVector3D XYZ, MLVector3D dXYZdU, MLVector3D dXYZdV, MLVector3D d2XYZdU2, MLVector3D d2XYZdUdV, MLVector3D d2XYZdV2, MLVector3D surfaceNormal, MLVector3D principalV, MLREAL *minCurvature, MLREAL *maxCurvature, MLREAL *avg, MLREAL *gauss, MLORIENT *orientation)
 Evaluate curvature at parametric coordinate on geometric surface. More...
 
MLSTATUS ML_evalSurfaceTolerance (GeometryKernelObj geomKernelObj, const char *entityName, MLREAL *minTolerance, MLREAL *maxTolerance)
 Evaluate model assembly tolerances on geometric surface. If the surface name given matches a model face, then the face's boundary edges and vertices will be querried for the assembly tolerance used to close the model. More...
 
MLSTATUS ML_createProjectionDataObj (GeometryKernelObj geomKernelObj, ProjectionDataObj *projectionDataObj)
 Allocates a new GeometryKernel-specific ProjectionData Object. A ProjectionData object is used to store inverse evaluation data specific to the GeometryKernel. More...
 
void ML_freeProjectionDataObj (ProjectionDataObj *projectionDataObj)
 Frees a GeometryKernel-specific ProjectionData Object. More...
 
MLSTATUS ML_projectPoint (GeometryKernelObj geomKernelObj, GeometryGroupObj geomGroupObj, MLVector3D point, ProjectionDataObj projectionDataObj)
 Closest point projection onto a GeometryGroup. A ProjectionData object is used to store inverse evaluation data specific to the GeometryKernel. More...
 
MLSTATUS ML_getProjectionInfo (GeometryKernelObj geomKernelObj, ProjectionDataObj projectionDataObj, MLVector3D xyz, MLVector2D UV, char *entityNameBuf, MLINT entityNameBufLen, MLREAL *distance, MLREAL *tolerance)
 Get info from closest point projection onto a GeometryGroup stored in a ProjectionData object specific to the GeometryKernel. More...
 
MLTYPE ML_getEntityType (GeometryKernelObj geomKernelObj, const char *entityName)
 Get the geomtric type of an entity by name. More...
 
MLSTATUS ML_entityExists (GeometryKernelObj geomKernelObj, const char *entityName)
 Determine if a geometric entity exists by name. More...
 

Function Documentation

◆ ML_addGeometryKernel()

MLSTATUS ML_addGeometryKernel ( MeshAssociativityObj  meshAssocObj,
GeometryKernelObj  geomKernelObj 
)

Add GeometryKernel object to MeshAssociativity.

Parameters
[in,out]meshAssocObjMeshAssociativity object
[in]geomKernelObjGeometryKernel object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_checkDataSizes()

MLSTATUS ML_checkDataSizes ( size_t  size_of_MLINT,
size_t  size_of_MLINT32,
size_t  size_of_MLFLOAT,
size_t  size_of_MLREAL 
)

Checks MeshLink Caller data sizes against MeshLink library.

Parameters
[in]size_of_MLINTsizeof(MLINT)
[in]size_of_MLINT32sizeof(MLINT32)
[in]size_of_MLFLOATsizeof(MLFLOAT)
[in]size_of_MLREALsizeof(MLREAL)
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_createMeshAssociativityObj()

MLSTATUS ML_createMeshAssociativityObj ( MeshAssociativityObj meshAssocObj)

Allocates a new MeshAssociativity Object.

Parameters
[in,out]meshAssocObjMeshAssociativity object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_createProjectionDataObj()

MLSTATUS ML_createProjectionDataObj ( GeometryKernelObj  geomKernelObj,
ProjectionDataObj projectionDataObj 
)

Allocates a new GeometryKernel-specific ProjectionData Object. A ProjectionData object is used to store inverse evaluation data specific to the GeometryKernel.

Parameters
[in]geomKernelObjGeometryKernel object
[in,out]projectionDataObjProjectionData object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_entityExists()

MLSTATUS ML_entityExists ( GeometryKernelObj  geomKernelObj,
const char *  entityName 
)

Determine if a geometric entity exists by name.

Parameters
[in]geomKernelObjGeometryKernel object
[in]entityNamegeometry entity name
Returns
ML_STATUS_OK if found

◆ ML_evalCurvatureOnCurve()

MLSTATUS ML_evalCurvatureOnCurve ( GeometryKernelObj  geomKernelObj,
MLVector2D  UV,
const char *  entityName,
MLVector3D  XYZ,
MLVector3D  Tangent,
MLVector3D  PrincipalNormal,
MLVector3D  Binormal,
MLREAL Curvature,
MLINT Linear 
)

Evaluate curvature at parametric coordinate on geometric curve.

Parameters
[in]geomKernelObjGeometryKernel object
[in]UV2D parametric coordinates (2nd coord unused)
[in]entityNameentity name
[out]XYZlocation on curve
[out]Tangentunit vector of tangent to curve
[out]PrincipalNormalunit vector of principal normal to curve (pointing towards the center of curvature)
[out]Binormalunit vector of binormal to curve (tangent x principal normal)
[out]Curvaturecurvature in radians per unit length
[out]Linearwhether the curve is linear and has no unique normal
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_evalCurvatureOnSurface()

MLSTATUS ML_evalCurvatureOnSurface ( GeometryKernelObj  geomKernelObj,
MLVector2D  UV,
const char *  entityName,
MLVector3D  XYZ,
MLVector3D  dXYZdU,
MLVector3D  dXYZdV,
MLVector3D  d2XYZdU2,
MLVector3D  d2XYZdUdV,
MLVector3D  d2XYZdV2,
MLVector3D  surfaceNormal,
MLVector3D  principalV,
MLREAL minCurvature,
MLREAL maxCurvature,
MLREAL avg,
MLREAL gauss,
MLORIENT orientation 
)

Evaluate curvature at parametric coordinate on geometric surface.

Parameters
[in]geomKernelObjGeometryKernel object
[in]UV2D parametric coordinates
[in]entityNameentity name
[out]XYZlocation on curve
[out]dXYZdUfirst partial derivative w.r.t. U
[out]dXYZdVfirst partial derivative w.r.t. V
[out]d2XYZdU2second partial derivative w.r.t. U
[out]d2XYZdUdVsecond partial derivative w.r.t. UV
[out]d2XYZdV2second partial derivative w.r.t. V
[out]surfaceNormalunit vector of surface normal
[out]principalVunit vector tangent to surface where curvature = min
[out]minCurvatureminimum curvature in radians per unit length
[out]maxCurvaturemaximum curvature in radians per unit length
[out]avgaverage curvature in radians per unit length
[out]gaussGaussian curvature
[out]orientationorientation of the surface in the model
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_evalDerivativesOnCurve()

MLSTATUS ML_evalDerivativesOnCurve ( GeometryKernelObj  geomKernelObj,
MLVector2D  UV,
const char *  entityName,
MLVector3D  XYZ,
MLVector3D  dXYZdU,
MLVector3D  d2XYZdU2 
)

Evaluate parametric derivatives on curve.

Parameters
[in]geomKernelObjGeometryKernel object
[in]UV2D parametric coordinates
[in]entityNameentity name
[out]XYZXYZ location on curve
[out]dXYZdUfirst derivative
[out]d2XYZdU2second derivative
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_evalRadiusOfCurvature()

MLSTATUS ML_evalRadiusOfCurvature ( GeometryKernelObj  geomKernelObj,
MLVector2D  UV,
const char *  entityName,
MLREAL minRradOfCurvature,
MLREAL maxRradOfCurvature 
)

Evaluate radius of curvature at parametric coordinates on geometric entity.

Parameters
[in]geomKernelObjGeometryKernel object
[in]UV2D parametric coordinates (2nd coord unused for 1D entities)
[in]entityNameentity name
[out]minRradOfCurvatureminimum radius of curvature
[out]maxRradOfCurvaturemaximum radius of curvature
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_evalSurfaceTolerance()

MLSTATUS ML_evalSurfaceTolerance ( GeometryKernelObj  geomKernelObj,
const char *  entityName,
MLREAL minTolerance,
MLREAL maxTolerance 
)

Evaluate model assembly tolerances on geometric surface. If the surface name given matches a model face, then the face's boundary edges and vertices will be querried for the assembly tolerance used to close the model.

Parameters
[in]geomKernelObjGeometryKernel object
[in]entityNamesurface name
[out]minToleranceminimum assembly tolerance on boundary
[out]maxCurvaturemaximum assembly tolerance on boundary
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_evalXYZ()

MLSTATUS ML_evalXYZ ( GeometryKernelObj  geomKernelObj,
MLVector2D  UV,
const char *  entityName,
MLVector3D  XYZ 
)

Evaluate XYZ at parametric coordinates on geometric entity.

Parameters
[in]geomKernelObjGeometryKernel object
[in]UV2D parametric coordinates (2nd coord unused for 1D entities)
[in]entityNameentity name
[out]XYZlocation
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_findFaceByInds()

MLSTATUS ML_findFaceByInds ( MeshModelObj  meshModelObj,
MLINT indices,
MLINT  numIndices,
MeshFaceObj meshFaceObj 
)

Find a MeshFace in a MeshModel by point indices. Returns first occurance of indices in a MeshSheet's MeshFace.

Parameters
[in]meshModelObjMeshModel object
[in]indicesPoint index array
[in]numIndicesNumber of point indices
[out]meshFaceObjMeshFace object
Returns
ML_STATUS_OK if found

◆ ML_findHighestTopoPointByInd()

MLSTATUS ML_findHighestTopoPointByInd ( MeshModelObj  meshModelObj,
MLINT  pointIndex,
MeshPointObj meshPointObj 
)

Find a point index's highest topological reference. Returns first usage in the order MeshModel, MeshSheet, MeshString.

Parameters
[in]meshModelObjMeshModel object
[in]pointIndexPoint index
[out]meshPointObjMeshPoint object
Returns
ML_STATUS_OK if found

◆ ML_findLowestTopoEdgeByInds()

MLSTATUS ML_findLowestTopoEdgeByInds ( MeshModelObj  meshModelObj,
MLINT indices,
MLINT  numIndices,
MeshEdgeObj meshEdgeObj 
)

Find a MeshEdge's lowest topological reference by point indices. Returns first usage in the order MeshString, MeshSheet, MeshModel.

Parameters
[in]meshModelObjMeshModel object
[in]indicesPoint index array
[in]numIndicesNumber of point indices
[out]meshEdgeObjMeshEdge object
Returns
ML_STATUS_OK if found

◆ ML_findLowestTopoPointByInd()

MLSTATUS ML_findLowestTopoPointByInd ( MeshModelObj  meshModelObj,
MLINT  pointIndex,
MeshPointObj meshPointObj 
)

Find a point index's lowest topological reference. Returns first usage in the order MeshString, MeshSheet, MeshModel.

Parameters
[in]meshModelObjMeshModel object
[in]pointIndexPoint index
[out]meshPointObjMeshPoint object
Returns
ML_STATUS_OK if found

◆ ML_findMeshEdgePointByInd()

MLSTATUS ML_findMeshEdgePointByInd ( MeshModelObj  meshModelObj,
MLINT  pointIndex,
MeshPointObj meshPointObj 
)

Find a point index reference in a MeshString's MeshEdge. Returns first occurance of index in a MeshString's MeshEdge array.

Parameters
[in]meshModelObjMeshModel object
[in]pointIndexPoint index
[out]meshPointObjMeshPoint object
Returns
ML_STATUS_OK if found

◆ ML_findMeshFacePointByInd()

MLSTATUS ML_findMeshFacePointByInd ( MeshModelObj  meshModelObj,
MLINT  pointIndex,
MeshPointObj meshPointObj 
)

Find a point index reference in a MeshSheet's MeshFace. Returns first occurance of index in a MeshSheet's MeshFace array.

Parameters
[in]meshModelObjMeshModel object
[in]pointIndexPoint index
[out]meshPointObjMeshPoint object
Returns
ML_STATUS_OK if found

◆ ML_freeMeshAssociativityObj()

void ML_freeMeshAssociativityObj ( MeshAssociativityObj meshAssocObj)

Frees a MeshAssociativity Object.

Parameters
[in,out]meshAssocObjMeshAssociativity object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_freeProjectionDataObj()

void ML_freeProjectionDataObj ( ProjectionDataObj projectionDataObj)

Frees a GeometryKernel-specific ProjectionData Object.

Parameters
[in,out]projectionDataObjProjectionData object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getActiveGeometryKernel()

MLSTATUS ML_getActiveGeometryKernel ( MeshAssociativityObj  meshAssocObj,
GeometryKernelObj geomKernelObj 
)

Get MeshAssociativity active Geometry Kernel object.

Parameters
[in]meshAssocObjMeshAssociativity object
[out]geomKernelObjGeometryKernel object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getAttribute()

MLSTATUS ML_getAttribute ( MeshAssociativityObj  meshAssocObj,
MLINT  attID,
char *  attNameBuf,
MLINT  attNameBufLen,
char *  attValueBuf,
MLINT  attValueBufLen 
)

Get attribute name-value pair by ID.

Parameters
[in]meshAssocObjMeshAssociativity object
[in]attIDattribute ID
[in,out]attNameBufattribute name buffer
[in,out]attNameBufLenattribute name buffer length
[in,out]attValueBufattribute value buffer
[in,out]attValueBufLenattribute value buffer length
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getEdgeInds()

MLSTATUS ML_getEdgeInds ( MeshEdgeObj  meshEdgeObj,
MLINT  inds[],
MLINT numInds 
)

Return array of MeshEdge point indices.

Parameters
[in]meshEdgeObjMeshEdge object
[in,out]indsPoint index array (size 2)
[out]numIndsPoint index count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getEntityNames()

MLSTATUS ML_getEntityNames ( GeometryGroupObj  geomGroupObj,
char *  entityNamesBufArr,
MLINT  entityNamesArrLen,
MLINT  entityNameBufLen,
MLINT num_entityNames 
)

Get array of entity names referenced by GeometryGroup.

Parameters
[in]geomGroupObjGeometryGroup object
[in,out]entityNamesBufArrentity name buffer array
[in]entityNamesArrLenentity name buffer array size
[in]entityNameBufLenentity name buffer length
[out]num_entityNamesentity name count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getEntityType()

MLTYPE ML_getEntityType ( GeometryKernelObj  geomKernelObj,
const char *  entityName 
)

Get the geomtric type of an entity by name.

Parameters
[in]geomKernelObjGeometryKernel object
[in]entityNamegeoemtry entity name
Returns
entity type

◆ ML_getFaceInds()

MLSTATUS ML_getFaceInds ( MeshFaceObj  meshFaceObj,
MLINT  inds[],
MLINT numInds 
)

Return array of MeshFace point indices.

Parameters
[in]meshFaceObjMeshFace object
[in,out]indsPoint index array (size 4)
[out]numIndsPoint index count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getFileAttIDs()

MLSTATUS ML_getFileAttIDs ( MeshAssociativityObj  meshAssocObj,
MeshLinkFileConstObj  fileObj,
MLINT  attIDs[],
MLINT  sizeAttIDs,
MLINT numAttIDs 
)

Get array of attribute IDs for a generic MeshLinkFile.

Parameters
[in]meshAssocObjMeshAssociativity object
[in]fileObjMeshLinkFile object (could be GeometryFile or MeshFile)
[in,out]attIDsattribute ID array
[in]sizeAttIDsattribute ID array size
[out]numAttIDsattribute ID count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getFilename()

MLSTATUS ML_getFilename ( MeshLinkFileConstObj  fileObj,
char *  filenameBuf,
MLINT  filenameBufLen 
)

Get file name for a generic MeshLinkFile.

Parameters
[in]fileObjMeshLinkFile object (could be GeometryFile or MeshFile)
[in,out]filenameBuffile name buffer
[in]filenameBufLenfile name buffer length
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getGeometryFileObj()

MLSTATUS ML_getGeometryFileObj ( MeshAssociativityObj  meshAssocObj,
MLINT  index,
MeshLinkFileConstObj fileObj 
)

Get GeometryFile refereneced in MeshAssociativity by index.

Parameters
[in]meshAssocObjMeshAssociativity object
[in]indexgeometry file index
[out]fileObjGeometryFile object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getGeometryGroupByID()

MLSTATUS ML_getGeometryGroupByID ( MeshAssociativityObj  meshAssocObj,
MLINT  gid,
GeometryGroupObj geomGroupObj 
)

Get GeometryGroup by ID.

Parameters
[in]meshAssocObjMeshAssociativity object
[in]gidGeometry Group ID
[out]geomGroupObjGeometryGroup object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getGeometryGroupIDs()

MLSTATUS ML_getGeometryGroupIDs ( MeshAssociativityObj  meshAssocObj,
MLINT  IDs[],
MLINT  sizeIDs,
MLINT numIDs 
)

Get array of GeometryGroup IDs in the MeshAssociativity database.

Parameters
[in]meshAssocObjMeshAssociativity object
[in,out]IDsGeometryGroup ID array
[in]sizeIDsGeometryGroup ID array size
[out]numIDsGeometryGroup ID count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getGeomModelSize()

MLSTATUS ML_getGeomModelSize ( GeometryKernelObj  geomKernelObj,
MLREAL modelSize 
)

Get the model size attribute in the GeometryKernel. Model size is used to define tolerances related to model closure, e.g. same point tolerance.

Parameters
[in]geomKernelObjGeometryKernel object
[out]modelSizemodel size
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getMeshEdgeInfo()

MLSTATUS ML_getMeshEdgeInfo ( MeshAssociativityObj  meshAssocObj,
MeshEdgeObj  meshEdgeObj,
char *  refBuf,
MLINT  refBufLen,
char *  nameBuf,
MLINT  nameBufLen,
MLINT gref,
MLINT mid,
MLINT  attIDs[],
MLINT  sizeAttIDs,
MLINT numAttIDs,
ParamVertexConstObj  pvObjs[],
MLINT  sizepvObjs,
MLINT numpvObjs 
)

Get MeshEdge information.

Parameters
[in]meshAssocObjMeshAssociativity object
[in]meshEdgeObjMeshEdge object
[in,out]refBufreference buffer
[in]refBufLenreference buffer length
[in,out]nameBufname buffer
[in]nameBufLenname buffer length
[out]grefGeometryGroup ID
[out]midID
[in,out]attIDsattribute ID array
[in]sizeAttIDsattribute ID array size
[out]numAttIDsattribute count
[in,out]pvObjsParamVertex object array
[in]sizepvObjsParamVertex object array size
[out]numpvObjsParamVertex object count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getMeshElementLinkageInfo()

MLSTATUS ML_getMeshElementLinkageInfo ( MeshAssociativityObj  meshAssocObj,
MeshElementLinkageObj  linkageObj,
char *  nameBuf,
MLINT  nameBufLen,
char *  sourceEntityRefBuf,
MLINT  sourceEntityRefBufLen,
char *  targetEntityRefBuf,
MLINT  targetEntityRefBufLen,
MLINT  attIDs[],
MLINT  sizeAttIDs,
MLINT numAttIDs 
)

Get info associated with a MeshElementLinkage.

Parameters
[in]meshAssocObjMeshAssociativity object
[in]linkageObjMeshElementLinkage object
[in,out]nameBufname buffer
[in]nameBufLenname buffer length
[in,out]sourceEntityRefBufSource mesh entity reference buffer
[in]sourceEntityRefBufLenSource mesh entity reference buffer size
[in,out]targetEntityRefBufTarget mesh entity reference buffer
[in]targetEntityRefBufLenTarget mesh entity reference buffer size
[in,out]attIDsattribute ID array
[in]sizeAttIDsattribute ID array size
[out]numAttIDsattribute count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getMeshElementLinkages()

MLSTATUS ML_getMeshElementLinkages ( MeshAssociativityObj  meshAssocObj,
MeshElementLinkageObj linkageObjs,
MLINT  sizeLinkageObj,
MLINT numLinkageObjs 
)

Get array of MeshElementLinkages in the MeshAssociativity database.

Parameters
[in]meshAssocObjMeshAssociativity object
[in,out]linkageObjsMeshElementLinkage object array
[in]sizeLinkageObjMeshElementLinkage object array size
[out]numLinkageObjsMeshElementLinkage object count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getMeshFaceInfo()

MLSTATUS ML_getMeshFaceInfo ( MeshAssociativityObj  meshAssocObj,
MeshEdgeObj  meshFaceObj,
char *  refBuf,
MLINT  refBufLen,
char *  nameBuf,
MLINT  nameBufLen,
MLINT gref,
MLINT mid,
MLINT  attIDs[],
MLINT  sizeAttIDs,
MLINT numAttIDs,
ParamVertexConstObj  pvObjs[],
MLINT  sizepvObjs,
MLINT numpvObjs 
)

Get MeshFace information.

Parameters
[in]meshAssocObjMeshAssociativity object
[in]meshFaceObjMeshFace object
[in,out]refBufreference buffer
[in]refBufLenreference buffer length
[in,out]nameBufname buffer
[in]nameBufLenname buffer length
[out]grefGeometryGroup ID
[out]midID
[in,out]attIDsattribute ID array
[in]sizeAttIDsattribute ID array size
[out]numAttIDsattribute count
[in,out]pvObjsParamVertex object array
[in]sizepvObjsParamVertex object array size
[out]numpvObjsParamVertex object count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getMeshLinkTransformInfo()

MLSTATUS ML_getMeshLinkTransformInfo ( MeshAssociativityObj  meshAssocObj,
MeshLinkTransformConstObj  xformObj,
char *  nameBuf,
MLINT  nameBufLen,
MLINT  attIDs[],
MLINT  sizeAttIDs,
MLINT numAttIDs 
)

Get info associated with a MeshLinkTransform.

Parameters
[in]meshAssocObjMeshAssociativity object
[in]xformObjMeshLinkTransform object
[in,out]nameBufname buffer
[in]nameBufLenname buffer length
[in,out]attIDsattribute ID array
[in]sizeAttIDsattribute ID array size
[out]numAttIDsattribute count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getMeshModelByName()

MLSTATUS ML_getMeshModelByName ( MeshAssociativityObj  meshAssocObj,
const char *  modelname,
MeshModelObj meshModel 
)

Get MeshModel object by name.

Parameters
[in]meshAssocObjMeshAssociativity object
[in]modelnameMesh Model name
[out]meshModelMeshModel object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getMeshModels()

MLSTATUS ML_getMeshModels ( MeshAssociativityObj  meshAssocObj,
MeshTopoObj modelObjs,
MLINT  sizeModelObj,
MLINT numModelObjs 
)

Get array of MeshModels in the MeshAssociativity.

Parameters
[in]meshAssocObjMeshAssociativity object
[in,out]modelObjsMeshModel object array
[in]sizeModelObjMeshModel object array size
[out]numModelObjsMeshModel object count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getMeshPointInfo()

MLSTATUS ML_getMeshPointInfo ( MeshAssociativityObj  meshAssocObj,
MeshPointObj  meshPointObj,
char *  refBuf,
MLINT  refBufLen,
char *  nameBuf,
MLINT  nameBufLen,
MLINT gref,
MLINT mid,
MLINT  attIDs[],
MLINT  sizeAttIDs,
MLINT numAttIDs,
ParamVertexConstObj pvObj 
)

Get MeshPoint information.

Parameters
[in]meshAssocObjMeshAssociativity object
[in]meshPointObjMeshPoint object
[in,out]refBufreference buffer
[in]refBufLenreference buffer length
[in,out]nameBufname buffer
[in]nameBufLenname buffer length
[out]grefGeometryGroup ID
[out]midID
[in,out]attIDsattribute ID array
[in]sizeAttIDsattribute ID array size
[out]numAttIDsattribute count
[out]pvObjParamVertex object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getMeshSheetByName()

MLSTATUS ML_getMeshSheetByName ( MeshAssociativityObj  meshAssocObj,
const char *  sheetname,
MeshModelObj meshModel,
MeshSheetObj meshSheet 
)

Get MeshSheet object by name.

Parameters
[in]meshAssocObjMeshAssociativity object
[in]sheetnameMesh Sheet name
[out]meshModelMeshModel object containing sheet
[out]meshSheetMeshSheet object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getMeshSheets()

MLSTATUS ML_getMeshSheets ( MeshModelObj  meshModelObj,
MeshSheetObj sheetObjs,
MLINT  sizeSheetObj,
MLINT numSheetObjs 
)

Get array of MeshSheets in the MeshModel.

Parameters
[in]meshModelObjMeshModel object
[in,out]sheetObjsMeshSheet object array
[in]sizeSheetObjMeshSheet object array size
[out]numSheetObjsMeshSheet object count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getMeshStringByName()

MLSTATUS ML_getMeshStringByName ( MeshAssociativityObj  meshAssocObj,
const char *  stringname,
MeshModelObj meshModel,
MeshStringObj meshString 
)

Get MeshString object by name.

Parameters
[in]meshAssocObjMeshAssociativity object
[in]stringnameMesh String name
[out]meshModelMeshModel object containing string
[out]meshStringMeshString object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getMeshStrings()

MLSTATUS ML_getMeshStrings ( MeshModelObj  meshModelObj,
MeshTopoObj  stringObjs[],
MLINT  sizeStringObj,
MLINT numStringObjs 
)

Get array of MeshStrings in the MeshModel.

Parameters
[in]meshModelObjMeshModel object
[in,out]stringObjsMeshString object array
[in]sizeStringObjMeshString object array size
[out]numStringObjsMeshString object count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getMeshTopoGref()

MLSTATUS ML_getMeshTopoGref ( MeshTopoObj  meshTopoObj,
MLINT gref 
)

Get GeometryGroup ID for a MeshTopo object. MeshTopo object may be a MeshPoint, MeshEdge, MeshFace object.

Parameters
[in]meshTopoObjMeshTopo object
[out]grefGeometryGroup ID
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getMeshTopoInfo()

MLSTATUS ML_getMeshTopoInfo ( MeshAssociativityObj  meshAssocObj,
MeshTopoObj  meshTopoObj,
char *  refBuf,
MLINT  refBufLen,
char *  nameBuf,
MLINT  nameBufLen,
MLINT gref,
MLINT mid,
MLINT  attIDs[],
MLINT  sizeAttIDs,
MLINT numAttIDs 
)

Get MeshTopo information. MeshTopo object may be a MeshPoint, MeshEdge, MeshFace object.

Parameters
[in]meshAssocObjMeshAssociativity object
[in]meshTopoObjMeshTopo object
[in,out]refBufreference buffer
[in]refBufLenreference buffer size
[in,out]nameBufname buffer
[in]nameBufLenname buffer length
[out]grefGeometryGroup ID
[out]midID
[in,out]attIDsattribute ID array
[in]sizeAttIDsattribute ID array size
[out]numAttIDsattribute count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getModelMeshSheetByName()

MLSTATUS ML_getModelMeshSheetByName ( MeshModelObj  meshModelObj,
const char *  sheetname,
MeshSheetObj meshSheetObj 
)

Get a MeshSheet in the MeshModel by name.

Parameters
[in]meshModelObjMeshModel object
[in]sheetnameMeshSheet name to find
[in,out]meshSheetObjMeshSheet object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getModelMeshStringByName()

MLSTATUS ML_getModelMeshStringByName ( MeshModelObj  meshModelObj,
const char *  stringname,
MeshStringObj meshStringObj 
)

Get a MeshString in the MeshModel by name.

Parameters
[in]meshModelObjMeshModel object
[in]stringnameMeshString name to find
[in,out]meshSheetObjMeshString object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getNumGeometryFiles()

MLINT ML_getNumGeometryFiles ( MeshAssociativityObj  meshAssocObj)

Get number of geometry files referenced by the MeshAssociativity.

Parameters
[in]meshAssocObjMeshAssociativity object
Returns
File count

◆ ML_getNumGeometryGroups()

MLINT ML_getNumGeometryGroups ( MeshAssociativityObj  meshAssocObj)

Get number of GeometryGroups in the MeshAssociativity database.

Parameters
[in]meshAssocObjMeshAssociativity object
Returns
GeometryGroup count

◆ ML_getNumMeshElementLinkages()

MLINT ML_getNumMeshElementLinkages ( MeshAssociativityObj  meshAssocObj)

Get number of MeshElementLinkages in the MeshAssociativity database.

Parameters
[in]meshAssocObjMeshAssociativity object
Returns
MeshElementLinkage count

◆ ML_getNumMeshModels()

MLINT ML_getNumMeshModels ( MeshAssociativityObj  meshAssocObj)

Get number of MeshModels in the MeshAssociativity.

Parameters
[in]meshAssocObjMeshAssociativity object
Returns
MeshModel count

◆ ML_getNumMeshSheets()

MLINT ML_getNumMeshSheets ( MeshModelObj  meshModelObj)

Get number of MeshSheets in the MeshModel.

Parameters
[in]meshModelObjMeshModel object
Returns
MeshSheet count

◆ ML_getNumMeshStrings()

MLINT ML_getNumMeshStrings ( MeshModelObj  meshModelObj)

Get number of MeshStrings in the MeshModel.

Parameters
[in]meshModelObjMeshModel object
Returns
MeshString count

◆ ML_getNumParamVerts()

MLINT ML_getNumParamVerts ( MeshTopoObj  meshTopoObj)

Get number of ParamVertex objects in the MeshTopo.

Parameters
[in]meshTopoObjMeshTopo derived object
Returns
ParamVertex count

◆ ML_getNumSheetMeshFaceEdges()

MLINT ML_getNumSheetMeshFaceEdges ( MeshSheetObj  meshSheetObj)

Get number of MeshFaceEdges in the MeshSheet.

Parameters
[in]meshSheetObjMeshSheet object
Returns
MeshFaceEdge count

◆ ML_getNumSheetMeshFaces()

MLINT ML_getNumSheetMeshFaces ( MeshSheetObj  meshSheetObj)

Get number of MeshFaces in the MeshSheet.

Parameters
[in]meshSheetObjMeshSheet object
Returns
MeshFace count

◆ ML_getNumStringMeshEdges()

MLINT ML_getNumStringMeshEdges ( MeshSheetObj  meshStringObj)

Get number of MeshEdges in the MeshString.

Parameters
[in]meshStringObjMeshString object
Returns
MeshEdge count

◆ ML_getParamVertInfo()

MLSTATUS ML_getParamVertInfo ( ParamVertexConstObj  pvObj,
char *  vrefBuf,
MLINT  vrefBufLen,
MLINT gref,
MLINT mid,
MLVector2D  UV 
)

Get Parametric Vertex information.

Parameters
[in]pvObjParamVertex object
[in,out]vrefBufMeshPoint reference buffer
[in]vrefBufLenMeshPoint reference buffer size
[out]grefGeometryGroup ID
[out]midID
[out]UVParametric coordinates in GeometryGroup entity
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getParamVerts()

MLSTATUS ML_getParamVerts ( MeshTopoConstObj  meshTopoObj,
ParamVertexConstObj  pvObjsArr[],
MLINT  pvObjsArrLen,
MLINT num_pvObjs 
)

Return array of Parametric Vertices for a MeshTopo object. MeshTopo object may be any MeshTopo derived object, e.g. MeshSheet, MeshFace.

Parameters
[in]meshTopoObjMeshTopo object
[in,out]pvObjsArrParamVertex array
[in]pvObjsArrLenParamVertex array size
[out]num_pvObjsParamVertex count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getProjectionInfo()

MLSTATUS ML_getProjectionInfo ( GeometryKernelObj  geomKernelObj,
ProjectionDataObj  projectionDataObj,
MLVector3D  xyz,
MLVector2D  UV,
char *  entityNameBuf,
MLINT  entityNameBufLen,
MLREAL distance,
MLREAL tolerance 
)

Get info from closest point projection onto a GeometryGroup stored in a ProjectionData object specific to the GeometryKernel.

Parameters
[in]geomKernelObjGeometryKernel object
[in]projectionDataObjProjectionData object
[out]xyzlocation
[out]UVparametric coordinates
[in,out]entityNameBufgeoemtry entity name buffer
[in]entityNameBufLengeoemtry entity name buffer length
[out]distancethe distance between the original point and projected point (can be NULL)
[out]tolerancethe error tolerance of the projection result (can be NULL)
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getSheetMeshFaceEdges()

MLSTATUS ML_getSheetMeshFaceEdges ( MeshSheetObj  meshSheetObj,
MeshTopoObj faceEdgeObjs,
MLINT  sizeFaceEdgeObj,
MLINT numFaceEdgeObjs 
)

Get array of MeshFaceEdges in the MeshSheet.

Parameters
[in]meshSheetObjMeshSheet object
[in,out]faceEdgeObjsMeshFaceEdge object array
[in]sizeFaceEdgeObjMeshFaceEdge object array size
[out]numFaceEdgeObjsMeshFaceEdge object count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getSheetMeshFaces()

MLSTATUS ML_getSheetMeshFaces ( MeshSheetObj  meshSheetObj,
MeshTopoObj faceObjs,
MLINT  sizeFaceObj,
MLINT numFaceObjs 
)

Get array of MeshFaces in the MeshSheet.

Parameters
[in]meshSheetObjMeshSheet object
[in,out]faceObjsMeshFace object array
[in]sizeFaceObjMeshFace object array size
[out]numFaceObjsMeshFace object count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getStringMeshEdges()

MLSTATUS ML_getStringMeshEdges ( MeshSheetObj  meshStringObj,
MeshTopoObj  edgeObjs[],
MLINT  sizeEdgeObj,
MLINT numEdgeObjs 
)

Get array of MeshEdges in the MeshString.

Parameters
[in]meshStringObjMeshString object
[in,out]edgeObjsMeshEdge object array
[in]sizeEdgeObjMeshEdge object array size
[out]numEdgeObjsMeshEdge object count
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getTransform()

MLSTATUS ML_getTransform ( MeshAssociativityObj  meshAssocObj,
MeshElementLinkageObj  linkageObj,
MeshLinkTransformConstObj xformObj 
)

Get MeshLinkTransform associated with a MeshElementLinkage.

Parameters
[in]meshAssocObjMeshAssociativity object
[in]linkageObjMeshElementLinkage object
[out]xformObjMeshLinkTransform object (null if none)
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_getTransformQuaternion()

MLSTATUS ML_getTransformQuaternion ( MeshLinkTransformConstObj  xformObj,
MLREAL  quat[4][4] 
)

Get the quaternion matrix associated with a MeshLinkTransform.

Parameters
[in]xformObjMeshLinkTransform object
[out]quat[4][4]quaternion matrix
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_parserGetMeshLinkAttributes()

MLSTATUS ML_parserGetMeshLinkAttributes ( MeshLinkParserObj  parseObj,
char *  xmlns,
MLINT  xmlnsBufLen,
char *  xmlns_xsi,
MLINT  xmlns_xsiBufLen,
char *  schemaLocation,
MLINT  schemaBufLen 
)

Get MeshLink schema attributes.

Parameters
[in]parseObjMeshLinkParser object
[in,out]xmlnsXML name space buffer
[in]xmlnsBufLenXML name space buffer length
[in,out]xmlns_xsiXML type space buffer
[in]xmlns_xsiBufLenXML type space buffer length
[in,out]schemaLocationschema location buffer
[in]schemaBufLenschema location buffer length
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_parserReadMeshLinkFile()

MLSTATUS ML_parserReadMeshLinkFile ( MeshLinkParserObj  parseObj,
const char *  meshlinkFilename,
MeshAssociativityObj  meshAssocObj 
)

Read a MeshLink XML file into a MeshAssociativity object.

Parameters
[in]parseObjMeshLinkParser object
[in]meshlinkFilenamemeshlink filename
[in,out]meshAssocObjMeshAssociativity object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_parserValidateFile()

MLSTATUS ML_parserValidateFile ( MeshLinkParserObj  parseObj,
const char *  meshlinkFilename,
const char *  schemaFilename 
)

Validate a MeshLink XML file against the schema.

Parameters
[in]parseObjMeshLinkParser object
[in]meshlinkFilenamemeshlink filename
[in]schemaFilenameschema filename
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_projectPoint()

MLSTATUS ML_projectPoint ( GeometryKernelObj  geomKernelObj,
GeometryGroupObj  geomGroupObj,
MLVector3D  point,
ProjectionDataObj  projectionDataObj 
)

Closest point projection onto a GeometryGroup. A ProjectionData object is used to store inverse evaluation data specific to the GeometryKernel.

Parameters
[in]geomKernelObjGeometryKernel object
[in]geomGroupObjGeometryGroup object
[in]pointXYZ location
[in,out]projectionDataObjProjectionData object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_readGeomFile()

MLSTATUS ML_readGeomFile ( GeometryKernelObj  geomKernelObj,
const char *  geomFilename 
)

Read a GeometryFile into the GeometryKernel.

Parameters
[in]geomKernelObjGeometryKernel object
[in]geomFilenamegeometry file name
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_removeGeometryKernel()

MLSTATUS ML_removeGeometryKernel ( MeshAssociativityObj  meshAssocObj,
GeometryKernelObj  geomKernelObj 
)

Remove GeometryKernel object from MeshAssociativity.

Parameters
[in,out]meshAssocObjMeshAssociativity object
[in]geomKernelObjGeometryKernel object
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_setActiveGeometryKernelByName()

MLSTATUS ML_setActiveGeometryKernelByName ( MeshAssociativityObj  meshAssocObj,
const char *  kernelname 
)

Set MeshAssociativity active Geometry Kernel by name.

Parameters
[in,out]meshAssocObjMeshAssociativity object
[in]kernelnameGeometry Kernel name
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_setGeomModelSize()

MLSTATUS ML_setGeomModelSize ( GeometryKernelObj  geomKernelObj,
MLREAL  modelSize 
)

Set the model size attribute in the GeometryKernel. Model size (extents) is used to define tolerances related to model closure, e.g. same point tolerance.

Parameters
[in]geomKernelObjGeometryKernel object
[in]modelSizemodel size
Returns
ML_STATUS_OK / ML_STATUS_ERROR

◆ ML_writerWriteMeshLinkFile()

MLSTATUS ML_writerWriteMeshLinkFile ( MeshLinkWriterObj  writeObj,
MeshAssociativityObj  meshAssocObj,
const char *  meshlinkFilename,
const char *  xmlns,
const char *  xmlns_xsi,
const char *  schemaLocation 
)

Write MeshAssociativity data to XML file.

Parameters
[in]writeObjMeshLinkWriter object
[in]meshAssocObjMeshAssociativity object
[in]meshlinkFilenamemeshlink filename
[in,out]xmlnsXML name space
[in,out]xmlns_xsiXML type space
[in,out]schemaLocationschema location
Returns
ML_STATUS_OK / ML_STATUS_ERROR