kfbxobject.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXOBJECT_H
#define FBXFILESDK_KFBXPLUGINS_KFBXOBJECT_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/kfbxplug.h>
#include <fbxfilesdk/kfbxplugins/kfbxproperty.h>

#include <fbxfilesdk/components/kbaselib/klib/kstringlist.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxDocument;
class KFbxImplementation;
class KFbxImplementationFilter;
class KFbxLibrary;
class KFbxMessage;
class KFbxPeripheral;
class KFbxStream;
class UserDataRecord;

enum eFbxCompare {
    eFbxCompareProperties
};

#define KFBXOBJECT_DECLARE(Class,Parent)                                                                        \
    KFBXPLUG_DECLARE(Class)     /* this also set public */                                                      \
    typedef Parent ParentClass;                                                                                 \
    static Class* Create(KFbxObject* pContainer,  char const* pName);                                           \
    virtual ~Class(){};                                                                                         \
private:                                                                                                        \
    Class(const Class&);                                                                                        \
    Class& operator=(const Class&);                                                                             \


#define KFBXOBJECT_DECLARE_ABSTRACT(Class,Parent)                                                               \
    KFBXPLUG_DECLARE_ABSTRACT(Class)    /* this also set public */                                              \
    typedef Parent ParentClass;                                                                                 \
private:                                                                                                        \
    Class(const Class&);                                                                                        \
    Class& operator=(const Class&);                                                                             \


#define KFBXOBJECT_IMPLEMENT(Class)                                                                             \
    KFBXPLUG_IMPLEMENT(Class)                                                                                   \
    Class* Class::Create(KFbxObject* pContainer, char const* pName)                                             \
    {                                                                                                           \
        if( !pContainer ) return NULL;                                                                          \
        Class* ClassPtr = Class::Create(pContainer->GetFbxSdkManager(), pName);                                 \
        pContainer->ConnectSrcObject(ClassPtr);                                                                 \
        return ClassPtr;                                                                                        \
    }                                                                                                           \


#define KFBXOBJECT_IMPLEMENT_ABSTRACT(Class)                                                                    \
    KFBXPLUG_IMPLEMENT_ABSTRACT(Class)                                                                          \

typedef size_t KFbxObjectID;
typedef int kFbxUpdateId;

class _KFbxObjectData;

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

public:
        typedef enum
        {
            eDEEP_CLONE,        
            eREFERENCE_CLONE    
        } ECloneType;

        virtual KFbxObject* Clone(KFbxObject::ECloneType pCloneType=eDEEP_CLONE, KFbxObject* pContainer=NULL) const;

        bool IsAReferenceTo() const;

        KFbxObject* GetReferenceTo() const;

        bool IsReferencedBy() const;

        int GetReferencedByCount() const;

        KFbxObject* GetReferencedBy(int pIndex) const;

        void SetName(char const* pName);

        char const* GetName() const;

        KString GetNameWithoutNameSpacePrefix() const;

        KString GetNameWithNameSpacePrefix() const;

        void SetInitialName(char const* pName);

        char const* GetInitialName() const;

        KString GetNameSpaceOnly( );

        void SetNameSpace(KString pNameSpace);

        KArrayTemplate<KString*> GetNameSpaceArray( char identifier );

        KString GetNameOnly() const;

        KString GetNameSpacePrefix() const;

        static KString RemovePrefix(char* pName);

        static KString StripPrefix(KString& lName);

        static KString StripPrefix(const char* pName);

        KFbxObjectID const& GetUniqueID() const;

        typedef enum {
            eUpdateId_Object,
            eUpdateId_Dependency
        } eFbxUpdateIdType;

        virtual kFbxUpdateId GetUpdateId(eFbxUpdateIdType pUpdateId=eUpdateId_Object) const;

        int ContentUnload();

        int ContentLoad();

        bool ContentIsLoaded() const;

        void ContentDecrementLockCount();

        void ContentIncrementLockCount();

        bool ContentIsLocked() const;

        virtual bool ContentWriteTo(KFbxStream& pStream) const;

        virtual bool ContentReadFrom(const KFbxStream& pStream);

        virtual bool GetSelected();

        virtual void SetSelected(bool pSelected);

        inline KFbxProperty GetFirstProperty() const
        {
            return RootProperty.GetFirstDescendent();
        }

        inline KFbxProperty GetNextProperty(KFbxProperty const &pProperty) const
        {
            return RootProperty.GetNextDescendent(pProperty);
        }

        inline KFbxProperty FindProperty(const char* pName, bool pCaseSensitive = true)const
        {
            return RootProperty.Find(pName, pCaseSensitive );
        }

        inline KFbxProperty FindProperty(const char* pName, KFbxDataType const &pDataType, bool pCaseSensitive = true) const
        {
            return RootProperty.Find(pName, pDataType, pCaseSensitive );
        }

        inline KFbxProperty FindPropertyHierarchical(const char* pName, bool pCaseSensitive = true)const
        {
            return RootProperty.FindHierarchical(pName, pCaseSensitive );
        }

        inline KFbxProperty FindPropertyHierarchical(const char* pName, KFbxDataType const &pDataType, bool pCaseSensitive = true) const
        {
            return RootProperty.FindHierarchical(pName, pDataType, pCaseSensitive );
        }

        inline KFbxProperty& GetRootProperty() { return RootProperty; }

        inline const KFbxProperty& GetRootProperty()const{ return RootProperty; }

        KFbxProperty GetClassRootProperty();

        inline bool ConnectSrcObject(KFbxObject* pObject,kFbxConnectionType pType=eFbxConnectionNone){ return RootProperty.ConnectSrcObject(pObject,pType); }

        inline bool IsConnectedSrcObject(const KFbxObject* pObject) const { return RootProperty.IsConnectedSrcObject(pObject); }

        inline bool DisconnectSrcObject(KFbxObject* pObject){ return RootProperty.DisconnectSrcObject(pObject); }

        inline bool DisconnectAllSrcObject() { return RootProperty.DisconnectAllSrcObject(); }

        inline bool DisconnectAllSrcObject(KFbxCriteria const &pCriteria) { return RootProperty.DisconnectAllSrcObject(pCriteria); }

        inline bool DisconnectAllSrcObject(kFbxClassId pClassId) { return RootProperty.DisconnectAllSrcObject(pClassId); }

        inline bool DisconnectAllSrcObject(kFbxClassId pClassId,KFbxCriteria const &pCriteria) { return RootProperty.DisconnectAllSrcObject(pClassId,pCriteria); }

        inline int GetSrcObjectCount() const { return RootProperty.GetSrcObjectCount(); }

        inline int GetSrcObjectCount(KFbxCriteria const &pCriteria) const { return RootProperty.GetSrcObjectCount(pCriteria); }

        inline int GetSrcObjectCount(kFbxClassId pClassId) const { return RootProperty.GetSrcObjectCount(pClassId); }

        inline int GetSrcObjectCount(kFbxClassId pClassId,KFbxCriteria const &pCriteria) const { return RootProperty.GetSrcObjectCount(pClassId,pCriteria); }

        inline KFbxObject* GetSrcObject(int pIndex=0) const { return RootProperty.GetSrcObject(pIndex); }

        inline KFbxObject* GetSrcObject(KFbxCriteria const &pCriteria,int pIndex=0) const { return RootProperty.GetSrcObject(pCriteria,pIndex); }

        inline KFbxObject* GetSrcObject(kFbxClassId pClassId,int pIndex=0) const { return RootProperty.GetSrcObject(pClassId,pIndex); }

        inline KFbxObject* GetSrcObject(kFbxClassId pClassId,KFbxCriteria const &pCriteria,int pIndex=0) const { return RootProperty.GetSrcObject(pClassId,pCriteria,pIndex); }

        inline KFbxObject* FindSrcObject(const char *pName,int pStartIndex=0) const { return RootProperty.FindSrcObject(pName,pStartIndex); }

        inline KFbxObject* FindSrcObject(KFbxCriteria const &pCriteria,const char *pName,int pStartIndex=0) const { return RootProperty.FindSrcObject(pCriteria,pName,pStartIndex); }

        inline KFbxObject* FindSrcObject(kFbxClassId pClassId,const char *pName,int pStartIndex=0) const { return RootProperty.FindSrcObject(pClassId,pName,pStartIndex); }

        inline KFbxObject* FindSrcObject(kFbxClassId pClassId,KFbxCriteria const &pCriteria,const char *pName,int pStartIndex=0) const { return RootProperty.FindSrcObject(pClassId,pCriteria,pName,pStartIndex); }

        template <class T> inline bool DisconnectAllSrcObject(T const *pFBX_TYPE) { return RootProperty.DisconnectAllSrcObject(pFBX_TYPE); }

        template <class T> inline bool DisconnectAllSrcObject(T const *pFBX_TYPE,KFbxCriteria const &pCriteria) { return RootProperty.DisconnectAllSrcObject(pFBX_TYPE,pCriteria); }

        template <class T> inline int GetSrcObjectCount(T const *pFBX_TYPE) const { return RootProperty.GetSrcObjectCount(pFBX_TYPE); }

        template <class T> inline int GetSrcObjectCount(T const *pFBX_TYPE,KFbxCriteria const &pCriteria) const { return RootProperty.GetSrcObjectCount(pFBX_TYPE,pCriteria); }

        template <class T> inline T* GetSrcObject(T const *pFBX_TYPE,int pIndex=0) const { return RootProperty.GetSrcObject(pFBX_TYPE,pIndex); }

        template <class T> inline T* GetSrcObject(T const *pFBX_TYPE,KFbxCriteria const &pCriteria,int pIndex=0) const { return RootProperty.GetSrcObject(pFBX_TYPE,pCriteria,pIndex); }

        template <class T> inline T* FindSrcObject(T const *pFBX_TYPE,const char *pName,int pStartIndex=0) const { return RootProperty.FindSrcObject(pFBX_TYPE,pName,pStartIndex); }

        template <class T> inline T* FindSrcObject(T const *pFBX_TYPE,KFbxCriteria const &pCriteria,const char *pName,int pStartIndex=0) const { return RootProperty.FindSrcObject(pFBX_TYPE,pCriteria,pName,pStartIndex); }

        inline bool ConnectDstObject(KFbxObject* pObject,kFbxConnectionType pType=eFbxConnectionNone) { return RootProperty.ConnectDstObject(pObject,pType); }

        inline bool IsConnectedDstObject(const KFbxObject* pObject) const { return RootProperty.IsConnectedDstObject(pObject); }

        inline bool DisconnectDstObject(KFbxObject* pObject) { return RootProperty.DisconnectDstObject(pObject); }

        inline bool DisconnectAllDstObject() { return RootProperty.DisconnectAllDstObject(); }

        inline bool DisconnectAllDstObject(KFbxCriteria const &pCriteria) { return RootProperty.DisconnectAllDstObject(pCriteria); }

        inline bool DisconnectAllDstObject(kFbxClassId pClassId) { return RootProperty.DisconnectAllDstObject(pClassId); }

        inline bool DisconnectAllDstObject(kFbxClassId pClassId,KFbxCriteria const &pCriteria) { return RootProperty.DisconnectAllDstObject(pClassId,pCriteria); }

        inline int GetDstObjectCount() const { return RootProperty.GetDstObjectCount(); }

        inline int GetDstObjectCount(KFbxCriteria const &pCriteria) const { return RootProperty.GetDstObjectCount(pCriteria); }

        inline int GetDstObjectCount(kFbxClassId pClassId) const { return RootProperty.GetDstObjectCount(pClassId); }

        inline int GetDstObjectCount(kFbxClassId pClassId,KFbxCriteria const &pCriteria) const { return RootProperty.GetDstObjectCount(pClassId,pCriteria); }

        inline KFbxObject* GetDstObject(int pIndex=0) const { return RootProperty.GetDstObject(pIndex); }

        inline KFbxObject* GetDstObject(KFbxCriteria const &pCriteria,int pIndex=0) const { return RootProperty.GetDstObject(pCriteria,pIndex); }

        inline KFbxObject* GetDstObject(kFbxClassId pClassId,int pIndex=0) const { return RootProperty.GetDstObject(pClassId,pIndex); }

        inline KFbxObject* GetDstObject(kFbxClassId pClassId,KFbxCriteria const &pCriteria,int pIndex=0) const { return RootProperty.GetDstObject(pClassId,pCriteria,pIndex); }

        inline KFbxObject* FindDstObject(const char *pName,int pStartIndex=0) const { return RootProperty.FindDstObject(pName,pStartIndex); }

        inline KFbxObject* FindDstObject(KFbxCriteria const &pCriteria,const char *pName,int pStartIndex=0) const { return RootProperty.FindDstObject(pCriteria,pName,pStartIndex); }

        inline KFbxObject* FindDstObject(kFbxClassId pClassId,const char *pName,int pStartIndex=0) const { return RootProperty.FindDstObject(pClassId,pName,pStartIndex); }

        inline KFbxObject* FindDstObject(kFbxClassId pClassId,KFbxCriteria const &pCriteria,const char *pName,int pStartIndex=0) const { return RootProperty.FindDstObject(pClassId,pCriteria,pName,pStartIndex); }

        template <class T> inline bool DisconnectAllDstObject(T const *pFBX_TYPE) { return RootProperty.DisconnectAllDstObject(pFBX_TYPE); }

        template <class T> inline bool DisconnectAllDstObject(T const *pFBX_TYPE,KFbxCriteria const &pCriteria) { return RootProperty.DisconnectAllDstObject(pFBX_TYPE,pCriteria); }

        template <class T> inline int GetDstObjectCount(T const *pFBX_TYPE) const { return RootProperty.GetDstObjectCount(pFBX_TYPE); }

        template <class T> inline int GetDstObjectCount(T const *pFBX_TYPE,KFbxCriteria const &pCriteria) const { return RootProperty.GetDstObjectCount(pFBX_TYPE,pCriteria); }

        template <class T> inline T* GetDstObject(T const *pFBX_TYPE,int pIndex=0) const { return RootProperty.GetDstObject(pFBX_TYPE,pIndex); }

        template <class T> inline T* GetDstObject(T const *pFBX_TYPE,KFbxCriteria const &pCriteria,int pIndex=0) const { return RootProperty.GetDstObject(pFBX_TYPE,pCriteria,pIndex); }

        template <class T> inline T* FindDstObject(T const *pFBX_TYPE,const char *pName,int pStartIndex=0) const { return RootProperty.FindDstObject(pFBX_TYPE,pName,pStartIndex); }

        template <class T> inline T* FindDstObject(T const *pFBX_TYPE,KFbxCriteria const &pCriteria,const char *pName,int pStartIndex=0) const { return RootProperty.FindDstObject(pFBX_TYPE,pCriteria,pName,pStartIndex); }

        inline bool ConnectSrcProperty(KFbxProperty const & pProperty) { return RootProperty.ConnectSrcProperty(pProperty); }

        inline bool IsConnectedSrcProperty(KFbxProperty const & pProperty) { return RootProperty.IsConnectedSrcProperty(pProperty); }

        inline bool DisconnectSrcProperty(KFbxProperty const & pProperty) { return RootProperty.DisconnectSrcProperty(pProperty); }

        inline int GetSrcPropertyCount() const { return RootProperty.GetSrcPropertyCount(); }

        inline KFbxProperty GetSrcProperty(int pIndex=0) const { return RootProperty.GetSrcProperty(pIndex); }

        inline KFbxProperty FindSrcProperty(const char *pName,int pStartIndex=0) const { return RootProperty.FindSrcProperty(pName,pStartIndex); }

        inline bool ConnectDstProperty(KFbxProperty const & pProperty) { return RootProperty.ConnectDstProperty(pProperty); }

        inline bool IsConnectedDstProperty(KFbxProperty const & pProperty) { return RootProperty.IsConnectedDstProperty(pProperty); }

        inline bool DisconnectDstProperty(KFbxProperty const & pProperty) { return RootProperty.DisconnectDstProperty(pProperty); }

        inline int GetDstPropertyCount() const { return RootProperty.GetDstPropertyCount(); }

        inline KFbxProperty GetDstProperty(int pIndex=0) const { return RootProperty.GetDstProperty(pIndex); }

        inline KFbxProperty FindDstProperty(const char *pName,int pStartIndex=0) const { return RootProperty.FindDstProperty(pName,pStartIndex); }

        void SetUserDataPtr(KFbxObjectID const& pUserID, void* pUserData);

        void* GetUserDataPtr(KFbxObjectID const& pUserID) const;

        inline void SetUserDataPtr(void* pUserData){ SetUserDataPtr(GetUniqueID(), pUserData); }

        inline void* GetUserDataPtr() const { return GetUserDataPtr(GetUniqueID()); }

        KFbxDocument* GetDocument() const;

        KFbxDocument* GetRootDocument() const;

        KFbxScene* GetScene() const;

        void EmitMessage(KFbxMessage * pMessage) const;

        virtual const char* Localize(const char* pID, const char* pDefault=NULL) const;

        KFbxLibrary* GetParentLibrary() const;

        bool AddImplementation(KFbxImplementation* pImplementation);

        bool RemoveImplementation(KFbxImplementation* pImplementation);

        bool HasDefaultImplementation(void) const;

        KFbxImplementation* GetDefaultImplementation(void) const;

        bool SetDefaultImplementation(KFbxImplementation* pImplementation);

        int GetImplementationCount(const KFbxImplementationFilter* pCriteria=NULL) const;

        KFbxImplementation* GetImplementation(int pIndex, const KFbxImplementationFilter* pCriteria=NULL) const;

        virtual KString GetUrl() const;

        virtual bool SetUrl(char* pUrl);

    virtual KFbxObject& Copy(const KFbxObject& pObject);

    KFbxProperty RootProperty;

protected:
    virtual void ContentClear();

    virtual KFbxPeripheral* GetPeripheral();

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
    virtual bool            Compare(KFbxObject *pOtherObject,eFbxCompare pCompareMethod=eFbxCompareProperties);

    virtual KFbxSdkManager* GetFbxSdkManager() const;
    virtual kFbxClassId     GetRuntimeClassId() const;

    typedef enum
    {
        eNONE                   = 0x00000000,
        eSYSTEM_FLAG            = 0x00000001,
        eSAVABLE_FLAG           = 0x00000002,
        eHIDDEN_FLAG            = 0x00000008,

        eSYSTEM_FLAGS           = 0x0000ffff,

        eUSER_FLAGS             = 0x000f0000,

        // These flags are not saved to the fbx file
        eSYSTEM_RUNTIME_FLAGS   = 0x0ff00000,

        eCONTENT_LOADED_FLAG    = 0x00100000,

        eUSER_RUNTIME_FIRST_FLAG= 0x10000000,
        eUSER_RUNTIME_FLAGS     = 0xf0000000,

        eRUNTIME_FLAGS          = 0xfff00000
    } EObjectFlag;

    void    SetObjectFlags(EObjectFlag pFlags, bool pValue);
    bool    GetObjectFlags(EObjectFlag pFlags) const;

    // All flags replaced at once. This includes overriding the runtime flags, so
    // most likely you'd want to do something like this:
    //
    // SetObjectFlags(pFlags | (GetObjectFlags() & KFbxObject::eRUNTIME_FLAGS));
    void    SetObjectFlags(kUInt pFlags);
    kUInt   GetObjectFlags() const; // All flags at once, as a bitmask

    //Basic comparison operator implementation. It simply compare property values between source and target.
    //NOTE: If a property cannot be found on one of the object, the comparison fails (return false).
    //Different classid will fail comparison as well as different property count. Reference properties are not compared.
    bool    operator==(KFbxObject const& pObject);
    bool    operator!=(KFbxObject const& pObject);

    //Important note: If this function is not implemented, the pFileSubTypeName string used when registering your
    //class via KFbxSdkManager::RegisterFbxClass will be used instead. This makes it useless to re-implement this
    //function if you do not intend to return a different string for the same class.
    virtual const char* GetTypeName() const;

    virtual KStringList GetTypeFlags() const;

    virtual void                SetDocument(KFbxDocument* pDocument);
    inline KFbxObjectHandle&    GetPropertyHandle() { return RootProperty.mPropertyHandle; }

    // This function will go as deep as possible to clear the Connection list without sending 
    // notifications to the connections to give them the chance to Disconnect themselves. 
    // This is a bypass of the intended workflow and should be used with care.
    void WipeAllConnections();

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

    // Constructs the object. Each subclass should call the base
    // KFbxObject::Construct first. Note that property initialization
    // should be done in the ConstructProperties() method, not this one.
    // pFrom - The object this object should be cloned from. NULL to
    // construct an independent object.
    virtual void            Construct(const KFbxObject* pFrom);

    // Initialize the KFbxProperty member variables of this class.
    // Each subclass should call its parent, and initialize its properties
    // in this method.
    // pForceSet - Forces the property values to be set to default values.
    virtual bool            ConstructProperties(bool pForceSet);
    virtual void            Destruct(bool pRecursive, bool pDependents);

    bool                    Copyable(const KFbxObject& pObject);

    virtual bool            SetRuntimeClassId(kFbxClassId pClassId);
    virtual bool            ConnecNotify(KFbxConnectEvent const& pEvent);
    virtual kFbxUpdateId    IncUpdateId(eFbxUpdateIdType pUpdateId=eUpdateId_Object);

    // property callbacks
    typedef enum {
        eFbxProperty_SetRequest,
        eFbxProperty_Set,
        eFbxProperty_Get
    } eFbxPropertyNotify;
    virtual bool PropertyNotify(eFbxPropertyNotify pType, KFbxProperty* pProperty);

private:
    void    CopyPropertiesFrom(const KFbxObject& pFrom);
    void    SetClassRootProperty(KFbxProperty &lProperty);
    int     GetFlatPropertyCount() const;

    _KFbxObjectData* mData;

    // friend classes for SDK access
    friend class KFbxScene;
    friend class KFbxProperty;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

inline bool KFbxConnectSrc(KFbxObject *pDstObject,KFbxObject *pSrcObject)   { return (pSrcObject && pDstObject) ? pDstObject->ConnectSrcObject(pSrcObject) : 0; }
inline bool KFbxConnectDst(KFbxObject *pSrcObject,KFbxObject *pDstObject)   { return (pSrcObject && pDstObject) ? pSrcObject->ConnectDstObject(pDstObject) : 0; }

typedef KFbxObject* HKFbxObject;

// template access functions SRC
template < class T > inline int KFbxGetSrcCount(KFbxObject const *pObject)                                                      { return pObject ? pObject->GetSrcObjectCount(T::ClassId) : 0; }
template < class T > inline int KFbxGetSrcCount(KFbxObject const *pObject,kFbxClassId pClassId)                                 { return pObject ? pObject->GetSrcObjectCount(pClassId) : 0;     }
template < class T > inline T* KFbxGetSrc(KFbxObject const *pObject,int pIndex=0)                                               { return pObject ? (T *) pObject->GetSrcObject(T::ClassId,pIndex) : 0; }
template < class T > inline T* KFbxGetSrc(KFbxObject const *pObject,int pIndex,kFbxClassId pClassId)                            { return pObject ? (T *) pObject->GetSrcObject(pClassId,pIndex) : 0;    }
template < class T > inline T* KFbxFindSrc(KFbxObject const *pObject,char const *pName,int pIndex=0)                            { return pObject ? (T *) pObject->FindSrcObject(T::ClassId,pName,pIndex) : 0;   }
template < class T > inline T* KFbxFindSrc(KFbxObject const *pObject,char const *pName,kFbxClassId pClassId,int pIndex=0)       { return pObject ? (T *) pObject->FindSrcObject(pClassId,pName,pIndex) : 0; }

template < class T > inline bool KFbxDisconnectAllSrc(KFbxObject *pObject)                                                      { return pObject->DisconnectAllSrcObject(T::ClassId);   }

// template access functions DST
template < class T > inline int KFbxGetDstCount(KFbxObject const *pObject)                                                      { return pObject ? pObject->GetDstObjectCount(T::ClassId) : 0; }
template < class T > inline int KFbxGetDstCount(KFbxObject const *pObject,kFbxClassId pClassId)                                 { return pObject ? pObject->GetDstObjectCount(pClassId) : 0;     }
template < class T > inline T* KFbxGetDst(KFbxObject const *pObject,int pIndex=0)                                               { return pObject ? (T *) pObject->GetDstObject(T::ClassId,pIndex) : 0; }
template < class T > inline T* KFbxGetDst(KFbxObject const *pObject,int pIndex,kFbxClassId pClassId)                            { return pObject ? (T *) pObject->GetDstObject(pClassId,pIndex) : 0;    }
template < class T > inline T* KFbxFindDst(KFbxObject const *pObject,char const *pName,int pIndex=0)                            { return pObject ? (T *) pObject->FindDstObject(T::ClassId,pName,pIndex) : 0;   }
template < class T > inline T* KFbxFindDst(KFbxObject const *pObject,char const *pName,kFbxClassId pClassId,int pIndex=0)       { return pObject ? (T *) pObject->FindDstObject(pClassId,pName,pIndex) : 0; }
template < class T > inline bool KFbxDisconnectAllDst(KFbxObject *pObject)                                                      { return pObject->DisconnectAllDstObject(T::ClassId);   }


/**********************************************************************
* Object Iterator
**********************************************************************/

template<typename KFbxProperty> class KFbxIterator
{
    public:
        KFbxIterator(KFbxObject const *pObject) : mObject(pObject) {}

        inline KFbxProperty const &GetFirst() { mProperty = mObject->GetFirstProperty(); return mProperty; }

        inline KFbxProperty const &GetNext() { mProperty = mObject->GetNextProperty(mProperty); return mProperty; }

    private:
        KFbxProperty        mProperty;
        KFbxObject const*   mObject;
};

class KFbxIteratorSrcBase
{
protected:
    KFbxProperty    mProperty;
    kFbxClassId     mClassId;
    int             mSize;
    int             mIndex;
public:
    inline KFbxIteratorSrcBase(KFbxProperty &pProperty,kFbxClassId pClassId) :
        mProperty(pProperty),
        mClassId(pClassId),
        mSize(0),
        mIndex(-1)
    {
        ResetToBegin();
    }
    inline KFbxIteratorSrcBase(KFbxObject* pObject,kFbxClassId pClassId) :
        mProperty(pObject->RootProperty),
        mClassId(pClassId),
        mSize(0),
        mIndex(-1)
    {
        ResetToBegin();
    }
    inline KFbxObject* GetFirst()
    {
        ResetToBegin();
        return GetNext();
    }
    inline KFbxObject* GetNext()
    {
        mIndex++;
        return ((mIndex>=0) && (mIndex<mSize)) ? mProperty.GetSrcObject(mClassId,mIndex) : NULL;
    }
    inline KFbxObject* GetSafeNext()
    {
        mSize = mProperty.GetSrcObjectCount(mClassId);
        return GetNext();
    }
    inline KFbxObject* GetLast()
    {
        ResetToEnd();
        return GetPrevious();
    }
    inline KFbxObject* GetPrevious()
    {
        mIndex--;
        return ((mIndex>=0) && (mIndex<mSize)) ? mProperty.GetSrcObject(mClassId,mIndex) : NULL;
    }
    inline KFbxObject* GetSafePrevious()
    {
        mSize = mProperty.GetSrcObjectCount(mClassId);
        while (mIndex>mSize) mIndex--;
        return GetPrevious();
    }


// Internal Access Function
protected:
    inline void ResetToBegin()
    {
        mSize = mProperty.GetSrcObjectCount(mClassId);
        mIndex = -1;
    }
    inline void ResetToEnd()
    {
        mSize = mProperty.GetSrcObjectCount(mClassId);
        mIndex = mSize;
    }
};

template<class Type> class KFbxIteratorSrc : protected KFbxIteratorSrcBase
{
public:
    inline KFbxIteratorSrc(KFbxObject* pObject) : KFbxIteratorSrcBase(pObject,Type::ClassId) {}
    inline KFbxIteratorSrc(KFbxProperty& pProperty) : KFbxIteratorSrcBase(pProperty,Type::ClassId) {}
    inline Type *GetFirst()         { return (Type *)KFbxIteratorSrcBase::GetFirst(); }
    inline Type *GetNext()          { return (Type *)KFbxIteratorSrcBase::GetNext(); }
    inline Type *GetSafeNext()      { return (Type *)KFbxIteratorSrcBase::GetSafeNext(); }
    inline Type *GetLast()          { return (Type *)KFbxIteratorSrcBase::GetLast(); }
    inline Type *GetPrevious()      { return (Type *)KFbxIteratorSrcBase::GetPrevious(); }
    inline Type *GetSafePrevious()  { return (Type *)KFbxIteratorSrcBase::GetSafePrevious(); }

// Internal Access Function
protected:
};

class KFbxIteratorDstBase
{
protected:
    KFbxProperty    mProperty;
    kFbxClassId     mClassId;
    int             mSize;
    int             mIndex;
public:
    inline KFbxIteratorDstBase(KFbxProperty &pProperty,kFbxClassId pClassId) :
        mProperty(pProperty),
        mClassId(pClassId),
        mSize(0),
        mIndex(-1)
    {
        ResetToBegin();
    }
    inline KFbxIteratorDstBase(KFbxObject* pObject,kFbxClassId pClassId) :
        mProperty(pObject->RootProperty),
        mClassId(pClassId),
        mSize(0),
        mIndex(-1)
    {
        ResetToBegin();
    }
    inline KFbxObject* GetFirst()
    {
        ResetToBegin();
        return GetNext();
    }
    inline KFbxObject* GetNext()
    {
        mIndex++;
        return ((mIndex>=0) && (mIndex<mSize)) ? mProperty.GetDstObject(mClassId,mIndex) : NULL;
    }
    inline KFbxObject* GetSafeNext()
    {
        mSize = mProperty.GetDstObjectCount(mClassId);
        return GetNext();
    }
    inline KFbxObject* GetLast()
    {
        ResetToEnd();
        return GetPrevious();
    }
    inline KFbxObject* GetPrevious()
    {
        mIndex--;
        return ((mIndex>=0) && (mIndex<mSize)) ? mProperty.GetDstObject(mClassId,mIndex) : NULL;
    }
    inline KFbxObject* GetSafePrevious()
    {
        mSize = mProperty.GetDstObjectCount(mClassId);
        while (mIndex>mSize) mIndex--;
        return GetPrevious();
    }


// Internal Access Function
protected:
    inline void ResetToBegin()
    {
        mSize = mProperty.GetDstObjectCount(mClassId);
        mIndex = -1;
    }
    inline void ResetToEnd()
    {
        mSize = mProperty.GetDstObjectCount(mClassId);
        mIndex = mSize;
    }
};

template<class Type> class KFbxIteratorDst : protected KFbxIteratorDstBase
{
public:
    inline KFbxIteratorDst(KFbxObject* pObject) : KFbxIteratorDstBase(pObject,Type::ClassId) {}
    inline KFbxIteratorDst(KFbxProperty& pProperty) : KFbxIteratorDstBase(pProperty,Type::ClassId) {}
    inline Type *GetFirst()         { return (Type *)KFbxIteratorDstBase::GetFirst(); }
    inline Type *GetNext()          { return (Type *)KFbxIteratorDstBase::GetNext(); }
    inline Type *GetSafeNext()      { return (Type *)KFbxIteratorDstBase::GetSafeNext(); }
    inline Type *GetLast()          { return (Type *)KFbxIteratorDstBase::GetLast(); }
    inline Type *GetPrevious()      { return (Type *)KFbxIteratorDstBase::GetPrevious(); }
    inline Type *GetSafePrevious()  { return (Type *)KFbxIteratorDstBase::GetSafePrevious(); }
};

#define KFbxForEach(Iterator,Object) for ( (Object)=(Iterator).GetFirst(); (Object)!=0; (Object)=(Iterator).GetNext() )
#define KFbxReverseForEach(Iterator,Object) for ( Object=(Iterator).GetLast(); (Object)!=0;  Object=(Iterator).GetPrevious() )
#define KFbxForEach_Safe(Iterator,Object) for ( Object=(Iterator).GetFirst(); (Object)!=0; Object=(Iterator).GetSafeNext() )
#define KFbxReverseForEach_Safe(Iterator,Object) for ( Object=(Iterator).GetLast(); (Object)!=0;  Object=(Iterator).GetSafePrevious() )

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
class KFbxObjectPropertyChanged : public kfbxevents::KFbxEvent<KFbxObjectPropertyChanged>
{
    KFBXEVENT_DECLARE(KFbxObjectPropertyChanged);

public:
    KFbxObjectPropertyChanged(KFbxProperty pProp) : mProp(pProp) {}
    KFbxProperty mProp;
};
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXOBJECT_H