tfCluster.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of mdcore.
 * 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 _MDCORE_INCLUDE_TFCLUSTER_H_
#define _MDCORE_INCLUDE_TFCLUSTER_H_
 
#include "tfParticle.h"
 
#include <vector>
 
 
namespace TissueForge {
 
 
    struct CAPI_EXPORT Cluster : Particle {};
 
    struct ClusterParticleHandle;
 
    struct CAPI_EXPORT ClusterParticleType : ParticleType {
 
        ClusterParticleType(const bool &noReg=false);
        virtual ~ClusterParticleType();
 
        std::string str() const override;
 
        bool hasType(const ParticleType *type);
 
        bool has(const int32_t &pid);
 
        bool has(ParticleType *ptype);
 
        bool has(ParticleHandle *part);
 
        HRESULT registerType() override;
 
        virtual ClusterParticleType *get() override;
 
    };
 
    struct CAPI_EXPORT ClusterParticleHandle : ParticleHandle {
        ClusterParticleHandle();
        ClusterParticleHandle(const int &id);
 
        std::string str() const override;
 
        Cluster *cluster();
 
        ParticleHandle *operator()(
            ParticleType *partType, 
            FVector3 *position=NULL, 
            FVector3 *velocity=NULL
        );
        
        ParticleHandle *operator()(ParticleType *partType, const std::string &str);
 
        bool has(const int32_t &pid);
 
        bool has(ParticleHandle *part);
 
        ParticleHandle* fission(
            FVector3 *axis=NULL, 
            bool *random=NULL, 
            FPTYPE *time=NULL, 
            FVector3 *normal=NULL, 
            FVector3 *point=NULL
        );
 
        ParticleHandle* split(
            FVector3 *axis=NULL, 
            bool *random=NULL, 
            FPTYPE *time=NULL, 
            FVector3 *normal=NULL, 
            FVector3 *point=NULL
        );
 
        ParticleList items();
 
        FPTYPE getRadiusOfGyration();
 
        FVector3 getCenterOfMass();
 
        FVector3 getCentroid();
 
        FMatrix3 getMomentOfInertia();
 
        uint16_t getNumParts();
 
        std::vector<int32_t> getPartIds();
    };
 
    CAPI_FUNC(HRESULT) Cluster_AddParticle(struct Cluster *cluster, struct Particle *part);
 
 
    CAPI_FUNC(HRESULT) Cluster_ComputeAggregateQuantities(struct Cluster *cluster);
 
    CAPI_FUNC(Particle*) Cluster_CreateParticle(
        Cluster *cluster,
        ParticleType* particleType, 
        FVector3 *position=NULL, 
        FVector3 *velocity=NULL
    );
 
    CAPI_FUNC(ClusterParticleType*) ClusterParticleType_FindFromName(const char* name);
 
    HRESULT _Cluster_init();
 
 
    Cluster *Cluster_fromString(const std::string &str);
 
    ClusterParticleType *ClusterParticleType_fromString(const std::string &str);
 
};
 
 
inline std::ostream &operator<<(std::ostream& os, const TissueForge::ClusterParticleHandle &p)
{
    os << p.str().c_str();
    return os;
}
 
inline std::ostream &operator<<(std::ostream& os, const TissueForge::ClusterParticleType &p)
{
    os << p.str().c_str();
    return os;
}
 
#endif // _MDCORE_INCLUDE_TFCLUSTER_H_