PhysicsAnimation.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_PHYSICS_ANIMATION_HPP
#define CUBBYFLOW_PHYSICS_ANIMATION_HPP

#include <Core/Animation/Animation.hpp>

namespace CubbyFlow
{
class PhysicsAnimation : public Animation
{
 public:
    PhysicsAnimation();

    PhysicsAnimation(const PhysicsAnimation&) = default;

    PhysicsAnimation(PhysicsAnimation&&) noexcept = default;

    virtual ~PhysicsAnimation() = default;

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

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

    [[nodiscard]] bool GetIsUsingFixedSubTimeSteps() const;

    void SetIsUsingFixedSubTimeSteps(bool isUsing);

    [[nodiscard]] unsigned int GetNumberOfFixedSubTimeSteps() const;

    void SetNumberOfFixedSubTimeSteps(unsigned int numberOfSteps);

    void AdvanceSingleFrame();

    [[nodiscard]] Frame GetCurrentFrame() const;

    void SetCurrentFrame(const Frame& frame);

    [[nodiscard]] double GetCurrentTimeInSeconds() const;

 protected:
    virtual void OnAdvanceTimeStep(double timeIntervalInSeconds) = 0;

    [[nodiscard]] virtual unsigned int GetNumberOfSubTimeSteps(
        double timeIntervalInSeconds) const;

    virtual void OnInitialize();

 private:
    void OnUpdate(const Frame& frame) final;

    void AdvanceTimeStep(double timeIntervalInSeconds);

    void Initialize();

    Frame m_currentFrame;
    bool m_isUsingFixedSubTimeSteps = true;
    unsigned int m_numberOfFixedSubTimeSteps = 1;
    double m_currentTime = 0.0;
};

using PhysicsAnimationPtr = std::shared_ptr<PhysicsAnimation>;
}  // namespace CubbyFlow

#endif