fbxdocument.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2012 Autodesk, Inc.
   All rights reserved.
 
   Use of this software is subject to the terms of the Autodesk license agreement
   provided at the time of installation or download, or which otherwise accompanies
   this software in either electronic or hard copy form.
 
****************************************************************************************/

#ifndef _FBXSDK_SCENE_DOCUMENT_H_
#define _FBXSDK_SCENE_DOCUMENT_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/scene/fbxcollection.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

// Forward declaration
class FbxTakeInfo;
class FbxPeripheral;
class FbxDocumentInfo;

class FBXSDK_DLL FbxDocument : public FbxCollection
{
    FBXSDK_OBJECT_DECLARE(FbxDocument,FbxCollection);

public:
        FbxPropertyT<FbxReference>                    Roots;


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

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

        inline FbxObject*                  GetRootMember (int pIndex=0) const                  { return Roots.GetSrcObject(pIndex); }
        template < class T > inline T*      GetRootMember (const T* pFBX_TYPE, int pIndex=0) const  { return (T*)Roots.GetSrcObject(T::ClassId,pIndex); }
        FbxObject*                         GetRootMember (FbxCriteria pCriteria, int pIndex=0) const;

        virtual bool    IsRootMember(FbxObject* pMember) const;


        FbxDocumentInfo* GetDocumentInfo() const;

        void SetDocumentInfo(FbxDocumentInfo* pSceneInfo);

    public:
        void SetPeripheral(FbxPeripheral* pPeripheral);

        virtual FbxPeripheral* GetPeripheral();

        int UnloadContent();

        int LoadContent();



        int GetReferencingDocuments(FbxArray<FbxDocument*>& pReferencingDocuments) const;

        int GetReferencingObjects(const FbxDocument* pFromDoc, FbxArray<FbxObject*>& pReferencingObjects) const;

        int GetReferencedDocuments(FbxArray<FbxDocument*>& pReferencedDocuments) const;

        int GetReferencedObjects(const FbxDocument* pToDoc, FbxArray<FbxObject*>& pReferencedObjects) const;

        FbxString GetPathToRootDocument(void) const;
        void GetDocumentPathToRootDocument(FbxArray<FbxDocument*>& pDocumentPath, bool pFirstCall = true) const;

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

        FbxPropertyT<FbxString>    ActiveAnimStackName;

        bool CreateAnimStack(const char* pName);

        bool RemoveAnimStack(const char* pName);

        void FillAnimStackNameArray(FbxArray<FbxString*>& pNameArray);



        bool SetTakeInfo(const FbxTakeInfo& pTakeInfo);

        FbxTakeInfo* GetTakeInfo(const FbxString& pTakeName) const;



        FbxError& GetError();

        enum EErrorCode
        {
            eTakeError,                 
            eObjectIsNull,              
            eObjectAlreadyOwned,        
            eObjectUnknown,             
            eMissingPeripheral,         
            eObjectPeripheralFailure,   
            eErrorCount                 
        };

        EErrorCode 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 FbxObject& Copy(const FbxObject& pObject);

        // Constructor / Destructor
        protected:

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

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

        // Helper functions
        public:
            void ConnectVideos();

        // Take management
        protected:
            bool FindTakeName(const FbxString& pTakeName);
          
        //
        protected:
            FbxManager*                     mSdkManager;
            FbxPeripheral*                     mPeripheral;
            FbxArray<FbxTakeInfo*>              mTakeInfoArray;
            FbxError                            mError;
            FbxDocumentInfo*                   mDocumentInfo;



        friend class FbxLayerContainer;
        friend class FbxNodeFinderDuplicateName;
    #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_SCENE_DOCUMENT_H_ */