AnimationState.h

#pragma once
// ===========================================================================
// Copyright (c) 2015 Toolchefs Ltd. All rights reserved.
//
// Use of this software is subject to the terms of the Toolchefs license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// ===========================================================================
 
#include <Atoms/Globals.h>
#include <AtomsCore/Globals.h>
#include <AtomsCore/AtomsMath.h>
#include <Atoms/AnimationStateClip.h>
 
#include <vector>
#include <string>
 
 
namespace Atoms
{
 
    class ATOMS_EXPORT AnimationState
    {
    public:
 
        AnimationState();
 
 
        AnimationState(const std::string &name, int id);
 
 
        AnimationState(
            const std::string &name,
            int id,
            const AtomsCore::Vector3 maxTurn,
            unsigned int blendIn,
            unsigned int blendOut
        );
 
 
        AnimationState(
            const std::string &name,
            int id,
            const AtomsCore::Vector3 maxTurn,
            unsigned int blendIn,
            unsigned int blendOut,
            bool randomLoop
        );
 
 
        AnimationState(
            const std::string& name,
            int id,
            const AtomsCore::Vector3 maxTurn,
            unsigned int blendIn,
            unsigned int blendOut,
            bool randomLoop,
            double velocity
        );
 
        AnimationState(const AnimationState& other);
 
        AnimationState& operator=(const AnimationState& other);
 
        ~AnimationState();
        
 
        inline void setName(const std::string &name);
 
 
        inline const std::string& name() const;
 
 
        inline void addClip(const AnimationStateClip &clip);
 
 
        inline void removeClip(unsigned int &clipId);
 
 
        inline const AnimationStateClip& clip(unsigned int clipId) const;
 
 
        inline AnimationStateClip& clip(unsigned int clipId);
 
 
        inline unsigned int numClips() const;
 
        inline void clearClips();
 
 
        inline void setId(int id);
 
 
        inline int id() const;
 
 
        inline bool isEmpty() const;
 
 
        inline void setMaxTurnAngle(const AtomsCore::Vector3& angle);
 
 
        inline const AtomsCore::Vector3& maxTurnAngle() const;
 
 
        inline void setMaxAcceleration(const AtomsCore::Vector2& acceleration);
 
 
        inline const AtomsCore::Vector2& maxAcceleration() const;
 
 
        inline void setAverageNumFrames(const AtomsCore::Vector2i& averageNumFrames);
 
 
        inline const AtomsCore::Vector2i& averageNumFrames() const;
 
 
        inline void setBlendInFrames(unsigned int frames);
 
 
        inline unsigned int blendInFrames() const;
 
 
        inline void setBlendOutFrames(unsigned int frames);
 
 
        inline unsigned int blendOutFrames() const;
 
 
        inline void setRandomLoop(bool value);
 
 
        inline bool randomLoop() const;
 
 
        inline const std::vector<unsigned int>& validClips() const;
 
 
        inline const std::vector<unsigned int>& validMotionTypeClips(unsigned int motionType) const;
 
        /* Updated the valid clips list of this state, resolving the priority between
        Exclusive / Merge / Random mode
        */
        void updateValidClips();
 
 
        inline void setVelocity(double velocity);
 
 
        inline double velocity() const;
 
 
        inline void setIsLocomotion(const bool value);
 
 
        inline bool isLocomotion() const;
 
 
        inline void setLocomotionName(const std::string& value);
 
 
        inline const std::string& locomotionName() const;
        
    private:
 
        std::string m_name;
 
        std::string m_locomotionName;
 
        std::vector<AnimationStateClip> m_clips;
 
        std::vector<unsigned int> m_validClips;
 
        std::vector<std::vector<unsigned int>> m_validMotionTypeClips;
 
        AtomsCore::Vector3 m_maxTurnAngle;
 
        AtomsCore::Vector2 m_maxAcceleration;
 
        AtomsCore::Vector2i m_averageNumFrames;
 
        double m_velocity;
 
        unsigned int m_blendInFrames;
 
        unsigned int m_blendOutFrames;
 
        int m_id;
 
        bool m_randomLoop;
 
        bool m_isLocomotion;
        
    };
}
 
 
#include "AnimationState.impl.h"