KFbxSdkManager Class Reference

This reference page is linked to from the following overview topics: Your First FBX SDK Program, I/O Settings, Importing a Scene, Exporting a Scene, Customizing File Formats with FBX SDK I/O Plug-ins, FBX SDK Object Model, Managing Memory with the FBX SDK Manager, FBX Objects, Customizing the FBX SDK, Merging Two Scenes, List of Python FBX classes.

---

Search for all occurrences

---

Detailed Description

SDK object manager.

The SDK manager is in charge of:

• scene element allocation, for example, KFbxScene::Create(pSdkManager, "").
• scene element deallocation, call KFbxSdkManager::Destroy() to deallocates all object created by the SDK manager.
• scene element search and access, please see GlobalObjectManagement section.

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. SDK manager can also specify custom memory allocators.

See also:

SetMemoryAllocator

Remarks:

You could create more than one SDK manager. However, it's better to NOT share the same object among different managers.

Examples:

Animation/main.cxx, Common/Common.cxx, Common/Common.h, ConvertScene/main.cxx, ExportDocument/main.cxx, ExportScene01/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, ExportScene03/MyKFbxMesh.cxx, ExportScene03/MyKFbxMesh.h, ExportScene04/main.cxx, ExportScene05/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, UIExamples/Common/ImportExport.cxx, UIExamples/Common/ImportExport.h, UIExamples/CubeCreator/SDK_Utility.cxx, UIExamples/CubeCreator/SDK_Utility.h, UIExamples/CubeCreator/UI.cxx, UIExamples/ImportExport/UI.cxx, UIExamples/SceneTreeView/SDK_Utility.cxx, UIExamples/SceneTreeView/SDK_Utility.h, UIExamples/SceneTreeView/UI.cxx, UserProperties/main.cxx, UVSample/main.cxx, ViewScene/InitScene.cxx, ViewScene/InitScene.h, and ViewScene/main.cxx.

Definition at line 78 of file kfbxsdkmanager.h.

#include <kfbxsdkmanager.h>

List of all members.

Public Member Functions
bool	CanDestroyFbxSrcObject (KFbxObject *pObject, KFbxObject *pSrcObject, bool pRecursive, bool pDependents) const
void	CreateMissingBindPoses (KFbxScene *pScene)
int	GetBindPoseCount (KFbxScene *pScene) const
int	GetFbxClassCount () const
kFbxClassId	GetNextFbxClass (kFbxClassId pClassId) const
Static Public Member Functions
static KString	PrefixName (char const *pPrefix, char const *pName)
	Add a prefix to a name.
static KFbxSdkManager *	GetDefaultKFbxManager ()
Protected Member Functions
KFBXNEW_DECLARE_FRIEND	KFbxSdkManager ()
virtual	~KFbxSdkManager ()
virtual void	Clear (KArrayTemplate< kFbxClassId > *pExcludeList=NULL, bool pDestroyUserNotification=true)
	Clear the manager of all the objects it has created.
void	ClassInit ()
void	ClassRelease ()
Protected Attributes
KFbxUserNotification *	mUserNotification
KFbxIOSettings *	mIOSettings
KFbxMessageEmitter *	mMessageEmitter
KFbxIOPluginRegistry *	mRegistry
KError	mError
Friends
class	KFbxPose
Memory Management
static bool	SetMemoryAllocator (KFbxMemoryAllocator *pMemoryAllocator)
	SDK Memory management.
FBX SDK Manager Creation/Destruction/retrieval
static KFbxSdkManager *	Create ()
	SDK manager allocation method.
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.
virtual void	Destroy ()
	Destructor.
Plug and Object Definition and Management
template<typename T1 , typename T2 >
kFbxClassId	RegisterFbxClass (char const *pName, T1 const *pFBX_TYPE_Class, T2 const *pFBX_TYPE_ParentClass, const char *pFbxFileTypeName=0, const char *pFbxFileSubTypeName=0)
	Class registration.
template<typename T >
kFbxClassId	RegisterRuntimeFbxClass (char const *pName, T const *pFBX_TYPE_ParentClass, const char *pFbxFileTypeName=0, const char *pFbxFileSubTypeName=0)
	Runtime class registration.
void	UnregisterRuntimeFbxClass (char const *pName)
	Runtime class unregistration.
template<typename T1 , typename T2 >
kFbxClassId	OverrideFbxClass (T1 const *pFBX_TYPE_Class, T2 const *pFBX_TYPE_OverridenClass)
	Override class.
K_DEPRECATED KFbxPlug *	CreateClass (kFbxClassId pClassId, char const *pName, const char *pFBXType=0, const char *pFBXSubType=0)
	Create class.
KFbxObject *	CreateNewObjectFromClassId (kFbxClassId pClassId, char const *pName, KFbxObject *pContainer=NULL, const KFbxObject *pCloneFrom=NULL)
	Create a new object of the specified ClassId.
K_DEPRECATED KFbxPlug *	CreateClass (KFbxObject *pContainer, kFbxClassId pClassId, const char *pName, const char *pFBXType=0, const char *pFBXSubType=0)
	Create class.
kFbxClassId	FindClass (const char *pClassName) const
	Find class by the specified name.
kFbxClassId	FindFbxFileClass (const char *pFbxFileTypeName, const char *pFbxFileSubTypeName) const
	Find file class.
template<typename T >
void	UnregisterFbxClass (T const *pFBX_TYPE_Class)
	Class unregistration.
Error Management
enum	EError { eOBJECT_NOT_FOUND, eNAME_ALREADY_IN_USE, eERROR_COUNT }
	Error codes. More...
KError &	GetError ()
	Retrieve error object.
EError	GetLastErrorID () const
	Get last error code.
const char *	GetLastErrorString () const
	Get last error string.
Data Type Management
KFbxDataType	CreateFbxDataType (const char *pName, EFbxType pType)
	Register a new data type to the manager.
KFbxDataType const &	GetFbxDataTypeFromName (const char *pDataType)
	Find a data type from the type name.
int	GetFbxDataTypeCount () const
	List the data types.
KFbxDataType &	GetFbxDataType (int pIndex)
	Find a data types at pIndex.
User Notification Object
KFbxUserNotification *	GetUserNotification () const
	Access to the unique UserNotification object.
void	SetUserNotification (KFbxUserNotification *pUN)
	Set the user notification.
IOSettings Object
virtual KFbxIOSettings *	GetIOSettings () const
	Access to a IOSettings object.
virtual void	SetIOSettings (KFbxIOSettings *pIOSettings)
	Set the IOSettings pointer.
Message Emitter (for Message Logging)
KFbxMessageEmitter &	GetMessageEmitter ()
	Access to the unique KFbxMessageEmitter object.
bool	SetMessageEmitter (KFbxMessageEmitter *pMessageEmitter)
	Sets to the unique KFbxMessageEmitter object.
Localization Hierarchy
void	AddLocalization (KFbxLocalizationManager *pLocManager)
	Add a localization object to the known localization providers.
void	RemoveLocalization (KFbxLocalizationManager *pLocManager)
	Remove a localization object from the known localization providers.
bool	SetLocale (const char *pLocale)
	Select the current locale for localization.
const char *	Localize (const char *pID, const char *pDefault=NULL) const
	Localization helper function.
Sub-Manager Management
KFbxPreviewManager &	GetPreviewManager ()
	Retrieve the manager responsible for managing object previews.
XRef Manager
KFbxXRefManager &	GetXRefManager ()
	Retrieve the manager responsible for managing object XRef resolution.
Library Management
KFbxLibrary *	GetRootLibrary () const
	Retrieve the main object Libraries.
KFbxLibrary *	GetSystemLibraries () const
KFbxLibrary *	GetUserLibraries () const
Plug-in Registry Object
KFbxIOPluginRegistry *	GetIOPluginRegistry () const
	Access to the unique KFbxIOPluginRegistry object.
Fbx Generic Plugins Management
bool	LoadPluginsDirectory (char *pFilename, char *pExtensions)
	Load plug-ins directory.
bool	LoadPlugin (char *pFilename)
	Load plug-in.
bool	UnloadPlugins ()
	Unload all plug-ins.
bool	EmitPluginsEvent (KFbxEventBase const &pEvent)
	Emit plugins event.
KArrayTemplate< KFbxPlugin const * >	GetPlugins () const
	Get plugins.
int	GetPluginCount () const
	get plugins count
KFbxPlugin *	FindPlugin (const char *pName, const char *pVersion) const
	Find plug in.
IO Settings
void	FillIOSettingsForReadersRegistered (KFbxIOSettings &pIOS)
	Fill IO Settings for registered readers.
void	FillIOSettingsForWritersRegistered (KFbxIOSettings &pIOS)
	Fill IO Settings for registered writers.
void	FillCommonIOSettings (KFbxIOSettings &pIOS, bool pImport)
	Fill common IO Settings.
Global Object Management
KArrayTemplate< KFbxObject * >	mObjectArray
KArrayTemplate< KFbxObject * >	mDestroyingObjects
KArrayTemplate< KFbxNode * >	mDestroyingKFbxNode
KArrayTemplate< KFbxTexture * >	mDestroyingKFbxTexture
KArrayTemplate< KFbxCluster * >	mDestroyingKFbxCluster
KArrayTemplate< KFbxDocument * >	mDestroyingKFbxDocument
KArrayTemplate< KFbxScene * >	mDestroyingKFbxScene
KArrayTemplate < KFbxSurfaceMaterial * >	mDestroyingKFbxSurfaceMaterial
int	mIsDestroyingScene
void	RegisterObject (KFbxPlug const *pPlug)
	Register object with the manager.
void	UnregisterObject (KFbxPlug const *pPlug)
	Unregister object with the manager.
void	RegisterObjects (const KArrayTemplate< KFbxObject * > &pArray)
	Register a list of objects with the manager.
void	UnregisterObjects (const KArrayTemplate< KFbxObject * > &pArray)
	Unregister a list of objects with the manager.
void	IncreaseDestroyingSceneFlag ()
void	DecreaseDestroyingSceneFlag ()
int	GetSrcObjectCount (KFbxNode const *) const
	Get the count of KFbxNode.
KFbxNode *	GetSrcObject (KFbxNode const *, int pIndex=0) const
	Get the (pIndex)th KFbxNode.
int	GetSrcObjectCount (KFbxTexture const *) const
	Get the count of KFbxTexture.
KFbxTexture *	GetSrcObject (KFbxTexture const *, int pIndex=0) const
	Get the (pIndex)th KFbxTexture.
int	GetSrcObjectCount (KFbxCluster const *) const
	Get the count of KFbxCluster.
KFbxCluster *	GetSrcObject (KFbxCluster const *, int pIndex=0) const
	Get the (pIndex)th KFbxCluster.
int	GetSrcObjectCount (KFbxScene const *) const
	Get the count of KFbxScene.
KFbxScene *	GetSrcObject (KFbxScene const *, int pIndex=0) const
	Get the (pIndex)th KFbxScene.
int	GetSrcObjectCount (KFbxDocument const *) const
	Get the count of KFbxDocument.
KFbxDocument *	GetSrcObject (KFbxDocument const *, int pIndex=0) const
	Get the (pIndex)th KFbxDocument.
int	GetSrcObjectCount (KFbxSurfaceMaterial const *) const
	Get the count of KFbxSurfaceMaterial.
KFbxSurfaceMaterial *	GetSrcObject (KFbxSurfaceMaterial const *, int pIndex=0) const
	Get the (pIndex)th KFbxSurfaceMaterial.
Reference Management
int	GetReferenceCount () const
	Get number of references.
KFbxReference *	GetReference (int pIndex) const
	Get reference at given index.
int	AddReference (KFbxReference *pReference)
	Add a reference.
bool	RemoveReference (KFbxReference *pReference)
	Remove the specified reference from reference list.
bool	ClearReference (KFbxReference *pReference)
	Clear the specified reference from the SDK manager.

---

Member Enumeration Documentation

enum EError

Search for all occurrences

Error codes.

Enumerator:

eOBJECT_NOT_FOUND	The requested object was not found in the Manager's database. Search for all occurrences
eNAME_ALREADY_IN_USE	A name clash occurred. Search for all occurrences
eERROR_COUNT	Mark the end of the error enum. Search for all occurrences

Definition at line 245 of file kfbxsdkmanager.h.

            {
                eOBJECT_NOT_FOUND,    
                eNAME_ALREADY_IN_USE, 
                eERROR_COUNT          
            } EError;

---

Constructor & Destructor Documentation

KFBXNEW_DECLARE_FRIEND KFbxSdkManager

(

)

[protected]

virtual ~KFbxSdkManager

(

)

[protected, virtual]

---

Member Function Documentation

static bool SetMemoryAllocator

(

KFbxMemoryAllocator *

pMemoryAllocator

)

[static]

Search for all occurrences

SDK Memory management.

Use this method to specify custom memory management routines. The FBX SDK will use the provided routines to allocate and deallocate memory.

Parameters:

pMemoryAllocator

The memory allocator to set.

Remarks:

Important: If you plan to specify custom memory management routines, you must do so BEFORE creating the first SDK manager. Those routines are global and thus shared between different instances of SDK managers.

Examples:

ExportScene05/main.cxx, and ViewScene/main.cxx.

static KFbxSdkManager* Create

(

)

[static]

Search for all occurrences

SDK manager allocation method.

Returns:

A pointer to the SDK manager or NULL if this is an evaluation copy of the FBX SDK and it is expired.

Examples:

Common/Common.cxx, ExportDocument/main.cxx, UIExamples/Common/ImportExport.cxx, UIExamples/CubeCreator/SDK_Utility.cxx, and UIExamples/SceneTreeView/SDK_Utility.cxx.

virtual void Destroy

(

)

[virtual]

Search for all occurrences

Destructor.

Deallocates all object previously created by the SDK manager.

Examples:

Common/Common.cxx, ConvertScene/main.cxx, ExportDocument/main.cxx, UIExamples/Common/ImportExport.cxx, UIExamples/CubeCreator/SDK_Utility.cxx, UIExamples/SceneTreeView/SDK_Utility.cxx, and ViewScene/main.cxx.

static void GetFileFormatVersion	(	int &	pMajor,
		int &	pMinor,
		int &	pRevision
	)		[static]

Search for all occurrences

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, ExportDocument/main.cxx, and UIExamples/Common/ImportExport.cxx.

kFbxClassId RegisterFbxClass	(	char const *	pName,
		T1 const *	pFBX_TYPE_Class,
		T2 const *	pFBX_TYPE_ParentClass,
		const char *	pFbxFileTypeName = 0,
		const char *	pFbxFileSubTypeName = 0
	)		[inline]

Search for all occurrences

Class registration.

Parameters:

pName	The class name. For example, "KFbxMesh" for KFbxMesh class.
pFBX_TYPE_Class	FBX type of the specified class.
pFBX_TYPE_ParentClass	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:

 RegisterFbxClass("KFbxCamera", FBX_TYPE(KFbxCamera), FBX_TYPE(KFbxNodeAttribute)); 

Examples:

ExportScene03/main.cxx.

Definition at line 139 of file kfbxsdkmanager.h.

                                                                                                                                                                                                                                 {
                T1::ClassId  = Internal_RegisterFbxClass(pName,T2::ClassId,(kFbxPlugConstructor)T1::SdkManagerCreate,pFbxFileTypeName,pFbxFileSubTypeName );
                return T1::ClassId;
            }

kFbxClassId RegisterRuntimeFbxClass	(	char const *	pName,
		T const *	pFBX_TYPE_ParentClass,
		const char *	pFbxFileTypeName = 0,
		const char *	pFbxFileSubTypeName = 0
	)		[inline]

Search for all occurrences

Runtime class registration.

Parameters:

pName	The class name. For example, "KFbxUIWidgetBoolean".
pFBX_TYPE_ParentClass	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:

 RegisterRuntimeFbxClass( "KFbxUIWidgetBoolean", FBX_TYPE(KFbxUIWidgetDefinition), NULL, "KFbxUIWidgetBoolean"); 

Definition at line 153 of file kfbxsdkmanager.h.

                                                                                                                                                                                                   {
                return Internal_RegisterFbxClass(pName,T::ClassId,(kFbxPlugConstructor)T::SdkManagerCreate,pFbxFileTypeName,pFbxFileSubTypeName );
            }

void UnregisterRuntimeFbxClass

(

char const *

pName

)

[inline]

Search for all occurrences

Runtime class unregistration.

Parameters:

pName

The class name.

Definition at line 160 of file kfbxsdkmanager.h.

            {
                kFbxClassId lClassId = FindClass(pName);

                if( !(lClassId == kFbxClassId()) )
                {
                    Internal_UnregisterFbxClass(lClassId);
                }
            }

kFbxClassId OverrideFbxClass	(	T1 const *	pFBX_TYPE_Class,
		T2 const *	pFBX_TYPE_OverridenClass
	)		[inline]

Search for all occurrences

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 175 of file kfbxsdkmanager.h.

                                                                                                                                                 {
                T1::ClassId  = Internal_OverrideFbxClass(T2::ClassId,(kFbxPlugConstructor)T1::SdkManagerCreate );
                return T1::ClassId;
            }

K_DEPRECATED KFbxPlug* CreateClass	(	kFbxClassId	pClassId,
		char const *	pName,
		const char *	pFBXType = 0,
		const char *	pFBXSubType = 0
	)

Search for all occurrences

Create class.

Parameters:

pClassId	Class ID for the created class.
pName	Specify the name for the created class.
pFBXType	The type name of the created class.
pFBXSubType	The sub type name of the created class.

Remarks:

This function is deprecated, please use CreateNewObjectFromClassId() instead.

KFbxObject* CreateNewObjectFromClassId	(	kFbxClassId	pClassId,
		char const *	pName,
		KFbxObject *	pContainer = NULL,
		const KFbxObject *	pCloneFrom = NULL
	)

Search for all occurrences

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.

Remarks:

This function will return NULL if the ClassId used is invalid. New ClassId can be registered using the function RegisterFbxClass().

K_DEPRECATED KFbxPlug* CreateClass	(	KFbxObject *	pContainer,
		kFbxClassId	pClassId,
		const char *	pName,
		const char *	pFBXType = 0,
		const char *	pFBXSubType = 0
	)

Search for all occurrences

Create class.

Parameters:

pContainer	New class will be connected to pContainer.
pClassId	Class ID for the created class.
pName	Specify the name for the created class
pFBXType	The type name of the created class.
pFBXSubType	The sub type name of the created class.

Remarks:

This function is deprecated, please use CreateNewObjectFromClassId() instead.

kFbxClassId FindClass

(

const char *

pClassName

)

const

Search for all occurrences

Find class by the specified name.

Parameters:

pClassName

Class Name to find.

kFbxClassId FindFbxFileClass	(	const char *	pFbxFileTypeName,
		const char *	pFbxFileSubTypeName
	)		const

Search for all occurrences

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.

void UnregisterFbxClass

(

T const *

pFBX_TYPE_Class

)

[inline]

Search for all occurrences

Class unregistration.

Parameters:

pFBX_TYPE_Class

FBX type of unregistered class.

Definition at line 225 of file kfbxsdkmanager.h.

            {
                Internal_UnregisterFbxClass( T::ClassId );
                T::ClassId = kFbxClassId();
            }

KError& GetError

(

)

Search for all occurrences

Retrieve error object.

Returns:

Reference to the Manager's error object.

EError GetLastErrorID

(

)

const

Search for all occurrences

Get last error code.

Returns:

Last error code.

const char* GetLastErrorString

(

)

const

Search for all occurrences

Get last error string.

Returns:

Textual description of the last error.

KFbxDataType CreateFbxDataType	(	const char *	pName,
		EFbxType	pType
	)

Search for all occurrences

Register a new data type to the manager.

Parameters:

pName	The type name.
pType	The data type.

Returns:

The newly created KFbxDataType

KFbxDataType const& GetFbxDataTypeFromName

(

const char *

pDataType

)

Search for all occurrences

Find a data type from the type name.

Parameters:

pDataType

The type name.

Returns:

the found datatype. return null if not found

int GetFbxDataTypeCount

(

)

const

Search for all occurrences

List the data types.

Returns:

the number of registered datatypes

KFbxDataType& GetFbxDataType

(

int

pIndex

)

Search for all occurrences

Find a data types at pIndex.

Parameters:

pIndex

The data type index.

Returns:

the found datatype. return null if not found

KFbxUserNotification* GetUserNotification

(

)

const

Search for all occurrences

Access to the unique UserNotification object.

Returns:

The pointer to the user notification or NULL if the object has not been allocated.

void SetUserNotification

(

KFbxUserNotification *

pUN

)

Search for all occurrences

Set the user notification.

Parameters:

pUN

virtual KFbxIOSettings* GetIOSettings

(

)

const [virtual]

Search for all occurrences

Access to a IOSettings object.

Returns:

The pointer to IOSettings or NULL if the object has not been allocated.

Examples:

Common/Common.cxx, ConvertScene/main.cxx, ExportDocument/main.cxx, ExportScene05/main.cxx, UIExamples/Common/ImportExport.cxx, UIExamples/CubeCreator/SDK_Utility.cxx, and UIExamples/SceneTreeView/SDK_Utility.cxx.

virtual void SetIOSettings

(

KFbxIOSettings *

pIOSettings

)

[virtual]

Search for all occurrences

Set the IOSettings pointer.

Parameters:

pIOSettings

Examples:

Common/Common.cxx, ExportDocument/main.cxx, UIExamples/Common/ImportExport.cxx, UIExamples/CubeCreator/SDK_Utility.cxx, and UIExamples/SceneTreeView/SDK_Utility.cxx.

KFbxMessageEmitter& GetMessageEmitter

(

)

Search for all occurrences

Access to the unique KFbxMessageEmitter object.

Returns:

The pointer to the message emitter.

bool SetMessageEmitter

(

KFbxMessageEmitter *

pMessageEmitter

)

Search for all occurrences

Sets to the unique KFbxMessageEmitter 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.

void AddLocalization

(

KFbxLocalizationManager *

pLocManager

)

Search for all occurrences

Add a localization object to the known localization providers.

Parameters:

pLocManager

the localization object to register.

void RemoveLocalization

(

KFbxLocalizationManager *

pLocManager

)

Search for all occurrences

Remove a localization object from the known localization providers.

Parameters:

pLocManager

the localization object to remove.

bool SetLocale

(

const char *

pLocale

)

Search for all occurrences

Select the current locale for localization.

Parameters:

pLocale

the locale name, for example "fr" or "en-US".

const char* Localize	(	const char *	pID,
		const char *	pDefault = NULL
	)		const

Search for all occurrences

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.

KFbxPreviewManager& GetPreviewManager

(

)

Search for all occurrences

Retrieve the manager responsible for managing object previews.

Returns:

The Preview manager for this SDK manager.

KFbxXRefManager& GetXRefManager

(

)

Search for all occurrences

Retrieve the manager responsible for managing object XRef resolution.

Returns:

The XRef manager for this SDK manager.

KFbxLibrary* GetRootLibrary

(

)

const

Search for all occurrences

Retrieve the main object Libraries.

Returns:

The Root library

KFbxLibrary* GetSystemLibraries

(

)

const

Search for all occurrences

KFbxLibrary* GetUserLibraries

(

)

const

Search for all occurrences

KFbxIOPluginRegistry* GetIOPluginRegistry

(

)

const

Search for all occurrences

Access to the unique KFbxIOPluginRegistry object.

Returns:

The pointer to the user KFbxIOPluginRegistry

Examples:

Common/Common.cxx, ConvertScene/main.cxx, ExportDocument/main.cxx, ExportScene05/main.cxx, UIExamples/Common/ImportExport.cxx, UIExamples/CubeCreator/SDK_Utility.cxx, UIExamples/SceneTreeView/SDK_Utility.cxx, UserProperties/main.cxx, and ViewScene/main.cxx.

bool LoadPluginsDirectory	(	char *	pFilename,
		char *	pExtensions
	)

Search for all occurrences

Load plug-ins directory.

Parameters:

pFilename	The directory path.
pExtensions	The plug in extension.

Returns:

True

Examples:

Common/Common.cxx.

bool LoadPlugin

(

char *

pFilename

)

Search for all occurrences

Load plug-in.

Parameters:

pFilename

The file name

Returns:

True

bool UnloadPlugins

(

)

Search for all occurrences

Unload all plug-ins.

bool EmitPluginsEvent

(

KFbxEventBase const &

pEvent

)

Search for all occurrences

Emit plugins event.

Parameters:

pEvent

The event to be emitted.

KArrayTemplate<KFbxPlugin const*> GetPlugins

(

)

const

Search for all occurrences

Get plugins.

int GetPluginCount

(

)

const

Search for all occurrences

get plugins count

Returns:

The number of plugins.

KFbxPlugin* FindPlugin	(	const char *	pName,
		const char *	pVersion
	)		const

Search for all occurrences

Find plug in.

Parameters:

pName	The plug in name.
pVersion	The plug in version.

Returns:

The plugin, null if not found.

void FillIOSettingsForReadersRegistered

(

KFbxIOSettings &

pIOS

)

Search for all occurrences

Fill IO Settings for registered readers.

Parameters:

pIOS	The properties hierarchies to fill.

void FillIOSettingsForWritersRegistered

(

KFbxIOSettings &

pIOS

)

Search for all occurrences

Fill IO Settings for registered writers.

Parameters:

pIOS	The properties hierarchies to fill.

void FillCommonIOSettings	(	KFbxIOSettings &	pIOS,
		bool	pImport
	)

Search for all occurrences

Fill common IO Settings.

Parameters:

pIOS	The properties hierarchies to fill.
pImport	If true, import properties are set, otherwise export properties are set.

void RegisterObject

(

KFbxPlug const *

pPlug

)

Search for all occurrences

Register object with the manager.

Parameters:

pPlug

The object to be registered.

void UnregisterObject

(

KFbxPlug const *

pPlug

)

Search for all occurrences

Unregister object with the manager.

Parameters:

pPlug

The object to be unregistered.

void RegisterObjects

(

const KArrayTemplate< KFbxObject * > &

pArray

)

Search for all occurrences

Register a list of objects with the manager.

Parameters:

pArray

The list of object to be registered.

void UnregisterObjects

(

const KArrayTemplate< KFbxObject * > &

pArray

)

Search for all occurrences

Unregister a list of objects with the manager.

Parameters:

pArray

The list of object to be unregistered.

void IncreaseDestroyingSceneFlag

(

)

Search for all occurrences

void DecreaseDestroyingSceneFlag

(

)

Search for all occurrences

int GetSrcObjectCount

(

KFbxNode const *

)

const [inline]

Search for all occurrences

Get the count of KFbxNode.

Definition at line 566 of file kfbxsdkmanager.h.

{ return mKFbxNodeArray.GetCount();  }

KFbxNode* GetSrcObject	(	KFbxNode const *	,
		int	pIndex = 0
	)		const [inline]

Search for all occurrences

Get the (pIndex)th KFbxNode.

Parameters:

pIndex

the index.

Definition at line 570 of file kfbxsdkmanager.h.

{ return mKFbxNodeArray.GetAt(pIndex); }

int GetSrcObjectCount

(

KFbxTexture const *

)

const [inline]

Search for all occurrences

Get the count of KFbxTexture.

Definition at line 576 of file kfbxsdkmanager.h.

{ return mKFbxTextureArray.GetCount();  }

KFbxTexture* GetSrcObject	(	KFbxTexture const *	,
		int	pIndex = 0
	)		const [inline]

Search for all occurrences

Get the (pIndex)th KFbxTexture.

Parameters:

pIndex

the index.

Definition at line 580 of file kfbxsdkmanager.h.

{ return mKFbxTextureArray.GetAt(pIndex); }

int GetSrcObjectCount

(

KFbxCluster const *

)

const [inline]

Search for all occurrences

Get the count of KFbxCluster.

Definition at line 586 of file kfbxsdkmanager.h.

{ return mKFbxClusterArray.GetCount();  }

KFbxCluster* GetSrcObject	(	KFbxCluster const *	,
		int	pIndex = 0
	)		const [inline]

Search for all occurrences

Get the (pIndex)th KFbxCluster.

Parameters:

pIndex

the index.

Definition at line 590 of file kfbxsdkmanager.h.

{ return mKFbxClusterArray.GetAt(pIndex); }

int GetSrcObjectCount

(

KFbxScene const *

)

const [inline]

Search for all occurrences

Get the count of KFbxScene.

Definition at line 596 of file kfbxsdkmanager.h.

{ return mKFbxSceneArray.GetCount();  }

KFbxScene* GetSrcObject	(	KFbxScene const *	,
		int	pIndex = 0
	)		const [inline]

Search for all occurrences

Get the (pIndex)th KFbxScene.

Parameters:

pIndex

the index.

Definition at line 600 of file kfbxsdkmanager.h.

{ return mKFbxSceneArray.GetAt(pIndex); }

int GetSrcObjectCount

(

KFbxDocument const *

)

const [inline]

Search for all occurrences

Get the count of KFbxDocument.

Definition at line 606 of file kfbxsdkmanager.h.

{ return mKFbxDocumentArray.GetCount();  }

KFbxDocument* GetSrcObject	(	KFbxDocument const *	,
		int	pIndex = 0
	)		const [inline]

Search for all occurrences

Get the (pIndex)th KFbxDocument.

Parameters:

pIndex

the index.

Definition at line 610 of file kfbxsdkmanager.h.

{ return mKFbxDocumentArray.GetAt(pIndex); }

int GetSrcObjectCount

(

KFbxSurfaceMaterial const *

)

const [inline]

Search for all occurrences

Get the count of KFbxSurfaceMaterial.

Definition at line 616 of file kfbxsdkmanager.h.

{ return mKFbxSurfaceMaterialArray.GetCount();  }

KFbxSurfaceMaterial* GetSrcObject	(	KFbxSurfaceMaterial const *	,
		int	pIndex = 0
	)		const [inline]

Search for all occurrences

Get the (pIndex)th KFbxSurfaceMaterial.

Parameters:

pIndex

the index.

Definition at line 620 of file kfbxsdkmanager.h.

{ return mKFbxSurfaceMaterialArray.GetAt(pIndex); }

int GetReferenceCount

(

)

const

Search for all occurrences

Get number of references.

Returns:

Number of references.

KFbxReference* GetReference

(

int

pIndex

)

const

Search for all occurrences

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.

int AddReference

(

KFbxReference *

pReference

)

Search for all occurrences

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.

bool RemoveReference

(

KFbxReference *

pReference

)

Search for all occurrences

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.

bool ClearReference

(

KFbxReference *

pReference

)

Search for all occurrences

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.

static KString PrefixName	(	char const *	pPrefix,
		char const *	pName
	)		[static]

Search for all occurrences

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

Remarks:

If a prefix already exists, it is removed before adding pPrefix.

static KFbxSdkManager* GetDefaultKFbxManager

(

)

[static]

Search for all occurrences

bool CanDestroyFbxSrcObject	(	KFbxObject *	pObject,
		KFbxObject *	pSrcObject,
		bool	pRecursive,
		bool	pDependents
	)		const

Search for all occurrences

void CreateMissingBindPoses

(

KFbxScene *

pScene

)

Search for all occurrences

int GetBindPoseCount

(

KFbxScene *

pScene

)

const

Search for all occurrences

virtual void Clear	(	KArrayTemplate< kFbxClassId > *	pExcludeList = NULL,
		bool	pDestroyUserNotification = true
	)		[protected, virtual]

Search for all occurrences

Clear the manager of all the objects it has created.

Parameters:

pExcludeList

List of classId that should not be cleared.

Remarks:

This exclusion list will only affect the mObjectArray. All the scenes, nodes and documents will be destroyed. Also, because of the high risk of instability that this behavior can introduce, the caller of this function with a non empty argument is responsible to ensure that the system stay in a stable state.

Parameters:

pDestroyUserNotification

If false, the mUserNotification member is not destroyed by this call.

Note:

Some objects called SystemLockedObjects will NOT be cleared, either. They are KFbxDocumentInfo, KFbxLibrary(include FbxRootLibrary, mFbxSystemLibraries,mFbxUserLibraries). They will be delete after calling KFbxSdkManager::Destroy().

void ClassInit

(

)

[protected]

Search for all occurrences

void ClassRelease

(

)

[protected]

Search for all occurrences

int GetFbxClassCount

(

)

const

Search for all occurrences

kFbxClassId GetNextFbxClass

(

kFbxClassId

pClassId

)

const

Search for all occurrences

---

Friends And Related Function Documentation

friend class KFbxPose [friend]

Search for all occurrences

Definition at line 773 of file kfbxsdkmanager.h.

---

Member Data Documentation

KArrayTemplate<KFbxObject*> mObjectArray [protected]

Search for all occurrences

Definition at line 520 of file kfbxsdkmanager.h.

KArrayTemplate<KFbxObject*> mDestroyingObjects [protected]

Search for all occurrences

Definition at line 521 of file kfbxsdkmanager.h.

KArrayTemplate<KFbxNode*> mDestroyingKFbxNode [protected]

Search for all occurrences

Definition at line 522 of file kfbxsdkmanager.h.

KArrayTemplate<KFbxTexture*> mDestroyingKFbxTexture [protected]

Search for all occurrences

Definition at line 523 of file kfbxsdkmanager.h.

KArrayTemplate<KFbxCluster*> mDestroyingKFbxCluster [protected]

Search for all occurrences

Definition at line 524 of file kfbxsdkmanager.h.

KArrayTemplate<KFbxDocument*> mDestroyingKFbxDocument [protected]

Search for all occurrences

Definition at line 525 of file kfbxsdkmanager.h.

KArrayTemplate<KFbxScene*> mDestroyingKFbxScene [protected]

Search for all occurrences

Definition at line 526 of file kfbxsdkmanager.h.

KArrayTemplate<KFbxSurfaceMaterial*> mDestroyingKFbxSurfaceMaterial [protected]

Search for all occurrences

Definition at line 527 of file kfbxsdkmanager.h.

int mIsDestroyingScene [protected]

Search for all occurrences

Definition at line 529 of file kfbxsdkmanager.h.

KFbxUserNotification* mUserNotification [protected]

Search for all occurrences

Definition at line 760 of file kfbxsdkmanager.h.

KFbxIOSettings* mIOSettings [protected]

Search for all occurrences

Definition at line 763 of file kfbxsdkmanager.h.

KFbxMessageEmitter* mMessageEmitter [protected]

Search for all occurrences

Definition at line 766 of file kfbxsdkmanager.h.

KFbxIOPluginRegistry* mRegistry [protected]

Search for all occurrences

Definition at line 769 of file kfbxsdkmanager.h.

KError mError [mutable, protected]

Search for all occurrences

Definition at line 771 of file kfbxsdkmanager.h.

---

The documentation for this class was generated from the following file:

• fbxfilesdk/kfbxplugins/kfbxsdkmanager.h