tfCCellPolarity.h

/*******************************************************************************
 * 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_MODELS_CENTER_CELL_POLARITY_CELL_POLARITY_H_
#define _WRAPS_C_MODELS_CENTER_CELL_POLARITY_CELL_POLARITY_H_
 
#include <tf_port_c.h>
 
#include <tfCParticle.h>
#include <tfCForce.h>
#include <tfCPotential.h>
 
// Handles
 
struct CAPI_EXPORT tfCellPolarityPolarContactTypeEnumHandle {
    unsigned int REGULAR;
    unsigned int ISOTROPIC;
    unsigned int ANISOTROPIC;
};

struct CAPI_EXPORT tfCellPolarityPersistentForceHandle {
    void *tfObj;
};

struct CAPI_EXPORT tfCellPolarityPolarityArrowDataHandle {
    void *tfObj;
};

struct CAPI_EXPORT tfCellPolarityContactPotentialHandle {
    void *tfObj;
};
 

// PolarContactType //
 

CAPI_FUNC(HRESULT) tfPolarContactType_init(struct tfCellPolarityPolarContactTypeEnumHandle *handle);
 

// PersistentForce //
 

CAPI_FUNC(HRESULT) tfCellPolarityPersistentForce_init(struct tfCellPolarityPersistentForceHandle *handle, float sensAB, float sensPCP);

CAPI_FUNC(HRESULT) tfCellPolarityPersistentForce_destroy(struct tfCellPolarityPersistentForceHandle *handle);

CAPI_FUNC(HRESULT) tfCellPolarityPersistentForce_toBase(struct tfCellPolarityPersistentForceHandle *handle, tfForceHandle *baseHandle);

CAPI_FUNC(HRESULT) tfCellPolarityPersistentForce_fromBase(tfForceHandle *baseHandle, struct tfCellPolarityPersistentForceHandle *handle);
 

// ContactPotential //
 

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_init(
    struct tfCellPolarityContactPotentialHandle *handle, 
    float cutoff, 
    float couplingFlat, 
    float couplingOrtho, 
    float couplingLateral, 
    float distanceCoeff, 
    unsigned int cType, 
    float mag, 
    float rate, 
    float bendingCoeff
);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_destroy(struct tfCellPolarityContactPotentialHandle *handle);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_toBase(struct tfCellPolarityContactPotentialHandle *handle, tfPotentialHandle *baseHandle);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_fromBase(struct tfPotentialHandle *baseHandle, struct tfCellPolarityContactPotentialHandle *handle);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_getCouplingFlat(struct tfCellPolarityContactPotentialHandle *handle, float *couplingFlat);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_setCouplingFlat(struct tfCellPolarityContactPotentialHandle *handle, float couplingFlat);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_getCouplingOrtho(struct tfCellPolarityContactPotentialHandle *handle, float *couplingOrtho);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_setCouplingOrtho(struct tfCellPolarityContactPotentialHandle *handle, float couplingOrtho);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_getCouplingLateral(struct tfCellPolarityContactPotentialHandle *handle, float *couplingLateral);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_setCouplingLateral(struct tfCellPolarityContactPotentialHandle *handle, float couplingLateral);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_getDistanceCoeff(struct tfCellPolarityContactPotentialHandle *handle, float *distanceCoeff);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_setDistanceCoeff(struct tfCellPolarityContactPotentialHandle *handle, float distanceCoeff);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_getCType(struct tfCellPolarityContactPotentialHandle *handle, unsigned int *cType);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_setCType(struct tfCellPolarityContactPotentialHandle *handle, unsigned int cType);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_getMag(struct tfCellPolarityContactPotentialHandle *handle, float *mag);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_setMag(struct tfCellPolarityContactPotentialHandle *handle, float mag);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_getRate(struct tfCellPolarityContactPotentialHandle *handle, float *rate);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_setRate(struct tfCellPolarityContactPotentialHandle *handle, float rate);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_getBendingCoeff(struct tfCellPolarityContactPotentialHandle *handle, float *bendingCoeff);

CAPI_FUNC(HRESULT) tfCellPolarityContactPotential_setBendingCoeff(struct tfCellPolarityContactPotentialHandle *handle, float bendingCoeff);
 

// PolarityArrowData //
 

CAPI_FUNC(HRESULT) tfPolarityArrowData_getArrowLength(struct tfCellPolarityPolarityArrowDataHandle *handle, float *arrowLength);

CAPI_FUNC(HRESULT) tfPolarityArrowData_setArrowLength(struct tfCellPolarityPolarityArrowDataHandle *handle, float arrowLength);
 

// Module functions //
 

CAPI_FUNC(HRESULT) tfCellPolarityGetVectorAB(int pId, bool current, float **vec);

CAPI_FUNC(HRESULT) tfCellPolarityGetVectorPCP(int pId, bool current, float **vec);

CAPI_FUNC(HRESULT) tfCellPolaritySetVectorAB(int pId, float *pVec, bool current, bool init);

CAPI_FUNC(HRESULT) tfCellPolaritySetVectorPCP(int pId, float *pVec, bool current, bool init);

CAPI_FUNC(HRESULT) tfCellPolarityUpdate();

CAPI_FUNC(HRESULT) tfCellPolarityRegisterParticle(struct tfParticleHandleHandle *ph);

CAPI_FUNC(HRESULT) tfCellPolarityUnregister(struct tfParticleHandleHandle *ph);

CAPI_FUNC(HRESULT) tfCellPolarityRegisterType(struct tfParticleTypeHandle *pType, const char *initMode, float *initPolarAB, float *initPolarPCP);

CAPI_FUNC(HRESULT) tfCellPolarityGetInitMode(struct tfParticleTypeHandle *pType, char **initMode, unsigned int *numChars);

CAPI_FUNC(HRESULT) tfCellPolaritySetInitMode(struct tfParticleTypeHandle *pType, const char *value);

CAPI_FUNC(HRESULT) tfCellPolarityGetInitPolarAB(struct tfParticleTypeHandle *pType, float **vec);

CAPI_FUNC(HRESULT) tfCellPolaritySetInitPolarAB(struct tfParticleTypeHandle *pType, float *value);

CAPI_FUNC(HRESULT) tfCellPolarityGetInitPolarPCP(struct tfParticleTypeHandle *pType, float **vec);

CAPI_FUNC(HRESULT) tfCellPolaritySetInitPolarPCP(struct tfParticleTypeHandle *pType, float *value);

CAPI_FUNC(HRESULT) tfCellPolaritySetDrawVectors(bool _draw);

CAPI_FUNC(HRESULT) tfCellPolaritySetArrowColors(const char *colorAB, const char *colorPCP);

CAPI_FUNC(HRESULT) tfCellPolaritySetArrowScale(float _scale);

CAPI_FUNC(HRESULT) tfCellPolaritySetArrowLength(float _length);

CAPI_FUNC(HRESULT) tfCellPolarityGetVectorArrowAB(unsigned int pId, struct tfCellPolarityPolarityArrowDataHandle *arrowData);

CAPI_FUNC(HRESULT) tfCellPolarityGetVectorArrowPCP(unsigned int pId, struct tfCellPolarityPolarityArrowDataHandle *arrowData);

CAPI_FUNC(HRESULT) tfCellPolarityLoad();
 
#endif // _WRAPS_C_MODELS_CENTER_CELL_POLARITY_CELL_POLARITY_H_