AnimationClipLooper.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 <Atoms/AnimationClip.h>
#include <algorithm>
#include <cassert>
 
namespace Atoms
{
    class AnimationClipLooper;
    
    typedef AnimationClipLooper*  AnimationClipLooperPtr; 
    
    typedef const AnimationClipLooper*  AnimationClipLooperCPtr; 
    
 
    class ATOMS_EXPORT AnimationClipLooper
    {
    public:
 
       AnimationClipLooper();
 
 
        AnimationClipLooper(AnimationClipCPtr animationClip);
        
        ~AnimationClipLooper(){}
 
        inline bool isValid() const;
        
        inline const AnimationClipCPtr animationClip() const;
 
 
        void setAnimationClip(AnimationClipCPtr animationClip);
        
 
        inline int numJoints() const;
        
 
        inline unsigned int numberBlendFrames() const;
        
 
        inline void setNumberBlendFrames(unsigned int value);
        
 
        inline void setLoopStartFrame(unsigned int value);
        
 
        inline unsigned int loopStartFrame() const;
        
 
        inline void setLoopEndFrame(unsigned int value);
        
 
        inline unsigned int loopEndFrame() const;
        
 
        AtomsCore::Vector3  getTranslation(const unsigned int jointId, const double time, const int offset = 0) const;
 
 
        AtomsCore::Quaternion  getRotation(const unsigned int jointId, const double time, const int offset = 0) const;
 
 
        AtomsCore::Vector3 getScale(const unsigned int jointId, const double time, const int offset = 0) const;
        
 
        void getTransformValues(const unsigned int jointId, const double time, AtomsCore::Vector3 &translation, AtomsCore::Quaternion &rotation, AtomsCore::Vector3 &scale, const int offset = 0) const;
 
 
        void getTransformValuesAtFrame(const unsigned int jointId, const unsigned frame, const double reminder, AtomsCore::Vector3 &translation, AtomsCore::Quaternion &rotation, AtomsCore::Vector3 &scale) const;
 
 
        AtomsCore::Vector3 getTranslationAtFrame(const unsigned int jointId, const unsigned frame, const double reminder) const;
 
 
        AtomsCore::Vector3 getTranslationAtGlobalFrame(const unsigned int jointId, const unsigned frame, const double reminder) const;
        
 
        AtomsCore::Quaternion getRotationAtFrame(const unsigned int jointId, const unsigned frame, const double reminder) const;
 
 
        AtomsCore::Quaternion getRotationAtGlobalFrame(const unsigned int jointId, const unsigned frame, const double reminder) const;
        
 
        AtomsCore::Vector3  getScaleAtFrame(const unsigned int jointId, const unsigned frame, const double reminder) const;
 
 
        AtomsCore::Vector3  getScaleAtGlobalFrame(const unsigned int jointId, const unsigned frame, const double reminder) const;
        
 
        inline std::vector<std::string> metadataNames(const unsigned int jointId) const;
 
 
        AtomsPtr<AtomsCore::Metadata> getMetadata(const unsigned int jointId, const std::string &metadataName, const double time, const int offset = 0) const;
 
 
        bool getMetadataInPlace(const unsigned int jointId, const std::string& metadataName, const double time, AtomsPtr<AtomsCore::Metadata>& outMeta, const int offset = 0) const;
 
 
 
        AtomsPtr<AtomsCore::Metadata> getMetadataAtFrame(const unsigned int jointId, const std::string &metadataName, const unsigned frame, const double reminder) const;
 
 
        void getMetadataAtFrameInPlace(const unsigned int jointId, const std::string& metadataName, const unsigned frame, const double reminder, AtomsPtr<AtomsCore::Metadata>& OutMeta) const;
 
 
        inline std::vector<std::string> staticMetadataNames(const unsigned int jointId) const;
 
 
        inline AtomsPtr<const AtomsCore::Metadata> getStaticMetadata(const unsigned int jointId, const std::string &metadataName) const;
 
 
        inline const AtomsCore::MapMetadata& staticMetadata(const unsigned int jointId) const;
        inline const std::map<std::string, AtomsPtr<AtomsCore::BaseTypedArrayMetadata>>& metadata(const unsigned int jointId) const;
 
        inline const std::vector<std::string>& animatedMetadata(const unsigned int jointId) const;
 
        inline unsigned int mapTimeToFrame(const double time, double &reminder, unsigned int &nextFrame, int offset = 0) const;
        inline unsigned int mapFrameToFrame(const unsigned frame, unsigned int &nextFrame) const;
 
        inline unsigned int numFrames() const;
 
        double getFactorFromFrame(unsigned int frame, unsigned int nextFrame, double reminder, unsigned int &loopedFrame, unsigned int &loopedNextFrame) const;
 
    private:
        
        AnimationClipCPtr m_animationClip;
        
        unsigned int m_numBlendFrames;
 
        unsigned int m_loopStart;
        
        unsigned int m_loopEnd;
    };
}
 
 
#include "AnimationClipLooper.impl.h"