tfCCluster.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of Tissue Forge.
 * Copyright (c) 2022-2024 T.J. Sego
 * 
 * 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_TFCCLUSTER_H_
#define _WRAPS_C_TFCCLUSTER_H_
 
#include "tf_port_c.h"
 
#include "tfCParticle.h"

struct CAPI_EXPORT tfClusterTypeSpec {
    tfFloatP_t mass;
    tfFloatP_t charge;
    tfFloatP_t radius;
    tfFloatP_t *target_energy;
    tfFloatP_t minimum_radius;
    tfFloatP_t eps;
    tfFloatP_t rmin;
    unsigned char dynamics;
    unsigned int frozen;
    char *name;
    char *name2;
    unsigned int numTypes;
    struct tfParticleTypeHandle **types;
};
 
// Handles

struct CAPI_EXPORT tfClusterParticleHandleHandle {
    void *tfObj;
};

struct CAPI_EXPORT tfClusterParticleTypeHandle {
    void *tfObj;
};
 

// tfClusterTypeSpec //
 

CAPI_FUNC(struct tfClusterTypeSpec) tfClusterTypeSpec_init();
 

// ClusterParticleHandle //
 

CAPI_FUNC(HRESULT) tfClusterParticleHandle_init(struct tfClusterParticleHandleHandle *handle, int id);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_destroy(struct tfClusterParticleHandleHandle *handle);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_createParticle(
    struct tfClusterParticleHandleHandle *handle, 
    struct tfParticleTypeHandle *partTypeHandle, 
    int *pid, 
    tfFloatP_t **position, 
    tfFloatP_t **velocity
);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_createParticleS(
    struct tfClusterParticleHandleHandle *handle, 
    struct tfParticleTypeHandle *partTypeHandle, 
    int *pid, 
    const char *str
);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_hasPartId(struct tfClusterParticleHandleHandle *handle, int pid, bool *result);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_hasPart(struct tfClusterParticleHandleHandle *handle, struct tfParticleHandleHandle *part, bool *result);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_splitAxis(struct tfClusterParticleHandleHandle *handle, int *cid, tfFloatP_t *axis, tfFloatP_t time);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_splitRand(struct tfClusterParticleHandleHandle *handle, int *cid, tfFloatP_t time);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_split(struct tfClusterParticleHandleHandle *handle, int *cid, tfFloatP_t time, tfFloatP_t *normal, tfFloatP_t *point);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_getNumParts(struct tfClusterParticleHandleHandle *handle, int *numParts);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_getParts(struct tfClusterParticleHandleHandle *handle, struct tfParticleListHandle *parts);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_getParticle(struct tfClusterParticleHandleHandle *handle, int i, struct tfParticleHandleHandle *parthandle);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_str(struct tfClusterParticleHandleHandle *handle, char **str, unsigned int *numChars);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_getRadiusOfGyration(struct tfClusterParticleHandleHandle *handle, tfFloatP_t *radiusOfGyration);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_getCenterOfMass(struct tfClusterParticleHandleHandle *handle, tfFloatP_t **com);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_getCentroid(struct tfClusterParticleHandleHandle *handle, tfFloatP_t **cent);

CAPI_FUNC(HRESULT) tfClusterParticleHandle_getMomentOfInertia(struct tfClusterParticleHandleHandle *handle, tfFloatP_t **moi);
 

// ClusterParticleType //
 

CAPI_FUNC(HRESULT) tfClusterParticleType_init(struct tfClusterParticleTypeHandle *handle);

CAPI_FUNC(HRESULT) tfClusterParticleType_initD(struct tfClusterParticleTypeHandle *handle, struct tfClusterTypeSpec pdef);

CAPI_FUNC(HRESULT) tfClusterParticleType_addType(struct tfClusterParticleTypeHandle *handle, struct tfParticleTypeHandle *phandle);

CAPI_FUNC(HRESULT) tfClusterParticleType_str(struct tfClusterParticleTypeHandle *handle, char **str, unsigned int *numChars);

CAPI_FUNC(HRESULT) tfClusterParticleType_hasType(struct tfClusterParticleTypeHandle *handle, struct tfParticleTypeHandle *phandle, bool *hasType);

CAPI_FUNC(HRESULT) tfClusterParticleType_hasTypeId(struct tfClusterParticleTypeHandle *handle, int pid, bool *result);

CAPI_FUNC(HRESULT) tfClusterParticleType_hasTypeML(struct tfClusterParticleTypeHandle *handle, struct tfParticleTypeHandle *ptype, bool *result);

CAPI_FUNC(HRESULT) tfClusterParticleType_hasPart(struct tfClusterParticleTypeHandle *handle, struct tfParticleHandleHandle *part, bool *result);

CAPI_FUNC(HRESULT) tfClusterParticleType_registerType(struct tfClusterParticleTypeHandle *handle);

CAPI_FUNC(HRESULT) tfClusterParticleType_createParticle(struct tfClusterParticleTypeHandle *handle, int *pid, tfFloatP_t *position, tfFloatP_t *velocity);
 

// Module functions //
 

CAPI_FUNC(HRESULT) tfClusterParticleType_FindFromName(struct tfClusterParticleTypeHandle *handle, const char* name);

CAPI_FUNC(HRESULT) tfClusterParticleType_getFromId(struct tfClusterParticleTypeHandle *handle, unsigned int pid);
 
#endif // _WRAPS_C_TFCCLUSTER_H_