#include <fbxmanager.h>
SDK object manager.
The SDK manager is in charge of:
It is possible to override memory allocation functions throughout the FBX SDK by providing system memory allocation functions using the handler set functions below. It must be done before the first FbxManager creation.
FbxSetMallocHandler(); FbxSetCallocHandler(); FbxSetReallocHandler(); FbxSetFreeHandler();
Upon destruction, all objects allocated by the SDK manager and not explicitly destroyed are destroyed as well. A derived class can be defined to allocate and deallocate specialized scene elements.
- Examples:
- Animation/main.cxx, Audio/main.cxx, Camera/main.cxx, Common/Common.cxx, Common/Common.h, ConvertScene/main.cxx, ExportDocument/main.cxx, ExportScene01/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, ExportScene04/main.cxx, ExportScene05/main.cxx, ExportShader/main.cxx, FileStream/main.cxx, ImportScene/main.cxx, Instances/main.cxx, Layers/main.cxx, MyOwnWriterReader/MyOwnReader.cxx, MyOwnWriterReader/MyOwnReader.h, MyOwnWriterReader/MyOwnWriter.cxx, MyOwnWriterReader/MyOwnWriter.h, MyOwnWriterReader/MyOwnWriterReader.cxx, MyOwnWriterReader/MyOwnWriterReader.h, Normals/main.cxx, Pivot/main.cxx, ProceduralTexture/main.cxx, StereoCamera/main.cxx, SwitchBinding/main.cxx, Transformations/main.cxx, UserProperties/main.cxx, UVSample/main.cxx, and ViewScene/SceneContext.h.
Definition at line 56 of file fbxmanager.h.
|
static const char * | GetVersion (bool pFull=true) |
| Get FBX SDK version string. More...
|
|
static void | GetFileFormatVersion (int &pMajor, int &pMinor, int &pRevision) |
| Get the current default FBX file format version number for this version of the FBX SDK. More...
|
|
|
template<typename T1 , typename T2 > |
FbxClassId | RegisterFbxClass (const char *pName, const T1 *, const T2 *, const char *pFbxFileTypeName=0, const char *pFbxFileSubTypeName=0) |
| Class registration. More...
|
|
template<typename T > |
FbxClassId | RegisterRuntimeFbxClass (const char *pName, const T *, const char *pFbxFileTypeName=0, const char *pFbxFileSubTypeName=0) |
| Runtime class registration. More...
|
|
void | UnregisterRuntimeFbxClass (const char *pName) |
| Runtime class unregistration. More...
|
|
template<typename T1 , typename T2 > |
FbxClassId | OverrideFbxClass (const T1 *pFBX_TYPE_Class, const T2 *pFBX_TYPE_OverridenClass) |
| Override class. More...
|
|
FbxObject * | CreateNewObjectFromClassId (FbxClassId pClassId, const char *pName, FbxObject *pContainer=((void *) 0), const FbxObject *pCloneFrom=((void *) 0)) |
| Create a new object of the specified ClassId. More...
|
|
FbxClassId | FindClass (const char *pClassName) const |
| Find class by the specified name. More...
|
|
FbxClassId | FindFbxFileClass (const char *pFbxFileTypeName, const char *pFbxFileSubTypeName) const |
| Find file class. More...
|
|
template<typename T > |
void | UnregisterFbxClass (const T *pFBX_TYPE_Class) |
| Class unregistration. More...
|
|
|
void | AddLocalization (FbxLocalizationManager *pLocManager) |
| Add a localization object to the known localization providers. More...
|
|
void | RemoveLocalization (FbxLocalizationManager *pLocManager) |
| Remove a localization object from the known localization providers. More...
|
|
bool | SetLocale (const char *pLocale) |
| Select the current locale for localization. More...
|
|
const char * | Localize (const char *pID, const char *pDefault=((void *) 0)) const |
| Localization helper function. More...
|
|
◆ Create()
◆ Destroy()
◆ GetVersion()
static const char* GetVersion |
( |
bool |
pFull = true | ) |
|
|
static |
Get FBX SDK version string.
- Parameters
-
pFull | If true, the complete version string including revision number and release date will be returned, otherwise only the version numbering is returned. |
- Examples:
- Common/Common.cxx, and ExportDocument/main.cxx.
◆ GetFileFormatVersion()
static void GetFileFormatVersion |
( |
int & |
pMajor, |
|
|
int & |
pMinor, |
|
|
int & |
pRevision |
|
) |
| |
|
static |
Get the current default FBX file format version number for this version of the FBX SDK.
- Parameters
-
pMajor | Version major number. |
pMinor | Version minor number. |
pRevision | Version revision number. |
- Examples:
- Common/Common.cxx, and ExportDocument/main.cxx.
◆ RegisterFbxClass()
FbxClassId RegisterFbxClass |
( |
const char * |
pName, |
|
|
const T1 * |
, |
|
|
const T2 * |
, |
|
|
const char * |
pFbxFileTypeName = 0 , |
|
|
const char * |
pFbxFileSubTypeName = 0 |
|
) |
| |
|
inline |
Class registration.
- Parameters
-
pName | The class name. For example, "FbxMesh" for FbxMesh class. |
T1 | FBX type of the specified class. |
T2 | FBX type of parent class. |
pFbxFileTypeName | The type name of the class in FBX file. |
pFbxFileSubTypeName | The sub type name of the class in FBX file. |
- Returns
- The class Id of the newly register class. Such as:
- Examples:
- ExportScene03/main.cxx.
Definition at line 108 of file fbxmanager.h.
110 T1::ClassId = Internal_RegisterFbxClass(pName, T2::ClassId, (
FbxObjectCreateProc)T1::Allocate, pFbxFileTypeName, pFbxFileSubTypeName);
FbxObject *(* FbxObjectCreateProc)(FbxManager &pManager, const char *pName, const FbxObject *pFrom)
The function pointer type for object constructor functions.
◆ RegisterRuntimeFbxClass()
FbxClassId RegisterRuntimeFbxClass |
( |
const char * |
pName, |
|
|
const T * |
, |
|
|
const char * |
pFbxFileTypeName = 0 , |
|
|
const char * |
pFbxFileSubTypeName = 0 |
|
) |
| |
|
inline |
Runtime class registration.
- Parameters
-
pName | The class name. For example, "FbxUIWidgetBoolean". |
T | FBX type of parent class. |
pFbxFileTypeName | The type name of the class in FBX file. |
pFbxFileSubTypeName | The sub type name of the class in FBX file. |
- Returns
- The class Id of the newly register class. Such as:
Definition at line 123 of file fbxmanager.h.
125 return Internal_RegisterFbxClass(pName, T::ClassId, (
FbxObjectCreateProc)T::Allocate, pFbxFileTypeName, pFbxFileSubTypeName);
FbxObject *(* FbxObjectCreateProc)(FbxManager &pManager, const char *pName, const FbxObject *pFrom)
The function pointer type for object constructor functions.
◆ UnregisterRuntimeFbxClass()
void UnregisterRuntimeFbxClass |
( |
const char * |
pName | ) |
|
|
inline |
Runtime class unregistration.
- Parameters
-
Definition at line 131 of file fbxmanager.h.
136 Internal_UnregisterFbxClass(lClassId);
FbxClassId FindClass(const char *pClassName) const
Find class by the specified name.
Internal class used to differentiate objects during run-time.
◆ OverrideFbxClass()
FbxClassId OverrideFbxClass |
( |
const T1 * |
pFBX_TYPE_Class, |
|
|
const T2 * |
pFBX_TYPE_OverridenClass |
|
) |
| |
|
inline |
Override class.
- Parameters
-
pFBX_TYPE_Class | FBX type of class. |
pFBX_TYPE_OverridenClass | FBX type of overridden class. |
- Returns
- The class Id
Definition at line 145 of file fbxmanager.h.
FbxObject *(* FbxObjectCreateProc)(FbxManager &pManager, const char *pName, const FbxObject *pFrom)
The function pointer type for object constructor functions.
◆ CreateNewObjectFromClassId()
Create a new object of the specified ClassId.
- Parameters
-
pClassId | The ClassId of the object to be created. |
pName | The name given to the newly created object. |
pContainer | An optional parameter to specify which object will "contain" the new object. By contain, we mean the new object will become a source to the container, connection-wise. |
pCloneFrom | A valid object pointer to use as the reference for cloning the object upon construction. |
- Returns
- If not null, a new instance of the specified class.
◆ FindClass()
FbxClassId FindClass |
( |
const char * |
pClassName | ) |
const |
Find class by the specified name.
- Parameters
-
pClassName | Class Name to find. |
◆ FindFbxFileClass()
FbxClassId FindFbxFileClass |
( |
const char * |
pFbxFileTypeName, |
|
|
const char * |
pFbxFileSubTypeName |
|
) |
| const |
Find file class.
- Parameters
-
pFbxFileTypeName | Specify the type name in FBX file to find. |
pFbxFileSubTypeName | Specify by The sub type name in FBX file to find. |
◆ UnregisterFbxClass()
void UnregisterFbxClass |
( |
const T * |
pFBX_TYPE_Class | ) |
|
|
inline |
Class unregistration.
- Parameters
-
pFBX_TYPE_Class | FBX type of unregistered class. |
Definition at line 177 of file fbxmanager.h.
179 Internal_UnregisterFbxClass(T::ClassId);
Internal class used to differentiate objects during run-time.
◆ CreateDataType()
Register a new data type to the manager.
- Parameters
-
pName | The type name. |
pType | The data type. |
- Returns
- The newly created FbxDataType
◆ GetDataTypeCount()
int GetDataTypeCount |
( |
| ) |
const |
List the data types.
- Returns
- the number of registered datatypes
◆ GetDataType()
Find a data types at pIndex.
- Parameters
-
pIndex | The data type index. |
- Returns
- the found datatype. return null if not found
◆ GetDataTypeFromName()
FbxDataType& GetDataTypeFromName |
( |
const char * |
pDataType | ) |
const |
Find a data type from the type name.
- Parameters
-
- Returns
- the found datatype. return null if not found
◆ GetUserNotification()
Access to the unique UserNotification object.
- Returns
- The pointer to the user notification or
NULL
if
the object has not been allocated.
◆ SetUserNotification()
Set the user notification.
- Parameters
-
◆ GetIOSettings()
◆ SetIOSettings()
◆ GetMessageEmitter()
FbxMessageEmitter& GetMessageEmitter |
( |
| ) |
|
Access to the unique FbxMessageEmitter object.
- Returns
- The pointer to the message emitter.
◆ SetMessageEmitter()
bool SetMessageEmitter |
( |
FbxMessageEmitter * |
pMessageEmitter | ) |
|
Sets to the unique FbxMessageEmitter object.
- Parameters
-
pMessageEmitter | the emitter to use, passing NULL will reset to the default emitter. The object will be deleted when the SDK manager is destroyed, thus ownership is transfered. |
◆ AddLocalization()
void AddLocalization |
( |
FbxLocalizationManager * |
pLocManager | ) |
|
Add a localization object to the known localization providers.
- Parameters
-
pLocManager | the localization object to register. |
◆ RemoveLocalization()
void RemoveLocalization |
( |
FbxLocalizationManager * |
pLocManager | ) |
|
Remove a localization object from the known localization providers.
- Parameters
-
pLocManager | the localization object to remove. |
◆ SetLocale()
bool SetLocale |
( |
const char * |
pLocale | ) |
|
Select the current locale for localization.
- Parameters
-
pLocale | the locale name, for example "fr" or "en-US". |
◆ Localize()
const char* Localize |
( |
const char * |
pID, |
|
|
const char * |
pDefault = ((void *) 0) |
|
) |
| const |
Localization helper function.
Calls each registered localization manager until one can localizes the text.
- Parameters
-
pID | the identifier for the text to localize. |
pDefault | the default text. Uses pID if NULL. |
- Returns
- the potentially localized text. May return the parameter passed in.
◆ GetXRefManager()
Retrieve the manager responsible for managing object XRef resolution.
- Returns
- The XRef manager for this SDK manager.
◆ GetRootLibrary()
Retrieve the main object Libraries.
- Returns
- The Root library
◆ GetSystemLibraries()
◆ GetUserLibraries()
◆ GetIOPluginRegistry()
◆ LoadPluginsDirectory()
bool LoadPluginsDirectory |
( |
const char * |
pFilename, |
|
|
const char * |
pExtensions = ((void *) 0) |
|
) |
| |
Load plug-ins directory.
- Parameters
-
pFilename | The directory path. |
pExtensions | The plug in extension. |
- Returns
True
- Examples:
- Common/Common.cxx.
◆ LoadPlugin()
bool LoadPlugin |
( |
const char * |
pFilename | ) |
|
Load plug-in.
- Parameters
-
- Returns
True
◆ UnloadPlugins()
◆ EmitPluginsEvent()
Emit plugins event.
- Parameters
-
pEvent | The event to be emitted. |
◆ GetPlugins()
◆ GetPluginCount()
int GetPluginCount |
( |
| ) |
const |
get plugins count
- Returns
- The number of plugins.
◆ FindPlugin()
FbxPlugin* FindPlugin |
( |
const char * |
pName, |
|
|
const char * |
pVersion |
|
) |
| const |
Find plug in.
- Parameters
-
pName | The plug in name. |
pVersion | The plug in version. |
- Returns
- The plugin,
null
if not found.
◆ FillIOSettingsForReadersRegistered()
Fill IO Settings for registered readers.
- Parameters
-
pIOS | The properties hierarchies to fill. |
◆ FillIOSettingsForWritersRegistered()
Fill IO Settings for registered writers.
- Parameters
-
pIOS | The properties hierarchies to fill. |
◆ FillCommonIOSettings()
Fill common IO Settings.
- Parameters
-
pIOS | The properties hierarchies to fill. |
pImport | If true , import properties are set, otherwise export properties are set. |
◆ RegisterObject()
Register object with the manager.
- Parameters
-
pObject | The object to be registered. |
◆ UnregisterObject()
Unregister object with the manager.
- Parameters
-
pObject | The object to be unregistered. |
◆ RegisterObjects()
Register a list of objects with the manager.
- Parameters
-
pArray | The list of object to be registered. |
◆ UnregisterObjects()
Unregister a list of objects with the manager.
- Parameters
-
pArray | The list of object to be unregistered. |
◆ IncreaseDestroyingSceneFlag()
void IncreaseDestroyingSceneFlag |
( |
| ) |
|
Increment the scene destroying counter.
◆ DecreaseDestroyingSceneFlag()
void DecreaseDestroyingSceneFlag |
( |
| ) |
|
Shrink the object list and decrements the scene destroying counter.
◆ GetReferenceCount()
int GetReferenceCount |
( |
| ) |
const |
Get number of references.
- Returns
- Number of references.
◆ GetReference()
Get reference at given index.
- Parameters
-
pIndex | Position in the list of references. |
- Returns
- Pointer to the reference or
NULL
if index is out of bounds.
◆ AddReference()
Add a reference.
- Parameters
-
pReference | The reference to be added. |
- Returns
- If the reference is correctly added to the scene, return
true
otherwise, if the reference is already there, returns false
.
◆ RemoveReference()
Remove the specified reference from reference list.
- Parameters
-
pReference | The reference to be removed. |
- Returns
- If the reference was successfully removed, return
true
otherwise, if the reference could not be found returns false
.
◆ ClearReference()
Clear the specified reference from the SDK manager.
- Parameters
-
pReference | The reference to be removed. |
- Returns
- If the reference was successfully cleared from the SDK manager, return
true
otherwise, if the reference could not be found returns false
.
◆ PrefixName()
static FbxString PrefixName |
( |
const char * |
pPrefix, |
|
|
const char * |
pName |
|
) |
| |
|
static |
Add a prefix to a name.
- Parameters
-
pPrefix | The prefix to be added to the pName . This string must contain the "::" characters in order to be considered as a prefix. |
pName | The name to be prefix. |
- Returns
- The prefixed string
◆ GetDocumentCount()
Get the count of document available in this manager.
- Returns
- The count of document owned by this manager.
◆ GetDocument()
Get the document at pIndex in the manager's list.
- Parameters
-
pIndex | The index of the document to retrieve. |
- Returns
- The document at the specified index. Will return NULL if index is invalid.
The documentation for this class was generated from the following file: