FBX C++ API Reference
|
#include <fbximporter.h>
Class to import an FBX file into SDK objects.
Normally this class is used as is. But for very special needs a user can override Initialize() for special purpose.
An importer will select the appropriate reader to a particular file. Ex: When an importer must import an FBX 7 file, the importer will ask for all registered readers if an FBX 7 file reader is available, then if a reader is found, the importer will create the specialized FBX 7 reader and read the file. This way, an importer can "read" many different type of files like FBX 5/6/7, 3DS, Obj, Dxf, Collada, etc.
Typical workflow for using the FbxImporter class:
Definition at line 90 of file fbximporter.h.
Public Types | |
typedef FbxIOBase | 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 FbxString | GetFileName () |
Returns the file name. More... | |
FbxStatus & | GetStatus () |
Get the status object containing the success or failure state. 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 FbxImporter * | Create (FbxManager *pManager, const char *pName) |
static FbxImporter * | Create (FbxObject *pContainer, const char *pName) |
![]() | |
static FbxIOBase * | Create (FbxManager *pManager, const char *pName) |
static FbxIOBase * | 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 | ~ FbxImporter () |
FbxImporter (FbxManager &pManager, const char *pName) | |
![]() | |
virtual | ~ FbxIOBase () |
FbxIOBase (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... | |
virtual FbxPeripheral * | GetPeripheral () |
Retrieves the peripheral of that object. More... | |
Static Protected Member Functions | |
static FbxImporter * | Allocate (FbxManager *pManager, const char *pName, const FbxImporter *pFrom) |
![]() | |
static FbxIOBase * | Allocate (FbxManager *pManager, const char *pName, const FbxIOBase *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) |
Import Functions | |
enum | EStreamOptionsGeneration { eParseFile, eDoNotParseFile } |
Stream options identifiers. More... | |
virtual bool | Initialize (const char *pFileName, int pFileFormat=-1, FbxIOSettings *pIOSettings=((void *) 0)) |
Initialize object. More... | |
virtual bool | Initialize (FbxStream *pStream, void *pStreamData=((void *) 0), const int pFileFormat=-1, FbxIOSettings *pIOSettings=((void *) 0)) |
Initialize object. More... | |
void | GetFileVersion (int &pMajor, int &pMinor, int &pRevision) |
Get the FBX version number of the FBX file. More... | |
bool | GetDefaultRenderResolution (FbxString &pCamName, FbxString &pResolutionMode, double &pW, double &pH) |
Get the default rendering resolution if present in the file header. More... | |
FbxIOFileHeaderInfo * | GetFileHeaderInfo () |
Get the complete file header information. More... | |
bool | GetImportOptions (EStreamOptionsGeneration pStreamOptionsGeneration=eParseFile) |
Read the currently opened file header to retrieve information related to takes. More... | |
bool | GetImportOptions (FbxIO *pFbxObject) |
Read the currently opened file header to retrieve information related to takes. More... | |
bool | Import (FbxDocument *pDocument, bool pNonBlocking=false) |
Import the currently opened file into a scene. More... | |
bool | IsImporting (bool &pImportResult) |
Check if the importer is currently importing. More... | |
float | GetProgress (FbxString *pStatus=((void *) 0)) |
Get the progress status in non-blocking mode. More... | |
void | SetProgressCallback (FbxProgressCallback pCallback, void *pArgs=((void *) 0)) |
Register a callback function for progress reporting in single thread mode. More... | |
void | SetEmbeddingExtractionFolder (const char *pExtractFolder) |
Explicitly set the embedding extraction folder. More... | |
const char * | GetEmbeddingExtractionFolder () |
Retrieve the current folder destination where the embedded files will be extracted. More... | |
FbxIOSettings * | GetIOSettings () |
Access to a IOSettings object. More... | |
void | SetIOSettings (FbxIOSettings *pIOSettings) |
Set the IOSettings pointer. More... | |
void | SetPassword (char *pPassword) |
Set the password. More... | |
Animation Stack Description Access | |
| |
int | GetAnimStackCount () |
Get the number of available animation stacks in the file. More... | |
FbxTakeInfo * | GetTakeInfo (int pIndex) |
Get the take information about an available take. More... | |
FbxString | GetActiveAnimStackName () |
Return the active animation stack name. More... | |
Scene Description Access | |
FbxDocumentInfo * | GetSceneInfo () |
Get the scene info. More... | |
File Format | |
int | GetFileFormat () |
Returns the index of the reader (FbxReader) associated with the file format. More... | |
bool | IsFBX () |
Additional Inherited Members | |
![]() | |
FbxProperty | RootProperty |
The root property that holds all children property for this object. More... | |
typedef FbxIOBase ParentClass |
Definition at line 92 of file fbximporter.h.
Stream options identifiers.
Enumerator | |
---|---|
eParseFile | |
eDoNotParseFile |
Definition at line 153 of file fbximporter.h.
|
inlineprotectedvirtual |
Definition at line 92 of file fbximporter.h.
|
inlineprotected |
Definition at line 92 of file fbximporter.h.
|
inlinevirtual |
|
static |
|
static |
|
staticprotected |
|
virtual |
Initialize object.
pFileName | Name of file to access. |
pFileFormat | file format identifier User does not need to specify it by default. if not specified, plugin will detect the file format according to file suffix automatically. |
pIOSettings | client IOSettings, if not specified, a default IOSettings will be created |
true
on success, false
otherwise. Reimplemented from FbxIOBase.
|
virtual |
Initialize object.
pStream | stream to access. |
pStreamData | user-defined stream data. |
pFileFormat | file format identifier User does not need to specify it by default. if not specified, plugin will request the file format from the stream automatically. |
pIOSettings | client IOSettings, if not specified, a default IOSettings will be created |
true
on success, false
otherwise. void GetFileVersion | ( | int & | pMajor, |
int & | pMinor, | ||
int & | pRevision | ||
) |
Get the FBX version number of the FBX file.
FBX version numbers start at 5.0.0.
pMajor | Version major number. |
pMinor | Version minor number. |
pRevision | Version revision number. |
bool GetDefaultRenderResolution | ( | FbxString & | pCamName, |
FbxString & | pResolutionMode, | ||
double & | pW, | ||
double & | pH | ||
) |
Get the default rendering resolution if present in the file header.
pCamName | Returned name of the camera. |
pResolutionMode | Returned resolution mode. |
pW | Returned width. |
pH | Returned height. |
true
if the default rendering settings are defined in the file, otherwise returns false
with empty parameters. FbxIOFileHeaderInfo* GetFileHeaderInfo | ( | ) |
Get the complete file header information.
bool GetImportOptions | ( | EStreamOptionsGeneration | pStreamOptionsGeneration = eParseFile | ) |
Read the currently opened file header to retrieve information related to takes.
pStreamOptionsGeneration | Stream options identifier. |
true
on success, false
otherwise. bool GetImportOptions | ( | FbxIO * | pFbxObject | ) |
Read the currently opened file header to retrieve information related to takes.
pFbxObject | Target FBX file. |
true
on success, false
otherwise. bool Import | ( | FbxDocument * | pDocument, |
bool | pNonBlocking = false |
||
) |
Import the currently opened file into a scene.
pDocument | Document to fill with file content. |
pNonBlocking | If true, the import process will be executed in a new thread, allowing it to be non-blocking. To determine if the import finished, refer to the function IsImporting(). |
true
on success, false
otherwise. bool IsImporting | ( | bool & | pImportResult | ) |
Check if the importer is currently importing.
pImportResult | This parameter, after the import finished, will contain the result of the import success or failure. |
float GetProgress | ( | FbxString * | pStatus = ((void *) 0) | ) |
Get the progress status in non-blocking mode.
pStatus | Optional current status string. |
void SetProgressCallback | ( | FbxProgressCallback | pCallback, |
void * | pArgs = ((void *) 0) |
||
) |
Register a callback function for progress reporting in single thread mode.
pCallback | Pointer of the callback function. |
pArgs | pointer to the arguments passed to the callback function. |
void SetEmbeddingExtractionFolder | ( | const char * | pExtractFolder | ) |
Explicitly set the embedding extraction folder.
If this is never called, the FBX SDK will determine the best folder to extract embedded files.
pExtractFolder | The file path name where the embedded files should be extracted. |
const char* GetEmbeddingExtractionFolder | ( | ) |
Retrieve the current folder destination where the embedded files will be extracted.
This might not be initialized until file I/O is performed.
FbxIOSettings* GetIOSettings | ( | ) |
Access to a IOSettings object.
NULL
if
the object has not been allocated. void SetIOSettings | ( | FbxIOSettings * | pIOSettings | ) |
Set the IOSettings pointer.
pIOSettings | Point to a FbxIOSettings object. |
void SetPassword | ( | char * | pPassword | ) |
Set the password.
All subsequently imported files are opened with the given password.
pPassword | Password string. |
int GetAnimStackCount | ( | ) |
Get the number of available animation stacks in the file.
FbxTakeInfo* GetTakeInfo | ( | int | pIndex | ) |
Get the take information about an available take.
Use the returned reference to a FbxTakeInfo object to set whether the indexed take is imported.
pIndex | Index of the requested take. |
NULL
if function failed. FbxString GetActiveAnimStackName | ( | ) |
Return the active animation stack name.
FbxDocumentInfo* GetSceneInfo | ( | ) |
Get the scene info.
NULL
if no scene information is available in the file. int GetFileFormat | ( | ) |
Returns the index of the reader (FbxReader) associated with the file format.
This index is considered the identifier of the file format. The array of registered readers can't be retrieved.
bool IsFBX | ( | ) |
true
if the file format is a recognized FBX format.
|
friend |
Definition at line 92 of file fbximporter.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 92 of file fbximporter.h.