fbxsdk/scene/fbxdocument.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2013 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>

class FbxStatus;
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> FBX_DEPRECATED inline T* FindRootMember(const T* pfbxType, char* pName){ return Roots.FindSrcObject<T>(pName); }

                template <class T> inline T* FindRootMember(char* pName){ return Roots.FindSrcObject<T>(pName); }

        inline int GetRootMemberCount () const { return Roots.GetSrcObjectCount(); }

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

                template <class T> inline int GetRootMemberCount() const { return Roots.GetSrcObjectCount<T>(); }

        int GetRootMemberCount(FbxCriteria pCriteria) const;

        inline FbxObject* GetRootMember(int pIndex=0) const { return Roots.GetSrcObject(pIndex); }

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

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

        FbxObject* GetRootMember(FbxCriteria pCriteria, int pIndex=0) const;

        virtual bool IsRootMember(FbxObject* pMember) const;


        FbxDocumentInfo* GetDocumentInfo() const;

        void SetDocumentInfo(FbxDocumentInfo* pSceneInfo);

        void SetPeripheral(FbxPeripheral* pPeripheral);

        virtual FbxPeripheral* GetPeripheral();

        int UnloadContent(FbxStatus* pStatus = NULL);

        int LoadContent(FbxStatus* pStatus = NULL);



        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, FbxStatus* pStatus = NULL);

        bool RemoveAnimStack(const char* pName);

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


        bool SetTakeInfo(const FbxTakeInfo& pTakeInfo);

        FbxTakeInfo* GetTakeInfo(const FbxString& pTakeName) const;


/*****************************************************************************************************************************
** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
*****************************************************************************************************************************/
#ifndef DOXYGEN_SHOULD_SKIP_THIS
        virtual FbxObject& Copy(const FbxObject& pObject);
        void ConnectVideos();

protected:
        virtual void Construct(const FbxDocument* pFrom);
        virtual void ConstructProperties(bool pForceSet);
        virtual void Destruct(bool pRecursive);

        virtual bool ConnectNotify(const FbxConnectEvent& pEvent);
        virtual void SetDocument(FbxDocument* pDocument);

        bool             FindTakeName(const FbxString& pTakeName);

        FbxArray<FbxTakeInfo*>  mTakeInfoArray;

private:
        FbxPeripheral*          mPeripheral;
        FbxDocumentInfo*        mDocumentInfo;
#endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_SCENE_DOCUMENT_H_ */