kfbxdocument.h

Go to the documentation of this file.

#ifndef FBXFILESDK_FBXCORE_FBXCOLLECTION_KFBXDOCUMENT_H
#define FBXFILESDK_FBXCORE_FBXCOLLECTION_KFBXDOCUMENT_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/fbxcore/fbxcollection/kfbxcollection.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

    // Forward declaration
    class KFbxTakeInfo;
    class KFbxPeripheral;
    class KFbxDocumentInfo;

    class KFBX_DLL KFbxDocument : public KFbxCollection
    {
        KFBXOBJECT_DECLARE(KFbxDocument,KFbxCollection);

    public:
            KFbxTypedProperty<fbxReference*>                    Roots;


            virtual void    Clear();
            inline  void    AddRootMember   (KFbxObject *pMember)   { AddMember(pMember); Roots.ConnectSrcObject(pMember); }
            inline  void    RootRootRemoveMember(KFbxObject *pMember)   { RemoveMember(pMember); Roots.DisconnectSrcObject(pMember); }
            template <class T> inline T *       FindRootMember(T const *pfbxType, char *pName) { return Roots.FindSrcObject(pfbxType, pName); }

            inline int                          GetRootMemberCount () const { return Roots.GetSrcObjectCount(); }
            template < class T > inline int     GetRootMemberCount (T const *pFBX_TYPE) const { return Roots.GetSrcObjectCount(T::ClassId); }
            int                                 GetRootMemberCount( KFbxCriteria pCriteria ) const;

            inline KFbxObject*                  GetRootMember (int pIndex=0) const                  { return Roots.GetSrcObject(pIndex); }
            template < class T > inline T*      GetRootMember (T const *pFBX_TYPE, int pIndex=0) const  { return (T *)Roots.GetSrcObject(T::ClassId,pIndex); }
            KFbxObject*                         GetRootMember (KFbxCriteria pCriteria, int pIndex=0) const;
 
            virtual bool    IsRootMember(KFbxObject *pMember) const;


            KFbxDocumentInfo* GetDocumentInfo() const;

            void SetDocumentInfo(KFbxDocumentInfo* pSceneInfo);

        public:
            void SetPeripheral(KFbxPeripheral* pPeripheral);

            virtual KFbxPeripheral* GetPeripheral();

            int UnloadContent();

            int LoadContent();



            int GetReferencingDocuments(KArrayTemplate<KFbxDocument*> & pReferencingDocuments) const;

            int GetReferencingObjects(KFbxDocument const * pFromDoc, KArrayTemplate<KFbxObject*> & pReferencingObjects) const;

            int GetReferencedDocuments(KArrayTemplate<KFbxDocument*> & pReferencedDocuments) const;

            int GetReferencedObjects(KFbxDocument const * pToDoc, KArrayTemplate<KFbxObject*> & pReferencedObjects) const;

            KString GetPathToRootDocument(void) const;
            void GetDocumentPathToRootDocument(KArrayTemplate<KFbxDocument*> & pDocumentPath, bool pFirstCall = true) const;

            bool IsARootDocument(void) { return (NULL == GetDocument()); }

            KFbxTypedProperty<fbxString>    ActiveAnimStackName;

            bool CreateAnimStack(const char* pName);

            K_DEPRECATED bool CreateTake(const char* pName);

            bool RemoveAnimStack(const char* pName);

            K_DEPRECATED bool RemoveTake(const char* pName);

            K_DEPRECATED bool SetCurrentTake(const char* pName);

            K_DEPRECATED char* GetCurrentTakeName();

            K_DEPRECATED void FillTakeNameArray(KArrayTemplate<KString*>& pNameArray);

            void FillAnimStackNameArray(KArrayTemplate<KString*>& pNameArray);



            bool SetTakeInfo(const KFbxTakeInfo& pTakeInfo);

            KFbxTakeInfo* GetTakeInfo(const KString& pTakeName) const;



            KError& GetError();

            typedef enum
            {
                eTAKE_ERROR,
                eKFBX_OBJECT_IS_NULL,
                eKFBX_OBJECT_ALREADY_OWNED,
                eKFBX_OBJECT_UNKNOWN,
                eKFBX_MISSING_PERIPHERAL,
                eKFBX_OBJECT_PERIPHERAL_FAILURE,
                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

                virtual KFbxObject& Copy(const KFbxObject& pObject);
                virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;

            // Constructor / Destructor
            protected:

                KFbxDocument(KFbxSdkManager& pManager, char const* pName);
                virtual void Construct  (const KFbxDocument* pFrom);
                virtual void Destruct   (bool pRecursive, bool pDependents);
                bool    ConstructProperties(bool pForceSet);

            // Notification and connection management
            protected:
                virtual bool    ConnecNotify (KFbxConnectEvent const &pEvent);
                virtual void    SetDocument(KFbxDocument* pDocument);

            // Helper functions
            public:
                void ConnectVideos();

            // Take management
            protected:
                bool FindTakeName(const KString& pTakeName);

            // this section will exist while the deprecated GetCurrentTakeName() exists
            private:    
                KString mDeprecatedCurrentTakeName;
                
            //
            protected:
                KFbxSdkManager*                     mSdkManager;
                KFbxPeripheral*                     mPeripheral;
                KArrayTemplate<KFbxTakeInfo *>      mTakeInfoArray;
                KError                              mError;
                KFbxDocumentInfo*                   mDocumentInfo;



            friend class KFbxLayerContainer;
            friend class KFbxNodeFinderDuplicateName;
        #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
    };

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_FBXCORE_FBXCOLLECTION_KFBXDOCUMENT_H