Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Friends

FbxObject Class Reference

This reference page is linked to from the following overview topics: Importing a Scene, FBX SDK Object Model, Managing Memory with the FBX SDK Manager, FBX Objects, FBX Properties, Connections, Customizing the FBX SDK, Merging Two Scenes, Animation Classes and their Interrelationships, Extracting the Animation Data from a FBX File, Evaluating the Animation in a Scene, List of Python Fbx classes.


Search for all occurrences

Detailed 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

Definition at line 159 of file fbxobject.h.

#include <fbxobject.h>

Inheritance diagram for FbxObject:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool Compare (FbxObject *pOtherObject)
bool operator== (const FbxObject &pObject)
bool operator!= (const FbxObject &pObject)
virtual void SetDocument (FbxDocument *pDocument)
FbxPropertyHandleGetPropertyHandle ()
virtual const char * GetTypeName () const
virtual FbxStringList GetTypeFlags () const
void WipeAllConnections ()
General Object Management
FBX_DEPRECATED bool Is (const FbxClassId &pClassId) const
 Test if this class is a hierarchical children of the specified class type.
template<class T >
FBX_DEPRECATED bool Is (T *pClassType) const
 Templated test if this class is a hierarchical children of the specified class type.
template<class T >
bool Is () const
 Templated test if this class is a hierarchical children of the specified class type.
FbxManagerGetFbxManager () const
 Retrieve the FbxManager this object belongs to.
FbxDocumentGetDocument () const
 Returns a const pointer to the document that contains this object.
FbxDocumentGetRootDocument () const
 Returns a const pointer to the root document that contains this object.
FbxSceneGetScene () const
 Returns a const pointer to the scene that contains this object.
void Destroy (bool pRecursive=false)
 Unregister and delete this object from memory.
void ResetProperties ()
 Reset all the properties of this object to their default values.
Selection management
virtual bool GetSelected ()
 Returns if this object is currently in a selected state.
virtual void SetSelected (bool pSelected)
 Sets whether this object is currently selected.
User data
void SetUserDataPtr (const FbxUInt64 &pUserID, void *pUserData)
 Sets the data pointer for an user data record whose ID is pUserID.
void * GetUserDataPtr (const FbxUInt64 &pUserID) const
 Returns the data pointer of an user data record whose ID is pUserID.
void SetUserDataPtr (void *pUserData)
 Sets the data pointer for the user data record whose ID is the object ID.
void * GetUserDataPtr () const
 Returns the data pointer of the user data record whose ID is the object ID.
General Object Connection and Relationship Management
bool ConnectSrcObject (FbxObject *pObject, FbxConnection::EType pType=FbxConnection::eNone)
 Connects this object to a source object.
bool IsConnectedSrcObject (const FbxObject *pObject) const
 Judges whether this object connects with the source object.
bool DisconnectSrcObject (FbxObject *pObject)
 Disconnects this object from a source object.
bool DisconnectAllSrcObject ()
 Disconnects this object from all source objects.
bool DisconnectAllSrcObject (const FbxCriteria &pCriteria)
 Disconnects this object from all source objects that satisfy a given criteria.
FBX_DEPRECATED bool DisconnectAllSrcObject (FbxClassId pClassId)
 Disconnects this object from all source objects of a specific class type.
int GetSrcObjectCount () const
 Returns the number of source objects with which this object connects.
int GetSrcObjectCount (const FbxCriteria &pCriteria) const
 Returns the number of source objects that satisfy the given criteria with which this object connects.
FBX_DEPRECATED int GetSrcObjectCount (FbxClassId pClassId) const
 Returns the number of source objects of the specific class type with which this object connects.
FbxObjectGetSrcObject (int pIndex=0) const
 Returns the source object with which this object connects at the specified index.
FbxObjectGetSrcObject (const FbxCriteria &pCriteria, int pIndex=0) const
 Returns the source object that satisfies the criteria at the specified index with which this object connects.
FBX_DEPRECATED FbxObjectGetSrcObject (FbxClassId pClassId, int pIndex=0) const
 Returns the source object of the specified class type at the specified index with which this object connects.
FbxObjectFindSrcObject (const char *pName, int pStartIndex=0) const
 Searches the source object with the specified name, starting at the specified index.
FbxObjectFindSrcObject (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.
FBX_DEPRECATED FbxObjectFindSrcObject (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.
template<class T >
FBX_DEPRECATED bool DisconnectAllSrcObject (const T *pFBX_TYPE)
 Disconnects this object from all source objects of the specified class type.
template<class T >
bool DisconnectAllSrcObject ()
 Disconnects this object from all source objects of the specified class type.
template<class T >
FBX_DEPRECATED bool DisconnectAllSrcObject (const T *pFBX_TYPE, const FbxCriteria &pCriteria)
 Disconnects this object from all source objects that are of the specified class type and that satisfy the given criteria.
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.
template<class T >
FBX_DEPRECATED int GetSrcObjectCount (const T *pFBX_TYPE) const
 Returns the number of source objects of a specific class type with which this object connects.
template<class T >
int GetSrcObjectCount () const
 Returns the number of source objects of a specific class type with which this object connects.
template<class T >
FBX_DEPRECATED int GetSrcObjectCount (const T *pFBX_TYPE, 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.
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.
template<class T >
FBX_DEPRECATED T * GetSrcObject (const T *pFBX_TYPE, int pIndex=0) const
 Returns the source object of the specified class type at the specified index.
template<class T >
T * GetSrcObject (int pIndex=0) const
 Returns the source object of the specified class type at the specified index.
template<class T >
FBX_DEPRECATED T * GetSrcObject (const T *pFBX_TYPE, 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.
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.
template<class T >
FBX_DEPRECATED T * FindSrcObject (const T *pFBX_TYPE, 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.
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.
template<class T >
FBX_DEPRECATED T * FindSrcObject (const T *pFBX_TYPE, 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.
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.
bool ConnectDstObject (FbxObject *pObject, FbxConnection::EType pType=FbxConnection::eNone)
 Connects this object to one destination object.
bool IsConnectedDstObject (const FbxObject *pObject) const
 Judges whether this object connects with the destination object.
bool DisconnectDstObject (FbxObject *pObject)
 Disconnects this object from the destination object.
bool DisconnectAllDstObject ()
 Disconnects this object from all destination objects.
bool DisconnectAllDstObject (const FbxCriteria &pCriteria)
 Disconnects this object from all destination objects that satisfy given criteria.
FBX_DEPRECATED bool DisconnectAllDstObject (FbxClassId pClassId)
 Disconnects this object from all destination objects of the specified class type.
int GetDstObjectCount () const
 Returns the number of destination objects with which this object connects.
int GetDstObjectCount (const FbxCriteria &pCriteria) const
 Returns the number of destination objects with which this object connects that satisfy the given criteria.
FBX_DEPRECATED int GetDstObjectCount (FbxClassId pClassId) const
 Returns the number of destination objects of the specified class type with which this object connects.
FbxObjectGetDstObject (int pIndex=0) const
 Returns the destination object at the specified index with which this object connects.
FbxObjectGetDstObject (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.
FBX_DEPRECATED FbxObjectGetDstObject (FbxClassId pClassId, int pIndex=0) const
 Returns the destination object of the specified class type with which this object connects at the specified index.
FbxObjectFindDstObject (const char *pName, int pStartIndex=0) const
 Searches the destination object with the specified name, starting at the specified index.
FbxObjectFindDstObject (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.
FBX_DEPRECATED FbxObjectFindDstObject (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.
template<class T >
FBX_DEPRECATED bool DisconnectAllDstObject (const T *pFBX_TYPE)
 Disconnects this object from all destination objects of the specified class type.
template<class T >
bool DisconnectAllDstObject ()
 Disconnects this object from all destination objects of the specified class type.
template<class T >
FBX_DEPRECATED bool DisconnectAllDstObject (const T *pFBX_TYPE, const FbxCriteria &pCriteria)
 Disconnects this object from all destination objects that are the specified class type and that satisfy the given criteria.
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.
template<class T >
FBX_DEPRECATED int GetDstObjectCount (const T *pFBX_TYPE) const
 Returns the number of destination objects of the specified class type with which this object connects.
template<class T >
int GetDstObjectCount () const
 Returns the number of destination objects of the specified class type with which this object connects.
template<class T >
FBX_DEPRECATED int GetDstObjectCount (const T *pFBX_TYPE, 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.
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.
template<class T >
FBX_DEPRECATED T * GetDstObject (const T *pFBX_TYPE, int pIndex=0) const
 Returns the destination object with which this object connects that is the specified class type at the specified index.
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.
template<class T >
FBX_DEPRECATED T * GetDstObject (const T *pFBX_TYPE, 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.
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.
template<class T >
FBX_DEPRECATED T * FindDstObject (const T *pFBX_TYPE, 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.
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.
template<class T >
FBX_DEPRECATED T * FindDstObject (const T *pFBX_TYPE, 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.
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.
Property Management
FbxProperty GetFirstProperty () const
 Returns the first property of this object.
FbxProperty GetNextProperty (const FbxProperty &pProperty) const
 Returns the next property of this object that follows the specified property.
FbxProperty FindProperty (const char *pName, bool pCaseSensitive=true) const
 Searches a property by name.
FbxProperty FindProperty (const char *pName, const FbxDataType &pDataType, bool pCaseSensitive=true) const
 Searches a property by name and data type.
FbxProperty FindPropertyHierarchical (const char *pName, bool pCaseSensitive=true) const
 Searches a property by full name.
FbxProperty FindPropertyHierarchical (const char *pName, const FbxDataType &pDataType, bool pCaseSensitive=true) const
 Searches a property by full name and data type.
FBX_DEPRECATED FbxPropertyGetRootProperty ()
 Returns the root property of this object.
FBX_DEPRECATED const FbxPropertyGetRootProperty () const
 Returns the root property of this object.
FbxProperty GetClassRootProperty ()
 Returns the class root property.
bool ConnectSrcProperty (const FbxProperty &pProperty)
 Connects this object to a source property.
bool IsConnectedSrcProperty (const FbxProperty &pProperty)
 Determines whether this object connects with the specified source property.
bool DisconnectSrcProperty (const FbxProperty &pProperty)
 Disconnects this object from the specified source property.
int GetSrcPropertyCount () const
 Returns the number of source properties with which this object connects.
FbxProperty GetSrcProperty (int pIndex=0) const
 Returns the source property at the specified index with which this object connects.
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.
bool ConnectDstProperty (const FbxProperty &pProperty)
 Connects this object to a destination property.
bool IsConnectedDstProperty (const FbxProperty &pProperty)
 Determines if this object connects with the specified destination property.
bool DisconnectDstProperty (const FbxProperty &pProperty)
 Disconnects this object from the specified destination property.
int GetDstPropertyCount () const
 Returns the number of destination properties with which this object connects.
FbxProperty GetDstProperty (int pIndex=0) const
 Returns the destination property at the specified index with which this object connects.
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.
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.
int ContentLoad ()
 Loads this object's content using the offload peripheral that is currently set in the document.
bool ContentIsLoaded () const
 Judges if this object's content is loaded.
void ContentDecrementLockCount ()
 Decreases the content lock count of an object.
void ContentIncrementLockCount ()
 Increases the content lock count of an object.
bool ContentIsLocked () const
 Judges if this object's content is locked.
virtual bool ContentWriteTo (FbxStream &pStream) const
 Writes the content of the object to the given stream.
virtual bool ContentReadFrom (const FbxStream &pStream)
 Reads the content of the object from the given stream.
Logging.
void EmitMessage (FbxMessage *pMessage) const
 Emits a message in all available message emitters in the document or SDK manager.
Localization helper.
virtual const char * Localize (const char *pID, const char *pDefault=NULL) const
 Localization helper function, it calls the implementation of FBX SDK manager.
Application Implementation Management
FbxLibraryGetParentLibrary () const
 Returns a handle on the parent library of this object.
bool AddImplementation (FbxImplementation *pImplementation)
 Adds an implementation.
bool RemoveImplementation (FbxImplementation *pImplementation)
 Removes an implementation.
bool HasDefaultImplementation (void) const
 Determines if this shading node has a default implementation.
FbxImplementationGetDefaultImplementation (void) const
 Returns the default implementation of this shading node.
bool SetDefaultImplementation (FbxImplementation *pImplementation)
 Sets the default implementation of this shading node.
int GetImplementationCount (const FbxImplementationFilter *pCriteria=NULL) const
 Returns the number of implementations that satisfy a given criteria.
FbxImplementationGetImplementation (int pIndex, const FbxImplementationFilter *pCriteria=NULL) const
 Returns the implementation at the specified index that satisfies the given criteria.
Object Storage && Retrieval
virtual FbxString GetUrl () const
 Returns the URL of this object.
virtual bool SetUrl (char *pUrl)
 Sets the URL of this object.
Run-time ClassId Management
void SetRuntimeClassId (const FbxClassId &pClassId)
 Set the run-time ClassId for this class.
FbxClassId GetRuntimeClassId () const
 Retrieve 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.
bool IsRuntimePlug () const
 Find out if the ClassId was registered during run-time rather than at compile time.

Static Public Member Functions

static void SetWipeMode (bool pState)
static bool GetWipeMode ()

Public Attributes

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

Protected Types

enum  EPropertyNotifyType { ePropertySetRequest, ePropertySet, ePropertyGet }

Protected Member Functions

virtual void Construct (const FbxObject *pFrom)
 Optional constructor override, automatically called by default constructor.
virtual void ConstructProperties (bool pForceSet)
 Optional property constructor override, automatically called by default constructor.
virtual void Destruct (bool pRecursive)
 Optional destructor override, automatically called by default destructor.
virtual void ContentClear ()
 Clears this object's content from memory.
virtual FbxPeripheralGetPeripheral ()
 Retrieves the peripheral of that object.
 FbxObject (FbxManager &pManager, const char *pName)
virtual bool ConnectNotify (const FbxConnectEvent &pEvent)
virtual bool PropertyNotify (EPropertyNotifyType pType, FbxProperty &pProperty)
bool Copyable (const FbxObject &pObject)

Friends

class FbxProperty

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
}
 

Flags available to control objects.

More...
void SetObjectFlags (EObjectFlag pFlags, bool pValue)
 Set the state of object flags.
bool GetObjectFlags (EObjectFlag pFlags) const
 Get the state of object flags.
void SetAllObjectFlags (FbxUInt pFlags)
 Override all object flags at once.
FbxUInt GetAllObjectFlags () const
 Get all object flags at once.

Copying, Cloning and Referencing

enum  ECloneType { eDeepClone, eReferenceClone }
 

Types of clones that can be created for FbxObject.

More...
virtual FbxObjectCopy (const FbxObject &pObject)
 Copy an object content into this object.
virtual FbxObjectClone (FbxObject::ECloneType pCloneType=eDeepClone, FbxObject *pContainer=NULL) const
 Creates a clone of this object.
bool IsAReferenceTo () const
 Checks if this object is a reference clone of another object.
FbxObjectGetReferenceTo () const
 If this object is a reference clone, returns the original object (from which the clone originates).
bool IsReferencedBy () const
 Checks if any objects are reference cloned from this object.
int GetReferencedByCount () const
 Returns the number of objects that are reference clones of this object.
FbxObjectGetReferencedBy (int pIndex) const
 Returns a reference clone of this object at the specified index.

Object Name Management

void SetName (const char *pName)
 Sets the name of this object.
const char * GetName () const
 Returns the full name of this object.
FbxString GetNameWithoutNameSpacePrefix () const
 Returns the name of the object without the namespace qualifier.
FbxString GetNameWithNameSpacePrefix () const
 Returns the name of the object with the namespace qualifier.
void SetInitialName (const char *pName)
 Sets the initial name of the object.
const char * GetInitialName () const
 Returns the initial name of the object.
FbxString GetNameSpaceOnly ()
 Returns the namespace of the object.
void SetNameSpace (FbxString pNameSpace)
 Sets the namespace of the object.
FbxArray< FbxString * > GetNameSpaceArray (char identifier)
 Returns an array of all the namespaces for this object.
FbxString GetNameOnly () const
 Returns only the name (no namespace or prefix) of the object.
FbxString GetNameSpacePrefix () const
 Returns the namespace qualifier.
const FbxUInt64GetUniqueID () const
 Returns the unique ID of this object.
static FbxString RemovePrefix (char *pName)
 Removes the prefix of pName.
static FbxString StripPrefix (FbxString &lName)
 Strips the prefix of pName.
static FbxString StripPrefix (const char *pName)
 Strips the prefix of pName.

Member Enumeration Documentation

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.

Definition at line 211 of file fbxobject.h.

        {
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 252 of file fbxobject.h.

enum EPropertyNotifyType [protected]
Enumerator:
ePropertySetRequest 
ePropertySet 
ePropertyGet 

Definition at line 1216 of file fbxobject.h.

       :
    void                CopyPropertiesFrom(const FbxObject& pFrom);

Constructor & Destructor Documentation

FbxObject ( FbxManager pManager,
const char *  pName 
) [protected]

Member Function Documentation

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:
pClassIdThe 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 170 of file fbxobject.h.

{ return Is(T::ClassId); }
FBX_DEPRECATED bool Is ( T *  pClassType) const [inline]

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

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

Parameters:
pClassTypeA direct pointer to the C++ type of the object to test against.
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 176 of file fbxobject.h.

{ return GetClassId().Is(T::ClassId); }
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 181 of file fbxobject.h.

{
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.
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:
pRecursiveIf true, all children (source) objects will also be unregistered and deleted.
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:
pFlagsBit flags which value is going to be changed.
pValueIf true, bit flags will be set, otherwise bits will be un-set.
bool GetObjectFlags ( EObjectFlag  pFlags) const

Get the state of object flags.

Parameters:
pFlagsBit flags to query.
Returns:
true if the specified bit flags are all set.
void SetAllObjectFlags ( FbxUInt  pFlags)

Override all object flags at once.

Parameters:
pFlagsThe 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:
pObjectThe 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.

Reimplemented in FbxGlobalSettings, FbxAnimCurveBase, FbxAnimCurveNode, FbxCharacter, FbxCharacterPose, FbxDocument, FbxDocumentInfo, FbxPose, FbxScene, FbxThumbnail, FbxVideo, FbxBlendShape, FbxBlendShapeChannel, FbxCachedEffect, FbxCamera, FbxCameraSwitcher, FbxCluster, FbxGeometry, FbxGeometryBase, FbxGeometryWeightedMap, FbxLayerContainer, FbxLine, FbxLODGroup, FbxMarker, FbxMesh, FbxNode, FbxNull, FbxNurbs, FbxNurbsCurve, FbxNurbsSurface, FbxPatch, FbxShape, FbxSkeleton, FbxSkin, FbxBoundary, FbxTrimNurbsSurface, FbxVertexCacheDeformer, FbxBindingTableBase, FbxFileTexture, FbxLayeredTexture, FbxProceduralTexture, and FbxTexture.

virtual FbxObject* Clone ( FbxObject::ECloneType  pCloneType = eDeepClone,
FbxObject pContainer = NULL 
) 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:
pCloneTypeThe type of clone to be created. By default, the clone type is eDeepClone.
pContainerAn 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.
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.

Reimplemented in FbxCharacter, and FbxScene.

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:
pIndexThe 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:
pNameThe object name as a NULL terminated string.
const char* GetName ( ) const

Returns the full name of this object.

Returns:
The full name as a NULL terminated string.
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:
pNameThe 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:
pNameSpaceThe object's namespace as a NULL terminated string.
FbxArray<FbxString*> GetNameSpaceArray ( char  identifier)

Returns an array of all the namespaces for this object.

Parameters:
identifierThe 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:
pNameWhose prefix is removed.
Returns:
A temporary string without prefix.
static FbxString StripPrefix ( FbxString lName) [static]

Strips the prefix of pName.

Parameters:
lNameWhose prefix is stripped.
Returns:
lName stripped of its prefix.
static FbxString StripPrefix ( const char *  pName) [static]

Strips the prefix of pName.

Parameters:
pNameWhose 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:
pSelectedThe selection flag.
void SetUserDataPtr ( const FbxUInt64 pUserID,
void *  pUserData 
)

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

Parameters:
pUserIDThe ID of the user data record.
pUserDataThe 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.
void* GetUserDataPtr ( const FbxUInt64 pUserID) const

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

Parameters:
pUserIDThe ID of the user data record.
Returns:
The data pointer of the user data record, NULL if the user data record is not found.
void SetUserDataPtr ( void *  pUserData) [inline]

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

Parameters:
pUserDataThe 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 414 of file fbxobject.h.

{ return GetUserDataPtr(GetUniqueID()); }
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 419 of file fbxobject.h.

bool ConnectSrcObject ( FbxObject pObject,
FbxConnection::EType  pType = FbxConnection::eNone 
) [inline]

Connects this object to a source object.

Parameters:
pObjectThe source object to which this object connects.
pTypeThe connection type between this object and the source object.
Returns:
True on success, false otherwise.

Definition at line 431 of file fbxobject.h.

{ return RootProperty.IsConnectedSrcObject(pObject); }
bool IsConnectedSrcObject ( const FbxObject pObject) const [inline]

Judges whether this object connects with the source object.

Parameters:
pObjectThe source object.
Returns:
True if this object connects with the source object, false otherwise.

Definition at line 437 of file fbxobject.h.

{ return RootProperty.DisconnectSrcObject(pObject); }
bool DisconnectSrcObject ( FbxObject pObject) [inline]

Disconnects this object from a source object.

Parameters:
pObjectThe source object from which this object will be disconnected.
Returns:
True on success, false otherwise.

Definition at line 443 of file fbxobject.h.

bool DisconnectAllSrcObject ( ) [inline]

Disconnects this object from all source objects.

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

Definition at line 448 of file fbxobject.h.

{ return RootProperty.DisconnectAllSrcObject(pCriteria); }
bool DisconnectAllSrcObject ( const FbxCriteria pCriteria) [inline]

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

Parameters:
pCriteriaThe given criteria.
Returns:
True if it disconnects all the source objects successfully, false otherwise.

Definition at line 454 of file fbxobject.h.

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:
pClassIdThe specific class type.
Returns:
True if it disconnects all source objects successfully, false otherwise.

Definition at line 460 of file fbxobject.h.

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.

Definition at line 465 of file fbxobject.h.

{ return RootProperty.GetSrcObjectCount(pCriteria); }
int GetSrcObjectCount ( const FbxCriteria pCriteria) const [inline]

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

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

Definition at line 471 of file fbxobject.h.

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:
pClassIdThe specific class type.
Returns:
The number of source objects of the specific class type with which this object connects.

Definition at line 477 of file fbxobject.h.

{ return RootProperty.GetSrcObject(pIndex); }
FbxObject* GetSrcObject ( int  pIndex = 0) const [inline]

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

Parameters:
pIndexThe specified index whose default value is 0.
Returns:
The source object at the specified index, NULL if not found.

Definition at line 483 of file fbxobject.h.

{ return RootProperty.GetSrcObject(pCriteria,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:
pCriteriaThe given criteria.
pIndexThe 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 490 of file fbxobject.h.

{ return RootProperty.GetSrcObject(FbxCriteria::ObjectType(pClassId), 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:
pClassIdThe specified class type.
pIndexThe 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 497 of file fbxobject.h.

{ return RootProperty.FindSrcObject(pName,pStartIndex); }
FbxObject* FindSrcObject ( const char *  pName,
int  pStartIndex = 0 
) const [inline]

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

Parameters:
pNameThe object name.
pStartIndexThe start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 504 of file fbxobject.h.

{ return RootProperty.FindSrcObject(pCriteria,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:
pCriteriaThe given criteria.
pNameThe object name.
pStartIndexThe start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 512 of file fbxobject.h.

{ return RootProperty.FindSrcObject(FbxCriteria::ObjectType(pClassId), 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:
pClassIdThe specified class type.
pNameThe object name.
pStartIndexThe start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 520 of file fbxobject.h.

{ return RootProperty.DisconnectAllSrcObject(pFBX_TYPE); }
FBX_DEPRECATED bool DisconnectAllSrcObject ( const T *  pFBX_TYPE) [inline]

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

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

Parameters:
pFBX_TYPEThe specified class type.
Returns:
True if it disconnects all source objects successfully, false otherwise.

Definition at line 526 of file fbxobject.h.

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 530 of file fbxobject.h.

{ return RootProperty.DisconnectAllSrcObject(pFBX_TYPE,pCriteria); }
FBX_DEPRECATED bool DisconnectAllSrcObject ( const T *  pFBX_TYPE,
const FbxCriteria pCriteria 
) [inline]

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

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

Parameters:
pFBX_TYPEThe specified class type.
pCriteriaThe given criteria.
Returns:
True if it disconnects all source objects successfully, false otherwise.

Definition at line 537 of file fbxobject.h.

{ return RootProperty.DisconnectAllSrcObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }
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:
pCriteriaThe given criteria.
Returns:
true if it disconnects all source objects successfully, false otherwise.

Definition at line 542 of file fbxobject.h.

{ return RootProperty.GetSrcObjectCount(pFBX_TYPE); }
FBX_DEPRECATED int GetSrcObjectCount ( const T *  pFBX_TYPE) const [inline]

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

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

Parameters:
pFBX_TYPEThe specified class type.
Returns:
The number of source objects of the specified class type with which this object connects.

Definition at line 547 of file fbxobject.h.

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 551 of file fbxobject.h.

{ return RootProperty.GetSrcObjectCount(pFBX_TYPE,pCriteria); }
FBX_DEPRECATED int GetSrcObjectCount ( const T *  pFBX_TYPE,
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.

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

Parameters:
pFBX_TYPEThe specified class type.
pCriteriaThe given criteria.
Returns:
The number of source objects that are the specified class type and that satisfy the given criteria.

Definition at line 557 of file fbxobject.h.

{ return RootProperty.GetSrcObjectCount(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }
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:
pCriteriaThe given criteria.
Returns:
The number of source objects that are the specified class type and that satisfy the given criteria.

Definition at line 562 of file fbxobject.h.

{ return RootProperty.GetSrcObject(pFBX_TYPE, pIndex); }
FBX_DEPRECATED T* GetSrcObject ( const T *  pFBX_TYPE,
int  pIndex = 0 
) const [inline]

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

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

Parameters:
pFBX_TYPEThe specified class type.
pIndexThe 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 568 of file fbxobject.h.

{ return (T*)RootProperty.GetSrcObject(FbxCriteria::ObjectType(T::ClassId), pIndex); }
T* GetSrcObject ( int  pIndex = 0) const [inline]

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

Parameters:
pIndexThe 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 573 of file fbxobject.h.

{ return RootProperty.GetSrcObject(pFBX_TYPE,pCriteria,pIndex); }
FBX_DEPRECATED T* GetSrcObject ( const T *  pFBX_TYPE,
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.

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

Parameters:
pFBX_TYPEThe specified class type.
pCriteriaThe given criteria.
pIndexThe 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 580 of file fbxobject.h.

{ return (T*)RootProperty.GetSrcObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, 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:
pCriteriaThe given criteria.
pIndexThe 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 586 of file fbxobject.h.

{ return RootProperty.FindSrcObject(pFBX_TYPE,pName,pStartIndex); }
FBX_DEPRECATED T* FindSrcObject ( const T *  pFBX_TYPE,
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.

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

Parameters:
pFBX_TYPEThe specified class type.
pNameThe object name.
pStartIndexThe start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 594 of file fbxobject.h.

{ return (T*)RootProperty.FindSrcObject(FbxCriteria::ObjectType(T::ClassId), pName, pStartIndex); }
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:
pNameThe object name.
pStartIndexThe start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 600 of file fbxobject.h.

{ return RootProperty.FindSrcObject(pFBX_TYPE,pCriteria,pName,pStartIndex); }
FBX_DEPRECATED T* FindSrcObject ( const T *  pFBX_TYPE,
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.

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

Parameters:
pFBX_TYPEThe specified class type.
pCriteriaThe given criteria.
pNameThe object name.
pStartIndexThe start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 609 of file fbxobject.h.

{ return (T*)RootProperty.FindSrcObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, 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:
pCriteriaThe given criteria.
pNameThe object name.
pStartIndexThe start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 616 of file fbxobject.h.

bool ConnectDstObject ( FbxObject pObject,
FbxConnection::EType  pType = FbxConnection::eNone 
) [inline]

Connects this object to one destination object.

Parameters:
pObjectThe destination object with which this object connects.
pTypeThe connection type between this object and the destination object.
Returns:
True on success, false otherwise.

Definition at line 623 of file fbxobject.h.

{ return RootProperty.IsConnectedDstObject(pObject); }
bool IsConnectedDstObject ( const FbxObject pObject) const [inline]

Judges whether this object connects with the destination object.

Parameters:
pObjectThe destination object.
Returns:
True if this object connects with the destination object, false otherwise.

Definition at line 629 of file fbxobject.h.

{ return RootProperty.DisconnectDstObject(pObject); }
bool DisconnectDstObject ( FbxObject pObject) [inline]

Disconnects this object from the destination object.

Parameters:
pObjectThe destination object from which this object disconnects.
Returns:
True on success, false otherwise.

Definition at line 635 of file fbxobject.h.

bool DisconnectAllDstObject ( ) [inline]

Disconnects this object from all destination objects.

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

Definition at line 640 of file fbxobject.h.

{ return RootProperty.DisconnectAllDstObject(pCriteria); }
bool DisconnectAllDstObject ( const FbxCriteria pCriteria) [inline]

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

Parameters:
pCriteriaThe given criteria.
Returns:
True if it disconnects all destination objects successfully, false otherwise.

Definition at line 646 of file fbxobject.h.

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:
pClassIdThe specified class type.
Returns:
True if it disconnects all destination objects of the specified class type successfully, false otherwise.

Definition at line 652 of file fbxobject.h.

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 657 of file fbxobject.h.

{ return RootProperty.GetDstObjectCount(pCriteria); }
int GetDstObjectCount ( const FbxCriteria pCriteria) const [inline]

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

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

Definition at line 663 of file fbxobject.h.

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:
pClassIdThe specified class type.
Returns:
The number of destination objects of the specified class type with which this object connects.

Definition at line 669 of file fbxobject.h.

{ return RootProperty.GetDstObject(pIndex); }
FbxObject* GetDstObject ( int  pIndex = 0) const [inline]

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

Parameters:
pIndexThe specified index whose default value is 0.
Returns:
The destination object at the specified index, NULL if not found.

Definition at line 675 of file fbxobject.h.

{ return RootProperty.GetDstObject(pCriteria,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:
pCriteriaThe given criteria.
pIndexThe 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 682 of file fbxobject.h.

{ return RootProperty.GetDstObject(FbxCriteria::ObjectType(pClassId), 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:
pClassIdThe specified class type.
pIndexThe 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 689 of file fbxobject.h.

{ return RootProperty.FindDstObject(pName,pStartIndex); }
FbxObject* FindDstObject ( const char *  pName,
int  pStartIndex = 0 
) const [inline]

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

Parameters:
pNameThe object name.
pStartIndexThe start index.
Returns:
The destination object with the name, NULL if not found.

Definition at line 696 of file fbxobject.h.

{ return RootProperty.FindDstObject(pCriteria,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:
pCriteriaThe given criteria.
pNameThe object name.
pStartIndexThe start index.
Returns:
The destination object with the name, NULL if not found.

Definition at line 704 of file fbxobject.h.

{ return RootProperty.FindDstObject(FbxCriteria::ObjectType(pClassId), 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:
pClassIdThe specified class type.
pNameThe object name.
pStartIndexThe start index.
Returns:
The destination object with the name, NULL if not found.

Definition at line 712 of file fbxobject.h.

{ return RootProperty.DisconnectAllDstObject(pFBX_TYPE); }
FBX_DEPRECATED bool DisconnectAllDstObject ( const T *  pFBX_TYPE) [inline]

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

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

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

Definition at line 718 of file fbxobject.h.

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 722 of file fbxobject.h.

{ return RootProperty.DisconnectAllDstObject(pFBX_TYPE,pCriteria); }
FBX_DEPRECATED bool DisconnectAllDstObject ( const T *  pFBX_TYPE,
const FbxCriteria pCriteria 
) [inline]

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

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

Parameters:
pFBX_TYPEThe specified class type.
pCriteriaThe given criteria.
Returns:
true if it disconnects all destination objects successfully, false otherwise.

Definition at line 729 of file fbxobject.h.

{ return RootProperty.DisconnectAllDstObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }
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:
pCriteriaThe given criteria.
Returns:
true if it disconnects all destination objects successfully, false otherwise.

Definition at line 734 of file fbxobject.h.

{ return RootProperty.GetDstObjectCount(pFBX_TYPE); }
FBX_DEPRECATED int GetDstObjectCount ( const T *  pFBX_TYPE) 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:
pFBX_TYPEThe specified class type.
Returns:
The number of destination objects of the specified class type with which this object connects.

Definition at line 740 of file fbxobject.h.

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 744 of file fbxobject.h.

{ return RootProperty.GetDstObjectCount(pFBX_TYPE,pCriteria); }
FBX_DEPRECATED int GetDstObjectCount ( const T *  pFBX_TYPE,
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.

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

Parameters:
pFBX_TYPEThe specified class type.
pCriteriaThe given criteria.
Returns:
The number of destination objects that are the specified class type and that satisfy the given criteria.

Definition at line 751 of file fbxobject.h.

{ return RootProperty.GetDstObjectCount(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }
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:
pCriteriaThe given criteria.
Returns:
The number of destination objects that are the specified class type and that satisfy the given criteria.

Definition at line 756 of file fbxobject.h.

{ return RootProperty.GetDstObject(pFBX_TYPE,pIndex); }
FBX_DEPRECATED T* GetDstObject ( const T *  pFBX_TYPE,
int  pIndex = 0 
) const [inline]

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

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

Parameters:
pFBX_TYPEThe specified class type.
pIndexThe 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 763 of file fbxobject.h.

{ return (T*)RootProperty.GetDstObject(FbxCriteria::ObjectType(T::ClassId), pIndex); }
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:
pIndexThe 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 768 of file fbxobject.h.

{ return RootProperty.GetDstObject(pFBX_TYPE,pCriteria,pIndex); }
FBX_DEPRECATED T* GetDstObject ( const T *  pFBX_TYPE,
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.

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

Parameters:
pFBX_TYPEThe specified class type.
pCriteriaThe given criteria.
pIndexThe 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 776 of file fbxobject.h.

{ return (T*)RootProperty.GetDstObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, 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:
pCriteriaThe given criteria.
pIndexThe 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 782 of file fbxobject.h.

{ return RootProperty.FindDstObject(pFBX_TYPE,pName,pStartIndex); }
FBX_DEPRECATED T* FindDstObject ( const T *  pFBX_TYPE,
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.

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

Parameters:
pFBX_TYPEThe specified class type.
pNameThe object name.
pStartIndexThe start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 790 of file fbxobject.h.

{ return (T*)RootProperty.FindDstObject(FbxCriteria::ObjectType(T::ClassId), pName, pStartIndex); }
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:
pNameThe object name.
pStartIndexThe start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 796 of file fbxobject.h.

{ return RootProperty.FindDstObject(pFBX_TYPE,pCriteria,pName,pStartIndex); }
FBX_DEPRECATED T* FindDstObject ( const T *  pFBX_TYPE,
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.

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

Parameters:
pFBX_TYPEThe specified class type.
pCriteriaThe given criteria.
pNameThe object name.
pStartIndexThe start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 805 of file fbxobject.h.

{ return (T*)RootProperty.FindDstObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, 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:
pCriteriaThe given criteria.
pNameThe object name.
pStartIndexThe start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 812 of file fbxobject.h.

{
FbxProperty GetFirstProperty ( ) const [inline]

Returns the first property of this object.

Returns:
The first property of this object.

Definition at line 822 of file fbxobject.h.

        {
FbxProperty GetNextProperty ( const FbxProperty pProperty) const [inline]

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

Parameters:
pPropertyThe specified property.
Returns:
The next property of this object that follows pProperty.

Definition at line 831 of file fbxobject.h.

        {
FbxProperty FindProperty ( const char *  pName,
bool  pCaseSensitive = true 
) const [inline]

Searches a property by name.

Parameters:
pNameThe property name.
pCaseSensitiveWhether the name is case-sensitive.
Returns:
A valid FbxProperty if found, else an invalid FbxProperty. See FbxProperty::IsValid()

Definition at line 841 of file fbxobject.h.

        {
FbxProperty FindProperty ( const char *  pName,
const FbxDataType pDataType,
bool  pCaseSensitive = true 
) const [inline]

Searches a property by name and data type.

Parameters:
pNameThe property name.
pDataTypeThe data type of the property.
pCaseSensitiveWhether the name is case-sensitive.
Returns:
A valid FbxProperty if the property is found, else an invalid FbxProperty. See FbxProperty::IsValid()

Definition at line 852 of file fbxobject.h.

        {
FbxProperty FindPropertyHierarchical ( const char *  pName,
bool  pCaseSensitive = true 
) const [inline]

Searches a property by full name.

Parameters:
pNameThe full name of the property as a NULL terminated string.
pCaseSensitivewhether 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 863 of file fbxobject.h.

        {
FbxProperty FindPropertyHierarchical ( const char *  pName,
const FbxDataType pDataType,
bool  pCaseSensitive = true 
) const [inline]

Searches a property by full name and data type.

Parameters:
pNameThe full name of the property as a NULL terminated string.
pDataTypeThe data type of the property.
pCaseSensitivewhether 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 875 of file fbxobject.h.

                                                             { return RootProperty; }
FBX_DEPRECATED FbxProperty& GetRootProperty ( ) [inline]

Returns the root property of this object.

(Deprecated, use RootProperty instead)

Returns:
The root property.

Definition at line 883 of file fbxobject.h.

{ return RootProperty; }
FBX_DEPRECATED const FbxProperty& GetRootProperty ( ) const [inline]

Returns the root property of this object.

(Deprecated, use RootProperty instead)

Returns:
The root property.

Definition at line 888 of file fbxobject.h.

{ return RootProperty.ConnectSrcProperty(pProperty); }
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:
pPropertyThe source property with which this object connects.
Returns:
True on success, false otherwise.

Definition at line 900 of file fbxobject.h.

{ return RootProperty.IsConnectedSrcProperty(pProperty); }
bool IsConnectedSrcProperty ( const FbxProperty pProperty) [inline]

Determines whether this object connects with the specified source property.

Parameters:
pPropertyThe specified source property.
Returns:
True if this object connects with the specified source property, false otherwise.

Definition at line 906 of file fbxobject.h.

{ return RootProperty.DisconnectSrcProperty(pProperty); }
bool DisconnectSrcProperty ( const FbxProperty pProperty) [inline]

Disconnects this object from the specified source property.

Parameters:
pPropertyThe specified source property.
Returns:
True on success, false otherwise.

Definition at line 912 of file fbxobject.h.

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 917 of file fbxobject.h.

{ return RootProperty.GetSrcProperty(pIndex); }
FbxProperty GetSrcProperty ( int  pIndex = 0) const [inline]

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

Parameters:
pIndexThe specified index.
Returns:
The source property at the specified index.

Definition at line 923 of file fbxobject.h.

{ return RootProperty.FindSrcProperty(pName,pStartIndex); }
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:
pNameThe specified property name.
pStartIndexThe start index.
Returns:
The source property with the specified name.

Definition at line 930 of file fbxobject.h.

{ return RootProperty.ConnectDstProperty(pProperty); }
bool ConnectDstProperty ( const FbxProperty pProperty) [inline]

Connects this object to a destination property.

Parameters:
pPropertyThe destination property with which this object connects.
Returns:
True on success, false otherwise.

Definition at line 936 of file fbxobject.h.

{ return RootProperty.IsConnectedDstProperty(pProperty); }
bool IsConnectedDstProperty ( const FbxProperty pProperty) [inline]

Determines if this object connects with the specified destination property.

Parameters:
pPropertyThe specified destination property.
Returns:
True if this object connects with the specified destination property, false otherwise.

Definition at line 942 of file fbxobject.h.

{ return RootProperty.DisconnectDstProperty(pProperty); }
bool DisconnectDstProperty ( const FbxProperty pProperty) [inline]

Disconnects this object from the specified destination property.

Parameters:
pPropertyThe specified destination property.
Returns:
True on success, false otherwise.

Definition at line 948 of file fbxobject.h.

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 953 of file fbxobject.h.

{ return RootProperty.GetDstProperty(pIndex); }
FbxProperty GetDstProperty ( int  pIndex = 0) const [inline]

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

Parameters:
pIndexThe specified index.
Returns:
The destination property at the specified index.

Definition at line 959 of file fbxobject.h.

{ return RootProperty.FindDstProperty(pName,pStartIndex); }
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:
pNameThe specified property name.
pStartIndexThe start index.
Returns:
The destination property with the specified name.

Definition at line 966 of file fbxobject.h.

:
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:
pStreamThe 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:
pStreamThe 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:
pMessageThe 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 = NULL 
) 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:
pIDThe identifier of the text to be localized.
pDefaultThe 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.

Reimplemented in FbxLibrary.

bool AddImplementation ( FbxImplementation pImplementation)

Adds an implementation.

Parameters:
pImplementationThe 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.
bool RemoveImplementation ( FbxImplementation pImplementation)

Removes an implementation.

Parameters:
pImplementationThe 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:
pImplementationThe 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.
int GetImplementationCount ( const FbxImplementationFilter pCriteria = NULL) const

Returns the number of implementations that satisfy a given criteria.

Parameters:
pCriteriaThe given criteria.
Returns:
The number of implementations.
FbxImplementation* GetImplementation ( int  pIndex,
const FbxImplementationFilter pCriteria = NULL 
) const

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

Parameters:
pIndexThe specified index.
pCriteriaThe 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:
pUrlThe 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:
pClassIdThe 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:
pClassIdThe 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 Construct ( const FbxObject pFrom) [protected, virtual]

Optional constructor override, automatically called by default constructor.

Parameters:
pFromIf 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.
virtual void ConstructProperties ( bool  pForceSet) [protected, virtual]
virtual void Destruct ( bool  pRecursive) [protected, virtual]

Optional destructor override, automatically called by default destructor.

Parameters:
pRecursiveIf 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.

Reimplemented in FbxExporter, FbxImporter, FbxIOSettings, FbxAnimCurveNode, FbxAnimEvalClassic, FbxAnimEvaluator, FbxCharacter, FbxCharacterPose, FbxContainerTemplate, FbxDocument, FbxDocumentInfo, FbxLibrary, FbxPose, FbxThumbnail, FbxCache, FbxCameraSwitcher, FbxGeometry, FbxGeometryWeightedMap, FbxLayerContainer, FbxLine, FbxMesh, FbxNode, FbxNurbs, FbxNurbsCurve, FbxNurbsSurface, FbxPatch, FbxBindingOperator, FbxCameraManipulator, and FbxProcessorShaderDependency.

virtual void ContentClear ( ) [protected, virtual]

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.

Reimplemented in FbxGeometryBase.

virtual FbxPeripheral* GetPeripheral ( ) [protected, virtual]

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.

virtual bool Compare ( FbxObject pOtherObject) [virtual]
bool operator== ( const FbxObject pObject)
bool operator!= ( const FbxObject pObject)
virtual void SetDocument ( FbxDocument pDocument) [virtual]
FbxPropertyHandle& GetPropertyHandle ( ) [inline]

Definition at line 1196 of file fbxobject.h.

:
    FbxObject(FbxManager& pManager, const char* pName);
virtual const char* GetTypeName ( ) const [virtual]
virtual FbxStringList GetTypeFlags ( ) const [virtual]
void WipeAllConnections ( )
static void SetWipeMode ( bool  pState) [static]
static bool GetWipeMode ( ) [static]
virtual bool ConnectNotify ( const FbxConnectEvent pEvent) [protected, virtual]
virtual bool PropertyNotify ( EPropertyNotifyType  pType,
FbxProperty pProperty 
) [protected, virtual]
bool Copyable ( const FbxObject pObject) [protected]

Friends And Related Function Documentation

friend class FbxProperty [friend]

Definition at line 1243 of file fbxobject.h.


Member Data Documentation

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

Definition at line 1154 of file fbxobject.h.


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

FbxObject FbxObject FbxObject FbxObject FbxObject FbxObject FbxObject FbxObject FbxObject FbxObject
FbxObject FbxObject FbxObject FbxObject FbxObject FbxObject FbxObject FbxObject FbxObject FbxObject