FBX C++ API Reference
|
#include <fbxdocument.h>
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.
Definition at line 46 of file fbxdocument.h.
Public Types | |
typedef FbxCollection | ParentClass |
![]() | |
typedef FbxObject | ParentClass |
![]() | |
typedef FbxEmitter | ParentClass |
enum | EObjectFlag { eNone = 0, eInitialized = 1 << 0, eSystem = 1 << 1, eSavable = 1 << 2, eSelected = 1 << 3, eHidden = 1 << 4, eContentLoaded = 1 << 5, eDontLocalize = 1 << 6, eCopyCalledByClone = 1 << 16 } |
Flags available to control objects. More... | |
enum | ECloneType { eDeepClone, eReferenceClone } |
Types of clones that can be created for FbxObject. More... | |
Public Member Functions | |
virtual FbxClassId | GetClassId () const |
![]() | |
virtual bool | AddMember (FbxObject *pMember) |
Adds a member. More... | |
virtual bool | RemoveMember (FbxObject *pMember) |
Removes a member. More... | |
int | GetMemberCount () const |
Returns the number of objects contained within the collection. More... | |
FbxObject * | GetMember (int pIndex=0) const |
Returns the member of the collection at the given index. More... | |
virtual bool | IsMember (const FbxObject *pMember) const |
Judges whether an object is a part of the collection. More... | |
template<class T > | |
int | GetMemberCount () const |
Returns the number of class T objects contained within the collection. More... | |
template<class T > | |
T * | GetMember (int pIndex=0) const |
Returns the member of class T at the given index in the collection. More... | |
template<class T > | |
T * | FindMember (const char *pName) const |
Searches for a member of class T. More... | |
int | GetMemberCount (const FbxCriteria &pCriteria) const |
Returns the number of objects contained within the collection that meet the specified criteria. More... | |
FbxObject * | GetMember (const FbxCriteria &pCriteria, int pIndex=0) const |
Returns the member at the given index in the collection if it meets the specified criteria. More... | |
FbxObject * | FindMember (const FbxCriteria &pCriteria, const char *pName) const |
Searches for a member with the given name that also meets the given criteria. More... | |
virtual void | SetSelectedAll (bool pSelection) |
Selects/Deselects all the contained objects. More... | |
![]() | |
virtual void | Compact () |
Compact the memory used by this object. More... | |
template<class T > | |
bool | Is () const |
Templated test if this class is a hierarchical children of the specified class type. More... | |
FbxManager * | GetFbxManager () const |
Retrieve the FbxManager this object belongs to. More... | |
FbxDocument * | GetDocument () const |
Returns a const pointer to the document that contains this object. More... | |
FbxDocument * | GetRootDocument () const |
Returns a const pointer to the root document that contains this object. More... | |
FbxScene * | GetScene () const |
Returns a const pointer to the scene that contains this object. More... | |
void | Destroy (bool pRecursive=false) |
Unregister and delete this object from memory. More... | |
void | ResetProperties () |
Reset all the properties of this object to their default values. More... | |
virtual bool | GetSelected () |
Returns if this object is currently in a selected state. More... | |
virtual void | SetSelected (bool pSelected) |
Sets whether this object is currently selected. More... | |
void | SetUserDataPtr (const FbxUInt64 &pUserID, void *pUserData) |
Sets the data pointer for an user data record whose ID is pUserID. More... | |
void * | GetUserDataPtr (const FbxUInt64 &pUserID) const |
Returns the data pointer of an user data record whose ID is pUserID. More... | |
void | SetUserDataPtr (void *pUserData) |
Sets the data pointer for the user data record whose ID is the object ID. More... | |
void * | GetUserDataPtr () const |
Returns the data pointer of the user data record whose ID is the object ID. More... | |
bool | ConnectSrcObject (FbxObject *pObject, FbxConnection::EType pType=FbxConnection::eNone) |
Connects this object to a source object. More... | |
bool | IsConnectedSrcObject (const FbxObject *pObject) const |
Judges whether this object connects with the source object. More... | |
bool | DisconnectSrcObject (FbxObject *pObject) |
Disconnects this object from a source object. More... | |
bool | DisconnectAllSrcObject () |
Disconnects this object from all source objects. More... | |
bool | DisconnectAllSrcObject (const FbxCriteria &pCriteria) |
Disconnects this object from all source objects that satisfy a given criteria. More... | |
int | GetSrcObjectCount () const |
Returns the number of source objects with which this object connects. More... | |
int | GetSrcObjectCount (const FbxCriteria &pCriteria) const |
Returns the number of source objects that satisfy the given criteria with which this object connects. More... | |
FbxObject * | GetSrcObject (int pIndex=0) const |
Returns the source object with which this object connects at the specified index. More... | |
FbxObject * | GetSrcObject (const FbxCriteria &pCriteria, int pIndex=0) const |
Returns the source object that satisfies the criteria at the specified index with which this object connects. More... | |
FbxObject * | FindSrcObject (const char *pName, int pStartIndex=0) const |
Searches the source object with the specified name, starting at the specified index. More... | |
FbxObject * | FindSrcObject (const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const |
Searches the source object with the specified name which satisfies the given criteria, starting at the specified index. More... | |
template<class T > | |
bool | DisconnectAllSrcObject () |
Disconnects this object from all source objects of the specified class type. More... | |
template<class T > | |
bool | DisconnectAllSrcObject (const FbxCriteria &pCriteria) |
Disconnects this object from all source objects that are of the specified class type and that satisfy the given criteria. More... | |
template<class T > | |
int | GetSrcObjectCount () const |
Returns the number of source objects of a specific class type with which this object connects. More... | |
template<class T > | |
int | GetSrcObjectCount (const FbxCriteria &pCriteria) const |
Returns the number of source objects with which this object connects that are the specified class type and that satisfy the given criteria. More... | |
template<class T > | |
T * | GetSrcObject (int pIndex=0) const |
Returns the source object of the specified class type at the specified index. More... | |
template<class T > | |
T * | GetSrcObject (const FbxCriteria &pCriteria, int pIndex=0) const |
Returns the source object that is the specified class type and that satisfies the given criteria at the specified index. More... | |
template<class T > | |
T * | FindSrcObject (const char *pName, int pStartIndex=0) const |
Searches the source object with the specified name that is the specified class type, starting at the specified index. More... | |
template<class T > | |
T * | FindSrcObject (const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const |
Searches the source object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index. More... | |
bool | ConnectDstObject (FbxObject *pObject, FbxConnection::EType pType=FbxConnection::eNone) |
Connects this object to one destination object. More... | |
bool | IsConnectedDstObject (const FbxObject *pObject) const |
Judges whether this object connects with the destination object. More... | |
bool | DisconnectDstObject (FbxObject *pObject) |
Disconnects this object from the destination object. More... | |
bool | DisconnectAllDstObject () |
Disconnects this object from all destination objects. More... | |
bool | DisconnectAllDstObject (const FbxCriteria &pCriteria) |
Disconnects this object from all destination objects that satisfy given criteria. More... | |
int | GetDstObjectCount () const |
Returns the number of destination objects with which this object connects. More... | |
int | GetDstObjectCount (const FbxCriteria &pCriteria) const |
Returns the number of destination objects with which this object connects that satisfy the given criteria. More... | |
FbxObject * | GetDstObject (int pIndex=0) const |
Returns the destination object at the specified index with which this object connects. More... | |
FbxObject * | GetDstObject (const FbxCriteria &pCriteria, int pIndex=0) const |
Returns the destination object with which this object connects that satisfies the given criteria at the specified index. More... | |
FbxObject * | FindDstObject (const char *pName, int pStartIndex=0) const |
Searches the destination object with the specified name, starting at the specified index. More... | |
FbxObject * | FindDstObject (const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const |
Searches the destination object with the specified name which satisfies the given criteria, starting at the specified index. More... | |
template<class T > | |
bool | DisconnectAllDstObject () |
Disconnects this object from all destination objects of the specified class type. More... | |
template<class T > | |
bool | DisconnectAllDstObject (const FbxCriteria &pCriteria) |
Disconnects this object from all destination objects that are the specified class type and that satisfy the given criteria. More... | |
template<class T > | |
int | GetDstObjectCount () const |
Returns the number of destination objects of the specified class type with which this object connects. More... | |
template<class T > | |
int | GetDstObjectCount (const FbxCriteria &pCriteria) const |
Returns the number of destination objects with which this object connects that are the specified class type and that satisfy the given criteria. More... | |
template<class T > | |
T * | GetDstObject (int pIndex=0) const |
Returns the destination object with which this object connects that is the specified class type at the specified index. More... | |
template<class T > | |
T * | GetDstObject (const FbxCriteria &pCriteria, int pIndex=0) const |
Returns the destination object with which this object connects that is the specified class type and that satisfies the given criteria at the specified index. More... | |
template<class T > | |
T * | FindDstObject (const char *pName, int pStartIndex=0) const |
Searches the destination object with the specified name which is of the specified class type, starting at the specified index. More... | |
template<class T > | |
T * | FindDstObject (const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const |
Searches the destination object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index. More... | |
FbxProperty | GetFirstProperty () const |
Returns the first property of this object. More... | |
FbxProperty | GetNextProperty (const FbxProperty &pProperty) const |
Returns the next property of this object that follows the specified property. More... | |
FbxProperty | FindProperty (const char *pName, bool pCaseSensitive=true) const |
Searches a property by name. More... | |
FbxProperty | FindProperty (const char *pName, const FbxDataType &pDataType, bool pCaseSensitive=true) const |
Searches a property by name and data type. More... | |
FbxProperty | FindPropertyHierarchical (const char *pName, bool pCaseSensitive=true) const |
Searches a property by full name. More... | |
FbxProperty | FindPropertyHierarchical (const char *pName, const FbxDataType &pDataType, bool pCaseSensitive=true) const |
Searches a property by full name and data type. More... | |
FbxProperty | GetClassRootProperty () |
Returns the class root property. More... | |
bool | ConnectSrcProperty (const FbxProperty &pProperty) |
Connects this object to a source property. More... | |
bool | IsConnectedSrcProperty (const FbxProperty &pProperty) |
Determines whether this object connects with the specified source property. More... | |
bool | DisconnectSrcProperty (const FbxProperty &pProperty) |
Disconnects this object from the specified source property. More... | |
int | GetSrcPropertyCount () const |
Returns the number of source properties with which this object connects. More... | |
FbxProperty | GetSrcProperty (int pIndex=0) const |
Returns the source property at the specified index with which this object connects. More... | |
FbxProperty | FindSrcProperty (const char *pName, int pStartIndex=0) const |
Searches a source property with which this object connects that has a specific name, starting at the specified index. More... | |
bool | ConnectDstProperty (const FbxProperty &pProperty) |
Connects this object to a destination property. More... | |
bool | IsConnectedDstProperty (const FbxProperty &pProperty) |
Determines if this object connects with the specified destination property. More... | |
bool | DisconnectDstProperty (const FbxProperty &pProperty) |
Disconnects this object from the specified destination property. More... | |
int | GetDstPropertyCount () const |
Returns the number of destination properties with which this object connects. More... | |
FbxProperty | GetDstProperty (int pIndex=0) const |
Returns the destination property at the specified index with which this object connects. More... | |
FbxProperty | FindDstProperty (const char *pName, int pStartIndex=0) const |
Searches a destination property with which this object connects that has a specific name, starting at the specified index. More... | |
int | ContentUnload () |
Unloads this object's content using the offload peripheral that is currently set in the document then flushes it from memory. More... | |
int | ContentLoad () |
Loads this object's content using the offload peripheral that is currently set in the document. More... | |
bool | ContentIsLoaded () const |
Judges if this object's content is loaded. More... | |
void | ContentDecrementLockCount () |
Decreases the content lock count of an object. More... | |
void | ContentIncrementLockCount () |
Increases the content lock count of an object. More... | |
bool | ContentIsLocked () const |
Judges if this object's content is locked. More... | |
virtual bool | ContentWriteTo (FbxStream &pStream) const |
Writes the content of the object to the given stream. More... | |
virtual bool | ContentReadFrom (const FbxStream &pStream) |
Reads the content of the object from the given stream. More... | |
void | EmitMessage (FbxMessage *pMessage) const |
Emits a message in all available message emitters in the document or SDK manager. More... | |
virtual const char * | Localize (const char *pID, const char *pDefault=((void *) 0)) const |
Localization helper function, it calls the implementation of FBX SDK manager. More... | |
FbxLibrary * | GetParentLibrary () const |
Returns a handle on the parent library of this object. More... | |
bool | AddImplementation (FbxImplementation *pImplementation) |
Adds an implementation. More... | |
bool | RemoveImplementation (FbxImplementation *pImplementation) |
Removes an implementation. More... | |
bool | HasDefaultImplementation (void) const |
Determines if this shading node has a default implementation. More... | |
FbxImplementation * | GetDefaultImplementation (void) const |
Returns the default implementation of this shading node. More... | |
bool | SetDefaultImplementation (FbxImplementation *pImplementation) |
Sets the default implementation of this shading node. More... | |
int | GetImplementationCount (const FbxImplementationFilter *pCriteria=((void *) 0)) const |
Returns the number of implementations that satisfy a given criteria. More... | |
FbxImplementation * | GetImplementation (int pIndex, const FbxImplementationFilter *pCriteria=((void *) 0)) const |
Returns the implementation at the specified index that satisfies the given criteria. More... | |
virtual FbxString | GetUrl () const |
Returns the URL of this object. More... | |
virtual bool | SetUrl (char *pUrl) |
Sets the URL of this object. More... | |
void | SetRuntimeClassId (const FbxClassId &pClassId) |
Set the run-time ClassId for this class. More... | |
FbxClassId | GetRuntimeClassId () const |
Retrieve the run-time ClassId for this object. More... | |
bool | IsRuntime (const FbxClassId &pClassId) const |
Test if this class is a hierarchical children of the specified class type. More... | |
bool | IsRuntimePlug () const |
Find out if the ClassId was registered during run-time rather than at compile time. More... | |
void | SetObjectFlags (EObjectFlag pFlags, bool pValue) |
Set the state of object flags. More... | |
bool | GetObjectFlags (EObjectFlag pFlags) const |
Get the state of object flags. More... | |
void | SetAllObjectFlags (FbxUInt pFlags) |
Override all object flags at once. More... | |
FbxUInt | GetAllObjectFlags () const |
Get all object flags at once. More... | |
virtual FbxObject & | Copy (const FbxObject &pObject) |
Copy an object content into this object. More... | |
virtual FbxObject * | Clone (FbxObject::ECloneType pCloneType=eDeepClone, FbxObject *pContainer=((void *) 0), void *pSet=((void *) 0)) const |
Creates a clone of this object. More... | |
bool | IsAReferenceTo () const |
Checks if this object is a reference clone of another object. More... | |
FbxObject * | GetReferenceTo () const |
If this object is a reference clone, returns the original object (from which the clone originates). More... | |
bool | IsReferencedBy () const |
Checks if any objects are reference cloned from this object. More... | |
int | GetReferencedByCount () const |
Returns the number of objects that are reference clones of this object. More... | |
FbxObject * | GetReferencedBy (int pIndex) const |
Returns a reference clone of this object at the specified index. More... | |
void | SetName (const char *pName) |
Sets the name of this object. More... | |
const char * | GetName () const |
Returns the full name of this object. More... | |
FbxString | GetNameWithoutNameSpacePrefix () const |
Returns the name of the object without the namespace qualifier. More... | |
FbxString | GetNameWithNameSpacePrefix () const |
Returns the name of the object with the namespace qualifier. More... | |
void | SetInitialName (const char *pName) |
Sets the initial name of the object. More... | |
const char * | GetInitialName () const |
Returns the initial name of the object. More... | |
FbxString | GetNameSpaceOnly () |
Returns the namespace of the object. More... | |
void | SetNameSpace (FbxString pNameSpace) |
Sets the namespace of the object. More... | |
FbxArray< FbxString * > | GetNameSpaceArray (char identifier) |
Returns an array of all the namespaces for this object. More... | |
FbxString | GetNameOnly () const |
Returns only the name (no namespace or prefix) of the object. More... | |
FbxString | GetNameSpacePrefix () const |
Returns the namespace qualifier. More... | |
const FbxUInt64 & | GetUniqueID () const |
Returns the unique ID of this object. More... | |
![]() | |
void | AddListener (FbxEventHandler &pHandler) |
Add the specified event handler to current emitter list. More... | |
void | RemoveListener (FbxEventHandler &pHandler) |
Remove the specified event handler from current emitter list. More... | |
template<typename EventType > | |
void | Emit (const EventType &pEvent) const |
Emit an event with the specified the event type. More... | |
Static Public Member Functions | |
static FbxDocument * | Create (FbxManager *pManager, const char *pName) |
static FbxDocument * | Create (FbxObject *pContainer, const char *pName) |
![]() | |
static FbxCollection * | Create (FbxManager *pManager, const char *pName) |
static FbxCollection * | Create (FbxObject *pContainer, const char *pName) |
![]() | |
static FbxObject * | Create (FbxManager *pManager, const char *pName) |
static FbxObject * | Create (FbxObject *pContainer, const char *pName) |
static FbxString | RemovePrefix (char *pName) |
Removes the prefix of pName. More... | |
static FbxString | StripPrefix (FbxString &lName) |
Strips the prefix of pName. More... | |
static FbxString | StripPrefix (const char *pName) |
Strips the prefix of pName. More... | |
Static Public Attributes | |
static FbxClassId | ClassId |
![]() | |
static FbxClassId | ClassId |
![]() | |
static FbxClassId | ClassId |
Protected Member Functions | |
virtual | ~ FbxDocument () |
FbxDocument (FbxManager &pManager, const char *pName) | |
![]() | |
virtual | ~ FbxCollection () |
FbxCollection (FbxManager &pManager, const char *pName) | |
![]() | |
virtual | ~ FbxObject () |
virtual void | Construct (const FbxObject *pFrom) |
Optional constructor override, automatically called by default constructor. More... | |
virtual void | ConstructProperties (bool pForceSet) |
Optional property constructor override, automatically called by default constructor. More... | |
virtual void | Destruct (bool pRecursive) |
Optional destructor override, automatically called by default destructor. More... | |
virtual void | ContentClear () |
Clears this object's content from memory. More... | |
Static Protected Member Functions | |
static FbxDocument * | Allocate (FbxManager *pManager, const char *pName, const FbxDocument *pFrom) |
![]() | |
static FbxCollection * | Allocate (FbxManager *pManager, const char *pName, const FbxCollection *pFrom) |
![]() | |
static FbxObject * | Allocate (FbxManager *pManager, const char *pName, const FbxObject *pFrom) |
Friends | |
class | fbxsdk ::FbxManager |
template<typename T > | |
T * | fbxsdk ::FbxNew () |
template<typename T , typename T1 > | |
T * | fbxsdk ::FbxNew (T1 &p1) |
template<typename T , typename T1 > | |
T * | fbxsdk ::FbxNew (const T1 &p1) |
template<typename T , typename T1 , typename T2 > | |
T * | fbxsdk ::FbxNew (T1 &p1, T2 &p2) |
template<typename T , typename T1 , typename T2 > | |
T * | fbxsdk ::FbxNew (T1 &p1, const T2 &p2) |
template<typename T , typename T1 , typename T2 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, T2 &p2) |
template<typename T , typename T1 , typename T2 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2) |
template<typename T , typename T1 , typename T2 , typename T3 > | |
T * | fbxsdk ::FbxNew (T1 &p1, T2 &p2, T3 &p3) |
template<typename T , typename T1 , typename T2 , typename T3 > | |
T * | fbxsdk ::FbxNew (T1 &p1, T2 &p2, const T3 &p3) |
template<typename T , typename T1 , typename T2 , typename T3 > | |
T * | fbxsdk ::FbxNew (T1 &p1, const T2 &p2, T3 &p3) |
template<typename T , typename T1 , typename T2 , typename T3 > | |
T * | fbxsdk ::FbxNew (T1 &p1, const T2 &p2, const T3 &p3) |
template<typename T , typename T1 , typename T2 , typename T3 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, T2 &p2, T3 &p3) |
template<typename T , typename T1 , typename T2 , typename T3 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, T2 &p2, const T3 &p3) |
template<typename T , typename T1 , typename T2 , typename T3 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, T3 &p3) |
template<typename T , typename T1 , typename T2 , typename T3 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (T1 &p1, T2 &p2, T3 &p3, T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (T1 &p1, T2 &p2, T3 &p3, const T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (T1 &p1, T2 &p2, const T3 &p3, T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (T1 &p1, T2 &p2, const T3 &p3, const T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (T1 &p1, const T2 &p2, T3 &p3, T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (T1 &p1, const T2 &p2, T3 &p3, const T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (T1 &p1, const T2 &p2, const T3 &p3, T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, T2 &p2, T3 &p3, T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, T2 &p2, T3 &p3, const T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, T2 &p2, const T3 &p3, T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, T2 &p2, const T3 &p3, const T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, T3 &p3, T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, T3 &p3, const T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 > | |
T * | fbxsdk ::FbxNew (T1 &p1, T2 &p2, T3 &p3, T4 &p4, T5 &p5) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, T2 &p2, T3 &p3, T4 &p4, T5 &p5) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, T3 &p3, T4 &p4, T5 &p5) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, T2 &p2, const T3 &p3, T4 &p4, T5 &p5) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, T2 &p2, T3 &p3, const T4 &p4, T5 &p5) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, T2 &p2, T3 &p3, T4 &p4, const T5 &p5) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, T4 &p4, T5 &p5) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, T3 &p3, const T4 &p4, T5 &p5) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, T3 &p3, T4 &p4, const T5 &p5) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4, T5 &p5) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, T4 &p4, const T5 &p5) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4, const T5 &p5) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4, const T5 &p5, const T6 &p6) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4, const T5 &p5, const T6 &p6, const T7 &p7) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 , typename T8 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4, const T5 &p5, const T6 &p6, const T7 &p7, const T8 &p8) |
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 , typename T8 , typename T9 > | |
T * | fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4, const T5 &p5, const T6 &p6, const T7 &p7, const T8 &p8, const T9 &p9) |
template<typename T > | |
void | fbxsdk ::FbxDelete (T *p) |
template<typename T > | |
void | fbxsdk ::FbxDelete (const T *p) |
template<typename T > | |
T * | fbxsdk ::FbxNewArray (const int n) |
template<typename T > | |
void | fbxsdk ::FbxDeleteArray (T *p) |
Properties | |
FbxPropertyT< FbxReference > | Roots |
Document Member Manager | |
virtual void | Clear () |
Remove document members and restore default settings. More... | |
void | AddRootMember (FbxObject *pMember) |
Add a member object and connect it to Roots. More... | |
void | RootRootRemoveMember (FbxObject *pMember) |
Remove a member object from the document. More... | |
template<class T > | |
T * | FindRootMember (char *pName) |
Find a member object in the document, that has the given type and name. More... | |
int | GetRootMemberCount () const |
Return the number of objects in the document. More... | |
template<class T > | |
int | GetRootMemberCount () const |
Return the number of objects of class T in the document. More... | |
int | GetRootMemberCount (FbxCriteria pCriteria) const |
Return the number of objects of the document that satisfy the given criteria. More... | |
FbxObject * | GetRootMember (int pIndex=0) const |
Return the member of the document at given index. More... | |
template<class T > | |
T * | GetRootMember (int pIndex=0) const |
Return the member of class T of the document at given index. More... | |
FbxObject * | GetRootMember (FbxCriteria pCriteria, int pIndex=0) const |
Return the document member which satisfies given criteria, for given index. More... | |
virtual bool | IsRootMember (FbxObject *pMember) const |
Is an object part of the document. More... | |
Document information | |
FbxDocumentInfo * | GetDocumentInfo () const |
Get the document information. More... | |
void | SetDocumentInfo (FbxDocumentInfo *pSceneInfo) |
Set the document information. More... | |
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. More... | |
virtual FbxPeripheral * | GetPeripheral () |
Retrieve the current peripheral of the document. More... | |
int | UnloadContent (FbxStatus *pStatus=((void *) 0)) |
Unload all the unloadable objects contained in the document using the currently set peripheral. More... | |
int | LoadContent (FbxStatus *pStatus=((void *) 0)) |
Load all the objects contained in the document with the data from the currently set peripheral. More... | |
Referencing management | |
int | GetReferencingDocuments (FbxArray< FbxDocument *> &pReferencingDocuments) const |
Fills an array of pointers to documents that reference objects in this document. More... | |
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. More... | |
int | GetReferencedDocuments (FbxArray< FbxDocument *> &pReferencedDocuments) const |
Fills an array of pointers to documents that are referenced by objects in this document. More... | |
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. More... | |
FbxString | GetPathToRootDocument (void) const |
Gets the path string to the root document, if the current document is contained in another document. More... | |
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. More... | |
bool | IsARootDocument (void) |
Tells if this document is a root document. More... | |
Animation Stack Management | |
| |
FbxPropertyT< FbxString > | ActiveAnimStackName |
Holds the name of the FbxAnimStack that the application uses for animation in this document. More... | |
bool | CreateAnimStack (const char *pName, FbxStatus *pStatus=((void *) 0)) |
Adds a new animation stack object to this document. More... | |
bool | RemoveAnimStack (const char *pName) |
Destroy the animation stack object identified by pName from this document. More... | |
void | FillAnimStackNameArray (FbxArray< FbxString *> &pNameArray) |
Fill a string array with all existing animation stack names. More... | |
Animation Stack Information Management | |
| |
bool | SetTakeInfo (const FbxTakeInfo &pTakeInfo) |
Set information about an animation stack. More... | |
FbxTakeInfo * | GetTakeInfo (const FbxString &pTakeName) const |
Get information about an animation stack. More... | |
Additional Inherited Members | |
![]() | |
FbxProperty | RootProperty |
The root property that holds all children property for this object. More... | |
typedef FbxCollection ParentClass |
Definition at line 48 of file fbxdocument.h.
|
inlineprotectedvirtual |
Definition at line 48 of file fbxdocument.h.
|
inlineprotected |
Definition at line 48 of file fbxdocument.h.
|
inlinevirtual |
Reimplemented from FbxCollection.
Reimplemented in FbxScene, and FbxLibrary.
Definition at line 48 of file fbxdocument.h.
|
static |
|
static |
|
staticprotected |
|
virtual |
Remove document members and restore default settings.
Reimplemented from FbxCollection.
Reimplemented in FbxScene.
|
inline |
Add a member object and connect it to Roots.
pMember | Object to add to the document. |
Definition at line 68 of file fbxdocument.h.
|
inline |
Remove a member object from the document.
pMember | Object to remove from the document. |
Definition at line 73 of file fbxdocument.h.
|
inline |
Find a member object in the document, that has the given type and name.
pName | Member name. |
Definition at line 77 of file fbxdocument.h.
|
inline |
Return the number of objects in the document.
Definition at line 80 of file fbxdocument.h.
|
inline |
Return the number of objects of class T in the document.
Definition at line 84 of file fbxdocument.h.
int GetRootMemberCount | ( | FbxCriteria | pCriteria | ) | const |
Return the number of objects of the document that satisfy the given criteria.
pCriteria | Criteria for selecting objects. |
|
inline |
Return the member of the document at given index.
pIndex | Selection index. |
Definition at line 95 of file fbxdocument.h.
|
inline |
Return the member of class T of the document at given index.
pIndex | Selection index. |
Definition at line 99 of file fbxdocument.h.
FbxObject* GetRootMember | ( | FbxCriteria | pCriteria, |
int | pIndex = 0 |
||
) | const |
Return the document member which satisfies given criteria, for given index.
pCriteria | Criteria for selecting objects. |
pIndex | Selection index. |
|
virtual |
Is an object part of the document.
pMember | Queried object. |
true
if pMember is an object part of the document, false
otherwise. FbxDocumentInfo* GetDocumentInfo | ( | ) | const |
Get the document information.
void SetDocumentInfo | ( | FbxDocumentInfo * | pSceneInfo | ) |
Set the document information.
pSceneInfo | Pointer to the document information object. |
void SetPeripheral | ( | FbxPeripheral * | pPeripheral | ) |
Set the current peripheral to be used to load or unload objects from this document.
pPeripheral | The peripheral to be set. |
|
virtual |
Retrieve the current peripheral of the document.
Reimplemented from FbxObject.
int UnloadContent | ( | FbxStatus * | pStatus = ((void *) 0) | ) |
Unload all the unloadable objects contained in the document using the currently set peripheral.
pStatus | The FbxStatus object to hold error codes. |
int LoadContent | ( | FbxStatus * | pStatus = ((void *) 0) | ) |
Load all the objects contained in the document with the data from the currently set peripheral.
pStatus | The FbxStatus object to hold error codes. |
int GetReferencingDocuments | ( | FbxArray< FbxDocument *> & | pReferencingDocuments | ) | const |
Fills an array of pointers to documents that reference objects in this document.
pReferencingDocuments | Array of pointers to documents. |
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.
pFromDoc | Pointer to the document containing referencing objects. |
pReferencingObjects | Array of pointers to referencing objects. |
int GetReferencedDocuments | ( | FbxArray< FbxDocument *> & | pReferencedDocuments | ) | const |
Fills an array of pointers to documents that are referenced by objects in this document.
pReferencedDocuments | Array of pointers to documents. |
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.
pToDoc | Pointer to the document containing referenced objects. |
pReferencedObjects | Array of pointers to referenced objects. |
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.
pDocumentPath | Array of FbxDocument to store the document path. |
pFirstCall | Recursive flag: always use pFirstCall = true . |
|
inline |
Tells if this document is a root document.
false
if the current document is contained in another document, true
otherwise. Definition at line 225 of file fbxdocument.h.
bool CreateAnimStack | ( | const char * | pName, |
FbxStatus * | pStatus = ((void *) 0) |
||
) |
Adds a new animation stack object to this document.
In case of error, FbxDocument::GetLastErrorID() will return eTakeError
.
pName | Animation stack name. |
pStatus | The FbxStatus object to hold error codes. |
true
if a new FbxAnimStack has been successfully created, false
if an error occurred or if the specified name defines a FbxAnimStack that already exists in the document. bool RemoveAnimStack | ( | const char * | pName | ) |
Destroy the animation stack object identified by pName from this document.
pName | Name of the animation stack to be deleted. |
true
if the FbxAnimStack has been destroyed and false
otherwise. Fill a string array with all existing animation stack names.
The array of string is cleared before it is used
pNameArray | An array of string objects. |
bool SetTakeInfo | ( | const FbxTakeInfo & | pTakeInfo | ) |
Set information about an animation stack.
pTakeInfo | Animation stack information. Field FbxTakeInfo::mName specifies the targeted animation stack. |
true
if animation stack is found with this name, and if information is set. FbxTakeInfo* GetTakeInfo | ( | const FbxString & | pTakeName | ) | const |
Get information about an animation stack.
pTakeName | Name of the targeted animation stack. |
NULL
if animation stack isn't found or has no information set for this document.
|
friend |
Definition at line 48 of file fbxdocument.h.
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
static |
Definition at line 48 of file fbxdocument.h.
FbxPropertyT<FbxReference> Roots |
Definition at line 55 of file fbxdocument.h.
FbxPropertyT<FbxString> ActiveAnimStackName |
Holds the name of the FbxAnimStack that the application uses for animation in this document.
Definition at line 235 of file fbxdocument.h.