FbxObject Class Reference

#include <fbxobject.h>

Class Description

The base class of most FBX objects.

Provides the benefits of connectivity, identity, run-time typing, properties, naming, copying, cloning, selection, and automated file IO. Most of the FBX SDK API deals with FbxObject pointers when it comes to manipulate objects in its simplest form.

The ClassID mechanism replaces the dynamic_cast mechanism for efficient run-time type information.

The FbxObject provides methods for managing the connections between objects. Using connections, objects can be related to each other to form hierarchies or structures. All of the FBX scene's object relations are expressed as connections between objects. Those connections can be altered as needed to reflect most kind of setups encountered in this world. For example, connections can be used to express parenting between transform nodes. Connections are not strict in the sense that we allow any type of objects to connect to any other type of objects. The meaning of the connection is purely semantic. As of yet, we do not provide the functionality to validate if the connections made by the users are allowed or not.

FbxObject provide a property (FbxProperty) mechanism to describe characteristics of objects in a scene. Properties may be either static or dynamic. Static properties are defined in the class direction and can be accessed directly by their name on the object exposing them without the need for a search in the property list of the object. Dynamic properties can be added during run-time, while the program is running. Objects can have an unlimited amount of properties. Properties can be listed at run-time, allowing for a flexible support of custom data on objects, since they might be considered by the FBX file readers/writers depending on the flags set.

Here is an example of a new empty minimal class template for FBX objects:

//Declaration
class MyClass : public FbxObject
{
    FBXSDK_OBJECT_DECLARE(MyClass, FbxObject);  //Be careful! The second parameter to this macro must be the parent class name!

public:
    //Declare methods and properties here...
};

//Implementation
FBXSDK_OBJECT_IMPLEMENT(MyClass);

Before the new class can be used, it needs to be registered to the manager with the following method:

MyFbxManager->RegisterFbxClass("MyClassName", FBX_TYPE(MyClass), FBX_TYPE(FbxObject));  //Be careful! The 3rd parameter must be the parent class! If the parent class change, it must be updated here too!

Then to create or delete instances of your new class, the following methods must be used:

//Creating a new instance
MyClass* MyObject = MyClass::Create(MyFbxManager, "Object Name");

//Deleting this instance
MyObject->Destroy();
MyObject = NULL;

See also

FbxProperty

Examples:

Definition at line 157 of file fbxobject.h.

Inheritance diagram for FbxObject:

Public Types
typedef FbxEmitter	ParentClass

Public Member Functions
virtual FbxClassId	GetClassId () const
virtual void	Compact ()
	Compact the memory used by this object. More...
General Object Management
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...
Selection management
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...
User data
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...
General Object Connection and Relationship Management
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...
Property Management
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...
Off-Loading Management
Remarks You can modify the unloaded state flag using the SetObjectFlags() method. The ContentIsUnloaded() method below (implemented in this class) is simply a synonym of GetObjectFlags(eCONTENT_UNLOADED_FLAG)
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...
Logging.
void	EmitMessage (FbxMessage *pMessage) const
	Emits a message in all available message emitters in the document or SDK manager. More...
Localization helper.
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...
Application Implementation Management
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...
Object Storage && Retrieval
virtual FbxString	GetUrl () const
	Returns the URL of this object. More...
virtual bool	SetUrl (char *pUrl)
	Sets the URL of this object. More...
Run-time ClassId Management
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...
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 FbxObject *	Create (FbxManager *pManager, const char *pName)
static FbxObject *	Create (FbxObject *pContainer, const char *pName)

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

Static Public Attributes
static FbxClassId	ClassId

Protected Member Functions
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 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)

Object Flags Management
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...
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...

Copying, Cloning and Referencing
enum	ECloneType { eDeepClone, eReferenceClone }
	Types of clones that can be created for FbxObject. 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...

Object Name Management
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...
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...

Member Typedef Documentation

typedef FbxEmitter ParentClass

Definition at line 159 of file fbxobject.h.

Member Enumeration Documentation

enum EObjectFlag

Flags available to control objects.

Enumerator
eNone	No flags.
eInitialized	Automatically set when FbxObject::Construct() is completed.
eSystem	When set, object is deleted upon FbxManager destroy only. Use carefully!
eSavable	If set, object is stored in FBX file upon export. All objects are savable by default.
eSelected	Used by the selection mechanic to specify a selected object.
eHidden	Used for interface representation; if set, the object should not be visible.
eContentLoaded	Used by load-on-demand mechanic to specify if an object has its content loaded.
eDontLocalize	Used by asset builder; Do not localize this object.
eCopyCalledByClone	Used internally. If set, modify the Copy behavior of the object

Definition at line 203 of file fbxobject.h.

        {
            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 
        };

enum ECloneType

Types of clones that can be created for FbxObject.

Enumerator
eDeepClone	A deep copy of the object. Changes to either the original or clone properties do not propagate to each other.
eReferenceClone	Changes to original object properties propagate to clone. Changes to clone properties do not propagate to original.

Definition at line 245 of file fbxobject.h.

        {
            eDeepClone,     
            eReferenceClone 
        };

Constructor & Destructor Documentation

virtual ~FbxObject ( )

inlineprotectedvirtual

Definition at line 159 of file fbxobject.h.

:

Member Function Documentation

virtual FbxClassId GetClassId ( ) const

inlinevirtual

Reimplemented in FbxAnimCurve, FbxControlSetPlug, FbxIOSettings, FbxTrimNurbsSurface, FbxPose, FbxCharacter, FbxImporter, FbxExporter, FbxNode, FbxAnimCurveBase, FbxAnimEvaluator, FbxScene, FbxNurbsCurve, FbxAnimCurveNode, FbxSubDeformer, FbxImplementation, FbxBindingOperator, FbxCharacterPose, FbxCluster, FbxDocument, FbxGeometry, FbxGeometryBase, FbxLayeredTexture, FbxGeometryWeightedMap, FbxBlendShape, FbxDeformer, FbxAnimStack, FbxBlendShapeChannel, FbxSkin, FbxCamera, FbxLine, FbxSkeleton, FbxFileTexture, FbxCache, FbxNurbsSurface, FbxAnimEvalClassic, FbxContainerTemplate, FbxCameraSwitcher, FbxMesh, FbxShape, FbxNurbs, FbxAnimLayer, FbxLibrary, FbxSelectionSet, FbxCameraStereo, FbxBoundary, FbxBindingTable, FbxBindingTableBase, FbxCameraManipulator, FbxObjectMetaData, FbxLayerContainer, FbxNodeAttribute, FbxIOBase, FbxCollection, FbxDisplayLayer, FbxCachedEffect, FbxGlobalSettings, FbxConstraint, FbxConstraintParent, FbxEnvironment, FbxSelectionNode, FbxThumbnail, FbxLight, FbxProceduralGeometry, FbxVertexCacheDeformer, FbxProceduralTexture, FbxProcessor, FbxProcessorShaderDependency, FbxConstraintAim, FbxConstraintPosition, FbxConstraintRotation, FbxConstraintScale, FbxContainer, FbxDocumentInfo, FbxMarker, FbxOpticalReference, FbxPatch, FbxTexture, FbxProcessorXRefCopy, FbxConstraintCustom, FbxConstraintSingleChainIK, FbxCollectionExclusive, FbxSceneReference, FbxVideo, FbxNull, FbxSurfaceLambert, FbxSurfaceMaterial, FbxSurfacePhong, FbxProcessorXRefCopyUserLibrary, and FbxGenericNode.

Definition at line 159 of file fbxobject.h.

:

static FbxObject* Create ( FbxManager *  pManager, const char *  pName  )

static

static FbxObject* Create ( FbxObject *  pContainer, const char *  pName  )

static

static FbxObject* Allocate ( FbxManager *  pManager, const char *  pName, const FbxObject *  pFrom  )

staticprotected

FBX_DEPRECATED bool Is ( const FbxClassId &  pClassId ) const

inline

Test if this class is a hierarchical children of the specified class type.

This is the standard method to differentiate object classes. (Deprecated, please use Is<Type>() instead.)

Parameters

pClassId

The class type to test against self.

Returns

true if the object is a hierarchical children of the type specified.

Remarks

This function will perform a complete search until it reaches the top level class, but it will stop as soon as one ClassId matches the test.

Definition at line 168 of file fbxobject.h.

{ return GetClassId().Is(pClassId); }

bool Is ( ) const

inline

Templated test if this class is a hierarchical children of the specified class type.

Returns

true if the object is a hierarchical children of the type specified.

Remarks

This function will perform a complete search until it reaches the top level class, but it will stop as soon as one ClassId matches the test.

Definition at line 173 of file fbxobject.h.

{ return GetClassId().Is(T::ClassId); }

FbxManager* GetFbxManager

(

)

const

Retrieve the FbxManager this object belongs to.

Returns

A pointer to the manager that this object belongs to.

FbxDocument* GetDocument

(

)

const

Returns a const pointer to the document that contains this object.

Returns

A const pointer to the document that contains this object or NULL if the object does not belong to any document.

FbxDocument* GetRootDocument

(

)

const

Returns a const pointer to the root document that contains this object.

Returns

A const pointer to the root document that contains this object or NULL if the object does not belong to any document.

Remarks

It returns this pointer if this object is a document object and does not belong to any document. That means this object is the root document.

FbxScene* GetScene

(

)

const

Returns a const pointer to the scene that contains this object.

Returns

A pointer to the scene that contains this object or NULL if the object does not belong to any scene.

Examples:

void Destroy

(

bool

pRecursive = false

)

Unregister and delete this object from memory.

This will also breaks all connections as well as removing all the instance of all the properties of this object with the object's class.

Parameters

pRecursive

If true, all children (source) objects will also be unregistered and deleted.

Examples:

void ResetProperties

(

)

Reset all the properties of this object to their default values.

void SetObjectFlags	(	EObjectFlag	pFlags,
		bool	pValue
	)

Set the state of object flags.

Parameters

pFlags	Bit flags which value is going to be changed.
pValue	If true, bit flags will be set, otherwise bits will be un-set.

bool GetObjectFlags

(

EObjectFlag

pFlags

)

const

Get the state of object flags.

Parameters

pFlags

Bit flags to query.

Returns

true if the specified bit flags are all set.

void SetAllObjectFlags

(

FbxUInt

pFlags

)

Override all object flags at once.

Parameters

pFlags

The bit flags to set all the object flags to.

Remarks

This function will override all flags; unspecified bit flags will be un-set.

FbxUInt GetAllObjectFlags

(

)

const

Get all object flags at once.

Returns

All bit flags at once.

virtual FbxObject& Copy ( const FbxObject &  pObject )

virtual

Copy an object content into this object.

Parameters

pObject

The source object to copy data from.

Returns

Returns the destination object being modified by the source.

Remarks

This function replace the assignment operator (operator=). It will copy all property values and the name. Connections are NOT copied.

virtual FbxObject* Clone ( FbxObject::ECloneType  pCloneType = eDeepClone, FbxObject *  pContainer = ((void *) 0), void *  pSet = ((void *) 0)  ) const

virtual

Creates a clone of this object.

By default, the connections are NOT cloned. If the desired effect is to clone the connections as well, you must clone using the FbxCloneManager (refer to this class documentation for further details).

Parameters

pCloneType	The type of clone to be created. By default, the clone type is eDeepClone.
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.
pSet	See remark section.

Returns

The new clone, or NULL (if the specified clone type is not supported).

Remarks

When doing either a "deep" or "reference" clone type, the clone will always get its properties values set from the source object properties values.

Since this is a virtual function, some classes might do additional tasks.

The pSet argument is not used in the default implementation of this method. Specialized implementations should cast this pointer to FbxCloneManager::CloneSet to have access to the cloned objects so far. Typically, this pointer is set by the clone manager.

Examples:

bool IsAReferenceTo

(

)

const

Checks if this object is a reference clone of another object.

Returns

True if this object is a clone of another object, false otherwise

FbxObject* GetReferenceTo

(

)

const

If this object is a reference clone, returns the original object (from which the clone originates).

Returns

The original object, or NULL (if this object is not a reference clone).

bool IsReferencedBy

(

)

const

Checks if any objects are reference cloned from this object.

Returns

True if there are objects reference cloned from this object, false otherwise.

int GetReferencedByCount

(

)

const

Returns the number of objects that are reference clones of this object.

Returns

The number of objects that are reference clones of this object.

FbxObject* GetReferencedBy

(

int

pIndex

)

const

Returns a reference clone of this object at the specified index.

Parameters

pIndex

The specified index, valid values are [0, GetReferencedByCount())

Returns

The reference clone, or NULL (if pIndex is out of range).

void SetName

(

const char *

pName

)

Sets the name of this object.

Parameters

pName

The object name as a NULL terminated string.

Examples:

const char* GetName

(

)

const

Returns the full name of this object.

Returns

The full name as a NULL terminated string.

Examples:

FbxString GetNameWithoutNameSpacePrefix

(

)

const

Returns the name of the object without the namespace qualifier.

Returns

The object name without the namespace qualifier.

FbxString GetNameWithNameSpacePrefix

(

)

const

Returns the name of the object with the namespace qualifier.

Returns

The object name with the namespace qualifier.

void SetInitialName

(

const char *

pName

)

Sets the initial name of the object.

Parameters

pName

The object's initial name as a NULL terminated string.

const char* GetInitialName

(

)

const

Returns the initial name of the object.

Returns

The object's initial name as a NULL terminated string.

FbxString GetNameSpaceOnly

(

)

Returns the namespace of the object.

Returns

The object's namespace as a NULL terminated string.

void SetNameSpace

(

FbxString

pNameSpace

)

Sets the namespace of the object.

Parameters

pNameSpace

The object's namespace as a NULL terminated string.

FbxArray<FbxString*> GetNameSpaceArray

(

char

identifier

)

Returns an array of all the namespaces for this object.

Parameters

identifier

The identifier of the namespaces.

Returns

The array of all namespaces.

FbxString GetNameOnly

(

)

const

Returns only the name (no namespace or prefix) of the object.

Returns

The name only as a NULL terminated string.

FbxString GetNameSpacePrefix

(

)

const

Returns the namespace qualifier.

Returns

The namespace qualifier.

static FbxString RemovePrefix ( char *  pName )

static

Removes the prefix of pName.

Parameters

pName

Whose prefix is removed.

Returns

A temporary string without prefix.

static FbxString StripPrefix ( FbxString &  lName )

static

Strips the prefix of pName.

Parameters

lName

Whose prefix is stripped.

Returns

lName stripped of its prefix.

static FbxString StripPrefix ( const char *  pName )

static

Strips the prefix of pName.

Parameters

pName

Whose prefix is stripped.

Returns

A temporary string stripped of its prefix.

const FbxUInt64& GetUniqueID

(

)

const

Returns the unique ID of this object.

virtual bool GetSelected ( )

virtual

Returns if this object is currently in a selected state.

Returns

True if this object is selected, false otherwise.

virtual void SetSelected ( bool  pSelected )

virtual

Sets whether this object is currently selected.

Parameters

pSelected

The selection flag.

void SetUserDataPtr	(	const FbxUInt64 &	pUserID,
		void *	pUserData
	)

Sets the data pointer for an user data record whose ID is pUserID.

Parameters

pUserID	The ID of the user data record.
pUserData	The data pointer of the user data record.

Remarks

An user data record is composed of an ID and a data pointer. If the user data record identified by pUserID does not exist, a new user data record is created and its data pointer is set as pUserData.

Examples:

void* GetUserDataPtr

(

const FbxUInt64 &

pUserID

)

const

Returns the data pointer of an user data record whose ID is pUserID.

Parameters

pUserID

The ID of the user data record.

Returns

The data pointer of the user data record, NULL if the user data record is not found.

Examples:

void SetUserDataPtr ( void *  pUserData )

inline

Sets the data pointer for the user data record whose ID is the object ID.

Parameters

pUserData

The data pointer of the user data record.

Remarks

An user data record is composed of an ID and a data pointer. If the user data record identified by pUserID does not exist, a new user data record is created and its data pointer is set as pUserData.

Definition at line 411 of file fbxobject.h.

{ SetUserDataPtr(GetUniqueID(), pUserData); }

void* GetUserDataPtr ( ) const

inline

Returns the data pointer of the user data record whose ID is the object ID.

Returns

The data pointer of the user data record, NULL if the user data record is not found.

Definition at line 416 of file fbxobject.h.

{ return GetUserDataPtr(GetUniqueID()); }

bool ConnectSrcObject ( FbxObject *  pObject, FbxConnection::EType  pType = FbxConnection::eNone  )

inline

Connects this object to a source object.

Parameters

pObject	The source object to which this object connects.
pType	The connection type between this object and the source object.

Returns

True on success, false otherwise.

Examples:

Definition at line 428 of file fbxobject.h.

{ return RootProperty.ConnectSrcObject(pObject,pType); }

bool IsConnectedSrcObject ( const FbxObject *  pObject ) const

inline

Judges whether this object connects with the source object.

Parameters

pObject

The source object.

Returns

True if this object connects with the source object, false otherwise.

Definition at line 434 of file fbxobject.h.

{ return RootProperty.IsConnectedSrcObject(pObject); }

bool DisconnectSrcObject ( FbxObject *  pObject )

inline

Disconnects this object from a source object.

Parameters

pObject

The source object from which this object will be disconnected.

Returns

True on success, false otherwise.

Definition at line 440 of file fbxobject.h.

{ return RootProperty.DisconnectSrcObject(pObject); }

bool DisconnectAllSrcObject ( )

inline

Disconnects this object from all source objects.

Returns

True if it disconnects all source objects successfully, false otherwise.

Definition at line 445 of file fbxobject.h.

{ return RootProperty.DisconnectAllSrcObject(); }

bool DisconnectAllSrcObject ( const FbxCriteria &  pCriteria )

inline

Disconnects this object from all source objects that satisfy a given criteria.

Parameters

pCriteria

The given criteria.

Returns

True if it disconnects all the source objects successfully, false otherwise.

Definition at line 451 of file fbxobject.h.

{ return RootProperty.DisconnectAllSrcObject(pCriteria); }

FBX_DEPRECATED bool DisconnectAllSrcObject ( FbxClassId  pClassId )

inline

Disconnects this object from all source objects of a specific class type.

(Deprecated, please use DisconnectAllSrcObject<Type>() instead.)

Parameters

pClassId

The specific class type.

Returns

True if it disconnects all source objects successfully, false otherwise.

Definition at line 457 of file fbxobject.h.

{ return RootProperty.DisconnectAllSrcObject(FbxCriteria::ObjectType(pClassId)); }

int GetSrcObjectCount ( ) const

inline

Returns the number of source objects with which this object connects.

Returns

The number of source objects with which this object connects.

Examples:

Definition at line 462 of file fbxobject.h.

{ return RootProperty.GetSrcObjectCount(); }

int GetSrcObjectCount ( const FbxCriteria &  pCriteria ) const

inline

Returns the number of source objects that satisfy the given criteria with which this object connects.

Parameters

pCriteria

The given criteria.

Returns

The number of source objects that satisfy the given criteria with which this object connects.

Definition at line 468 of file fbxobject.h.

{ return RootProperty.GetSrcObjectCount(pCriteria); }

FBX_DEPRECATED int GetSrcObjectCount ( FbxClassId  pClassId ) const

inline

Returns the number of source objects of the specific class type with which this object connects.

(Deprecated, please use GetSrcObjectCount<Type>() instead.)

Parameters

pClassId

The specific class type.

Returns

The number of source objects of the specific class type with which this object connects.

Definition at line 474 of file fbxobject.h.

{ return RootProperty.GetSrcObjectCount(FbxCriteria::ObjectType(pClassId)); }

FbxObject* GetSrcObject ( int  pIndex = 0 ) const

inline

Returns the source object with which this object connects at the specified index.

Parameters

pIndex

The specified index whose default value is 0.

Returns

The source object at the specified index, NULL if not found.

Examples:

Definition at line 480 of file fbxobject.h.

{ return RootProperty.GetSrcObject(pIndex); }

FbxObject* GetSrcObject ( const FbxCriteria &  pCriteria, int  pIndex = 0  ) const

inline

Returns the source object that satisfies the criteria at the specified index with which this object connects.

Parameters

pCriteria	The given criteria.
pIndex	The specified index whose default value is 0.

Returns

The source object that satisfies the given criteria at the specified index, NULL if not found.

Definition at line 487 of file fbxobject.h.

{ return RootProperty.GetSrcObject(pCriteria,pIndex); }

FBX_DEPRECATED FbxObject* GetSrcObject ( FbxClassId  pClassId, int  pIndex = 0  ) const

inline

Returns the source object of the specified class type at the specified index with which this object connects.

(Deprecated, please use GetSrcObject<Type>() instead.)

Parameters

pClassId	The specified class type.
pIndex	The specified index whose default value is 0.

Returns

The source object of the specified class type at the specified index, NULL if not found.

Definition at line 494 of file fbxobject.h.

{ return RootProperty.GetSrcObject(FbxCriteria::ObjectType(pClassId), pIndex); }

FbxObject* FindSrcObject ( const char *  pName, int  pStartIndex = 0  ) const

inline

Searches the source object with the specified name, starting at the specified index.

Parameters

pName	The object name.
pStartIndex	The start index.

Returns

The source object with the name, NULL if not found.

Definition at line 501 of file fbxobject.h.

{ return RootProperty.FindSrcObject(pName,pStartIndex); }

FbxObject* FindSrcObject ( const FbxCriteria &  pCriteria, const char *  pName, int  pStartIndex = 0  ) const

inline

Searches the source object with the specified name which satisfies the given criteria, starting at the specified index.

Parameters

pCriteria	The given criteria.
pName	The object name.
pStartIndex	The start index.

Returns

The source object with the name, NULL if not found.

Definition at line 509 of file fbxobject.h.

{ return RootProperty.FindSrcObject(pCriteria,pName,pStartIndex); }

FBX_DEPRECATED FbxObject* FindSrcObject ( FbxClassId  pClassId, const char *  pName, int  pStartIndex = 0  ) const

inline

Searches the source object with the specified name which is also the specified class type, starting at the specified index.

(Deprecated, please use FindSrcObject<Type>() instead.)

Parameters

pClassId	The specified class type.
pName	The object name.
pStartIndex	The start index.

Returns

The source object with the name, NULL if not found.

Definition at line 517 of file fbxobject.h.

{ return RootProperty.FindSrcObject(FbxCriteria::ObjectType(pClassId), pName, pStartIndex); }

bool DisconnectAllSrcObject ( )

inline

Disconnects this object from all source objects of the specified class type.

Returns

true if it disconnects all source objects successfully, false otherwise.

Definition at line 521 of file fbxobject.h.

{ return RootProperty.DisconnectAllSrcObject(FbxCriteria::ObjectType(T::ClassId)); }

bool DisconnectAllSrcObject ( const FbxCriteria &  pCriteria )

inline

Disconnects this object from all source objects that are of the specified class type and that satisfy the given criteria.

Parameters

pCriteria

The given criteria.

Returns

true if it disconnects all source objects successfully, false otherwise.

Definition at line 526 of file fbxobject.h.

{ return RootProperty.DisconnectAllSrcObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }

int GetSrcObjectCount ( ) const

inline

Returns the number of source objects of a specific class type with which this object connects.

Returns

The number of source objects of the specified class type with which this object connects.

Definition at line 530 of file fbxobject.h.

{ return RootProperty.GetSrcObjectCount(FbxCriteria::ObjectType(T::ClassId)); }

int GetSrcObjectCount ( const FbxCriteria &  pCriteria ) const

inline

Returns the number of source objects with which this object connects that are the specified class type and that satisfy the given criteria.

Parameters

pCriteria

The given criteria.

Returns

The number of source objects that are the specified class type and that satisfy the given criteria.

Definition at line 535 of file fbxobject.h.

{ return RootProperty.GetSrcObjectCount(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }

T* GetSrcObject ( int  pIndex = 0 ) const

inline

Returns the source object of the specified class type at the specified index.

Parameters

pIndex

The specified index whose default value is 0.

Returns

The source object of a specified class type at the specified index, NULL if not found.

Definition at line 540 of file fbxobject.h.

{ return (T*)RootProperty.GetSrcObject(FbxCriteria::ObjectType(T::ClassId), pIndex); }

T* GetSrcObject ( const FbxCriteria &  pCriteria, int  pIndex = 0  ) const

inline

Returns the source object that is the specified class type and that satisfies the given criteria at the specified index.

Parameters

pCriteria	The given criteria.
pIndex	The specified index whose default value is 0.

Returns

The source object that is of the specified class type and that satisfies the given criteria at the specified index, NULL if not found.

Definition at line 546 of file fbxobject.h.

{ return (T*)RootProperty.GetSrcObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, pIndex); }

T* FindSrcObject ( const char *  pName, int  pStartIndex = 0  ) const

inline

Searches the source object with the specified name that is the specified class type, starting at the specified index.

Parameters

pName	The object name.
pStartIndex	The start index.

Returns

The source object with the name, NULL if not found.

Definition at line 552 of file fbxobject.h.

{ return (T*)RootProperty.FindSrcObject(FbxCriteria::ObjectType(T::ClassId), pName, pStartIndex); }

T* FindSrcObject ( const FbxCriteria &  pCriteria, const char *  pName, int  pStartIndex = 0  ) const

inline

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.

Parameters

pCriteria	The given criteria.
pName	The object name.
pStartIndex	The start index.

Returns

The source object with the name, NULL if not found.

Definition at line 559 of file fbxobject.h.

{ return (T*)RootProperty.FindSrcObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, pName, pStartIndex); }

bool ConnectDstObject ( FbxObject *  pObject, FbxConnection::EType  pType = FbxConnection::eNone  )

inline

Connects this object to one destination object.

Parameters

pObject	The destination object with which this object connects.
pType	The connection type between this object and the destination object.

Returns

True on success, false otherwise.

Examples:

Definition at line 566 of file fbxobject.h.

{ return RootProperty.ConnectDstObject(pObject,pType); }

bool IsConnectedDstObject ( const FbxObject *  pObject ) const

inline

Judges whether this object connects with the destination object.

Parameters

pObject

The destination object.

Returns

True if this object connects with the destination object, false otherwise.

Definition at line 572 of file fbxobject.h.

{ return RootProperty.IsConnectedDstObject(pObject); }

bool DisconnectDstObject ( FbxObject *  pObject )

inline

Disconnects this object from the destination object.

Parameters

pObject

The destination object from which this object disconnects.

Returns

True on success, false otherwise.

Definition at line 578 of file fbxobject.h.

{ return RootProperty.DisconnectDstObject(pObject); }

bool DisconnectAllDstObject ( )

inline

Disconnects this object from all destination objects.

Returns

True if it disconnects all destination objects successfully, false otherwise.

Definition at line 583 of file fbxobject.h.

{ return RootProperty.DisconnectAllDstObject(); }

bool DisconnectAllDstObject ( const FbxCriteria &  pCriteria )

inline

Disconnects this object from all destination objects that satisfy given criteria.

Parameters

pCriteria

The given criteria.

Returns

True if it disconnects all destination objects successfully, false otherwise.

Definition at line 589 of file fbxobject.h.

{ return RootProperty.DisconnectAllDstObject(pCriteria); }

FBX_DEPRECATED bool DisconnectAllDstObject ( FbxClassId  pClassId )

inline

Disconnects this object from all destination objects of the specified class type.

(Deprecated, please use DisconnectAllDstObject<Type>() instead.)

Parameters

pClassId

The specified class type.

Returns

True if it disconnects all destination objects of the specified class type successfully, false otherwise.

Definition at line 595 of file fbxobject.h.

{ return RootProperty.DisconnectAllDstObject(FbxCriteria::ObjectType(pClassId)); }

int GetDstObjectCount ( ) const

inline

Returns the number of destination objects with which this object connects.

Returns

The number of destination objects with which this object connects.

Definition at line 600 of file fbxobject.h.

{ return RootProperty.GetDstObjectCount(); }

int GetDstObjectCount ( const FbxCriteria &  pCriteria ) const

inline

Returns the number of destination objects with which this object connects that satisfy the given criteria.

Parameters

pCriteria

The given criteria.

Returns

The number of destination objects with which this object connects that satisfy the given criteria.

Definition at line 606 of file fbxobject.h.

{ return RootProperty.GetDstObjectCount(pCriteria); }

FBX_DEPRECATED int GetDstObjectCount ( FbxClassId  pClassId ) const

inline

Returns the number of destination objects of the specified class type with which this object connects.

(Deprecated, please use GetDstObjectCount<Type>() instead.)

Parameters

pClassId

The specified class type.

Returns

The number of destination objects of the specified class type with which this object connects.

Definition at line 612 of file fbxobject.h.

{ return RootProperty.GetDstObjectCount(FbxCriteria::ObjectType(pClassId)); }

FbxObject* GetDstObject ( int  pIndex = 0 ) const

inline

Returns the destination object at the specified index with which this object connects.

Parameters

pIndex

The specified index whose default value is 0.

Returns

The destination object at the specified index, NULL if not found.

Definition at line 618 of file fbxobject.h.

{ return RootProperty.GetDstObject(pIndex); }

FbxObject* GetDstObject ( const FbxCriteria &  pCriteria, int  pIndex = 0  ) const

inline

Returns the destination object with which this object connects that satisfies the given criteria at the specified index.

Parameters

pCriteria	The given criteria.
pIndex	The specified index whose default value is 0.

Returns

The destination object that satisfies the given criteria at the specified index, NULL if not found.

Definition at line 625 of file fbxobject.h.

{ return RootProperty.GetDstObject(pCriteria,pIndex); }

FBX_DEPRECATED FbxObject* GetDstObject ( FbxClassId  pClassId, int  pIndex = 0  ) const

inline

Returns the destination object of the specified class type with which this object connects at the specified index.

(Deprecated, please use GetDstObject<Type>() instead.)

Parameters

pClassId	The specified class type.
pIndex	The specified index whose default value is 0.

Returns

The destination object of the specified class type at the specified index, NULL if not found.

Definition at line 632 of file fbxobject.h.

{ return RootProperty.GetDstObject(FbxCriteria::ObjectType(pClassId), pIndex); }

FbxObject* FindDstObject ( const char *  pName, int  pStartIndex = 0  ) const

inline

Searches the destination object with the specified name, starting at the specified index.

Parameters

pName	The object name.
pStartIndex	The start index.

Returns

The destination object with the name, NULL if not found.

Definition at line 639 of file fbxobject.h.

{ return RootProperty.FindDstObject(pName,pStartIndex); }

FbxObject* FindDstObject ( const FbxCriteria &  pCriteria, const char *  pName, int  pStartIndex = 0  ) const

inline

Searches the destination object with the specified name which satisfies the given criteria, starting at the specified index.

Parameters

pCriteria	The given criteria.
pName	The object name.
pStartIndex	The start index.

Returns

The destination object with the name, NULL if not found.

Definition at line 647 of file fbxobject.h.

{ return RootProperty.FindDstObject(pCriteria,pName,pStartIndex); }

FBX_DEPRECATED FbxObject* FindDstObject ( FbxClassId  pClassId, const char *  pName, int  pStartIndex = 0  ) const

inline

Searches the destination object with the specified name which is the specified class type, starting at the specified index.

(Deprecated, please use FindDstObject<Type>() instead.)

Parameters

pClassId	The specified class type.
pName	The object name.
pStartIndex	The start index.

Returns

The destination object with the name, NULL if not found.

Definition at line 655 of file fbxobject.h.

{ return RootProperty.FindDstObject(FbxCriteria::ObjectType(pClassId), pName, pStartIndex); }

bool DisconnectAllDstObject ( )

inline

Disconnects this object from all destination objects of the specified class type.

Returns

true if it disconnects all destination objects of the specified class type successfully, false otherwise.

Definition at line 659 of file fbxobject.h.

{ return RootProperty.DisconnectAllDstObject(FbxCriteria::ObjectType(T::ClassId)); }

bool DisconnectAllDstObject ( const FbxCriteria &  pCriteria )

inline

Disconnects this object from all destination objects that are the specified class type and that satisfy the given criteria.

Parameters

pCriteria

The given criteria.

Returns

true if it disconnects all destination objects successfully, false otherwise.

Definition at line 664 of file fbxobject.h.

{ return RootProperty.DisconnectAllDstObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }

int GetDstObjectCount ( ) const

inline

Returns the number of destination objects of the specified class type with which this object connects.

Returns

The number of destination objects of the specified class type with which this object connects.

Definition at line 668 of file fbxobject.h.

{ return RootProperty.GetDstObjectCount(FbxCriteria::ObjectType(T::ClassId)); }

int GetDstObjectCount ( const FbxCriteria &  pCriteria ) const

inline

Returns the number of destination objects with which this object connects that are the specified class type and that satisfy the given criteria.

Parameters

pCriteria

The given criteria.

Returns

The number of destination objects that are the specified class type and that satisfy the given criteria.

Definition at line 673 of file fbxobject.h.

{ return RootProperty.GetDstObjectCount(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }

T* GetDstObject ( int  pIndex = 0 ) const

inline

Returns the destination object with which this object connects that is the specified class type at the specified index.

Parameters

pIndex

The specified index whose default value is 0.

Returns

The destination object of the specified class type at the specified index, NULL if not found.

Definition at line 678 of file fbxobject.h.

{ return (T*)RootProperty.GetDstObject(FbxCriteria::ObjectType(T::ClassId), pIndex); }

T* GetDstObject ( const FbxCriteria &  pCriteria, int  pIndex = 0  ) const

inline

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.

Parameters

pCriteria	The given criteria.
pIndex	The specified index whose default value is 0.

Returns

The destination object that is the specified class type and that satisfies the given criteria at the specified index, NULL if not found.

Definition at line 684 of file fbxobject.h.

{ return (T*)RootProperty.GetDstObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, pIndex); }

T* FindDstObject ( const char *  pName, int  pStartIndex = 0  ) const

inline

Searches the destination object with the specified name which is of the specified class type, starting at the specified index.

Parameters

pName	The object name.
pStartIndex	The start index.

Returns

The source object with the name, NULL if not found.

Definition at line 690 of file fbxobject.h.

{ return (T*)RootProperty.FindDstObject(FbxCriteria::ObjectType(T::ClassId), pName, pStartIndex); }

T* FindDstObject ( const FbxCriteria &  pCriteria, const char *  pName, int  pStartIndex = 0  ) const

inline

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.

Parameters

pCriteria	The given criteria.
pName	The object name.
pStartIndex	The start index.

Returns

The source object with the name, NULL if not found.

Definition at line 697 of file fbxobject.h.

{ return (T*)RootProperty.FindDstObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, pName, pStartIndex); }

FbxProperty GetFirstProperty ( ) const

inline

Returns the first property of this object.

Returns

The first property of this object.

Examples:

Definition at line 707 of file fbxobject.h.

        {
            return RootProperty.GetFirstDescendent();
        }

FbxProperty GetNextProperty ( const FbxProperty &  pProperty ) const

inline

Returns the next property of this object that follows the specified property.

Parameters

pProperty

The specified property.

Returns

The next property of this object that follows pProperty.

Examples:

Definition at line 716 of file fbxobject.h.

        {
            return RootProperty.GetNextDescendent(pProperty);
        }

FbxProperty FindProperty ( const char *  pName, bool  pCaseSensitive = true  ) const

inline

Searches a property by name.

Parameters

pName	The property name.
pCaseSensitive	Whether the name is case-sensitive.

Returns

A valid FbxProperty if found, else an invalid FbxProperty. See FbxProperty::IsValid()

Examples:

Definition at line 726 of file fbxobject.h.

        {
            return RootProperty.Find(pName, pCaseSensitive );
        }

FbxProperty FindProperty ( const char *  pName, const FbxDataType &  pDataType, bool  pCaseSensitive = true  ) const

inline

Searches a property by name and data type.

Parameters

pName	The property name.
pDataType	The data type of the property.
pCaseSensitive	Whether the name is case-sensitive.

Returns

A valid FbxProperty if the property is found, else an invalid FbxProperty. See FbxProperty::IsValid()

Definition at line 737 of file fbxobject.h.

        {
            return RootProperty.Find(pName, pDataType, pCaseSensitive );
        }

FbxProperty FindPropertyHierarchical ( const char *  pName, bool  pCaseSensitive = true  ) const

inline

Searches a property by full name.

Parameters

pName	The full name of the property as a NULL terminated string.
pCaseSensitive	whether or not the name is case-sensitive.

Returns

A valid FbxProperty if the property is found, else an invalid FbxProperty. See FbxProperty::IsValid()

Examples:

Definition at line 748 of file fbxobject.h.

        {
            return RootProperty.FindHierarchical(pName, pCaseSensitive );
        }

FbxProperty FindPropertyHierarchical ( const char *  pName, const FbxDataType &  pDataType, bool  pCaseSensitive = true  ) const

inline

Searches a property by full name and data type.

Parameters

pName	The full name of the property as a NULL terminated string.
pDataType	The data type of the property.
pCaseSensitive	whether or not the name is case-sensitive.

Returns

A valid FbxProperty if the property is found, else an invalid FbxProperty. See FbxProperty::IsValid()

Definition at line 760 of file fbxobject.h.

        {
            return RootProperty.FindHierarchical(pName, pDataType, pCaseSensitive );
        }

FbxProperty GetClassRootProperty

(

)

Returns the class root property.

Returns

The class root property if it exists, else an invalid FbxProperty. See FbxProperty::IsValid().

Remarks

Class FbxObject and its sub-classes all have a class root property. This class root property contains basic information about the class type, such as the class name.

bool ConnectSrcProperty ( const FbxProperty &  pProperty )

inline

Connects this object to a source property.

Parameters

pProperty

The source property with which this object connects.

Returns

True on success, false otherwise.

Definition at line 775 of file fbxobject.h.

{ return RootProperty.ConnectSrcProperty(pProperty); }

bool IsConnectedSrcProperty ( const FbxProperty &  pProperty )

inline

Determines whether this object connects with the specified source property.

Parameters

pProperty

The specified source property.

Returns

True if this object connects with the specified source property, false otherwise.

Definition at line 781 of file fbxobject.h.

{ return RootProperty.IsConnectedSrcProperty(pProperty); }

bool DisconnectSrcProperty ( const FbxProperty &  pProperty )

inline

Disconnects this object from the specified source property.

Parameters

pProperty

The specified source property.

Returns

True on success, false otherwise.

Definition at line 787 of file fbxobject.h.

{ return RootProperty.DisconnectSrcProperty(pProperty); }

int GetSrcPropertyCount ( ) const

inline

Returns the number of source properties with which this object connects.

Returns

The number of source properties with which this object connects.

Definition at line 792 of file fbxobject.h.

{ return RootProperty.GetSrcPropertyCount(); }

FbxProperty GetSrcProperty ( int  pIndex = 0 ) const

inline

Returns the source property at the specified index with which this object connects.

Parameters

pIndex

The specified index.

Returns

The source property at the specified index.

Definition at line 798 of file fbxobject.h.

{ return RootProperty.GetSrcProperty(pIndex); }

FbxProperty FindSrcProperty ( const char *  pName, int  pStartIndex = 0  ) const

inline

Searches a source property with which this object connects that has a specific name, starting at the specified index.

Parameters

pName	The specified property name.
pStartIndex	The start index.

Returns

The source property with the specified name.

Definition at line 805 of file fbxobject.h.

{ return RootProperty.FindSrcProperty(pName,pStartIndex); }

bool ConnectDstProperty ( const FbxProperty &  pProperty )

inline

Connects this object to a destination property.

Parameters

pProperty

The destination property with which this object connects.

Returns

True on success, false otherwise.

Examples:

Definition at line 811 of file fbxobject.h.

{ return RootProperty.ConnectDstProperty(pProperty); }

bool IsConnectedDstProperty ( const FbxProperty &  pProperty )

inline

Determines if this object connects with the specified destination property.

Parameters

pProperty

The specified destination property.

Returns

True if this object connects with the specified destination property, false otherwise.

Definition at line 817 of file fbxobject.h.

{ return RootProperty.IsConnectedDstProperty(pProperty); }

bool DisconnectDstProperty ( const FbxProperty &  pProperty )

inline

Disconnects this object from the specified destination property.

Parameters

pProperty

The specified destination property.

Returns

True on success, false otherwise.

Definition at line 823 of file fbxobject.h.

{ return RootProperty.DisconnectDstProperty(pProperty); }

int GetDstPropertyCount ( ) const

inline

Returns the number of destination properties with which this object connects.

Returns

The number of destination properties with which this object connects.

Definition at line 828 of file fbxobject.h.

{ return RootProperty.GetDstPropertyCount(); }

FbxProperty GetDstProperty ( int  pIndex = 0 ) const

inline

Returns the destination property at the specified index with which this object connects.

Parameters

pIndex

The specified index.

Returns

The destination property at the specified index.

Definition at line 834 of file fbxobject.h.

{ return RootProperty.GetDstProperty(pIndex); }

FbxProperty FindDstProperty ( const char *  pName, int  pStartIndex = 0  ) const

inline

Searches a destination property with which this object connects that has a specific name, starting at the specified index.

Parameters

pName	The specified property name.
pStartIndex	The start index.

Returns

The destination property with the specified name.

Definition at line 841 of file fbxobject.h.

{ return RootProperty.FindDstProperty(pName,pStartIndex); }

int ContentUnload

(

)

Unloads this object's content using the offload peripheral that is currently set in the document then flushes it from memory.

Returns

2 if the object's content is already unloaded or 1 if this object's content has been successfully unloaded to the current peripheral.

Remarks

If the content is locked more than once, or the peripheral cannot handle this object's unloading, or if an error occurs, this method returns 0 and does not flush the content.

int ContentLoad

(

)

Loads this object's content using the offload peripheral that is currently set in the document.

Returns

1 if this object's content has been successfully loaded from the current peripheral, 2 if the content is already loaded, and 0 if an error occurs or the object's content is locked.

Remarks

On a successful Load attempt, the object content is locked.

bool ContentIsLoaded

(

)

const

Judges if this object's content is loaded.

Returns

True if this object's content is loaded, false otherwise.

Remarks

An object that has not been filled yet must be considered unloaded.

void ContentDecrementLockCount

(

)

Decreases the content lock count of an object.

If the content lock count of an object is greater than 0, the content of the object is considered locked.

void ContentIncrementLockCount

(

)

Increases the content lock count of an object.

If the content lock count of an object is greater than 0, the content of the object is considered locked.

bool ContentIsLocked

(

)

const

Judges if this object's content is locked.

The content is considered locked if the content lock count is greater than 0

Returns

True if this object's content is locked, false otherwise.

Remarks

A locked state prevents the object content from being unloaded from memory but does not block the loading.

virtual bool ContentWriteTo ( FbxStream &  pStream ) const

virtual

Writes the content of the object to the given stream.

Parameters

pStream

The destination stream.

Returns

True if the content is successfully processed by the receiving stream, false otherwise.

Reimplemented in FbxGeometryBase, and FbxPatch.

virtual bool ContentReadFrom ( const FbxStream &  pStream )

virtual

Reads the content of the object from the given stream.

Parameters

pStream

The source stream.

Returns

True if the object fills itself with the received data from the stream successfully, false otherwise.

Reimplemented in FbxGeometryBase, and FbxPatch.

void EmitMessage

(

FbxMessage *

pMessage

)

const

Emits a message in all available message emitters in the document or SDK manager.

Parameters

pMessage

The message to emit.

Remarks

The ownership of the message is transferred, don't delete it.

virtual const char* Localize ( const char *  pID, const char *  pDefault = ((void *) 0)  ) const

virtual

Localization helper function, it calls the implementation of FBX SDK manager.

Sub-classes that manage their own localization could over-ride this function.

Parameters

pID	The identifier of the text to be localized.
pDefault	The default text. Uses pID as the default text if pDefault is NULL.

Returns

The localized text or the default text if the text can't be localized, .

Reimplemented in FbxLibrary.

FbxLibrary* GetParentLibrary

(

)

const

Returns a handle on the parent library of this object.

Returns

The parent library of this object, or NULL if the parent library doesn't exist.

bool AddImplementation

(

FbxImplementation *

pImplementation

)

Adds an implementation.

Parameters

pImplementation

The implementation to be added.

Returns

True on success, false otherwise.

Remarks

To succeed this function must be called with an implementation that has not already been added to this node.

Examples:

bool RemoveImplementation

(

FbxImplementation *

pImplementation

)

Removes an implementation.

Parameters

pImplementation

The implementation to be removed.

Returns

True on success, false otherwise.

Remarks

To succeed this function must be called with an implementation that has already been added to this node.

bool HasDefaultImplementation

(

void

)

const

Determines if this shading node has a default implementation.

Returns

True if this shading node has a default implementation, false otherwise.

FbxImplementation* GetDefaultImplementation

(

void

)

const

Returns the default implementation of this shading node.

Returns

The default implementation of this shading node.

bool SetDefaultImplementation

(

FbxImplementation *

pImplementation

)

Sets the default implementation of this shading node.

Parameters

pImplementation

The implementation to be set.

Returns

True on success, false otherwise.

Remarks

To succeed this function must be called with an implementation that has already been added to this node. Only the implementation which has already been added can be set as the default implementation.

Examples:

int GetImplementationCount

(

const FbxImplementationFilter *

pCriteria = ((void *) 0)

)

const

Returns the number of implementations that satisfy a given criteria.

Parameters

pCriteria

The given criteria.

Returns

The number of implementations.

FbxImplementation* GetImplementation	(	int	pIndex,
		const FbxImplementationFilter *	pCriteria = ((void *) 0)
	)		const

Returns the implementation at the specified index that satisfies the given criteria.

Parameters

pIndex	The specified index.
pCriteria	The given criteria.

Returns

The implementation at the specified index, NULL if not found.

virtual FbxString GetUrl ( ) const

virtual

Returns the URL of this object.

Returns

The URL of this object.

Remarks

The URL indicates where the object is stored.

virtual bool SetUrl ( char *  pUrl )

virtual

Sets the URL of this object.

Parameters

pUrl	The URL to be set.

Returns

True on success, false otherwise.

Remarks

The URL indicates where the object is stored.

void SetRuntimeClassId

(

const FbxClassId &

pClassId

)

Set the run-time ClassId for this class.

In most contexts, users do not have to change the run-time ClassId, they are automatically generated when registered a new class during run-time.

Parameters

pClassId

The ClassId to set as the run-time ClassId for this object.

FbxClassId GetRuntimeClassId

(

)

const

Retrieve the run-time ClassId for this object.

Returns

The run-time ClassId for this object.

bool IsRuntime

(

const FbxClassId &

pClassId

)

const

Test if this class is a hierarchical children of the specified class type.

This test will be performed on the run-time class registered with the FBX SDK Manager rather than the static ClassId generated at compile time.

Parameters

pClassId

The class type to test against self.

Returns

True if the object is a hierarchical children of the type specified.

Remarks

This function will perform a complete search until it reaches the top level class, but it will stop as soon as one ClassId matches the test.

bool IsRuntimePlug

(

)

const

Find out if the ClassId was registered during run-time rather than at compile time.

Returns

True if the run-time ClassId is inequal to the ClassId.

virtual void Compact ( )

virtual

Compact the memory used by this object.

Remarks

Note that this function might not result in saved memory because it depends if the sub-class implements it, or if any memory can actually be saved.

virtual void Construct ( const FbxObject *  pFrom )

protectedvirtual

Optional constructor override, automatically called by default constructor.

Parameters

pFrom

If not null, the function must take it into account like a copy constructor.

Remarks

In case it is decided to override this function, do not forget to call ParentClass::Construct(pFrom) at the beginning.

Reimplemented in FbxControlSetPlug.

virtual void ConstructProperties ( bool  pForceSet )

protectedvirtual

Optional property constructor override, automatically called by default constructor.

Parameters

pForceSet

If the property value must be set regardless of default value.

Remarks

If your object have properties, they must be initialized in this function.

Reimplemented in FbxControlSetPlug.

Examples:

virtual void Destruct ( bool  pRecursive )

protectedvirtual

Optional destructor override, automatically called by default destructor.

Parameters

pRecursive

If true, children objects should be destroyed as well.

Remarks

In case it is decided to override this function, do not forget to call ParentClass::Destruct(pResursive) at the end.

Examples:

virtual void ContentClear ( )

protectedvirtual

Clears this object's content from memory.

This method must be overridden in the derived classes.

Remarks

This method is called by ContentUnload() if the object content's unloading is successful.

virtual FbxPeripheral* GetPeripheral ( )

protectedvirtual

Retrieves the peripheral of that object.

Returns

The current peripheral for that object

Remarks

A peripheral manipulates the content of an object. For instance, a peripheral can load the connections of an object on demand.

Reimplemented in FbxDocument.

Friends And Related Function Documentation

friend class fbxsdk::FbxManager

friend

Definition at line 159 of file fbxobject.h.

T* fbxsdk::FbxNew ( )

friend

T* fbxsdk::FbxNew ( T1 &  p1 )

friend

T* fbxsdk::FbxNew ( const T1 &  p1 )

friend

T* fbxsdk::FbxNew ( T1 &  p1, T2 &  p2  )

friend

T* fbxsdk::FbxNew ( T1 &  p1, const T2 &  p2  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, T2 &  p2  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2  )

friend

T* fbxsdk::FbxNew ( T1 &  p1, T2 &  p2, T3 &  p3  )

friend

T* fbxsdk::FbxNew ( T1 &  p1, T2 &  p2, const T3 &  p3  )

friend

T* fbxsdk::FbxNew ( T1 &  p1, const T2 &  p2, T3 &  p3  )

friend

T* fbxsdk::FbxNew ( T1 &  p1, const T2 &  p2, const T3 &  p3  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, T2 &  p2, T3 &  p3  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, T2 &  p2, const T3 &  p3  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, T3 &  p3  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, const T3 &  p3  )

friend

T* fbxsdk::FbxNew ( T1 &  p1, T2 &  p2, T3 &  p3, T4 &  p4  )

friend

T* fbxsdk::FbxNew ( T1 &  p1, T2 &  p2, T3 &  p3, const T4 &  p4  )

friend

T* fbxsdk::FbxNew ( T1 &  p1, T2 &  p2, const T3 &  p3, T4 &  p4  )

friend

T* fbxsdk::FbxNew ( T1 &  p1, T2 &  p2, const T3 &  p3, const T4 &  p4  )

friend

T* fbxsdk::FbxNew ( T1 &  p1, const T2 &  p2, T3 &  p3, T4 &  p4  )

friend

T* fbxsdk::FbxNew ( T1 &  p1, const T2 &  p2, T3 &  p3, const T4 &  p4  )

friend

T* fbxsdk::FbxNew ( T1 &  p1, const T2 &  p2, const T3 &  p3, T4 &  p4  )

friend

T* fbxsdk::FbxNew ( T1 &  p1, const T2 &  p2, const T3 &  p3, const T4 &  p4  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, T2 &  p2, T3 &  p3, T4 &  p4  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, T2 &  p2, T3 &  p3, const T4 &  p4  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, T2 &  p2, const T3 &  p3, T4 &  p4  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, T2 &  p2, const T3 &  p3, const T4 &  p4  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, T3 &  p3, T4 &  p4  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, T3 &  p3, const T4 &  p4  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, const T3 &  p3, T4 &  p4  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, const T3 &  p3, const T4 &  p4  )

friend

T* fbxsdk::FbxNew ( T1 &  p1, T2 &  p2, T3 &  p3, T4 &  p4, T5 &  p5  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, T2 &  p2, T3 &  p3, T4 &  p4, T5 &  p5  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, T3 &  p3, T4 &  p4, T5 &  p5  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, T2 &  p2, const T3 &  p3, T4 &  p4, T5 &  p5  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, T2 &  p2, T3 &  p3, const T4 &  p4, T5 &  p5  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, T2 &  p2, T3 &  p3, T4 &  p4, const T5 &  p5  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, const T3 &  p3, T4 &  p4, T5 &  p5  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, T3 &  p3, const T4 &  p4, T5 &  p5  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, T3 &  p3, T4 &  p4, const T5 &  p5  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, const T3 &  p3, const T4 &  p4, T5 &  p5  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, const T3 &  p3, T4 &  p4, const T5 &  p5  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, const T3 &  p3, const T4 &  p4, const T5 &  p5  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, const T3 &  p3, const T4 &  p4, const T5 &  p5, const T6 &  p6  )

friend

T* fbxsdk::FbxNew ( const T1 &  p1, const T2 &  p2, const T3 &  p3, const T4 &  p4, const T5 &  p5, const T6 &  p6, const T7 &  p7  )

friend

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  )

friend

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  )

friend

void fbxsdk::FbxDelete ( T *  p )

friend

void fbxsdk::FbxDelete ( const T *  p )

friend

T* fbxsdk::FbxNewArray ( const int  n )

friend

void fbxsdk::FbxDeleteArray ( T *  p )

friend

Member Data Documentation

FbxClassId ClassId

static

Definition at line 159 of file fbxobject.h.

FbxProperty RootProperty

The root property that holds all children property for this object.

Examples:

Definition at line 1033 of file fbxobject.h.

---

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

• fbxsdk/core/fbxobject.h