tfCSurface.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of Tissue Forge.
 * Copyright (c) 2022-2024 T.J. Sego and Tien Comlekoglu
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 ******************************************************************************/

 
#ifndef _WRAPS_C_VERTEX_SOLVER_TFCSURFACE_H_
#define _WRAPS_C_VERTEX_SOLVER_TFCSURFACE_H_
 
#include <tf_port_c.h>
 
#include <tfC_io.h>
#include <tfCStyle.h>
 

struct CAPI_EXPORT tfVertexSolverSurfaceTypeStyleSpec {
    char *color;
    unsigned int visible;
};

struct CAPI_EXPORT tfVertexSolverSurfaceTypeSpec {
    tfFloatP_t *edgeTensionLam;
    unsigned int edgeTensionOrder;
    tfFloatP_t *normalStressMag;
    tfFloatP_t *surfaceAreaLam;
    tfFloatP_t *surfaceAreaVal;
    tfFloatP_t **surfaceTractionComps;
    char *name;
    struct tfVertexSolverSurfaceTypeStyleSpec *style;
    char **adhesionNames;
    tfFloatP_t *adhesionValues;
    unsigned int numAdhesionValues;
};
 
 
// Handles

struct CAPI_EXPORT tfVertexSolverSurfaceHandleHandle {
    void *tfObj;
};

struct CAPI_EXPORT tfVertexSolverSurfaceTypeHandle {
    void *tfObj;
};
 

// tfVertexSolverSurfaceTypeSpec //
 

CAPI_FUNC(struct tfVertexSolverSurfaceTypeSpec) tfVertexSolverSurfaceTypeSpec_init();
 

// tfVertexSolverSurfaceTypeStyleSpec //
 

CAPI_FUNC(struct tfVertexSolverSurfaceTypeStyleSpec) tfVertexSolverSurfaceTypeStyleSpec_init();
 

// SurfaceHandle //
 

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_init(struct tfVertexSolverSurfaceHandleHandle *handle, int id);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_fromString(struct tfVertexSolverSurfaceHandleHandle *handle, const char *s);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_destroy(struct tfVertexSolverSurfaceHandleHandle *handle);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getId(struct tfVertexSolverSurfaceHandleHandle *handle, int *objId);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_definesBody(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverBodyHandleHandle *b, 
    bool *result
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_definedByVertex(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverVertexHandleHandle *v, 
    bool *result
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_objType(struct tfVertexSolverSurfaceHandleHandle *handle, unsigned int *label);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_destroySurface(struct tfVertexSolverSurfaceHandleHandle *handle);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_destroySurfaces(struct tfVertexSolverSurfaceHandleHandle **handles, unsigned int numObjs);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_destroySurfaceC(struct tfVertexSolverSurfaceHandleHandle *handle);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_validate(struct tfVertexSolverSurfaceHandleHandle *handle, bool *result);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_positionChanged(struct tfVertexSolverSurfaceHandleHandle *handle);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_str(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    char **str, 
    unsigned int *numChars
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_toString(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    char **str, 
    unsigned int *numChars
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_addVertex(struct tfVertexSolverSurfaceHandleHandle *handle, struct tfVertexSolverVertexHandleHandle *v);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_insertVertexAt(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverVertexHandleHandle *v, 
    const int &idx
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_insertVertexBefore(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverVertexHandleHandle *v, 
    struct tfVertexSolverVertexHandleHandle *before
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_insertVertexBetween(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverVertexHandleHandle *toInsert, 
    struct tfVertexSolverVertexHandleHandle *v1, 
    struct tfVertexSolverVertexHandleHandle *v2
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_removeVertex(struct tfVertexSolverSurfaceHandleHandle *handle, struct tfVertexSolverVertexHandleHandle *v);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_replaceVertexAt(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverVertexHandleHandle *toInsert, 
    const int &idx
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_replaceVertexWith(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverVertexHandleHandle *toInsert, 
    struct tfVertexSolverVertexHandleHandle *toRemove
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_addBody(struct tfVertexSolverSurfaceHandleHandle *handle, struct tfVertexSolverBodyHandleHandle *b);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_removeBody(struct tfVertexSolverSurfaceHandleHandle *handle, struct tfVertexSolverBodyHandleHandle *b);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_replaceBodyAt(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverBodyHandleHandle *toInsert, 
    const int &idx
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_replaceBodyWith(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverBodyHandleHandle *toInsert, 
    struct tfVertexSolverBodyHandleHandle *toRemove
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_refreshBodies(struct tfVertexSolverSurfaceHandleHandle *handle);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getType(struct tfVertexSolverSurfaceHandleHandle *handle, struct tfVertexSolverSurfaceTypeHandle *stype);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_become(struct tfVertexSolverSurfaceHandleHandle *handle, struct tfVertexSolverSurfaceTypeHandle *stype);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getBodies(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverBodyHandleHandle **objs, 
    int *numObjs
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getVertices(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverVertexHandleHandle **objs, 
    int *numObjs
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_findVertex(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    tfFloatP_t *dir, 
    struct tfVertexSolverVertexHandleHandle *result
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_findBody(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    tfFloatP_t *dir, 
    struct tfVertexSolverBodyHandleHandle *result
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_neighborVertices(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverVertexHandleHandle *v, 
    struct tfVertexSolverVertexHandleHandle *v1, 
    struct tfVertexSolverVertexHandleHandle *v2
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_neighborSurfaces(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverSurfaceHandleHandle **objs, 
    int *numObjs
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_connectedSurfacesS(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverVertexHandleHandle **verts, 
    unsigned int numVerts, 
    struct tfVertexSolverSurfaceHandleHandle **objs, 
    int *numObjs
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_connectedSurfaces(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverSurfaceHandleHandle **objs, 
    int *numObjs
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_connectingVertices(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverSurfaceHandleHandle *other, 
    struct tfVertexSolverVertexHandleHandle **objs, 
    int *numObjs
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_contiguousVertexLabels(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverSurfaceHandleHandle *other, 
    unsigned int **labels, 
    int *numLabels
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_sharedContiguousVertices(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverSurfaceHandleHandle *other, 
    unsigned int edgeLabel, 
    struct tfVertexSolverVertexHandleHandle **objs, 
    int *numObjs
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getNormal(struct tfVertexSolverSurfaceHandleHandle *handle, tfFloatP_t **result);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getUnnormalizedNormal(struct tfVertexSolverSurfaceHandleHandle *handle, tfFloatP_t **result);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getCentroid(struct tfVertexSolverSurfaceHandleHandle *handle, tfFloatP_t **result);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getVelocity(struct tfVertexSolverSurfaceHandleHandle *handle, tfFloatP_t **result);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getArea(struct tfVertexSolverSurfaceHandleHandle *handle, tfFloatP_t *result);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getPerimeter(struct tfVertexSolverSurfaceHandleHandle *handle, tfFloatP_t *result);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getDensity(struct tfVertexSolverSurfaceHandleHandle *handle, tfFloatP_t *result);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_setDensity(struct tfVertexSolverSurfaceHandleHandle *handle, tfFloatP_t density);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getMass(struct tfVertexSolverSurfaceHandleHandle *handle, tfFloatP_t *result);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_volumeSense(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverBodyHandleHandle *body, 
    tfFloatP_t *result
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getVolumeContr(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverBodyHandleHandle *body, 
    tfFloatP_t *result
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getOutwardNormal(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverBodyHandleHandle *body, 
    tfFloatP_t **result
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getVertexArea(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverVertexHandleHandle *v, 
    tfFloatP_t *result
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getVertexMass(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverVertexHandleHandle *v, 
    tfFloatP_t *result
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_hasStyle(struct tfVertexSolverSurfaceHandleHandle *handle, bool *result);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_getStyle(struct tfVertexSolverSurfaceHandleHandle *handle, struct tfRenderingStyleHandle *result);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_setStyle(struct tfVertexSolverSurfaceHandleHandle *handle, struct tfRenderingStyleHandle *s);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_normalDistance(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    tfFloatP_t *pos, 
    tfFloatP_t *result
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_isOutside(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    tfFloatP_t *pos, 
    bool *result
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_contains(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    tfFloatP_t *pos, 
    bool *result, 
    struct tfVertexSolverVertexHandleHandle *v0, 
    struct tfVertexSolverVertexHandleHandle *v1
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_merge(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverSurfaceHandleHandle *toRemove, 
    tfFloatP_t *lenCfs, 
    unsigned int numLenCfs
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_extend(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    unsigned int vertIdxStart, 
    tfFloatP_t *pos, 
    struct tfVertexSolverSurfaceHandleHandle *newObj
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_extrude(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    unsigned int vertIdxStart, 
    tfFloatP_t normLen, 
    struct tfVertexSolverSurfaceHandleHandle *newObj
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_splitBy(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    struct tfVertexSolverVertexHandleHandle *v1, 
    struct tfVertexSolverVertexHandleHandle *v2, 
    struct tfVertexSolverSurfaceHandleHandle *newObj
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceHandle_splitHow(
    struct tfVertexSolverSurfaceHandleHandle *handle, 
    tfFloatP_t *cp_pos, 
    tfFloatP_t *cp_norm, 
    struct tfVertexSolverSurfaceHandleHandle *newObj
);
 

// SurfaceType //
 

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_init(struct tfVertexSolverSurfaceTypeHandle *handle);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_initD(struct tfVertexSolverSurfaceTypeHandle *handle, struct tfVertexSolverSurfaceTypeSpec sdef);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_fromString(struct tfVertexSolverSurfaceTypeHandle *handle, const char *str);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_objType(struct tfVertexSolverSurfaceTypeHandle *handle, unsigned int *label);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_str(
    struct tfVertexSolverSurfaceTypeHandle *handle, 
    char **str, 
    unsigned int *numChars
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_toString(
    struct tfVertexSolverSurfaceTypeHandle *handle, 
    char **str, 
    unsigned int *numChars
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_registerType(struct tfVertexSolverSurfaceTypeHandle *handle);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_isRegistered(struct tfVertexSolverSurfaceTypeHandle *handle, bool *result);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_getName(
    struct tfVertexSolverSurfaceTypeHandle *handle, 
    char **str, 
    unsigned int *numChars
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_setName(struct tfVertexSolverSurfaceTypeHandle *handle, const char *str);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_getStyle(struct tfVertexSolverSurfaceTypeHandle *handle, struct tfRenderingStyleHandle *style);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_getDensity(struct tfVertexSolverSurfaceTypeHandle *handle, tfFloatP_t *result);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_setDensity(struct tfVertexSolverSurfaceTypeHandle *handle, tfFloatP_t result);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_getInstances(
    struct tfVertexSolverSurfaceTypeHandle *handle, 
    struct tfVertexSolverSurfaceHandleHandle **objs, 
    unsigned int *numObjs
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_getInstanceIds(
    struct tfVertexSolverSurfaceTypeHandle *handle, 
    int **ids, 
    unsigned int *numObjs
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_createSurfaceV(
    struct tfVertexSolverSurfaceTypeHandle *handle, 
    struct tfVertexSolverVertexHandleHandle **vertices, 
    unsigned int numVerts, 
    struct tfVertexSolverSurfaceHandleHandle *newObj
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_createSurfaceP(
    struct tfVertexSolverSurfaceTypeHandle *handle, 
    tfFloatP_t **positions, 
    unsigned int numPositions, 
    struct tfVertexSolverSurfaceHandleHandle *newObj
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_createSurfaceIO(
    struct tfVertexSolverSurfaceTypeHandle *handle, 
    struct tfIoThreeDFFaceDataHandle *face, 
    struct tfVertexSolverSurfaceHandleHandle *newObj
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_createSurfaceVA(
    struct tfVertexSolverSurfaceTypeHandle *handle, 
    struct tfVertexSolverVertexHandleHandle ***vertices, 
    unsigned int numSurfaces, 
    unsigned int *numVerts, 
    struct tfVertexSolverSurfaceHandleHandle **newObjs
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_createSurfacePA(
    struct tfVertexSolverSurfaceTypeHandle *handle, 
    tfFloatP_t ***spositions, 
    unsigned int numSurfaces, 
    unsigned int *numPositions, 
    struct tfVertexSolverSurfaceHandleHandle **newObjs
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_createSurfaceIOA(
    struct tfVertexSolverSurfaceTypeHandle *handle, 
    struct tfIoThreeDFFaceDataHandle **faces, 
    unsigned int numSurfaces, 
    struct tfVertexSolverSurfaceHandleHandle **newObjs
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_nPolygon(
    struct tfVertexSolverSurfaceTypeHandle *handle, 
    unsigned int n, 
    tfFloatP_t *center, 
    tfFloatP_t radius, 
    tfFloatP_t *ax1, 
    tfFloatP_t *ax2, 
    struct tfVertexSolverSurfaceHandleHandle *newObj
);

CAPI_FUNC(HRESULT) tfVertexSolverSurfaceType_replace(
    struct tfVertexSolverSurfaceTypeHandle *handle, 
    struct tfVertexSolverVertexHandleHandle *toReplace, 
    tfFloatP_t *lenCfs, 
    unsigned int numLenCfs, 
    struct tfVertexSolverSurfaceHandleHandle *newObj
);
 

// Module functions //
 

CAPI_FUNC(HRESULT) tfVertexSolverCreateSurfaceByVertices(
    struct tfVertexSolverVertexHandleHandle **verts, 
    unsigned int numVerts, 
    struct tfVertexSolverSurfaceHandleHandle *newObj
);

CAPI_FUNC(HRESULT) tfVertexSolverCreateSurfaceByIOData(
    struct tfIoThreeDFFaceDataHandle *face, 
    struct tfVertexSolverSurfaceHandleHandle *newObj
);

CAPI_FUNC(HRESULT) tfVertexSolverFindSurfaceTypeFromName(const char *name, struct tfVertexSolverSurfaceTypeHandle *result);

CAPI_FUNC(HRESULT) tfVertexSolverBindSurfaceTypeAdhesion(
    struct tfVertexSolverSurfaceTypeHandle **stypes, 
    struct tfVertexSolverSurfaceTypeSpec *sdefs, 
    unsigned int numTypes
);
 
#endif // _WRAPS_C_VERTEX_SOLVER_TFCSURFACE_H_