ParticleSystemSolver3.h

Go to the documentation of this file.

/*************************************************************************
> File Name: ParticleSystemSolver3.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: Basic 3-D particle system solver.
> Created Time: 2017/05/21
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_PARTICLE_SYSTEM_SOLVER3_H
#define CUBBYFLOW_PARTICLE_SYSTEM_SOLVER3_H

#include <Core/Animation/PhysicsAnimation.h>
#include <Core/Collider/Collider3.h>
#include <Core/Emitter/ParticleEmitter3.h>
#include <Core/Field/VectorField3.h>
#include <Core/Particle/ParticleSystemData3.h>
#include <Core/Utils/Constants.h>
#include <Core/Vector/Vector3.h>

namespace CubbyFlow
{
    class ParticleSystemSolver3 : public PhysicsAnimation
    {
    public:
        class Builder;

        ParticleSystemSolver3();

        ParticleSystemSolver3(double radius, double mass);

        virtual ~ParticleSystemSolver3();

        double GetDragCoefficient() const;

        void SetDragCoefficient(double newDragCoefficient);
        
        double GetRestitutionCoefficient() const;

        void SetRestitutionCoefficient(double newRestitutionCoefficient);

        const Vector3D& GetGravity() const;

        void SetGravity(const Vector3D& newGravity);

        const ParticleSystemData3Ptr& GetParticleSystemData() const;

        const Collider3Ptr& GetCollider() const;

        void SetCollider(const Collider3Ptr& newCollider);

        const ParticleEmitter3Ptr& GetEmitter() const;

        void SetEmitter(const ParticleEmitter3Ptr& newEmitter);

        const VectorField3Ptr& GetWind() const;

        void SetWind(const VectorField3Ptr& newWind);

        static Builder GetBuilder();

    protected:
        void OnInitialize() override;

        void OnAdvanceTimeStep(double timeStepInSeconds) override;

        virtual void AccumulateForces(double timeStepInSeconds);

        virtual void OnBeginAdvanceTimeStep(double timeStepInSeconds);

        virtual void OnEndAdvanceTimeStep(double timeStepInSeconds);

        void ResolveCollision();

        void ResolveCollision(ArrayAccessor1<Vector3D> newPositions, ArrayAccessor1<Vector3D> newVelocities);

        void SetParticleSystemData(const ParticleSystemData3Ptr& newParticles);

    private:
        double m_dragCoefficient = 1e-4;
        double m_restitutionCoefficient = 0.0;
        Vector3D m_gravity = Vector3D(0.0, GRAVITY, 0.0);

        ParticleSystemData3Ptr m_particleSystemData;
        ParticleSystemData3::VectorData m_newPositions;
        ParticleSystemData3::VectorData m_newVelocities;
        Collider3Ptr m_collider;
        ParticleEmitter3Ptr m_emitter;
        VectorField3Ptr m_wind;

        void BeginAdvanceTimeStep(double timeStepInSeconds);

        void EndAdvanceTimeStep(double timeStepInSeconds);

        void AccumulateExternalForces();
        
        void TimeIntegration(double timeStepInSeconds);

        void UpdateCollider(double timeStepInSeconds) const;

        void UpdateEmitter(double timeStepInSeconds) const;
    };

    using ParticleSystemSolver3Ptr = std::shared_ptr<ParticleSystemSolver3>;

    template <typename DerivedBuilder>
    class ParticleSystemSolverBuilderBase3
    {
    public:
        DerivedBuilder& WithRadius(double radius);

        DerivedBuilder& WithMass(double mass);

    protected:
        double m_radius = 1e-3;
        double m_mass = 1e-3;
    };

    template <typename T>
    T& ParticleSystemSolverBuilderBase3<T>::WithRadius(double radius)
    {
        m_radius = radius;
        return static_cast<T&>(*this);
    }

    template <typename T>
    T& ParticleSystemSolverBuilderBase3<T>::WithMass(double mass)
    {
        m_mass = mass;
        return static_cast<T&>(*this);
    }

    class ParticleSystemSolver3::Builder final
        : public ParticleSystemSolverBuilderBase3<ParticleSystemSolver3::Builder>
    {
    public:
        ParticleSystemSolver3 Build() const;

        ParticleSystemSolver3Ptr MakeShared() const;
    };
}

#endif