kfbxdatastream.h

Go to the documentation of this file.

#ifndef _FBXSDK_DATASTREAM_H_
#define _FBXSDK_DATASTREAM_H_

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

 Copyright © 2000 - 2007 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 <kaydaradef.h>
#ifndef KFBX_DLL 
    #define KFBX_DLL K_DLLIMPORT
#endif

#include <klib/ktime.h>
#include <klib/kstring.h>



#include <fbxfilesdk_nsbegin.h>

class KFbxDataStream_internal;

class KFBX_DLL KFbxDataStream
{
    public:

    KFbxDataStream();

    KFbxDataStream(KFbxDataStream const &pDataStream);

    ~KFbxDataStream();


    bool ReadBegin();

    bool ReadEnd();

    void FieldReadResetPosition();

    int FieldGetCount();

    char* FieldGetName(int pFieldIndex);

    int FieldGetInstanceCount(char* pFieldName);

    bool FieldReadBegin(int pFieldIndex, int pInstance);

    bool FieldReadBegin(char* pFieldName);

    bool FieldReadBegin(char* pFieldName, int pInstance);

    void FieldReadEnd();

    bool FieldReadIsBlock();

    bool FieldReadBlockBegin();

    void FieldReadBlockEnd();

    int FieldReadGetCount();

    int FieldReadGetRemain();

    char FieldReadGetType();

    char FieldReadCH();

    char FieldReadCH(char* pFieldName, char pDefault=0);

    char* FieldReadC();

    char* FieldReadC(char* pFieldName, char* pDefault="");

    inline char* FieldReadS() {return FieldReadC ();}

    inline char* FieldReadS(char* pFieldName, char* pDefault="") {return FieldReadC (pFieldName, pDefault);}

    inline bool FieldReadB() { return FieldReadI() != 0; }

    inline bool FieldReadB(char* pFieldName, bool pDefault = false ) { return FieldReadI( pFieldName, pDefault ) != 0; }

    int FieldReadI();

    int FieldReadI(char* pFieldName, int pDefault=0);

    kLongLong FieldReadLL();

    kLongLong FieldReadLL(char* pFieldName, kLongLong pDefault=0);

    float FieldReadF();

    float FieldReadF(char* pFieldName, float pDefault=0);

    double FieldReadD();

    double FieldReadD(char* pFieldName, double pDefault=0);

    KTime FieldReadT(char* pFieldName);

    KTime FieldReadT();

    KTimeSpan FieldReadTS(char* pFieldName);

    KTimeSpan FieldReadTS();

    inline void FieldReadFn(float* pValue, kUInt pn) {for (kUInt c=0; c<pn; c++) {pValue[c] = FieldReadF ();}}

    inline void FieldRead3F(float* pValue) {FieldReadFn (pValue, 3);}

    inline void FieldRead4F(float* pValue) {FieldReadFn (pValue, 4);}

    void FieldReadFn(char* pFieldName, float* pValue, float *pDefault, kUInt pn);

    inline void FieldRead3F(char* pFieldName, float* pValue, float* pDefault=NULL) {FieldReadFn (pFieldName, pValue, pDefault, 3);} 

    inline void FieldRead4F(char* pFieldName, float* pValue, float* pDefault=NULL) {FieldReadFn (pFieldName, pValue, pDefault, 4);}

    inline void FieldReadDn(double* pValue, kUInt pn) {for (kUInt c=0; c<pn; c++) {pValue[c] = FieldReadD ();}}

    inline void FieldRead3D(double* pValue) {FieldReadDn (pValue, 3);}

    inline void FieldRead4D(double* pValue) {FieldReadDn (pValue, 4);}

    void FieldReadDn(char* pFieldName, double* pValue, double *pDefault, kUInt pn);

    inline void FieldRead3D(char* pFieldName, double* pValue, double* pDefault=NULL) {FieldReadDn (pFieldName, pValue, pDefault, 3);} 

    inline void FieldRead4D(char* pFieldName, double* pValue, double* pDefault=NULL) {FieldReadDn (pFieldName, pValue, pDefault, 4);}

    void* FieldReadR(int* pByteSize);

    void* FieldReadR(char* pFieldName,int* pByteSize);



    bool WriteBegin();

    bool WriteEnd();

    void FieldWriteBegin(char* pFieldName);

    void FieldWriteEnd();

    void FieldWriteBlockBegin();

    void FieldWriteObjectBegin(char* pObjectType, char* pName, char* pSubType=NULL);

    void FieldWriteObjectEnd(); 

    void FieldWriteBlockBegin(char* pFileName);

    void FieldWriteBlockEnd ();

    void FieldWriteCH(char pValue);

    inline void FieldWriteCH(char* pFieldName, char pValue) {FieldWriteBegin (pFieldName); FieldWriteCH (pValue); FieldWriteEnd ();}

    void FieldWriteC(char* pValue);

    inline void FieldWriteC(char* pFieldName, char* pValue) {FieldWriteBegin (pFieldName); FieldWriteC (pValue); FieldWriteEnd ();}

    inline void FieldWriteS(KString pValue) {FieldWriteC (pValue.Buffer ());}

    inline void FieldWriteS(char* pFieldName, KString pValue) {FieldWriteC (pFieldName, pValue.Buffer ());}

    inline void FieldWriteB(bool pValue){ FieldWriteI( pValue ); }

    inline void FieldWriteB(char* pFieldName, bool pValue) {FieldWriteBegin (pFieldName); FieldWriteB (pValue); FieldWriteEnd ();}

    void FieldWriteI(int pValue);

    inline void FieldWriteI(char* pFieldName, int pValue) {FieldWriteBegin (pFieldName); FieldWriteI (pValue); FieldWriteEnd ();}

    void FieldWriteLL(kLongLong pValue);

    inline void FieldWriteLL(char* pFieldName, kLongLong pValue) {FieldWriteBegin (pFieldName); FieldWriteLL (pValue); FieldWriteEnd ();}

    void FieldWriteF(float pValue);

    inline void FieldWriteF(char* pFieldName, float pValue) {FieldWriteBegin (pFieldName); FieldWriteF (pValue); FieldWriteEnd ();}

    void FieldWriteD(double  pValue);

    inline void FieldWriteD(char* pFieldName, double pValue) {FieldWriteBegin (pFieldName); FieldWriteD (pValue); FieldWriteEnd ();}

    void FieldWriteT(KTime pTime);

    inline void FieldWriteT(char* pFieldName,KTime pValue) {FieldWriteBegin (pFieldName); FieldWriteT (pValue); FieldWriteEnd ();}

    void FieldWriteTS(KTimeSpan pTimeSpan);

    inline void FieldWriteTS(char* pFieldName,KTimeSpan pValue) {FieldWriteBegin (pFieldName); FieldWriteTS (pValue); FieldWriteEnd ();}

    inline void FieldWriteFn(float* pValue, kUInt pn) {for (kUInt c=0; c<pn; c++) {FieldWriteF (pValue[c]);}}

    inline void FieldWriteFn(char* pFieldName, float* pValue, kUInt pn) {FieldWriteBegin (pFieldName); FieldWriteFn (pValue, pn); FieldWriteEnd ();}

    inline void FieldWrite3F(float* pValue) {FieldWriteFn (pValue, 3);}

    inline void FieldWrite3F(char* pFieldName, float* pValue) {FieldWriteFn (pFieldName, pValue, 3);}

    inline void FieldWrite4F(float* pValue) {FieldWriteFn (pValue, 4);}

    inline void FieldWrite4F(char* pFieldName, float* pValue) {FieldWriteFn (pFieldName, pValue, 4);}

    inline void FieldWriteDn(double* pValue, kUInt pn) {for (kUInt c=0; c<pn; c++) {FieldWriteD (pValue[c]);}}

    inline void FieldWriteDn(char* pFieldName, double* pValue, kUInt pn) {FieldWriteBegin (pFieldName); FieldWriteDn (pValue, pn); FieldWriteEnd ();}

    inline void FieldWrite3D(double* pValue) {FieldWriteDn (pValue, 3);}

    inline void FieldWrite3D(char* pFieldName, double* pValue) {FieldWriteDn (pFieldName, pValue, 3);}

    inline void FieldWrite4D(double* pValue) {FieldWriteDn (pValue, 4);}

    inline void FieldWrite4D(char* pFieldName, double* pValue) {FieldWriteDn (pFieldName, pValue, 4);}

    void FieldWriteR(void* pRawData, int pByteSize);

    inline void FieldWriteR(char* pFieldName, void* pRawData, int pByteSize) {FieldWriteBegin (pFieldName); FieldWriteR (pRawData, pByteSize); FieldWriteEnd ();}

    inline void FieldWriteObjectReference(char* pName) {FieldWriteC (pName);}

    inline void FieldWriteObjectReference(char* pFieldName, char* pName) {FieldWriteC (pFieldName, pName);}

    void WriteComments(char* pFieldName);


    KFbxDataStream& operator=(const KFbxDataStream& pDataStream);

    private:
        KFbxDataStream_internal*    mInternal;
};

#include <fbxfilesdk_nsend.h>

#endif // #ifndef _FBXSDK_DATASTREAM_H_