animator.h

Go to the documentation of this file.

/*
* Copyright (c) 2010-2020 OTClient <https://github.com/edubart/otclient>
*
* 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.
*/
 
#ifndef ANIMATOR_H
#define ANIMATOR_H
 
#include "declarations.h"
 
#include <framework/core/declarations.h>
 
enum AnimationPhase : int16
{
    AnimPhaseAutomatic = -1,
    AnimPhaseRandom = 254,
    AnimPhaseAsync = 255,
};
 
enum AnimationDirection : uint8
{
    AnimDirForward = 0,
    AnimDirBackward = 1
};
 
class Animator : public stdext::shared_object
{
public:
    Animator();
 
    void unserialize(int animationPhases, const FileStreamPtr& fin);
    void serialize(const FileStreamPtr& fin);
    void setPhase(int phase);
    void resetAnimation();
 
    int getPhase();
    int getPhaseAt(ticks_t time);
    int getStartPhase() const;
    int getAnimationPhases() { return m_animationPhases; }
    int getAverageDuration() { return getTotalDuration() / getAnimationPhases(); }
 
    bool isAsync() { return m_async; }
    bool isComplete() { return m_isComplete; }
 
    ticks_t getTotalDuration();
 
private:
    int getPingPongPhase();
    int getLoopPhase();
    int getPhaseDuration(int phase);
 
    void calculateSynchronous();
 
    int m_currentDuration;
    int m_animationPhases;
    int m_currentLoop;
    int m_startPhase;
    int m_loopCount;
    int m_phase;
 
    bool m_isComplete;
    bool m_async;
 
    std::vector<std::tuple<int, int>> m_phaseDurations;
    AnimationDirection m_currentDirection;
    ticks_t m_lastPhaseTicks;
};
 
#endif