tfCellPolarity.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 _SOURCE_MODELS_CENTER_TFCELLPOLARITY_H_
#define _SOURCE_MODELS_CENTER_TFCELLPOLARITY_H_
 
#include <tfParticle.h>
#include <tfAngle.h>
#include <tfBond.h>
#include <tfForce.h>
#include <tfParticleTypeList.h>
#include <tfPotential.h>
#include <rendering/tfArrowRenderer.h>
 
#include <string>
#include <unordered_map>
 
namespace TissueForge::models::center::CellPolarity { 

CPPAPI_FUNC(FVector3) getVectorAB(const int &pId, const bool &current=true);

CPPAPI_FUNC(FVector3) getVectorPCP(const int &pId, const bool &current=true);

CPPAPI_FUNC(void) setVectorAB(const int &pId, const FVector3 &pVec, const bool &current=true, const bool &init=false);

CPPAPI_FUNC(void) setVectorPCP(const int &pId, const FVector3 &pVec, const bool &current=true, const bool &init=false);

CPPAPI_FUNC(void) update();

CPPAPI_FUNC(void) registerParticle(ParticleHandle *ph);

CPPAPI_FUNC(void) unregister(ParticleHandle *ph);

CPPAPI_FUNC(void) registerType(
    ParticleType *pType, 
    const std::string &initMode="random", 
    const FVector3 &initPolarAB=FVector3(0.0), 
    const FVector3 &initPolarPCP=FVector3(0.0)
);

CPPAPI_FUNC(const std::string) getInitMode(ParticleType *pType);

CPPAPI_FUNC(void) setInitMode(ParticleType *pType, const std::string &value);

CPPAPI_FUNC(const FVector3) getInitPolarAB(ParticleType *pType);

CPPAPI_FUNC(void) setInitPolarAB(ParticleType *pType, const FVector3 &value);

CPPAPI_FUNC(const FVector3) getInitPolarPCP(ParticleType *pType);

CPPAPI_FUNC(void) setInitPolarPCP(ParticleType *pType, const FVector3 &value);

struct CAPI_EXPORT PersistentForce : Force {
    FloatP_t sensAB = 0.0;
    
    FloatP_t sensPCP = 0.0;
 
    ~PersistentForce();
};

CPPAPI_FUNC(PersistentForce*) createPersistentForce(const FloatP_t &sensAB=0.0, const FloatP_t &sensPCP=0.0);
 
typedef enum PolarContactType {
    REGULAR = 0, 
    ISOTROPIC = 1, 
    ANISOTROPIC = 2
} PolarContactType;
 
struct CAPI_EXPORT PolarityArrowData : rendering::ArrowData {
    FloatP_t arrowLength = 1.0;
};

CPPAPI_FUNC(void) setDrawVectors(const bool &_draw);

CPPAPI_FUNC(void) setArrowColors(const std::string &colorAB, const std::string &colorPCP);

CPPAPI_FUNC(void) setArrowScale(const FloatP_t &_scale);

CPPAPI_FUNC(void) setArrowLength(const FloatP_t &_length);

CPPAPI_FUNC(PolarityArrowData*) getVectorArrowAB(const int32_t &pId);

CPPAPI_FUNC(PolarityArrowData*) getVectorArrowPCP(const int32_t &pId);

CPPAPI_FUNC(void) load();

struct CAPI_EXPORT ContactPotential : Potential {
    FloatP_t couplingFlat;

    FloatP_t couplingOrtho;
    
    FloatP_t couplingLateral;
    
    FloatP_t distanceCoeff;

    PolarContactType cType;

    FloatP_t mag;

    FloatP_t rate;

    FloatP_t bendingCoeff;
 
    ContactPotential();
};

CPPAPI_FUNC(ContactPotential*) createContactPotential(
    const FloatP_t &cutoff, 
    const FloatP_t &mag=1.0, 
    const FloatP_t &rate=1.0,
    const FloatP_t &distanceCoeff=1.0, 
    const FloatP_t &couplingFlat=1.0, 
    const FloatP_t &couplingOrtho=0.0, 
    const FloatP_t &couplingLateral=0.0, 
    std::string contactType="regular", 
    const FloatP_t &bendingCoeff=0.0
);
 
};
 
 
#endif // _SOURCE_MODELS_CENTER_TFCELLPOLARITY_H_