Class Description

FbxDocument is a base class for FbxScene and FbxLibrary classes.

A document is a collection (FbxCollection) of objects (FbxObject), called the root member objects. This is because these objects each form the root of an object graph. The manager (FbxManager) has access to all documents, scenes and libraries.

A document can be contained in another document, thus, a hierarchy of documents can be built. The root of all documents is simply called the root document.

A document manages animation stacks (FbxAnimStack). It also provides access to animation stack information (FbxTakeInfo).

A document carries information in its FbxDocumentInfo.

Documents manage peripherals to load and unload objects (see class FbxPeripheral), as well as references to other objects or documents.

Error management is also available.

Examples:: Common/Common.cxx, Common/Common.h, ExportDocument/main.cxx, MyOwnWriterReader/MyOwnReader.cxx, MyOwnWriterReader/MyOwnReader.h, MyOwnWriterReader/MyOwnWriter.cxx, MyOwnWriterReader/MyOwnWriter.h, UI_Examples/CubeCreator/SDK_Utility.cxx, and UI_Examples/CubeCreator/SDK_Utility.h.

Definition at line 46 of file fbxdocument.h.

Inheritance diagram for FbxDocument:

List of all members.

Properties
FbxPropertyT< FbxReference >	Roots
Document Member Manager
virtual void	Clear ()
	Remove document members and restore default settings.
void	AddRootMember (FbxObject *pMember)
	Add a member object and connect it to Roots.
void	RootRootRemoveMember (FbxObject *pMember)
	Remove a member object from the document.
template<class T >
FBX_DEPRECATED T *	FindRootMember (const T pfbxType, char pName)
	Find a member object in the document, that has the given type and name.
template<class T >
T *	FindRootMember (char *pName)
	Find a member object in the document, that has the given type and name.
int	GetRootMemberCount () const
	Return the number of objects in the document.
template<class T >
FBX_DEPRECATED int	GetRootMemberCount (const T *pFBX_TYPE) const
	Return the number of objects of class T in the document.
template<class T >
int	GetRootMemberCount () const
	Return the number of objects of class T in the document.
int	GetRootMemberCount (FbxCriteria pCriteria) const
	Return the number of objects of the document that satisfy the given criteria.
FbxObject *	GetRootMember (int pIndex=0) const
	Return the member of the document at given index.
template<class T >
FBX_DEPRECATED T *	GetRootMember (const T *pFBX_TYPE, int pIndex=0) const
	Return the member of class T of the document at given index.
template<class T >
T *	GetRootMember (int pIndex=0) const
	Return the member of class T of the document at given index.
FbxObject *	GetRootMember (FbxCriteria pCriteria, int pIndex=0) const
	Return the document member which satisfies given criteria, for given index.
virtual bool	IsRootMember (FbxObject *pMember) const
	Is an object part of the document.
Document information
FbxDocumentInfo *	GetDocumentInfo () const
	Get the document information.
void	SetDocumentInfo (FbxDocumentInfo *pSceneInfo)
	Set the document information.
Offloading management
Documents manage peripherals to load and unload objects (see class FbxPeripheral). A peripheral manipulates the content of an object. For instance, a peripheral can load the connections of an object on demand. The document does not own the peripheral therefore it will not attempt to delete it at destruction time. Cloning the document will share the pointer to the peripheral across the cloned objects. The assignment operator has a similar behavior.
void	SetPeripheral (FbxPeripheral *pPeripheral)
	Set the current peripheral to be used to load or unload objects from this document.
virtual FbxPeripheral *	GetPeripheral ()
	Retrieve the current peripheral of the document.
int	UnloadContent (FbxStatus *pStatus=NULL)
	Unload all the unloadable objects contained in the document using the currently set peripheral.
int	LoadContent (FbxStatus *pStatus=NULL)
	Load all the objects contained in the document with the data from the currently set peripheral.
Referencing management
int	GetReferencingDocuments (FbxArray< FbxDocument * > &pReferencingDocuments) const
	Fills an array of pointers to documents that reference objects in this document.
int	GetReferencingObjects (const FbxDocument pFromDoc, FbxArray< FbxObject > &pReferencingObjects) const
	Fills an array of pointers to objects in a given document (pFromDoc) that reference objects in this document.
int	GetReferencedDocuments (FbxArray< FbxDocument * > &pReferencedDocuments) const
	Fills an array of pointers to documents that are referenced by objects in this document.
int	GetReferencedObjects (const FbxDocument pToDoc, FbxArray< FbxObject > &pReferencedObjects) const
	Fills an array of pointers to objects in a given document (pToDoc) that are referenced by objects in this document.
FbxString	GetPathToRootDocument (void) const
	Gets the path string to the root document, if the current document is contained in another document.
void	GetDocumentPathToRootDocument (FbxArray< FbxDocument * > &pDocumentPath, bool pFirstCall=true) const
	Gets the document path to the root document as an array of documents, if the current document is contained in another document.
bool	IsARootDocument (void)
	Tells if this document is a root document.
Animation Stack Management
Remarks: Animation stacks replaces the deprecated takes.
FbxPropertyT< FbxString >	ActiveAnimStackName
	Holds the name of the FbxAnimStack that the application uses for animation in this document.
bool	CreateAnimStack (const char pName, FbxStatus pStatus=NULL)
	Adds a new animation stack object to this document.
bool	RemoveAnimStack (const char *pName)
	Destroy the animation stack object identified by pName from this document.
void	FillAnimStackNameArray (FbxArray< FbxString * > &pNameArray)
	Fill a string array with all existing animation stack names.
Animation Stack Information Management
Remarks: Although takes are deprecated, class FbxTakeInfo is not deprecated and now contains animation stack information.
bool	SetTakeInfo (const FbxTakeInfo &pTakeInfo)
	Set information about an animation stack.
FbxTakeInfo *	GetTakeInfo (const FbxString &pTakeName) const
	Get information about an animation stack.

Member Function Documentation

virtual void Clear ( ) [virtual]

FBX_DEPRECATED T* FindRootMember	(	const T *	pfbxType,
		char *	pName
	)		`[inline]`

FBX_DEPRECATED T* GetRootMember	(	const T *	pFBX_TYPE,
		int	pIndex = `0`
	)		const `[inline]`

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

pCriteria	Criteria for selecting objects.
pIndex	Selection index.

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

pFromDoc	Pointer to the document containing referencing objects.
pReferencingObjects	Array of pointers to referencing objects.

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

pToDoc	Pointer to the document containing referenced objects.
pReferencedObjects	Array of pointers to referenced objects.

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

pDocumentPath	Array of FbxDocument to store the document path.
pFirstCall	Recursive flag: always use pFirstCall = `true`.

bool CreateAnimStack	(	const char *	pName,
		FbxStatus *	pStatus = `NULL`
	)

pName	Animation stack name.
pStatus	The FbxStatus object to hold error codes.

Class Description

Properties

Document Member Manager

Document information

Offloading management

Referencing management

Animation Stack Management

Animation Stack Information Management

Member Function Documentation

Member Data Documentation