kfbxanimcurvebase.h

Go to the documentation of this file.

/****************************************************************************************

Copyright (C) 2010 Autodesk, Inc.
All rights reserved.

Use of this software is subject to the terms of the Autodesk license agreement
provided at the time of installation or download, or which otherwise accompanies
this software in either electronic or hard copy form.

****************************************************************************************/

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXANIMCURVEBASE_H
#define FBXFILESDK_KFBXPLUGINS_KFBXANIMCURVEBASE_H

#include <fbxfilesdk/fbxfilesdk_def.h>
#include <fbxfilesdk/kfbxplugins/kfbxobject.h>
#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFBX_DLL KFbxAnimCurveKeyBase
{
public:
    KTime mTime;

    KFbxAnimCurveKeyBase()
    {
        mTime = KTIME_ZERO;
    }

    virtual ~KFbxAnimCurveKeyBase() {};

    virtual KTime GetTime() const
    {
        return mTime;
    }

    virtual void  SetTime(const KTime& pTime) {
        mTime = pTime;
    }
};

class KFBX_DLL KFbxAnimCurveBase : public KFbxObject
{
    KFBXOBJECT_DECLARE_ABSTRACT(KFbxAnimCurveBase, KFbxObject);

public:

        virtual void KeyClear () = 0;
        
        virtual int KeyGetCount () const = 0;

        virtual int KeyAdd (KTime pTime, KFbxAnimCurveKeyBase& pKey, int* pLast = NULL) = 0;

        virtual bool KeySet(int pIndex, KFbxAnimCurveKeyBase& pKey) = 0;

        virtual bool KeyRemove(int pIndex) = 0;

        virtual bool KeyRemove(int pStartIndex, int pEndIndex) = 0;


        virtual KTime KeyGetTime(int pKeyIndex) const { return KTIME_INFINITE; }

        virtual void KeySetTime(int pKeyIndex, KTime pTime) = 0;


        typedef enum {
            eCONSTANT          = 1,
            eREPETITION        = 2,
            eMIRROR_REPETITION = 3,
            eKEEP_SLOPE        = 4
        } EExtrapolationType;

        void SetPreExtrapolation(EExtrapolationType pExtrapolation) { mPreExtrapolation = pExtrapolation; }
            
        EExtrapolationType GetPreExtrapolation() const { return mPreExtrapolation; }
        
        void SetPreExtrapolationCount(unsigned long pCount) { mPreExtrapolationCount = pCount; }
        
        unsigned long GetPreExtrapolationCount() const { return mPreExtrapolationCount; }
        
        void SetPostExtrapolation(EExtrapolationType pExtrapolation) { mPostExtrapolation = pExtrapolation; }
        
        EExtrapolationType GetPostExtrapolation() const { return mPostExtrapolation; }
        
        void SetPostExtrapolationCount(unsigned long pCount) { mPostExtrapolationCount = pCount; }
            
        unsigned long GetPostExtrapolationCount() const { return mPostExtrapolationCount; }

          virtual float Evaluate (KTime pTime, int* pLast = NULL) = 0;

        virtual float EvaluateIndex( double pIndex) = 0;

        virtual bool GetTimeInterval(KTime& pStart, KTime& pStop);

        virtual bool GetTimeInterval(KTimeSpan& pTimeInterval);

protected:
    KFbxAnimCurveBase(KFbxSdkManager& pManager, char const* pName);

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    //  WARNING!
    //    Anything beyond these lines may not be documented accurately and is 
    //     subject to change without notice.
public:
    virtual bool Store(KFbx* pFileObject) = 0;
    virtual bool Retrieve(KFbx* pFileObject) = 0;

private:
    EExtrapolationType mPreExtrapolation;
    unsigned long      mPreExtrapolationCount;
    EExtrapolationType mPostExtrapolation;
    unsigned long      mPostExtrapolationCount;

    friend class KFbxObject;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXANIMCURVEBASE_H