MeshAssociativity_c.h

Go to the documentation of this file.

/****************************************************************************
 *
 * Copyright (c) 2019-2020 Pointwise, Inc.
 * All rights reserved.
 *
 * This sample Pointwise source code is not supported by Pointwise, Inc.
 * It is provided freely for demonstration purposes only.
 * SEE THE WARRANTY DISCLAIMER AT THE BOTTOM OF THIS FILE.
 *
 ***************************************************************************/

#ifndef MESH_ASSOCIATIVITY_C_API
#define MESH_ASSOCIATIVITY_C_API

#include "Types.h"
#include <stdlib.h>

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_checkDataSizes(
    size_t size_of_MLINT,
    size_t size_of_MLINT32,
    size_t size_of_MLFLOAT,
    size_t size_of_MLREAL
);

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_createMeshAssociativityObj( MeshAssociativityObj *meshAssocObj ) ;
 ML_EXTERN ML_STORAGE_CLASS 
void   ML_freeMeshAssociativityObj(MeshAssociativityObj *meshAssocObj) ;

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS   ML_parserValidateFile(
        MeshLinkParserObj parseObj,
        const char *meshlinkFilename,
        const char *schemaFilename);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS    ML_parserReadMeshLinkFile(
        MeshLinkParserObj parseObj,
        const char *meshlinkFilename,
        MeshAssociativityObj meshAssocObj);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS    ML_parserGetMeshLinkAttributes(
        MeshLinkParserObj parseObj,
        char *xmlns, MLINT xmlnsBufLen,
        char *xmlns_xsi, MLINT xmlns_xsiBufLen,
        char *schemaLocation, MLINT schemaBufLen);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS    ML_writerWriteMeshLinkFile(
        MeshLinkWriterObj writeObj,
        MeshAssociativityObj meshAssocObj,
        const char *meshlinkFilename,
        const char *xmlns,
        const char *xmlns_xsi,
        const char *schemaLocation);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getMeshModelByName(MeshAssociativityObj meshAssocObj, 
    const char *modelname, MeshModelObj *meshModel);

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getMeshSheetByName(MeshAssociativityObj meshAssocObj,
    const char *sheetname, 
    MeshModelObj *meshModel, MeshSheetObj *meshSheet);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getMeshStringByName(MeshAssociativityObj meshAssocObj,
    const char *stringname, 
    MeshModelObj *meshModel, MeshStringObj *meshString);

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_addGeometryKernel(MeshAssociativityObj meshAssocObj, GeometryKernelObj geomKernelObj);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_removeGeometryKernel(MeshAssociativityObj meshAssocObj, GeometryKernelObj geomKernelObj);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_setActiveGeometryKernelByName(MeshAssociativityObj meshAssocObj, const char *kernelname);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getActiveGeometryKernel(
        MeshAssociativityObj meshAssocObj,
        GeometryKernelObj *geomKernelObj);

 ML_EXTERN ML_STORAGE_CLASS 
MLINT ML_getNumGeometryFiles(MeshAssociativityObj meshAssocObj);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getGeometryFileObj(MeshAssociativityObj meshAssocObj,
    MLINT index,
    MeshLinkFileConstObj *fileObj);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getFilename( MeshLinkFileConstObj fileObj, char *filenameBuf, MLINT filenameBufLen );

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_setGeomModelSize(
    GeometryKernelObj geomKernelObj,
    MLREAL modelSize);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getGeomModelSize(
    GeometryKernelObj geomKernelObj,
    MLREAL *modelSize);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_readGeomFile(
        GeometryKernelObj geomKernelObj,
        const char *geomFilename);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getFileAttIDs(MeshAssociativityObj meshAssocObj,
        MeshLinkFileConstObj fileObj,
        MLINT attIDs[],
        MLINT sizeAttIDs,
        MLINT *numAttIDs  );
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getAttribute(MeshAssociativityObj meshAssocObj,
        MLINT attID,
        char *attNameBuf, MLINT attNameBufLen,
        char *attValueBuf, MLINT attValueBufLen
    );

 ML_EXTERN ML_STORAGE_CLASS 
MLINT ML_getNumMeshModels(MeshAssociativityObj meshAssocObj );
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getMeshModels(MeshAssociativityObj meshAssocObj,
        MeshTopoObj *modelObjs,
        MLINT sizeModelObj,
        MLINT *numModelObjs
    );
 ML_EXTERN ML_STORAGE_CLASS 
MLINT ML_getNumParamVerts(MeshTopoObj meshTopoObj
    );
 ML_EXTERN ML_STORAGE_CLASS 
    MLINT ML_getNumMeshSheets(MeshModelObj meshModelObj
    );
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getMeshSheets(MeshModelObj meshModelObj,
        MeshSheetObj *sheetObjs,
        MLINT sizeSheetObj,
        MLINT *numSheetObjs
    );
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getModelMeshSheetByName(MeshModelObj meshModelObj,
    const char *sheetname,
    MeshSheetObj *meshSheetObj);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getModelMeshStringByName(MeshModelObj meshModelObj,
    const char *stringname,
    MeshStringObj *meshStringObj);

 ML_EXTERN ML_STORAGE_CLASS 
MLINT ML_getNumSheetMeshFaces(MeshSheetObj meshSheetObj
);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getSheetMeshFaces(MeshSheetObj meshSheetObj,
    MeshTopoObj *faceObjs,
    MLINT sizeFaceObj,
    MLINT *numFaceObjs
);
 ML_EXTERN ML_STORAGE_CLASS 
MLINT ML_getNumSheetMeshFaceEdges(MeshSheetObj meshSheetObj
);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getSheetMeshFaceEdges(MeshSheetObj meshSheetObj,
    MeshTopoObj *faceEdgeObjs,
    MLINT sizeFaceEdgeObj,
    MLINT *numFaceEdgeObjs
);

 ML_EXTERN ML_STORAGE_CLASS 
MLINT ML_getNumMeshStrings(MeshModelObj meshModelObj
);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getMeshStrings(MeshModelObj meshModelObj,
    MeshTopoObj stringObjs[],
    MLINT sizeStringObj,
    MLINT *numStringObjs
);

 ML_EXTERN ML_STORAGE_CLASS 
MLINT ML_getNumStringMeshEdges(MeshSheetObj meshStringObj
);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getStringMeshEdges(MeshSheetObj meshStringObj,
    MeshTopoObj edgeObjs[],
    MLINT sizeEdgeObj,
    MLINT *numEdgeObjs
);


 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getMeshElementLinkages(
    MeshAssociativityObj meshAssocObj,
    MeshElementLinkageObj *linkageObjs,
    MLINT sizeLinkageObj,
    MLINT *numLinkageObjs
);
 ML_EXTERN ML_STORAGE_CLASS 
MLINT  ML_getNumMeshElementLinkages(
    MeshAssociativityObj meshAssocObj);

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getTransform(
    MeshAssociativityObj meshAssocObj,
    MeshElementLinkageObj linkageObj,
    MeshLinkTransformConstObj *xformObj
);

 ML_EXTERN ML_STORAGE_CLASS 
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);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getMeshLinkTransformInfo(
    MeshAssociativityObj meshAssocObj,
    MeshLinkTransformConstObj xformObj,
    char *nameBuf, MLINT nameBufLen,
    MLINT attIDs[],
    MLINT sizeAttIDs,
    MLINT *numAttIDs);

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

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_findLowestTopoPointByInd(MeshModelObj meshModelObj,
        MLINT pointIndex, MeshPointObj* meshPointObj);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_findHighestTopoPointByInd(MeshModelObj meshModelObj,
    MLINT pointIndex, MeshPointObj* meshPointObj);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_findMeshEdgePointByInd(MeshModelObj meshModelObj,
    MLINT pointIndex, MeshPointObj* meshPointObj);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_findMeshFacePointByInd(MeshModelObj meshModelObj,
    MLINT pointIndex, MeshPointObj* meshPointObj);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getFaceInds(MeshFaceObj meshFaceObj,
    MLINT inds[],       /* array of size 4 */
    MLINT *numInds
);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getEdgeInds(MeshEdgeObj meshEdgeObj,
    MLINT inds[],       /* array of size 2 */
    MLINT *numInds
);

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_findFaceByInds(MeshModelObj meshModelObj,
    MLINT *indices, MLINT numIndices,   /* python wrapper depends on these names */
    MeshFaceObj *meshFaceObj);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_findLowestTopoEdgeByInds(MeshModelObj meshModelObj,
        MLINT *indices, MLINT numIndices,  /* python wrapper depends on these names */
        MeshEdgeObj *meshEdgeObj);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getParamVerts(MeshTopoConstObj meshTopoObj,
        ParamVertexConstObj pvObjsArr[],  /* array of ParamVertexConstObj */
        MLINT pvObjsArrLen,               /* length of array */
        MLINT *num_pvObjs );
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getParamVertInfo(ParamVertexConstObj pvObj,
        char *vrefBuf, MLINT vrefBufLen,
        MLINT *gref,
        MLINT *mid,
        MLVector2D UV);

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getMeshTopoGref(
        MeshTopoObj meshTopoObj,
        MLINT *gref);
 ML_EXTERN ML_STORAGE_CLASS 
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 );

 ML_EXTERN ML_STORAGE_CLASS 
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);

 ML_EXTERN ML_STORAGE_CLASS 
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);

 ML_EXTERN ML_STORAGE_CLASS 
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);

 ML_EXTERN ML_STORAGE_CLASS 
MLINT  ML_getNumGeometryGroups(
    MeshAssociativityObj meshAssocObj);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS  ML_getGeometryGroupIDs(
    MeshAssociativityObj meshAssocObj,
    MLINT IDs[],
    MLINT sizeIDs,
    MLINT *numIDs);

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getGeometryGroupByID(
        MeshAssociativityObj meshAssocObj,
        MLINT gid,
        GeometryGroupObj *geomGroupObj
    );
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getEntityNames(
        GeometryGroupObj geomGroupObj,
        char *entityNamesBufArr,      /* array of entity name buffers */
        MLINT entityNamesArrLen,   /* length of names array */
        MLINT entityNameBufLen,    /* buffer length of a each name */
        MLINT *num_entityNames
    );

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_evalXYZ(
    GeometryKernelObj geomKernelObj,
    MLVector2D UV,
    const char *entityName,
    MLVector3D XYZ);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_evalRadiusOfCurvature(
        GeometryKernelObj geomKernelObj,
        MLVector2D UV,
        const char *entityName,
        MLREAL *minRradOfCurvature,
        MLREAL *maxRradOfCurvature);

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_evalCurvatureOnCurve(
    GeometryKernelObj geomKernelObj,
    MLVector2D UV,                  /* Evaluation parametric location on curve */
    const char *entityName,         /* Evaluation entity name */
    MLVector3D             XYZ,     /* Evaluated location on curve */
    MLVector3D         Tangent,     /* tangent to curve  */
    MLVector3D PrincipalNormal,     /* principal normal (pointing towards the center of curvature) */
    MLVector3D        Binormal,     /* binormal (tangent x principal normal) */
    /* curvature in radians per unit length
     * ALWAYS non-negative and in the direction of the principal normal
     * Radius of curvature = 1 / Curvature
     */
    MLREAL  *Curvature,
    MLINT   *Linear           /* If non-zero, the curve is linear and has no unique normal */
);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_evalDerivativesOnCurve(
    GeometryKernelObj geomKernelObj,
    MLVector2D UV,                  /* Evaluation parametric location on curve */
    const char *entityName,         /* Evaluation entity name */
    MLVector3D        XYZ,          /* Evaluated location on curve */
    MLVector3D        dXYZdU,       /* First derivative */
    MLVector3D        d2XYZdU2      /* Second derivative */
);


 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_evalCurvatureOnSurface(
    GeometryKernelObj geomKernelObj,
    MLVector2D UV,                      /* Evaluation parametric location on surface */
    const char *entityName,             /* Evaluation entity name */

    MLVector3D        XYZ,              /* Evaluated location on surface */
    MLVector3D        dXYZdU,           /* First partial derivative */
    MLVector3D        dXYZdV,           /* First partial derivative */
    MLVector3D        d2XYZdU2,         /* Second partial derivative */
    MLVector3D        d2XYZdUdV,        /* Second partial derivative */
    MLVector3D        d2XYZdV2,         /* Second partial derivative */
    MLVector3D        surfaceNormal,    /* Surface normal - unit vector */
    /* Unit vector tangent to surface where curvature = min
     * surfaceNormal cross principalV yields the direction where curvature = max
     * if the surface is locally planar (min and max are 0.0) or if the
     * surface is locally spherical (min and max are equal),
     * this will be an arbitrary vector tangent to the surface
     */
    MLVector3D        principalV,
    /* Minimum and maximum curvature, in radians per unit length
     * Defined so that positive values indicate the surface bends
     * in the direction of surfaceNormal, and negative values indicate
     * the surface bends away from surfaceNormal
     */
    MLREAL          *minCurvature,
    MLREAL          *maxCurvature,
    /* The average or mean curvature is defined as :
     *    avg = (min + max) / 2
     * The Gaussian curvature is defined as :
     *    gauss = min * max
     */
    MLREAL          *avg,               /* Average curvature */
    MLREAL          *gauss,             /* Gaussian curvature */
    MLORIENT        *orientation        /* Orientation of surface in model */
);

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_evalSurfaceTolerance(
    GeometryKernelObj geomKernelObj,
    const char *entityName,             /* Evaluation surface name */
    MLREAL          *minTolerance,
    MLREAL          *maxTolerance
);

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_createProjectionDataObj(
        GeometryKernelObj geomKernelObj,
        ProjectionDataObj *projectionDataObj
    );
 ML_EXTERN ML_STORAGE_CLASS 
    void ML_freeProjectionDataObj(ProjectionDataObj *projectionDataObj);

 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_projectPoint(
    GeometryKernelObj geomKernelObj,
    GeometryGroupObj geomGroupObj,
    MLVector3D point,
    ProjectionDataObj projectionDataObj
);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_getProjectionInfo(
    GeometryKernelObj geomKernelObj,
    ProjectionDataObj projectionDataObj,
    MLVector3D xyz,
    MLVector2D UV,
    char *entityNameBuf, MLINT entityNameBufLen,
    MLREAL *distance,
    MLREAL *tolerance
);

 ML_EXTERN ML_STORAGE_CLASS 
MLTYPE ML_getEntityType(
    GeometryKernelObj geomKernelObj,
    const char *entityName
);
 ML_EXTERN ML_STORAGE_CLASS 
MLSTATUS ML_entityExists(
    GeometryKernelObj geomKernelObj,
    const char *entityName
);

#endif

/****************************************************************************
 *
 * DISCLAIMER:
 * TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, POINTWISE DISCLAIMS
 * ALL WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED
 * TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, WITH REGARD TO THIS SCRIPT. TO THE MAXIMUM EXTENT PERMITTED
 * BY APPLICABLE LAW, IN NO EVENT SHALL POINTWISE BE LIABLE TO ANY PARTY
 * FOR ANY SPECIAL, INCIDENTAL, INDIRECT, OR CONSEQUENTIAL DAMAGES
 * WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF
 * BUSINESS INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE
 * USE OF OR INABILITY TO USE THIS SCRIPT EVEN IF POINTWISE HAS BEEN
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGES AND REGARDLESS OF THE
 * FAULT OR NEGLIGENCE OF POINTWISE.
 *
 ***************************************************************************/