PointParticleEmitter3.h

Go to the documentation of this file.

/*************************************************************************
> File Name: PointParticleEmitter3.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: 3-D point particle emitter.
> Created Time: 2017/07/22
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_POINT_PARTICLE_EMITTER3_H
#define CUBBYFLOW_POINT_PARTICLE_EMITTER3_H

#include <Core/Emitter/ParticleEmitter3.h>

#include <random>

namespace CubbyFlow
{
    class PointParticleEmitter3 final : public ParticleEmitter3
    {
    public:
        class Builder;

        PointParticleEmitter3(
            const Vector3D& origin,
            const Vector3D& direction,
            double speed,
            double spreadAngleInDegrees,
            size_t maxNumOfNewParticlesPerSec = 1,
            size_t maxNumOfParticles = std::numeric_limits<size_t>::max(),
            uint32_t seed = 0);

        size_t GetMaxNumberOfNewParticlesPerSecond() const;

        void SetMaxNumberOfNewParticlesPerSecond(size_t rate);

        size_t GetMaxNumberOfParticles() const;

        void SetMaxNumberOfParticles(size_t maxNumberOfParticles);

        static Builder GetBuilder();

    private:
        std::mt19937 m_rng;

        double m_firstFrameTimeInSeconds = 0.0;
        size_t m_numberOfEmittedParticles = 0;

        size_t m_maxNumberOfNewParticlesPerSecond = 1;
        size_t m_maxNumberOfParticles = std::numeric_limits<size_t>::max();

        Vector3D m_origin;
        Vector3D m_direction;
        double m_speed;
        double m_spreadAngleInRadians;

        void OnUpdate(
            double currentTimeInSeconds,
            double timeIntervalInSeconds) override;

        void Emit(
            Array1<Vector3D>* newPositions,
            Array1<Vector3D>* newVelocities,
            size_t maxNewNumberOfParticles);

        double Random();
    };

    using PointParticleEmitter3Ptr = std::shared_ptr<PointParticleEmitter3>;

    class PointParticleEmitter3::Builder final
    {
    public:
        Builder& WithOrigin(const Vector3D& origin);

        Builder& WithDirection(const Vector3D& direction);

        Builder& WithSpeed(double speed);

        Builder& WithSpreadAngleInDegrees(double spreadAngleInDegrees);

        Builder& WithMaxNumberOfNewParticlesPerSecond(size_t maxNumOfNewParticlesPerSec);

        Builder& WithMaxNumberOfParticles(size_t maxNumberOfParticles);

        Builder& WithRandomSeed(uint32_t seed);

        PointParticleEmitter3 Build() const;

        PointParticleEmitter3Ptr MakeShared() const;

    private:
        size_t m_maxNumberOfNewParticlesPerSecond = 1;
        size_t m_maxNumberOfParticles = std::numeric_limits<size_t>::max();
        Vector3D m_origin{ 0, 0, 0 };
        Vector3D m_direction{ 0, 1, 0 };
        double m_speed = 1.0;
        double m_spreadAngleInDegrees = 90.0;
        uint32_t m_seed = 0;
    };
}

#endif