Animation.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
#include <kiwano/core/Common.h>
#include <kiwano/core/Cloneable.h>
#include <kiwano/base/ObjectBase.h>
#include <kiwano/core/Time.h>
#include <kiwano/core/IntrusiveList.h>
#include <kiwano/math/Math.h>
 
namespace kiwano
{
class Actor;
class Animator;
class Animation;
 
enum class AnimationEvent
{
    Started,   
    LoopDone,  
    Done,      
};
 
class KGE_API AnimationEventHandler : public RefObject
{
public:
    virtual void Handle(Animation* anim, Actor* target, AnimationEvent evt) = 0;
 
    static RefPtr<AnimationEventHandler> Create(const Function<void(Animation*, Actor*, AnimationEvent)>& handler);
 
    static RefPtr<AnimationEventHandler> Create(AnimationEvent evt, const Function<void(Animation*, Actor*)>& handler);
 
    static RefPtr<AnimationEventHandler> HandleStarted(const Function<void(Animation*, Actor*)>& handler);
 
    static RefPtr<AnimationEventHandler> HandleLoopDone(const Function<void(Animation*, Actor*)>& handler);
 
    static RefPtr<AnimationEventHandler> HandleDone(const Function<void(Animation*, Actor*)>& handler);
};
 
typedef IntrusiveList<RefPtr<Animation>> AnimationList;
 
class KGE_API Animation
    : public ObjectBase
    , public Cloneable<Animation>
    , protected IntrusiveListValue<RefPtr<Animation>>
{
    friend class Animator;
    friend class AnimationGroup;
    friend IntrusiveList<RefPtr<Animation>>;
 
public:
    Animation();
 
    virtual ~Animation();
 
    void Resume();
 
    void Pause();
 
    void Stop();
 
    void SetDelay(Duration delay);
 
    void SetLoops(int loops);
 
    void RemoveTargetWhenDone();
 
    virtual Animation* Reverse() const = 0;
 
    bool IsRunning() const;
 
    int GetLoops() const;
 
    Duration GetDelay() const;
 
    void SetHandler(RefPtr<AnimationEventHandler> handler);
 
    RefPtr<AnimationEventHandler> GetHandler() const;
 
protected:
    virtual void Init(Actor* target);
 
    virtual void Update(Actor* target, Duration dt);
 
    void UpdateStep(Actor* target, Duration dt);
 
    void Complete(Actor* target);
 
    void Reset();
 
    enum class Status
    {
        NotStarted,  
        Delayed,     
        Started,     
        Done,        
        Removeable   
    };
 
    Status GetStatus() const;
 
    Duration GetElapsed() const;
 
    int GetLoopsDone() const;
 
    void Done();
 
    bool IsDone() const;
 
    bool IsRemoveable() const;
 
    void EmitEvent(Actor* target, AnimationEvent evt);
 
    void DoClone(Animation* to) const;
 
private:
    Status   status_;
    bool     running_;
    bool     detach_target_;
    int      loops_;
    int      loops_done_;
    Duration delay_;
    Duration elapsed_;
 
    RefPtr<AnimationEventHandler> handler_;
};
 
inline void Animation::Resume()
{
    running_ = true;
}
 
inline void Animation::Pause()
{
    running_ = false;
}
 
inline void Animation::Stop()
{
    Done();
}
 
inline void Animation::SetDelay(Duration delay)
{
    delay_ = delay;
}
 
inline void Animation::SetLoops(int loops)
{
    loops_ = loops;
}
 
inline void Animation::RemoveTargetWhenDone()
{
    detach_target_ = true;
}
 
inline void Animation::Done()
{
    status_ = Status::Done;
}
 
inline Animation::Status Animation::GetStatus() const
{
    return status_;
}
 
inline bool Animation::IsRunning() const
{
    return running_;
}
 
inline bool Animation::IsDone() const
{
    return status_ == Status::Done || status_ == Status::Removeable;
}
 
inline bool Animation::IsRemoveable() const
{
    return status_ == Status::Removeable;
}
 
inline void Animation::EmitEvent(Actor* target, AnimationEvent evt)
{
    if (handler_)
    {
        handler_->Handle(this, target, evt);
    }
}
 
inline int Animation::GetLoops() const
{
    return loops_;
}
 
inline Duration Animation::GetDelay() const
{
    return delay_;
}
 
inline void Animation::SetHandler(RefPtr<AnimationEventHandler> handler)
{
    handler_ = handler;
}
 
inline RefPtr<AnimationEventHandler> Animation::GetHandler() const
{
    return handler_;
}
 
inline Duration Animation::GetElapsed() const
{
    return elapsed_;
}
 
inline int Animation::GetLoopsDone() const
{
    return loops_done_;
}
 
}  // namespace kiwano