#include <fbxlibrary.h>

Class Description

This library class represents libraries that store sub-libraries and shading objects.

Shading objects are objects of class FbxTexture, FbxSurfaceMaterial, and FbxLight.

Definition at line 30 of file fbxlibrary.h.

Inheritance diagram for FbxLibrary:

Public Member Functions
FbxLibrary *	GetParentLibrary (void) const
	Returns a pointer to the parent library if one exists. More...

void	SystemLibrary (bool pSystemLibrary)
	Sets whether not this library is a system library. More...

bool	IsSystemLibrary () const
	Returns whether or not this library is a system library. More...

void	LocalizationBaseNamePrefix (const char *pPrefix)
	The prefix must not include the dash and language code, nor can it contain the extension. More...

FbxString	LocalizationBaseNamePrefix () const
	Retrieves the localization prefix. More...

bool	AddSubLibrary (FbxLibrary *pSubLibrary)
	Adds a sub-library. More...

bool	RemoveSubLibrary (FbxLibrary *pSubLibrary)
	Removes a sub-library. More...

int	GetSubLibraryCount (void) const
	Returns the total number of sub-libraries. More...

FbxLibrary *	GetSubLibrary (int pIndex) const
	Returns the sub-library at the specified index. More...

FbxObject *	CloneAsset (FbxObject pToClone, FbxObject pOptionalDestinationContainer=NULL) const
	Clones the specified asset. More...

bool	ImportAssets (FbxLibrary *pSrcLibrary)
	Transfers ownership from the source library to this library for any assets passing through the filter. More...

bool	ImportAssets (FbxLibrary *pSrcLibrary, const FbxCriteria &pAssetFilter)
	Transfers ownership from the source library to this library for any assets passing through the filter. More...

template<class T >
T *	InstantiateMember (const T pFBX_TYPE, const FbxObjectFilter &pFilter, bool pRecurse=true, FbxObject pOptContainer=NULL)
	Returns a new instance of a library member. More...

FbxLocalizationManager &	GetLocalizationManager () const
	Returns the localization manager for the library. More...

virtual const char *	Localize (const char pID, const char pDefault=NULL) const
	Localization helper function. More...

bool	AddShadingObject (FbxObject *pShadingObject)
	Adds a shading object. More...

bool	RemoveShadingObject (FbxObject *pShadingObject)
	Removes a shading object. More...

int	GetShadingObjectCount (void) const
	Returns the total number of shading objects. More...

FbxObject *	GetShadingObject (int pIndex) const
	Returns the shading object at the specified index. More...

int	GetShadingObjectCount (const FbxImplementationFilter &pCriteria) const
	Returns the number of shading objects according to their implementations. More...

FbxObject *	GetShadingObject (int pIndex, const FbxImplementationFilter &pCriteria) const
	Returns a handle on the shading object at the specified index that corresponds to the given filtering parameters. More...

Public Member Functions inherited from FbxDocument
virtual void	Clear ()
	Remove document members and restore default settings. More...

void	AddRootMember (FbxObject *pMember)
	Add a member object and connect it to Roots. More...

void	RootRootRemoveMember (FbxObject *pMember)
	Remove a member object from the document. More...

template<class T >
T *	FindRootMember (char *pName)
	Find a member object in the document, that has the given type and name. More...

int	GetRootMemberCount () const
	Return the number of objects in the document. More...

template<class T >
int	GetRootMemberCount () const
	Return the number of objects of class T in the document. More...

int	GetRootMemberCount (FbxCriteria pCriteria) const
	Return the number of objects of the document that satisfy the given criteria. More...

FbxObject *	GetRootMember (int pIndex=0) const
	Return the member of the document at given index. More...

template<class T >
T *	GetRootMember (int pIndex=0) const
	Return the member of class T of the document at given index. More...

FbxObject *	GetRootMember (FbxCriteria pCriteria, int pIndex=0) const
	Return the document member which satisfies given criteria, for given index. More...

virtual bool	IsRootMember (FbxObject *pMember) const
	Is an object part of the document. More...

FbxDocumentInfo *	GetDocumentInfo () const
	Get the document information. More...

void	SetDocumentInfo (FbxDocumentInfo *pSceneInfo)
	Set the document information. More...

void	SetPeripheral (FbxPeripheral *pPeripheral)
	Set the current peripheral to be used to load or unload objects from this document. More...

virtual FbxPeripheral *	GetPeripheral ()
	Retrieve the current peripheral of the document. More...

int	UnloadContent (FbxStatus *pStatus=NULL)
	Unload all the unloadable objects contained in the document using the currently set peripheral. More...

int	LoadContent (FbxStatus *pStatus=NULL)
	Load all the objects contained in the document with the data from the currently set peripheral. More...

int	GetReferencingDocuments (FbxArray< FbxDocument * > &pReferencingDocuments) const
	Fills an array of pointers to documents that reference objects in this document. More...

int	GetReferencingObjects (const FbxDocument pFromDoc, FbxArray< FbxObject > &pReferencingObjects) const
	Fills an array of pointers to objects in a given document (pFromDoc) that reference objects in this document. More...

int	GetReferencedDocuments (FbxArray< FbxDocument * > &pReferencedDocuments) const
	Fills an array of pointers to documents that are referenced by objects in this document. More...

int	GetReferencedObjects (const FbxDocument pToDoc, FbxArray< FbxObject > &pReferencedObjects) const
	Fills an array of pointers to objects in a given document (pToDoc) that are referenced by objects in this document. More...

FbxString	GetPathToRootDocument (void) const
	Gets the path string to the root document, if the current document is contained in another document. More...

void	GetDocumentPathToRootDocument (FbxArray< FbxDocument * > &pDocumentPath, bool pFirstCall=true) const
	Gets the document path to the root document as an array of documents, if the current document is contained in another document. More...

bool	IsARootDocument (void)
	Tells if this document is a root document. More...

bool	CreateAnimStack (const char pName, FbxStatus pStatus=NULL)
	Adds a new animation stack object to this document. More...

bool	RemoveAnimStack (const char *pName)
	Destroy the animation stack object identified by pName from this document. More...

void	FillAnimStackNameArray (FbxArray< FbxString * > &pNameArray)
	Fill a string array with all existing animation stack names. More...

bool	SetTakeInfo (const FbxTakeInfo &pTakeInfo)
	Set information about an animation stack. More...

FbxTakeInfo *	GetTakeInfo (const FbxString &pTakeName) const
	Get information about an animation stack. More...

Public Member Functions inherited from FbxCollection
virtual bool	AddMember (FbxObject *pMember)
	Adds a member. More...

virtual bool	RemoveMember (FbxObject *pMember)
	Removes a member. More...

int	GetMemberCount () const
	Returns the number of objects contained within the collection. More...

FbxObject *	GetMember (int pIndex=0) const
	Returns the member of the collection at the given index. More...

virtual bool	IsMember (const FbxObject *pMember) const
	Judges whether an object is a part of the collection. More...

template<class T >
int	GetMemberCount () const
	Returns the number of class T objects contained within the collection. More...

template<class T >
T *	GetMember (int pIndex=0) const
	Returns the member of class T at the given index in the collection. More...

template<class T >
T *	FindMember (const char *pName) const
	Searches for a member of class T. More...

int	GetMemberCount (const FbxCriteria &pCriteria) const
	Returns the number of objects contained within the collection that meet the specified criteria. More...

FbxObject *	GetMember (const FbxCriteria &pCriteria, int pIndex=0) const
	Returns the member at the given index in the collection if it meets the specified criteria. More...

FbxObject *	FindMember (const FbxCriteria &pCriteria, const char *pName) const
	Searches for a member with the given name that also meets the given criteria. More...

virtual void	SetSelectedAll (bool pSelection)
	Selects/Deselects all the contained objects. More...

Public Member Functions inherited from FbxObject
virtual void	Compact ()
	Compact the memory used by this object. More...

FBX_DEPRECATED bool	Is (const FbxClassId &pClassId) const
	Test if this class is a hierarchical children of the specified class type. 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...

FBX_DEPRECATED bool	DisconnectAllSrcObject (FbxClassId pClassId)
	Disconnects this object from all source objects of a specific class type. 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...

FBX_DEPRECATED int	GetSrcObjectCount (FbxClassId pClassId) const
	Returns the number of source objects of the specific class type 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...

FBX_DEPRECATED FbxObject *	GetSrcObject (FbxClassId pClassId, int pIndex=0) const
	Returns the source object of the specified class type 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...

FBX_DEPRECATED FbxObject *	FindSrcObject (FbxClassId pClassId, const char *pName, int pStartIndex=0) const
	Searches the source object with the specified name which is also the specified class type, 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...

FBX_DEPRECATED bool	DisconnectAllDstObject (FbxClassId pClassId)
	Disconnects this object from all destination objects of the specified class type. 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...

FBX_DEPRECATED int	GetDstObjectCount (FbxClassId pClassId) const
	Returns the number of destination objects of the specified class type with which this object connects. 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...

FBX_DEPRECATED FbxObject *	GetDstObject (FbxClassId pClassId, int pIndex=0) const
	Returns the destination object of the specified class type with which this object connects 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...

FBX_DEPRECATED FbxObject *	FindDstObject (FbxClassId pClassId, const char *pName, int pStartIndex=0) const
	Searches the destination object with the specified name which is the specified class type, 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...

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=NULL) const
	Returns the number of implementations that satisfy a given criteria. More...

FbxImplementation *	GetImplementation (int pIndex, const FbxImplementationFilter *pCriteria=NULL) 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=NULL, void pSet=NULL) 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...

Public Member Functions inherited from FbxEmitter
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 FbxCriteria	GetAssetCriteriaFilter ()
	Returns a criteria filter which you can use to filter objects when iterating items in the library. More...

static FbxCriteria	GetAssetDependentsFilter ()
	Returns a filter which you should use when you clone / export objects. More...

Static Public Member Functions inherited from FbxObject
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...

Additional Inherited Members
Public Types inherited from FbxObject
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 Attributes inherited from FbxDocument
FbxPropertyT< FbxReference >	Roots

FbxPropertyT< FbxString >	ActiveAnimStackName
	Holds the name of the FbxAnimStack that the application uses for animation in this document. More...

Public Attributes inherited from FbxObject
FbxProperty	RootProperty
	The root property that holds all children property for this object. More...

Protected Member Functions inherited from 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...

Member Function Documentation

FbxLibrary* GetParentLibrary ( void ) const

Returns a pointer to the parent library if one exists.

void SystemLibrary ( bool pSystemLibrary )

Sets whether not this library is a system library.

Parameters

pSystemLibrary A flag which indicates whether or not this library is a system library.

bool IsSystemLibrary ( ) const

Returns whether or not this library is a system library.

void LocalizationBaseNamePrefix ( const char * pPrefix )

The prefix must not include the dash and language code, nor can it contain the extension.

But if you want, it can contain a folder or sub-folder, such as: locales/mydocloc. This is resolved using the XRef Manager, with priority given to the library's ".fbm" folder, if one exists.

Parameters

pPrefix New prefix to be set.

FbxString LocalizationBaseNamePrefix ( ) const

Retrieves the localization prefix.

bool AddSubLibrary ( FbxLibrary * pSubLibrary )

Adds a sub-library.

Parameters

pSubLibrary The sub-library to be added.

Returns: True if adding the sub-library is successful, returns false if not.

bool RemoveSubLibrary ( FbxLibrary * pSubLibrary )

Removes a sub-library.

Parameters

pSubLibrary The sub-library to be removed.

Returns: True if the sub-library is removed, false if not.

int GetSubLibraryCount ( void ) const

Returns the total number of sub-libraries.

FbxLibrary* GetSubLibrary ( int pIndex ) const

Returns the sub-library at the specified index.

Parameters

pIndex The sub-library index.

FbxObject* CloneAsset	(	FbxObject *	pToClone,
		FbxObject *	pOptionalDestinationContainer = `NULL`
	)		const

Clones the specified asset.

Parameters

pToClone	The asset to be cloned.
pOptionalDestinationContainer	The container for the asset copy.

Remarks: The asset and all its dependents are cloned.

static FbxCriteria GetAssetCriteriaFilter ( )

static

Returns a criteria filter which you can use to filter objects when iterating items in the library.

Only real 'assets' are returned, rather than FBX support objects. This currently includes lights, environments, materials and textures (maps). This is typically used to IMPORT from a library.

static FbxCriteria GetAssetDependentsFilter ( )

static

Returns a filter which you should use when you clone / export objects.

This filters out objects that should remain in the asset library.

Use this to EXPORT from a library (or CLONE from a library).

bool ImportAssets ( FbxLibrary * pSrcLibrary )

Transfers ownership from the source library to this library for any assets passing through the filter.

It is assumed that name conflicts and other details have been resolved beforehand.

External asset files required by the assets are copied (not moved). It's up to the owner of the source library to clean up the files if the files are not on a read-only transport. If this document hasn't been committed yet, the assets will not be copied.

Returns true if no filtered assets were skipped. If no assets pass through the filter, it returns true, because nothing has been skipped.

This may leave the source library in an invalid state. For example, the source library would be in an invalid state if you had decided to transfer texture objects to the library, but materials were kept in the source library.

To safeguard against this, the transfer disconnects objects, and thus materials are left without textures.

When you transfer an object, all its dependents come with it. If you move a material, it takes the associated textures as well. Although if you moved a texture, the material would not be transferred with it.

Parameters

pSrcLibrary The source library to be imported.

Returns: True if no filtered assets are skipped.

bool ImportAssets	(	FbxLibrary *	pSrcLibrary,
		const FbxCriteria &	pAssetFilter
	)

Transfers ownership from the source library to this library for any assets passing through the filter.

It is assumed that name conflicts and other details have been resolved beforehand.

External asset files required by the assets are copied (not moved). It's up to the owner of the source library to clean up the files if the files are not on a read-only transport. If this document hasn't been committed yet, the assets will not be copied.

Returns true if no filtered assets were skipped. If no assets pass through the filter, it returns true, because nothing has been skipped.

This may leave the source library in an invalid state. For example, the source library would be in an invalid state if you had decided to transfer texture objects to the library, but materials were kept in the source library.

To safeguard against this, the transfer disconnects objects, and thus materials are left without textures.

When you transfer an object, all its dependents come with it. If you move a material, it takes the associated textures as well. Although if you moved a texture, the material would not be transferred with it.

Parameters

pSrcLibrary	The source library to be imported.
pAssetFilter	The asset filter.

Returns: True if no filtered assets are skipped.

T* InstantiateMember	(	const T *	pFBX_TYPE,
		const FbxObjectFilter &	pFilter,
		bool	pRecurse = `true`,
		FbxObject *	pOptContainer = `NULL`
	)

Returns a new instance of a library member.

This instantiates the first object found that matches the filter.

Parameters

pFBX_TYPE	The type of member
pFilter	A user specified filter
pRecurse	A flag that indicates whether to check sub-libraries
pOptContainer	Optional container for the cloned asset

Returns: A new instance of the member. Note that the new member is not included with this library.

FbxLocalizationManager& GetLocalizationManager ( ) const

Returns the localization manager for the library.

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

virtual

Localization helper function.

Calls the FBX SDK manager implementation. Sub-classes that manage their own localization can over-ride this function.

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.

Reimplemented from FbxObject.

bool AddShadingObject ( FbxObject * pShadingObject )

Adds a shading object.

Parameters

pShadingObject The shading object to be added.

bool RemoveShadingObject ( FbxObject * pShadingObject )

Removes a shading object.

Parameters

pShadingObject The shading object to be removed.

int GetShadingObjectCount ( void ) const

Returns the total number of shading objects.

FbxObject* GetShadingObject ( int pIndex ) const

Returns the shading object at the specified index.

Parameters

pIndex Shading object index.

Returns: The shading object located at the specified index.

int GetShadingObjectCount ( const FbxImplementationFilter & pCriteria ) const

Returns the number of shading objects according to their implementations.

Parameters

pCriteria Filtering criteria that identifies what kind of implementations to consider.

Returns: The number of shading objects corresponding to the filtering parameters

FbxObject* GetShadingObject	(	int	pIndex,
		const FbxImplementationFilter &	pCriteria
	)		const

Returns a handle on the shading object at the specified index that corresponds to the given filtering parameters.

Parameters

pIndex	Shading object index.
pCriteria	Filtering criteria that identifies what kind of implementations to consider.

Returns: A handle on the shading object at the specified index that corresponds to the given filtering parameters.

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

fbxsdk/scene/fbxlibrary.h

FbxLibrary Class Reference

Class Description

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation