PhysicsAnimation.h

Go to the documentation of this file.

/*************************************************************************
> File Name: PhysicsAnimation.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: Abstract base class for physics-based animation.
> Created Time: 2017/04/23
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_PHYSICS_ANIMATION_H
#define CUBBYFLOW_PHYSICS_ANIMATION_H

#include <Core/Animation/Animation.h>

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

        virtual ~PhysicsAnimation();

        bool GetIsUsingFixedSubTimeSteps() const;

        void SetIsUsingFixedSubTimeSteps(bool isUsing);

        unsigned int GetNumberOfFixedSubTimeSteps() const;

        void SetNumberOfFixedSubTimeSteps(unsigned int numberOfSteps);

        void AdvanceSingleFrame();

        Frame GetCurrentFrame() const;

        void SetCurrentFrame(const Frame& frame);

        double GetCurrentTimeInSeconds() const;

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

        virtual unsigned int GetNumberOfSubTimeSteps(double timeIntervalInSeconds) const;

        virtual void OnInitialize();

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

        void OnUpdate(const Frame& frame) final;

        void AdvanceTimeStep(double timeIntervalInSeconds);

        void Initialize();
    };

    using PhysicsAnimationPtr = std::shared_ptr<PhysicsAnimation>;
}

#endif