VolumeGridEmitter3.h

Go to the documentation of this file.

/*************************************************************************
> File Name: VolumeGridEmitter3.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: 3-D grid-based volumetric emitter.
> Created Time: 2017/08/06
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_VOLUME_GRID_EMITTER3_H
#define CUBBYFLOW_VOLUME_GRID_EMITTER3_H

#include <Core/Emitter/GridEmitter3.h>
#include <Core/Grid/ScalarGrid3.h>
#include <Core/Grid/VectorGrid3.h>
#include <Core/Surface/ImplicitSurface3.h>
#include <Core/Vector/Vector3.h>

#include <memory>

namespace CubbyFlow
{
    class VolumeGridEmitter3 final : public GridEmitter3
    {
    public:
        class Builder;

        using ScalarMapper = std::function<double(double, const Vector3D&, double)>;

        using VectorMapper = std::function<Vector3D(double, const Vector3D&, const Vector3D&)>;

        explicit VolumeGridEmitter3(const ImplicitSurface3Ptr& sourceRegion, bool isOneShot = true);

        virtual ~VolumeGridEmitter3();

        void AddSignedDistanceTarget(const ScalarGrid3Ptr& scalarGridTarget);

        void AddStepFunctionTarget(const ScalarGrid3Ptr& scalarGridTarget, double minValue, double maxValue);

        void AddTarget(const ScalarGrid3Ptr& scalarGridTarget, const ScalarMapper& customMapper);

        void AddTarget(const VectorGrid3Ptr& vectorGridTarget, const VectorMapper& customMapper);

        const ImplicitSurface3Ptr& GetSourceRegion() const;

        bool GetIsOneShot() const;

        static Builder GetBuilder();

    private:
        using ScalarTarget = std::tuple<ScalarGrid3Ptr, ScalarMapper>;
        using VectorTarget = std::tuple<VectorGrid3Ptr, VectorMapper>;

        ImplicitSurface3Ptr m_sourceRegion;
        bool m_isOneShot = true;
        bool m_hasEmitted = false;
        std::vector<ScalarTarget> m_customScalarTargets;
        std::vector<VectorTarget> m_customVectorTargets;

        void OnUpdate(double currentTimeInSeconds, double timeIntervalInSeconds) override;

        void Emit();
    };

    using VolumeGridEmitter3Ptr = std::shared_ptr<VolumeGridEmitter3>;
    
    class VolumeGridEmitter3::Builder final
    {
    public:
        Builder& WithSourceRegion(const Surface3Ptr& sourceRegion);

        Builder& WithIsOneShot(bool isOneShot);

        VolumeGridEmitter3 Build() const;

        VolumeGridEmitter3Ptr MakeShared() const;

    private:
        ImplicitSurface3Ptr m_sourceRegion;
        bool m_isOneShot = true;
    };
}

#endif