Public Types | 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, 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 FbxObject class inherits from FbxPlug, which allows objects to be differentiated via the ClassId mechanism. 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...

 private:
     //A default constructor must be declared as either protected or private since objects must be created using the static function MyClass::Create.
     MyClass(FbxManager& pManager, const char* pName);
 };
 //Implementation
 FBXSDK_OBJECT_IMPLEMENT(MyClass);
 
 MyClass::MyClass(FbxManager& pManager, const char* pName) : FbxObject(pManager, pName)
 {
 }

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

 FbxSdkManager->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(FbxSdkManager, "Object Name");

 //Deleting this instance
 MyObject->Destroy();
 MyObject = NULL;
See also:
FbxPlug, FbxProperty
Examples:

ExportScene03/main.cxx, ExportScene03/MyKFbxMesh.cxx, ExportScene03/MyKFbxMesh.h, ImportScene/DisplayCommon.cxx, ImportScene/DisplayCommon.h, ImportScene/DisplayGenericInfo.cxx, ImportScene/DisplayUserProperties.cxx, ImportScene/DisplayUserProperties.h, Transformations/DisplayCommon.cxx, and Transformations/DisplayCommon.h.

Definition at line 134 of file fbxobject.h.

#include <fbxobject.h>

Inheritance diagram for FbxObject:
Inheritance graph
[legend]

List of all members.

Public Types

enum   EObjectFlag {
  eNone = 0x00000000, eSystem = 0x00000001, eSavable = 0x00000002, eSelected = 0x00000004,
  eHidden = 0x00000008, eContentLoaded = 0x00100000, eUserRuntimeFirst = 0x10000000, eAllRuntimeFlagsMask = 0xfff00000
}

Public Member Functions

virtual FbxObject Copy (const FbxObject &pObject)
  Copy an object content into this object.
virtual bool  Compare (FbxObject *pOtherObject)
virtual FbxManager GetFbxManager () const
  Retrieve the FBX SDK Manager associated to this object.
virtual FbxClassId  GetRuntimeClassId () const
  Retrieve the run-time ClassId for this object.
void  SetObjectFlags (EObjectFlag pFlags, bool pValue)
bool  GetObjectFlags (EObjectFlag pFlags) const
void  SetAllObjectFlags (FbxUInt pFlags)
FbxUInt  GetAllObjectFlags () const
bool  operator== (FbxObject const &pObject)
bool  operator!= (FbxObject const &pObject)
virtual const char *  GetTypeName () const
virtual FbxStringList  GetTypeFlags () const
virtual void  SetDocument (FbxDocument *pDocument)
FbxPropertyHandle GetPropertyHandle ()
void  WipeAllConnections ()
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.
Off-loading Serialization section.

The methods in this section are usually called by a peripheral.

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.
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.
Properties access
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.
FbxProperty GetRootProperty ()
  Returns the root property of this object.
const FbxProperty GetRootProperty () const
  Returns the root property of this object.
FbxProperty  GetClassRootProperty ()
  Returns the class root property.
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.
bool  DisconnectAllSrcObject (FbxClassId pClassId)
  Disconnects this object from all source objects of a specific class type.
bool  DisconnectAllSrcObject (FbxClassId pClassId, const FbxCriteria &pCriteria)
  Disconnects this object from all source objects that satisfy a given criteria and that are 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.
int  GetSrcObjectCount (FbxClassId pClassId) const
  Returns the number of source objects of the specific class type with which this object connects.
int  GetSrcObjectCount (FbxClassId pClassId, const FbxCriteria &pCriteria) const
  Returns the number of source objects that satisfy the given criteria and that are the specified class type.
FbxObject GetSrcObject (int pIndex=0) const
  Returns the source object with which this object connects at the specified index.
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.
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.
FbxObject GetSrcObject (FbxClassId pClassId, const FbxCriteria &pCriteria, int pIndex=0) const
  Returns the source object of the specified class type that satisfies the given criteria at the specified index.
FbxObject FindSrcObject (const char *pName, int pStartIndex=0) const
  Searches the source object with the specified name, starting at the specified index.
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.
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.
FbxObject FindSrcObject (FbxClassId pClassId, const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const
  Searches the source object with the specified name which is the specified class type and satisfies the given criteria, starting at the specified index.
template<class T >
bool  DisconnectAllSrcObject (const T *pFBX_TYPE)
  Disconnects this object from all source objects of the specified class type.
template<class T >
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 >
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 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 >
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 (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 *  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 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.
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.
bool  DisconnectAllDstObject (FbxClassId pClassId)
  Disconnects this object from all destination objects of the specified class type.
bool  DisconnectAllDstObject (FbxClassId pClassId, const FbxCriteria &pCriteria)
  Disconnects this object from all the destination objects that are the specified class type and that satisfy the given criteria.
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.
int  GetDstObjectCount (FbxClassId pClassId) const
  Returns the number of destination objects of the specified class type with which this object connects.
int  GetDstObjectCount (FbxClassId pClassId, const FbxCriteria &pCriteria) const
  Returns the number of destination objects of the specified class type with which this object connects that also satisfy the given criteria .
FbxObject GetDstObject (int pIndex=0) const
  Returns the destination object at the specified index with which this object connects.
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.
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.
FbxObject GetDstObject (FbxClassId pClassId, const FbxCriteria &pCriteria, int pIndex=0) const
  Returns the destination object with which this object connects that is of the specified class type and that satisfies the given criteria at the specified index.
FbxObject FindDstObject (const char *pName, int pStartIndex=0) const
  Searches the destination object with the specified name, starting at the specified index.
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.
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.
FbxObject FindDstObject (FbxClassId pClassId, 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 >
bool  DisconnectAllDstObject (const T *pFBX_TYPE)
  Disconnects this object from all destination objects of the specified class type.
template<class T >
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 >
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 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 >
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 (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 *  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 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.
General Property Connection and Relationship Management
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.
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.
Document Management
FbxDocument GetDocument () const
  Returns a const pointer to the document that contains this object.
FbxDocument GetRootDocument () const
  Returns a const pointer to the root document that contains this object.
FbxScene GetScene () const
  Returns a const pointer to the scene that contains this object.
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
FbxLibrary GetParentLibrary () 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.
FbxImplementation GetDefaultImplementation (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.
FbxImplementation GetImplementation (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.

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  ContentClear ()
  Clears this object's content from memory.
virtual FbxPeripheral GetPeripheral ()
  Retrieves the peripheral of that object.
  FbxObject (FbxManager &pManager, const char *pName)
virtual void  Construct (const FbxObject *pFrom)
virtual bool  ConstructProperties (bool pForceSet)
virtual void  Destruct (bool pRecursive, bool pDependents)
bool  Copyable (const FbxObject &pObject)
virtual bool  SetRuntimeClassId (FbxClassId pClassId)
  Set the run-time ClassId for this class.
virtual bool  ConnecNotify (const FbxConnectEvent &pEvent)
virtual bool  PropertyNotify (EPropertyNotifyType pType, FbxProperty *pProperty)

Friends

class  FbxScene
class  FbxProperty

Cloning and references

enum   ECloneType { eDeepClone, eReferenceClone }
 

Types of clones that can be created for FbxObject.

More...
virtual FbxObject Clone (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.
FbxObject GetReferenceTo () 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.
FbxObject GetReferencedBy (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 FbxUInt64 GetUniqueID () 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

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 do not propagate to each other.

eReferenceClone 

Changes to original object propagate to clone.

Changes to clone do not propagate to original.

Definition at line 145 of file fbxobject.h.

Enumerator:
eNone 
eSystem 
eSavable 
eSelected 
eHidden 
eContentLoaded 
eUserRuntimeFirst 
eAllRuntimeFlagsMask 

Definition at line 1083 of file fbxobject.h.

    {
        eNone =                 0x00000000, //No flags
        eSystem =               0x00000001, //System objects are destroyed only when manager is deleted
        eSavable =              0x00000002, //Savable objects are persisted in files, true by default
        eSelected =             0x00000004, //Selected flag, false by default
        eHidden =               0x00000008, //Hidden flag, false by default
        eContentLoaded =        0x00100000,
        eUserRuntimeFirst =     0x10000000,
        eAllRuntimeFlagsMask =  0xfff00000
    };
enum EPropertyNotifyType [protected]

Constructor & Destructor Documentation

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

Member Function Documentation

virtual FbxObject* Clone ( FbxObject::ECloneType  pCloneType = eDeepClone,
FbxObject pContainer = NULL 
) const [virtual]

Creates a clone of this object.

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.
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.
Examples:
ExportScene05/main.cxx.
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:
ExportDocument/main.cxx, and ExportScene05/main.cxx.
const char* GetName ( ) const
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.

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.

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.
FbxProperty GetFirstProperty ( ) const [inline]

Returns the first property of this object.

Returns:
The first property of this object.
Examples:
ImportScene/DisplayAnimation.cxx, ImportScene/DisplayGenericInfo.cxx, and ImportScene/DisplayUserProperties.cxx.

Definition at line 365 of file fbxobject.h.

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:
ImportScene/DisplayAnimation.cxx, ImportScene/DisplayGenericInfo.cxx, and ImportScene/DisplayUserProperties.cxx.

Definition at line 374 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:
ExportScene05/main.cxx, ImportScene/DisplayMesh.cxx, ImportScene/DisplayTexture.cxx, UserProperties/main.cxx, and ViewScene/SceneCache.cxx.

Definition at line 384 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 395 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:
ImportScene/DisplayMaterial.cxx.

Definition at line 406 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 418 of file fbxobject.h.

        {
            return RootProperty.FindHierarchical(pName, pDataType, pCaseSensitive );
        }
FbxProperty& GetRootProperty ( ) [inline]

Returns the root property of this object.

Returns:
The root property.
Examples:
ProceduralTexture/main.cxx.

Definition at line 426 of file fbxobject.h.

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

Returns the root property of this object.

Returns:
The root property.

Definition at line 431 of file fbxobject.h.

{ return RootProperty; }
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 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:
Camera/main.cxx, ExportScene03/main.cxx, ExportScene05/main.cxx, and Layers/main.cxx.

Definition at line 449 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 455 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 461 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 466 of file fbxobject.h.

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

{ return RootProperty.DisconnectAllSrcObject(pCriteria); }
bool DisconnectAllSrcObject ( FbxClassId  pClassId ) [inline]

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

Parameters:
pClassId The specific class type.
Returns:
True if it disconnects all source objects successfully, false otherwise.

Definition at line 478 of file fbxobject.h.

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

Disconnects this object from all source objects that satisfy a given criteria and that are a specific class type.

Parameters:
pClassId The specific class type.
pCriteria The given criteria.
Returns:
True if it disconnects from all source objects successfully, false otherwise.

Definition at line 485 of file fbxobject.h.

{ return RootProperty.DisconnectAllSrcObject(pClassId,pCriteria); }
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:
ImportScene/DisplayAnimation.cxx, ImportScene/DisplayGenericInfo.cxx, ImportScene/DisplayMesh.cxx, and ImportScene/DisplayTexture.cxx.

Definition at line 490 of file fbxobject.h.

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

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

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

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

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

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

Parameters:
pClassId The specified class type.
pCriteria The given criteria.
Returns:
The number of source objects.

Definition at line 509 of file fbxobject.h.

{ return RootProperty.GetSrcObjectCount(pClassId,pCriteria); }
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:
ExportScene02/main.cxx, ExportScene03/main.cxx, ImportScene/DisplayAnimation.cxx, ImportScene/DisplayGenericInfo.cxx, ImportScene/DisplayTexture.cxx, ProceduralTexture/main.cxx, and SwitchBinding/main.cxx.

Definition at line 515 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 522 of file fbxobject.h.

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

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

{ return RootProperty.GetSrcObject(pClassId,pIndex); }
FbxObject* GetSrcObject ( FbxClassId  pClassId,
const FbxCriteria pCriteria,
int  pIndex = 0 
) const [inline]

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

Parameters:
pClassId The specified class.
pCriteria The given criteria.
pIndex The specified index whose default value is 0.
Returns:
The source object of the specified class type that satisfies the given criteria at the specified index, NULL if not found.

Definition at line 537 of file fbxobject.h.

{ return RootProperty.GetSrcObject(pClassId,pCriteria,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 544 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 552 of file fbxobject.h.

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

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

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

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

Parameters:
pClassId The specified class type.
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 569 of file fbxobject.h.

{ return RootProperty.FindSrcObject(pClassId,pCriteria,pName,pStartIndex); }
bool DisconnectAllSrcObject ( const T *  pFBX_TYPE ) [inline]

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

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

Definition at line 575 of file fbxobject.h.

{ return RootProperty.DisconnectAllSrcObject(pFBX_TYPE); }
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.

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

Definition at line 582 of file fbxobject.h.

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

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

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

Definition at line 588 of file fbxobject.h.

{ return RootProperty.GetSrcObjectCount(pFBX_TYPE); }
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.

Parameters:
pFBX_TYPE The specified class type.
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 595 of file fbxobject.h.

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

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

Parameters:
pFBX_TYPE The specified class type.
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 602 of file fbxobject.h.

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

Parameters:
pFBX_TYPE The specified class type.
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 610 of file fbxobject.h.

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

Parameters:
pFBX_TYPE 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 618 of file fbxobject.h.

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

Parameters:
pFBX_TYPE The specified class type.
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 627 of file fbxobject.h.

{ return RootProperty.FindSrcObject(pFBX_TYPE,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.

Definition at line 634 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 640 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 646 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 651 of file fbxobject.h.

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

{ return RootProperty.DisconnectAllDstObject(pCriteria); }
bool DisconnectAllDstObject ( FbxClassId  pClassId ) [inline]

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

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

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

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

Parameters:
pClassId The specified class type.
pCriteria The given criteria.
Returns:
True if it disconnects all the destination objects successfully, false otherwise.

Definition at line 670 of file fbxobject.h.

{ return RootProperty.DisconnectAllDstObject(pClassId,pCriteria); }
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 675 of file fbxobject.h.

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

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

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

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

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

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

Parameters:
pClassId The specified class type.
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 694 of file fbxobject.h.

{ return RootProperty.GetDstObjectCount(pClassId,pCriteria); }
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 700 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 707 of file fbxobject.h.

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

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

{ return RootProperty.GetDstObject(pClassId,pIndex); }
FbxObject* GetDstObject ( FbxClassId  pClassId,
const FbxCriteria pCriteria,
int  pIndex = 0 
) const [inline]

Returns the destination object with which this object connects that is of the specified class type and that satisfies the given criteria at the specified index.

Parameters:
pClassId The specified class type.
pCriteria The given criteria.
pIndex The specified index whose default value is 0.
Returns:
The destination 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 722 of file fbxobject.h.

{ return RootProperty.GetDstObject(pClassId,pCriteria,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 729 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 737 of file fbxobject.h.

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

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

{ return RootProperty.FindDstObject(pClassId,pName,pStartIndex); }
FbxObject* FindDstObject ( FbxClassId  pClassId,
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:
pClassId The specified class type.
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 754 of file fbxobject.h.

{ return RootProperty.FindDstObject(pClassId,pCriteria,pName,pStartIndex); }
bool DisconnectAllDstObject ( const T *  pFBX_TYPE ) [inline]

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

Parameters:
pFBX_TYPE The specified class type.
Returns:
True if it disconnects all destination objects of the specified class type successfully, false otherwise.

Definition at line 760 of file fbxobject.h.

{ return RootProperty.DisconnectAllDstObject(pFBX_TYPE); }
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.

Parameters:
pFBX_TYPE The specified class type.
pCriteria The given criteria.
Returns:
True if it disconnects all destination objects successfully, false otherwise.

Definition at line 767 of file fbxobject.h.

{ return RootProperty.DisconnectAllDstObject(pFBX_TYPE,pCriteria); }
int GetDstObjectCount ( const T *  pFBX_TYPE ) const [inline]

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

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

Definition at line 773 of file fbxobject.h.

{ return RootProperty.GetDstObjectCount(pFBX_TYPE); }
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.

Parameters:
pFBX_TYPE The specified class type.
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 780 of file fbxobject.h.

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

Parameters:
pFBX_TYPE 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 787 of file fbxobject.h.

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

Parameters:
pFBX_TYPE The specified class type.
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 795 of file fbxobject.h.

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

Parameters:
pFBX_TYPE 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 803 of file fbxobject.h.

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

Parameters:
pFBX_TYPE The specified class type.
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 812 of file fbxobject.h.

{ return RootProperty.FindDstObject(pFBX_TYPE,pCriteria,pName,pStartIndex); }
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 823 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 829 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 835 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 840 of file fbxobject.h.

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 846 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 853 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:
ExportShader/main.cxx.

Definition at line 859 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 865 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 871 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 876 of file fbxobject.h.

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

{ return RootProperty.FindDstProperty(pName,pStartIndex); }
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:
ViewScene/SceneContext.cxx.
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:
ViewScene/DrawScene.cxx, ViewScene/SceneCache.cxx, and ViewScene/SceneContext.cxx.
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 915 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 920 of file fbxobject.h.

{ return GetUserDataPtr(GetUniqueID()); }
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:
ExportScene01/main.cxx.
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 = 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:
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.

Reimplemented in FbxLibrary.

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:
ExportShader/main.cxx.
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:
ExportShader/main.cxx.
int GetImplementationCount ( const FbxImplementationFilter pCriteria = NULL ) 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 = NULL 
) 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.
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.

Reimplemented in FbxGlobalSettings, FbxAnimCurveNode, FbxAnimStack, 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, FbxProceduralTexture, FbxTexture, and FbxCameraManipulator.

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]
virtual FbxManager* GetFbxManager ( ) const [virtual]

Retrieve the FBX SDK Manager associated to this object.

There is no implementation at the level of FbxPlug. A basic implementation is available at the FbxObject level.

Returns:
A pointer to the FBX SDK Manager of this object.

Reimplemented from FbxPlug.

Examples:
ViewScene/SceneContext.cxx.
virtual FbxClassId GetRuntimeClassId ( ) const [virtual]

Retrieve the run-time ClassId for this object.

Returns:
The run-time ClassId for this object.

Reimplemented from FbxPlug.

void SetObjectFlags ( EObjectFlag  pFlags,
bool  pValue 
)
bool GetObjectFlags ( EObjectFlag  pFlags ) const
void SetAllObjectFlags ( FbxUInt  pFlags )
FbxUInt GetAllObjectFlags ( ) const
bool operator== ( FbxObject const &  pObject )
bool operator!= ( FbxObject const &  pObject )
virtual const char* GetTypeName ( ) const [virtual]
virtual FbxStringList GetTypeFlags ( ) const [virtual]
virtual void SetDocument ( FbxDocument pDocument ) [virtual]
FbxPropertyHandle& GetPropertyHandle ( ) [inline]

Definition at line 1115 of file fbxobject.h.

{ return RootProperty.mPropertyHandle; }
void WipeAllConnections ( )
virtual void Construct ( const FbxObject pFrom ) [protected, virtual]
virtual bool ConstructProperties ( bool  pForceSet ) [protected, virtual]
virtual void Destruct ( bool  pRecursive,
bool  pDependents 
) [protected, virtual]
bool Copyable ( const FbxObject pObject ) [protected]
virtual bool SetRuntimeClassId ( FbxClassId  pClassId ) [protected, virtual]

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.
Returns:
Unused return value, deprecated.
Remarks:
This function is not implemented by FbxPlug, hence it will always return false. FbxObject implements this function and always return true.

Reimplemented from FbxPlug.

virtual bool ConnecNotify ( const FbxConnectEvent pEvent ) [protected, virtual]
virtual bool PropertyNotify ( EPropertyNotifyType  pType,
FbxProperty pProperty 
) [protected, virtual]

Friends And Related Function Documentation

friend class FbxScene [friend]
friend class FbxProperty [friend]

Reimplemented from FbxPlug.

Definition at line 1163 of file fbxobject.h.


Member Data Documentation

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

Examples:
ImportScene/DisplayMaterial.cxx.

Definition at line 1053 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