GridEmitter3.hpp

Go to the documentation of this file.

// This code is based on Jet framework.
// Copyright (c) 2018 Doyub Kim
// CubbyFlow is voxel-based fluid simulation engine for computer games.
// Copyright (c) 2020 CubbyFlow Team
// Core Part: Chris Ohk, Junwoo Hwang, Jihong Sin, Seungwoo Yoo
// AI Part: Dongheon Cho, Minseo Kim
// We are making my contributions/submissions to this project solely in our
// personal capacity and are not conveying any rights to any intellectual
// property of any third parties.

#ifndef CUBBYFLOW_GRID_EMITTER3_HPP
#define CUBBYFLOW_GRID_EMITTER3_HPP

#include <functional>
#include <memory>

namespace CubbyFlow
{
class GridEmitter3
{
 public:
    using OnBeginUpdateCallback =
        std::function<void(GridEmitter3*, double, double)>;

    GridEmitter3() = default;

    GridEmitter3(const GridEmitter3&) = default;

    GridEmitter3(GridEmitter3&&) noexcept = default;

    virtual ~GridEmitter3() = default;

    GridEmitter3& operator=(const GridEmitter3&) = default;

    GridEmitter3& operator=(GridEmitter3&&) noexcept = default;

    void Update(double currentTimeInSeconds, double timeIntervalInSeconds);

    [[nodiscard]] bool GetIsEnabled() const;

    void SetIsEnabled(bool enabled);

    void SetOnBeginUpdateCallback(const OnBeginUpdateCallback& callback);

 protected:
    virtual void OnUpdate(double currentTimeInSeconds,
                          double timeIntervalInSeconds) = 0;

    void CallOnBeginUpdateCallback(double currentTimeInSeconds,
                                   double timeIntervalInSeconds);

 private:
    OnBeginUpdateCallback m_onBeginUpdateCallback;
    bool m_isEnabled = true;
};

using GridEmitter3Ptr = std::shared_ptr<GridEmitter3>;
}  // namespace CubbyFlow

#endif