kfbxanimcurvebase.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXANIMCURVEBASE_H
#define FBXFILESDK_KFBXPLUGINS_KFBXANIMCURVEBASE_H

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

 Copyright (C) 2009 - 2010 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.

 The coded instructions, statements, computer programs, and/or related material 
 (collectively the "Data") in these files contain unpublished information 
 proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
 Canada and United States of America federal copyright law and by international 
 treaties. 
 
 The Data may not be disclosed or distributed to third parties, in whole or in
 part, without the prior written consent of Autodesk, Inc. ("Autodesk").

 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
 BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
 NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
 WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
 OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
 
 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
 OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
 SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
 OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
 HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
 FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
 ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
 WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
 OR DAMAGE. 

**************************************************************************************/
#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 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);

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