AnimationStateClip.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 <vector>
#include <string>
 
 
namespace Atoms
{
 
    class ATOMS_EXPORT AnimationStateClip
    {
    public:
 
        enum MotionType
        {
            kStraight = 0,
            kTurnLeft,
            kTurnRight,
            kTurnUp,
            kTurnDown,
            kBankLeft,
            kBankRight
        };
 
        enum MergeType
        {
            kMerge = 0,
            kExclusive,
            kRandom
        };
 
        AnimationStateClip();
        
        /*
        \param clipName Clip name
        \param motionType Motion type
        \param mergeType Merge type
        \param angle Turning angle
        \param blendAngle blendAngle
        */
        AnimationStateClip(
            const std::string& clipName, 
            unsigned int motionType = kStraight, 
            unsigned int mergeType = kMerge, 
            double angle = 0.0, 
            double blendAngle = 0.0,
            const std::string& tagName = "",
            const bool synced = true,
            const bool useClipDirection = false,
            const double maxTurnAngle = 0.0,
            const int blendFrames = 1);
 
        AnimationStateClip(const AnimationStateClip& rhs);
 
        AnimationStateClip& operator=(const AnimationStateClip& rhs);
 
        ~AnimationStateClip();
 
        inline const std::string& clipName() const;
 
        inline void setClipName(const std::string& name);
 
        inline const std::string& tagName() const;
 
        inline void setTagName(const std::string& name);
 
        inline unsigned int motionType() const;
 
        inline void setMotionType(unsigned int mType);
 
        inline unsigned int mergeType() const;
 
        inline void setMergeType(unsigned int mType);
 
        inline double angle() const;
 
        inline void setAngle(double value);
 
        inline double blendAngle() const;
 
        inline void setBlendAngle(double value);
 
        inline bool synced() const;
 
        inline void setSynced(const bool synced);
 
        inline bool useClipDirection() const;
 
        inline void setUseClipDirection(const bool useClipDirection);
 
        inline double maxTurnAngle() const;
 
        inline void setMaxTurnAngle(const double maxTurnAngle);
 
        inline int blendFrames() const;
 
        inline void setBlendFrames(const int blendFrames);
 
    private:
 
        std::string m_clipName;
 
        std::string m_tagName;
 
        unsigned int m_motionType;
 
        unsigned int m_mergeType;
 
        double m_angle;
 
        double m_blendAngle;
 
        bool m_synced;
 
        bool m_useClipDirection;
 
        double m_maxTurnAngle;
 
        int m_blendFrames;
    };
}
 
#include "AnimationStateClip.impl.h"