#include<kfbxdocument.h>
Definition at line59of filekfbxdocument.h.
Error Management | |
The same error object is shared among instances of this class. | |
enum | EError |
Error identifiers.More... | |
KError& | GetError() |
Retrieve error object. | |
EError | GetLastErrorID() const |
Get last error code. | |
const char * | GetLastErrorString() const |
Get last error string. | |
Document Member Manager | |
virtual void | Clear() |
Delete all contained objects. | |
void | AddRootMember(KFbxObject*pMember) |
Add a member. | |
void | RootRootRemoveMember(KFbxObject*pMember) |
Remove a member. | |
template<class T> | |
T * | FindRootMember(T const *pfbxType, char *pName) |
Find a member. | |
int | GetRootMemberCount() const |
Return the number of objects in the collection. | |
template<class T> | |
int | GetRootMemberCount(T const *pFBX_TYPE) const |
Return the number of objects in the collection. | |
int | GetRootMemberCount(KFbxCriteria pCriteria) const |
Delete all contained objects. | |
KFbxObject* | GetRootMember(int pIndex=0) const |
Return the index'th member of the collection. | |
template<class T> | |
T * | GetRootMember(T const *pFBX_TYPE, int pIndex=0) const |
Return the index'th member of the collection. | |
KFbxObject* | GetRootMember(KFbxCriteria pCriteria, int pIndex=0) const |
Delete all contained objects. | |
virtual bool | IsRootMember(KFbxObject*pMember) const |
Is an object part of the collection. | |
Scene information | |
KFbxDocumentInfo* | GetDocumentInfo() const |
Get the scene information. | |
void | SetDocumentInfo(KFbxDocumentInfo*pSceneInfo) |
Set the scene information. | |
Offloading management | |
NOTE: The document does not own the peripheral therefore it will not attempt to delete it at destruction time. Also, cloning the document will share the pointer to the peripheral across the cloned objects. And so will do the assignment operator. | |
void | SetPeripheral(KFbxPeripheral*pPeripheral) |
Set the current peripheral. | |
virtualKFbxPeripheral* | GetPeripheral() |
Retrieve the peripheral of that object. | |
int | UnloadContent() |
Offload all the unloadable objects contained in the document using the currently set offload peripheral. | |
int | LoadContent() |
Load all the objects contained in the document with the data from the currently set offload peripheral. | |
Referencing management | |
int | GetReferencingDocuments(KArrayTemplate<KFbxDocument*>&pReferencingDocuments) const |
Erase then fills an array of pointers to documents that reference objects in this document. | |
int | GetReferencingObjects(KFbxDocumentconst *pFromDoc, KArrayTemplate<KFbxObject*>&pReferencingObjects) const |
Erase then fills an array of pointers to objects in a given document (pFromDoc) that reference objects in this document. | |
int | GetReferencedDocuments(KArrayTemplate<KFbxDocument*>&pReferencedDocuments) const |
Erase then fills an array of pointers to documents that are referenced by objects in this document. | |
int | GetReferencedObjects(KFbxDocumentconst *pToDoc, KArrayTemplate<KFbxObject*>&pReferencedObjects) const |
Erase then fills an array of pointers to objects in a given document (pToDoc) that are referenced by objects in this document. | |
KString | GetPathToRootDocument(void) const |
Erase then fills an array of pointers to documents that reference objects in this document. | |
void | GetDocumentPathToRootDocument(KArrayTemplate<KFbxDocument*>&pDocumentPath, bool pFirstCall=true) const |
Erase then fills an array of pointers to documents that reference objects in this document. | |
bool | IsARootDocument(void) |
Erase then fills an array of pointers to documents that reference objects in this document. | |
Take Management | |
bool | CreateTake(char *pName) |
Create a take. | |
bool | RemoveTake(char *pName) |
Remove a take. | |
bool | SetCurrentTake(char *pName) |
Set the current take. | |
char * | GetCurrentTakeName() |
Get current take name. | |
void | FillTakeNameArray(KArrayTemplate<KString*>&pNameArray) |
Fill a string array with all existing take names. | |
Take Information Management | |
bool | SetTakeInfo(constKFbxTakeInfo&pTakeInfo) |
Set take information about an available take. | |
KFbxTakeInfo* | GetTakeInfo(constKString&pTakeName) |
Get take information about an available take. |
enumEError |
Error identifiers.
Most of these are only used internally.
Definition at line310of filekfbxdocument.h.
virtual void Clear | ( | ) | [virtual] |
void AddRootMember | ( | KFbxObject* | pMember | ) | [inline] |
void RootRootRemoveMember | ( | KFbxObject* | pMember | ) | [inline] |
T* FindRootMember | ( | T const * | pfbxType, | |
char * | pName | |||
) | [inline] |
Find a member.
Definition at line83of filekfbxdocument.h.
int GetRootMemberCount | ( | ) | const[inline] |
Return the number of objects in the collection.
Definition at line86of filekfbxdocument.h.
int GetRootMemberCount | ( | T const * | pFBX_TYPE | ) | const[inline] |
Return the number of objects in the collection.
Definition at line88of filekfbxdocument.h.
int GetRootMemberCount | ( | KFbxCriteria | pCriteria | ) | const |
Delete all contained objects.
KFbxObject* GetRootMember | ( | int | pIndex=0 | ) | const[inline] |
Return the index'th member of the collection.
Definition at line92of filekfbxdocument.h.
T* GetRootMember | ( | T const * | pFBX_TYPE, | |
int | pIndex=0 | |||
) | const[inline] |
Return the index'th member of the collection.
Definition at line94of filekfbxdocument.h.
KFbxObject* GetRootMember | ( | KFbxCriteria | pCriteria, | |
int | pIndex=0 | |||
) | const |
Delete all contained objects.
virtual bool IsRootMember | ( | KFbxObject* | pMember | ) | const[virtual] |
Is an object part of the collection.
KFbxDocumentInfo* GetDocumentInfo | ( | ) | const |
Get the scene information.
Referenced byKFbxScene::GetSceneInfo().
void SetDocumentInfo | ( | KFbxDocumentInfo* | pSceneInfo | ) |
Set the scene information.
pSceneInfo | Pointer to the scene information object. |
Referenced byKFbxScene::SetSceneInfo().
void SetPeripheral | ( | KFbxPeripheral* | pPeripheral | ) |
Set the current peripheral.
virtualKFbxPeripheral* GetPeripheral | ( | ) | [virtual] |
Retrieve the peripheral of that object.
Reimplemented fromKFbxObject.
int UnloadContent | ( | ) |
Offload all the unloadable objects contained in the document using the currently set offload peripheral.
int LoadContent | ( | ) |
Load all the objects contained in the document with the data from the currently set offload peripheral.
int GetReferencingDocuments | ( | KArrayTemplate<KFbxDocument*>& | pReferencingDocuments | ) | const |
Erase then fills an array of pointers to documents that reference objects in this document.
pReferencingDocuments | array of pointers to documents |
int GetReferencingObjects | ( | KFbxDocumentconst * | pFromDoc, | |
KArrayTemplate<KFbxObject*>& | pReferencingObjects | |||
) | const |
Erase then 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 | ( | KArrayTemplate<KFbxDocument*>& | pReferencedDocuments | ) | const |
Erase then fills an array of pointers to documents that are referenced by objects in this document.
pReferencedDocuments | array of pointers to documents |
int GetReferencedObjects | ( | KFbxDocumentconst * | pToDoc, | |
KArrayTemplate<KFbxObject*>& | pReferencedObjects | |||
) | const |
Erase then 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. |
KStringGetPathToRootDocument | ( | void | ) | const |
Erase then fills an array of pointers to documents that reference objects in this document.
pReferencingDocuments | array of pointers to documents |
void GetDocumentPathToRootDocument | ( | KArrayTemplate<KFbxDocument*>& | pDocumentPath, | |
bool | pFirstCall=true | |||
) | const |
Erase then fills an array of pointers to documents that reference objects in this document.
pReferencingDocuments | array of pointers to documents |
bool IsARootDocument | ( | void | ) | [inline] |
Erase then fills an array of pointers to documents that reference objects in this document.
pReferencingDocuments | array of pointers to documents |
Definition at line203of filekfbxdocument.h.
ReferencesKFbxObject::GetDocument().
bool CreateTake | ( | char * | pName | ) |
Create a take.
pName | Created take name. |
true
if not a single node, texture or material in the hierarchy had a take with this name before.false
if at least one node, texture or material in the hierarchy had a take with this name before.
In the last case,KFbxDocument::GetLastErrorID()will returneTAKE_ERROR
.
bool RemoveTake | ( | char * | pName | ) |
Remove a take.
pName | Name of the take to remove. |
true
if every node, texture and material in the hierarchy have a take with this name.false
if at least one node, texture or material in the hierarchy don't have a take with this name.
In the last case,KFbxDocument::GetLastErrorID()will returneTAKE_ERROR
.
bool SetCurrentTake | ( | char * | pName | ) |
Set the current take.
pName | Name of the take to set. |
true
if every node, texture and material in the hierarchy have a take with this name.false
if at least one node, texture or material in the hierarchy don't have a take with this name.
In the last case,KFbxDocument::GetLastErrorID()will returneTAKE_ERROR
.
All nodes, textures and materials without a take node of the requested name are set to default take node. It means that, if a node, texture or material does not have the requested take, it is assumed that this node is not animated in this take.
char* GetCurrentTakeName | ( | ) |
Get current take name.
An empty string if the document has not been imported from a file and functionKFbxDocument::SetCurrentTake()has not been called previously at least once.
void FillTakeNameArray | ( | KArrayTemplate<KString*>& | pNameArray | ) |
Fill a string array with all existing take names.
pNameArray | An array of string objects. |
The array of string is cleared before scanning the node hierarchy.
bool SetTakeInfo | ( | constKFbxTakeInfo& | pTakeInfo | ) |
Set take information about an available take.
pTakeInfo | Take information, fieldKFbxTakeInfo::mNamespecifies the targeted take. |
true
if take is found and take information set.KFbxTakeInfo* GetTakeInfo | ( | constKString& | pTakeName | ) |
Get take information about an available take.
pTakeName | Take name. |
NULL
if take isn't found or has no information set.KError&GetError | ( | ) |
Retrieve error object.
EErrorGetLastErrorID | ( | ) | const |
Get last error code.
const char* GetLastErrorString | ( | ) | const |
Get last error string.