kfbxcache.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXCACHE_H
#define FBXFILESDK_KFBXPLUGINS_KFBXCACHE_H

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

 Copyright (C) 2001 - 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/kfbxplugins/kfbxgroupname.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxCache_internal;
class KFbxVertexCacheDeformer;

class KFBX_DLL KFbxCache : public KFbxObject
{
    KFBXOBJECT_DECLARE(KFbxCache,KFbxObject);

public:

        typedef enum
        {
            eUNKNOWN,
            ePC2,
            eMC
        } EFileFormat;

        void SetCacheFileFormat(EFileFormat pFileFormat);

        EFileFormat GetCacheFileFormat() const;

        void SetCacheFileName(const char* pRelativeFileName, const char* pAbsoluteFileName);

        void GetCacheFileName(KString& pRelativeFileName, KString& pAbsoluteFileName) const;

        bool OpenFileForRead();

        bool IsOpen() const;

        bool CloseFile();

        double GetSamplingFrameRate();

        KTime GetCacheTimePerFrame();



        typedef enum
        {
            eMC_ONE_FILE,
            eMC_ONE_FILE_PER_FRAME
        } EMCFileCount;

        typedef enum
        {
            kUnknownData,
            kDouble,             //kDouble
            kDoubleArray,         //KArrayTemplate<kDouble>
            kDoubleVectorArray,  //KArrayTemplate<fbxDouble3> 
            kInt32Array,         //KArrayTemplate<kInt>
            kFloatArray,
            kFloatVectorArray    //KArrayTemplate<fbxFloat3>
        }EMCDataType;

        bool OpenFileForWrite(EMCFileCount pFileCount, double pSamplingFrameRate, const char* pChannelName, EMCDataType pMCDataType = kDoubleVectorArray );     

        int  GetChannelCount();

        bool GetChannelName(int pChannelIndex, KString& pChannelName);

        bool GetChannelDataType(int pChannelIndex, EMCDataType& pChannelType);


        int  GetChannelIndex(const char* pChannelName);

        bool Read(int pChannelIndex, KTime& pTime, double* pBuffer, unsigned int pPointCount);

        bool Read(int pChannelIndex, KTime& pTime, float* pBuffer, unsigned int pPointCount);

        bool Read(int pChannelIndex, KTime& pTime, int* pBuffer, unsigned int pPointCount);

        bool Write(int pChannelIndex, KTime& pTime, double* pBuffer, unsigned int pPointCount);

        bool Write(int pChannelIndex, KTime& pTime, float* pBuffer, unsigned int pPointCount);

        bool Write(int pChannelIndex, KTime& pTime, int* pBuffer, unsigned int pPointCount);

        bool GetAnimationRange(int pChannelIndex, KTime &pTimeStart, KTime &pTimeEnd);

        bool GetCacheType(EMCFileCount& pFileCount);

        bool GetChannelInterpretation(int pChannelIndex, KString& pInterpretation);

        typedef enum
        {
            eSAMPLING_REGULAR,
            eSAMPLING_IRREGULAR
        }EMCSamplingType;

        bool GetChannelSamplingType(int pChannelIndex, EMCSamplingType& pSamplingType);

        bool GetChannelSamplingRate(int pChannelIndex, KTime& pSamplingRate);

        bool GetChannelSampleCount(int pChannelIndex, unsigned int& pSampleCount);

        bool GetChannelPointCount(int pChannelIndex, KTime pTime, unsigned int& pPointCount);

        int  GetCacheDataFileCount() const;

        bool GetCacheDataFileName(int pIndex, KString& pRelativeFileName, KString& pAbsoluteFileName);

        bool EnableMultiChannelFetching(bool pMultiChannelFetching);



        bool OpenFileForWrite(double pFrameStartOffset, double pSamplingFrameRate, unsigned int pSampleCount, unsigned int pPointCount);

        unsigned int GetSampleCount();

        unsigned int GetPointCount();

        double GetFrameStartOffset();

        bool Read(unsigned int pFrameIndex, double* pBuffer, unsigned int pPointCount);

        bool Write(unsigned int pFrameIndex, double* pBuffer);



        bool ConvertFromPC2ToMC(EMCFileCount pFileCount, double pSamplingFrameRate);

        bool ConvertFromMCToPC2(double pSamplingFrameRate, unsigned int pChannelIndex);



        KError& GetError();

        typedef enum
        {
            eUNSUPPORTED_ARCHITECTURE,
            eINVALID_ABSOLUTE_PATH,
            eINVALID_SAMPLING_RATE,
            eINVALID_CACHE_FORMAT,
            eUNSUPPORTED_FILE_VERSION,
            eCONVERSION_FROM_PC2_FAILED,
            eCONVERSION_FROM_MC_FAILED,
            eCACHE_FILE_NOT_FOUND,
            eCACHE_FILE_NOT_OPENED,
            eCACHE_FILE_NOT_CREATED,
            eINVALID_OPEN_FLAG,
            eERROR_WRITING_SAMPLE,
            eERROR_READING_SAMPLE,
            eERROR_DATATYPE,
            eERROR_INVALIDCHANNELINDEX,
            eERROR_IRREGULARCHANNELSAMPLING,
            eERROR_CHANNELINTERPRETATION,
            eERROR_CHANNELSAMPLING,
            eERROR_INVALID_FILEINDEX,
            eERROR_CACHEDATAFILENAME,
            eERROR_CHANNELSTARTTIME,
            eERROR_CHANNELPOINTCOUNT,
            eERROR_INVALIDTIME,
            eERROR_COUNT
        } EError;

        EError GetLastErrorID() const;

        const char* GetLastErrorString() const;



//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    static const char* CacheFilePropertyName;
    static const char* CacheFileAbsolutePathPropertyName;
    static const char* CacheFileTypePropertyName;

    // Clone
    virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;

    typedef enum
    {
        _O_RDONLY,
        _O_WRONLY
    } EOpenFlag;

protected:
    bool OpenFile(EOpenFlag pFlag, EMCFileCount pFileCount, double pSamplingFrameRate, const char* pChannelName, unsigned int pSampleCount, unsigned int pPointCount, double pFrameStartOffset, EMCDataType pMCDataType = kDoubleVectorArray); 

    KFbxCache(KFbxSdkManager& pManager, char const* pName);

    virtual void Construct( const KFbxCache* pFrom );
    virtual bool ConstructProperties( bool pForceSet );
    virtual void Destruct(bool pRecursive, bool pDependents);

    // Cache
    KFbxCache_internal* mData;

private:
    KFbxTypedProperty<fbxString> CacheFile;
    KFbxTypedProperty<fbxString> CacheFileAbsolutePath;
    KFbxTypedProperty<fbxEnum> CacheFileType;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

typedef KFbxCache* HKFbxCache;

inline EFbxType FbxTypeOf( KFbxCache::EFileFormat const &pItem )            { return eENUM; }


#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXCACHE_H