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.
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;
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>

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
|
|
|
|
| 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. |
|
| enum ECloneType |
Types of clones that can be created for FbxObject.
Definition at line 145 of file fbxobject.h.
{
eDeepClone,
eReferenceClone
};
| enum EObjectFlag |
| 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] |
Definition at line 1145 of file fbxobject.h.
| FbxObject | ( | FbxManager & | pManager, |
| const char * | pName | ||
| ) | [protected] |
| virtual FbxObject* Clone | ( | FbxObject::ECloneType | pCloneType =
eDeepClone, |
| FbxObject * | pContainer =
NULL |
||
| ) | const [virtual] |
Creates a clone of this object.
| 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. |
| bool IsAReferenceTo | ( | ) | const |
Checks if this object is a reference clone of another object.
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).
| bool IsReferencedBy | ( | ) | const |
Checks if any objects are reference cloned from this object.
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.
| FbxObject* GetReferencedBy | ( | int | pIndex | ) | const |
Returns a reference clone of this object at the specified index.
| pIndex | The specified index, valid values are [0, GetReferencedByCount()) |
| void SetName | ( | const char * | pName | ) |
Sets the name of this object.
| pName | The object name as a NULL terminated string. |
| const char* GetName | ( | ) | const |
Returns the full name of this object.
NULL terminated string.| 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.
| pName | The object's initial name as a NULL terminated
string. |
| const char* GetInitialName | ( | ) | const |
Returns the initial name of the object.
NULL terminated
string.| FbxString GetNameSpaceOnly | ( | ) |
Returns the namespace of the object.
NULL terminated
string.| void SetNameSpace | ( | FbxString | pNameSpace | ) |
Sets the namespace of the object.
| pNameSpace | The object's namespace as a NULL terminated
string. |
Returns an array of all the namespaces for this object.
| identifier | The identifier of the namespaces. |
| FbxString GetNameOnly | ( | ) | const |
Returns only the name (no namespace or prefix) of the object.
NULL terminated string.| FbxString GetNameSpacePrefix | ( | ) | const |
| static FbxString RemovePrefix | ( | char * | pName | ) | [static] |
Removes the prefix of pName.
| pName | Whose prefix is removed. |
Strips the prefix of pName.
| lName | Whose prefix is stripped. |
| static FbxString StripPrefix | ( | const char * | pName | ) | [static] |
Strips the prefix of pName.
| pName | Whose prefix is stripped. |
| 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.
| 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.
True if this object's content is loaded,
false otherwise.| 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
True if this object's content is locked,
false otherwise.| virtual bool ContentWriteTo | ( | FbxStream & | pStream | ) | const [virtual] |
Writes the content of the object to the given stream.
| pStream | The destination stream. |
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.
| pStream | The source stream. |
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.
True if this object is selected,
false otherwise.| virtual void SetSelected | ( | bool | pSelected | ) | [virtual] |
Sets whether this object is currently selected.
| pSelected | The selection flag. |
| FbxProperty GetFirstProperty | ( | ) | const [inline] |
Returns the first property of this object.
Definition at line 365 of file fbxobject.h.
{
return RootProperty.GetFirstDescendent();
}
| FbxProperty GetNextProperty | ( | const FbxProperty & | pProperty | ) | const [inline] |
Returns the next property of this object that follows the specified property.
| pProperty | The specified property. |
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.
| pName | The property name. |
| pCaseSensitive | Whether the name is case-sensitive. |
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.
| pName | The property name. |
| pDataType | The data type of the property. |
| pCaseSensitive | Whether the name is case-sensitive. |
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.
| pName | The full name of the property as a NULL terminated
string. |
| pCaseSensitive | whether or not the name is case-sensitive. |
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.
| 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. |
Definition at line 418 of file fbxobject.h.
{
return RootProperty.FindHierarchical(pName, pDataType, pCaseSensitive );
}
| FbxProperty& GetRootProperty | ( | ) | [inline] |
Returns the root property of this object.
Definition at line 426 of file fbxobject.h.
{ return RootProperty; }
| const FbxProperty& GetRootProperty | ( | ) | const [inline] |
Returns the root property of this object.
Definition at line 431 of file fbxobject.h.
{ return RootProperty; }
| FbxProperty GetClassRootProperty | ( | ) |
Returns the class root property.
| bool ConnectSrcObject | ( | FbxObject * | pObject, |
| FbxConnection::EType | pType =
FbxConnection::eNone |
||
| ) | [inline] |
Connects this object to a source object.
| pObject | The source object to which this object connects. |
| pType | The connection type between this object and the source object. |
True on success, false
otherwise.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.
| pObject | The source object. |
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.
| pObject | The source object from which this object will be disconnected. |
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.
True if it disconnects all source objects
successfully, false otherwise.Definition at line 466 of file fbxobject.h.
{ return RootProperty.DisconnectAllSrcObject(); }
| bool DisconnectAllSrcObject | ( | const FbxCriteria & | pCriteria | ) | [inline] |
Disconnects this object from all source objects that satisfy a given criteria.
| pCriteria | The given criteria. |
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.
| pClassId | The specific class type. |
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.
| pClassId | The specific class type. |
| pCriteria | The given criteria. |
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.
Definition at line 490 of file fbxobject.h.
{ return RootProperty.GetSrcObjectCount(); }
| int GetSrcObjectCount | ( | const FbxCriteria & | pCriteria | ) | const [inline] |
Returns the number of source objects that satisfy the given criteria with which this object connects.
| pCriteria | The given criteria. |
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.
| pClassId | The specific class type. |
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.
| pClassId | The specified class type. |
| pCriteria | The given criteria. |
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.
| pIndex | The specified index whose default value is 0. |
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.
| pCriteria | The given criteria. |
| pIndex | The specified index whose default value is 0. |
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.
| pClassId | The specified class type. |
| pIndex | The specified index whose default value is 0. |
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.
| pClassId | The specified class. |
| pCriteria | The given criteria. |
| pIndex | The specified index whose default value is 0. |
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.
| pName | The object name. |
| pStartIndex | The start index. |
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.
| pCriteria | The given criteria. |
| pName | The object name. |
| pStartIndex | The start index. |
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.
| pClassId | The specified class type. |
| pName | The object name. |
| pStartIndex | The start index. |
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.
| pClassId | The specified class type. |
| pCriteria | The given criteria. |
| pName | The object name. |
| pStartIndex | The start index. |
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.
| pFBX_TYPE | The specified class type. |
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.
| pFBX_TYPE | The specified class type. |
| pCriteria | The given criteria. |
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.
| pFBX_TYPE | The specified class type. |
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.
| pFBX_TYPE | The specified class type. |
| pCriteria | 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.
| pFBX_TYPE | The specified class type. |
| pIndex | The specified index whose default value is 0. |
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.
| pFBX_TYPE | The specified class type. |
| pCriteria | The given criteria. |
| pIndex | The specified index whose default value is 0. |
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.
| pFBX_TYPE | The specified class type. |
| pName | The object name. |
| pStartIndex | The start index. |
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.
| pFBX_TYPE | The specified class type. |
| pCriteria | The given criteria. |
| pName | The object name. |
| pStartIndex | The start index. |
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.
| pObject | The destination object with which this object connects. |
| pType | The connection type between this object and the destination object. |
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.
| pObject | The destination object. |
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.
| pObject | The destination object from which this object disconnects. |
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.
True if it disconnects all destination objects
successfully, false otherwise.Definition at line 651 of file fbxobject.h.
{ return RootProperty.DisconnectAllDstObject(); }
| bool DisconnectAllDstObject | ( | const FbxCriteria & | pCriteria | ) | [inline] |
Disconnects this object from all destination objects that satisfy given criteria.
| pCriteria | The given criteria. |
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.
| pClassId | The specified class type. |
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.
| pClassId | The specified class type. |
| pCriteria | The given criteria. |
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.
Definition at line 675 of file fbxobject.h.
{ return RootProperty.GetDstObjectCount(); }
| int GetDstObjectCount | ( | const FbxCriteria & | pCriteria | ) | const [inline] |
Returns the number of destination objects with which this object connects that satisfy the given criteria.
| pCriteria | 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.
| pClassId | The specified class type. |
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 .
| pClassId | The specified class type. |
| pCriteria | 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.
| pIndex | The specified index whose default value is 0. |
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.
| pCriteria | The given criteria. |
| pIndex | The specified index whose default value is 0. |
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.
| pClassId | The specified class type. |
| pIndex | The specified index whose default value is 0. |
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.
| pClassId | The specified class type. |
| pCriteria | The given criteria. |
| pIndex | The specified index whose default value is 0. |
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.
| pName | The object name. |
| pStartIndex | The start index. |
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.
| pCriteria | The given criteria. |
| pName | The object name. |
| pStartIndex | The start index. |
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.
| pClassId | The specified class type. |
| pName | The object name. |
| pStartIndex | The start index. |
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.
| pClassId | The specified class type. |
| pCriteria | The given criteria. |
| pName | The object name. |
| pStartIndex | The start index. |
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.
| pFBX_TYPE | The specified class type. |
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.
| pFBX_TYPE | The specified class type. |
| pCriteria | The given criteria. |
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.
| pFBX_TYPE | The specified class type. |
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.
| pFBX_TYPE | The specified class type. |
| pCriteria | 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.
| pFBX_TYPE | The specified class type. |
| pIndex | The specified index whose default value is 0. |
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.
| pFBX_TYPE | The specified class type. |
| pCriteria | The given criteria. |
| pIndex | The specified index whose default value is 0. |
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.
| pFBX_TYPE | The specified class type. |
| pName | The object name. |
| pStartIndex | The start index. |
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.
| pFBX_TYPE | The specified class type. |
| pCriteria | The given criteria. |
| pName | The object name. |
| pStartIndex | The start index. |
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.
| pProperty | The source property with which this object connects. |
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.
| pProperty | The specified source property. |
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.
| pProperty | The specified source property. |
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.
Definition at line 840 of file fbxobject.h.
{ return RootProperty.GetSrcPropertyCount(); }
| FbxProperty GetSrcProperty | ( | int | pIndex = 0 |
) | const [inline] |
Returns the source property at the specified index with which this object connects.
| pIndex | 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.
| pName | The specified property name. |
| pStartIndex | The start index. |
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.
| pProperty | The destination property with which this object connects. |
True on success, false
otherwise.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.
| pProperty | The specified destination property. |
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.
| pProperty | The specified destination property. |
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.
Definition at line 876 of file fbxobject.h.
{ return RootProperty.GetDstPropertyCount(); }
| FbxProperty GetDstProperty | ( | int | pIndex = 0 |
) | const [inline] |
Returns the destination property at the specified index with which this object connects.
| pIndex | 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.
| pName | The specified property name. |
| pStartIndex | The start index. |
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.
| pUserID | The ID of the user data record. |
| pUserData | The data pointer of the user data record. |
| void* GetUserDataPtr | ( | const FbxUInt64 & | pUserID | ) | const |
Returns the data pointer of an user data record whose ID is pUserID.
| pUserID | The ID 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.
| pUserData | The data pointer of the user data record. |
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.
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.
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.
NULL if the object does not belong to any
document.| FbxScene* GetScene | ( | ) | const |
Returns a const pointer to the scene that contains this object.
NULL if the object does not belong to any scene.| void EmitMessage | ( | FbxMessage * | pMessage | ) | const |
Emits a message in all available message emitters in the document or SDK manager.
| pMessage | The message to emit. |
| 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.
| pID | The identifier of the text to be localized. |
| pDefault | The default text. Uses pID as the default text if pDefault is NULL. |
Reimplemented in FbxLibrary.
| FbxLibrary* GetParentLibrary | ( | ) | const |
Returns a handle on the parent library of this object.
NULL if the
parent library doesn't exist.Reimplemented in FbxLibrary.
| bool AddImplementation | ( | FbxImplementation * | pImplementation | ) |
Adds an implementation.
| pImplementation | The implementation to be added. |
True on success, false
otherwise.| bool RemoveImplementation | ( | FbxImplementation * | pImplementation | ) |
Removes an implementation.
| pImplementation | The implementation to be removed. |
True on success, false
otherwise.| bool HasDefaultImplementation | ( | void | ) | const |
Determines if this shading node has a default implementation.
True if this shading node has a default
implementation, false otherwise.| FbxImplementation* GetDefaultImplementation | ( | void | ) | const |
Returns the default implementation of this shading node.
| bool SetDefaultImplementation | ( | FbxImplementation * | pImplementation | ) |
Sets the default implementation of this shading node.
| pImplementation | The implementation to be set. |
True on success, false
otherwise.| int GetImplementationCount | ( | const FbxImplementationFilter * | pCriteria = NULL |
) | const |
Returns the number of implementations that satisfy a given criteria.
| pCriteria | The given criteria. |
| FbxImplementation* GetImplementation | ( | int | pIndex, |
| const FbxImplementationFilter * | pCriteria =
NULL |
||
| ) | const |
Returns the implementation at the specified index that satisfies the given criteria.
| pIndex | The specified index. |
| pCriteria | The given criteria. |
| virtual FbxString GetUrl | ( | ) | const [virtual] |
Returns the URL of this object.
| virtual bool SetUrl | ( | char * | pUrl | ) | [virtual] |
Sets the URL of this object.
| pUrl | The URL to be set. |
True on success, false
otherwise.Copy an object content into this object.
| pObject | The source object to copy data from. |
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.
Reimplemented in FbxGeometryBase.
| virtual FbxPeripheral* GetPeripheral | ( | ) | [protected, virtual] |
Retrieves the peripheral of that object.
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.
Reimplemented from FbxPlug.
| virtual FbxClassId GetRuntimeClassId | ( | ) | const [virtual] |
Retrieve 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] |
Reimplemented in FbxPose, FbxCachedEffect, FbxMarker, FbxNode, and FbxSkeleton.
| virtual FbxStringList GetTypeFlags | ( | ) | const [virtual] |
Reimplemented in FbxCharacter, FbxControlSetPlug, FbxVideo, FbxBlendShape, FbxBlendShapeChannel, FbxCachedEffect, FbxCamera, FbxCameraStereo, FbxCluster, FbxDeformer, FbxGenericNode, FbxLight, FbxLODGroup, FbxMarker, FbxNode, FbxNull, FbxOpticalReference, FbxShape, FbxSkeleton, FbxSkin, FbxSubDeformer, and FbxVertexCacheDeformer.
| virtual void SetDocument | ( | FbxDocument * | pDocument | ) | [virtual] |
Reimplemented in FbxDocument, FbxGeometry, and FbxLayerContainer.
| 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] |
Reimplemented in FbxGlobalSettings, FbxIOSettings, FbxAnimCurveNode, FbxAnimStack, FbxConstraint, FbxConstraintAim, FbxConstraintParent, FbxConstraintPosition, FbxConstraintRotation, FbxConstraintScale, FbxConstraintSingleChainIK, FbxContainer, FbxContainerTemplate, FbxDisplayLayer, FbxDocument, FbxDocumentInfo, FbxSceneReference, FbxSelectionSet, FbxThumbnail, FbxVideo, FbxBlendShapeChannel, FbxCache, FbxCachedEffect, FbxCamera, FbxCameraStereo, FbxCameraSwitcher, FbxCluster, FbxGeometryBase, FbxLight, FbxLine, FbxLODGroup, FbxMarker, FbxNode, FbxNodeAttribute, FbxNull, FbxShape, FbxSkeleton, FbxVertexCacheDeformer, FbxBindingOperator, FbxFileTexture, FbxImplementation, FbxProceduralTexture, FbxSurfaceLambert, FbxSurfaceMaterial, FbxSurfacePhong, FbxTexture, FbxProcessorShaderDependency, FbxProcessorXRefCopy, and FbxProcessorXRefCopyUserLibrary.
| virtual void Destruct | ( | bool | pRecursive, |
| bool | pDependents | ||
| ) | [protected, virtual] |
Reimplemented from FbxPlug.
Reimplemented in FbxExporter, FbxImporter, FbxIOSettings, FbxAnimCurve, FbxAnimCurveNode, FbxAnimEvaluator, FbxCharacter, FbxContainerTemplate, FbxDocument, FbxLibrary, FbxPose, FbxSceneReference, FbxThumbnail, FbxCache, FbxCameraSwitcher, FbxGeometry, FbxGeometryWeightedMap, FbxLayerContainer, FbxLine, FbxMesh, FbxNode, FbxNurbs, FbxNurbsCurve, FbxNurbsSurface, FbxPatch, FbxSubDiv, FbxBindingOperator, and FbxProcessorShaderDependency.
| 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.
| pClassId | The ClassId to set as the run-time ClassId for this object. |
Reimplemented from FbxPlug.
| virtual bool ConnecNotify | ( | const FbxConnectEvent & | pEvent | ) | [protected, virtual] |
Reimplemented in FbxCharacter, FbxDocument, FbxSelectionNode, FbxVideo, FbxLayerContainer, and FbxLayeredTexture.
| virtual bool PropertyNotify | ( | EPropertyNotifyType | pType, |
| FbxProperty * | pProperty | ||
| ) | [protected, virtual] |
Reimplemented in FbxNode, and FbxTexture.
friend class FbxScene [friend] |
Reimplemented in FbxGlobalSettings, FbxCharacter, FbxCharacterPose, FbxConstraint, FbxControlSetPlug, FbxBlendShape, FbxBlendShapeChannel, FbxCluster, FbxDeformer, FbxGenericNode, FbxGeometry, FbxLayerContainer, FbxNode, FbxNodeAttribute, FbxSkin, and FbxSubDeformer.
Definition at line 1162 of file fbxobject.h.
friend class FbxProperty
[friend] |
The root property that holds all children property for this object.
Definition at line 1053 of file fbxobject.h.