This reference page is linked to from the following overview topics: Animation Classes and their Interrelationships, FBX Extensions to Maya, FBX Extensions to 3ds Max, Customizing the FBX SDK, Importing a Scene, FBX Extensions to MotionBuilder, Exporting with the FBX Extensions SDK, Importing with the FBX Extensions SDK, FBX SDK 2014, Merging Two Scenes, FBX SDK Object Model, FBX Objects, Managing Memory with the FBX SDK Manager, List of Python Fbx classes, FBX Properties, Extracting the Animation Data from a FBX File, Connections, Evaluating the Animation in a Scene.
#include <fbxobject.h>
The base class of most FBX objects.
Provides the benefits of connectivity, identity, run-time typing, properties, naming, copying, cloning, selection, and automated file IO. Most of the FBX SDK API deals with FbxObject pointers when it comes to manipulate objects in its simplest form.
The ClassID mechanism replaces the dynamic_cast mechanism for efficient run-time type information.
The FbxObject provides methods for managing the connections between objects. Using connections, objects can be related to each other to form hierarchies or structures. All of the FBX scene's object relations are expressed as connections between objects. Those connections can be altered as needed to reflect most kind of setups encountered in this world. For example, connections can be used to express parenting between transform nodes. Connections are not strict in the sense that we allow any type of objects to connect to any other type of objects. The meaning of the connection is purely semantic. As of yet, we do not provide the functionality to validate if the connections made by the users are allowed or not.
FbxObject provide a property (FbxProperty) mechanism to describe characteristics of objects in a scene. Properties may be either static or dynamic. Static properties are defined in the class direction and can be accessed directly by their name on the object exposing them without the need for a search in the property list of the object. Dynamic properties can be added during run-time, while the program is running. Objects can have an unlimited amount of properties. Properties can be listed at run-time, allowing for a flexible support of custom data on objects, since they might be considered by the FBX file readers/writers depending on the flags set.
Here is an example of a new empty minimal class template for FBX objects:
//Declaration class MyClass : public FbxObject { FBXSDK_OBJECT_DECLARE(MyClass, FbxObject); //Be careful! The second parameter to this macro must be the parent class name! public: //Declare methods and properties here... };
//Implementation FBXSDK_OBJECT_IMPLEMENT(MyClass);
Before the new class can be used, it needs to be registered to the manager with the following method:
MyFbxManager->RegisterFbxClass("MyClassName", FBX_TYPE(MyClass), FBX_TYPE(FbxObject)); //Be careful! The 3rd parameter must be the parent class! If the parent class change, it must be updated here too!
Then to create or delete instances of your new class, the following methods must be used:
//Creating a new instance MyClass* MyObject = MyClass::Create(MyFbxManager, "Object Name"); //Deleting this instance MyObject->Destroy(); MyObject = NULL;
ExportScene03/main.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 159 of file fbxobject.h.
Public Member Functions |
|
|
General Object Management
|
|
| FBX_DEPRECATED bool | Is (const FbxClassId &pClassId) const |
| Test if this class is a hierarchical
children of the specified class type. |
|
| template<class T > | |
| FBX_DEPRECATED bool | Is (T *pClassType) const |
| Templated test if this class is a
hierarchical children of the specified class type. |
|
| template<class T > | |
| bool | Is () const |
| Templated test if this class is a
hierarchical children of the specified class type. |
|
| FbxManager * | GetFbxManager () const |
| Retrieve the FbxManager
this object belongs to. |
|
| 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. |
|
| void | Destroy (bool pRecursive=false) |
| Unregister and delete this object from
memory. |
|
| void | ResetProperties () |
| Reset all the properties of this object to
their default values. |
|
|
Selection management
|
|
| virtual bool | GetSelected () |
| Returns if this object is currently in a
selected state. |
|
| virtual void | SetSelected (bool pSelected) |
| Sets whether this object is currently
selected. |
|
|
User data
|
|
| void | SetUserDataPtr (const FbxUInt64 &pUserID, void *pUserData) |
| Sets the data pointer for an user data
record whose ID is pUserID. |
|
| void * | GetUserDataPtr (const FbxUInt64 &pUserID) const |
| Returns the data pointer of an user data
record whose ID is pUserID. |
|
| void | SetUserDataPtr (void *pUserData) |
| Sets the data pointer for the user data
record whose ID is the object ID. |
|
| void * | GetUserDataPtr () const |
| Returns the data pointer of the user data
record whose ID is the object ID. |
|
|
General Object Connection and Relationship
Management
|
|
| bool | ConnectSrcObject (FbxObject *pObject, FbxConnection::EType pType=FbxConnection::eNone) |
| Connects this object to a source object.
|
|
| bool | IsConnectedSrcObject (const FbxObject *pObject) const |
| Judges whether this object connects with the
source object. |
|
| bool | DisconnectSrcObject (FbxObject *pObject) |
| Disconnects this object from a source
object. |
|
| bool | DisconnectAllSrcObject () |
| Disconnects this object from all source
objects. |
|
| bool | DisconnectAllSrcObject (const FbxCriteria &pCriteria) |
| Disconnects this object from all source
objects that satisfy a given criteria. |
|
| FBX_DEPRECATED bool | DisconnectAllSrcObject (FbxClassId pClassId) |
| Disconnects this object from all source
objects of a specific class type. |
|
| int | GetSrcObjectCount () const |
| Returns the number of source objects with
which this object connects. |
|
| int | GetSrcObjectCount (const FbxCriteria &pCriteria) const |
| Returns the number of source objects that
satisfy the given criteria with which this object connects.
|
|
| FBX_DEPRECATED int | GetSrcObjectCount (FbxClassId pClassId) const |
| Returns the number of source objects of the
specific class type with which this object connects. |
|
| 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.
|
|
| FBX_DEPRECATED FbxObject * | GetSrcObject (FbxClassId pClassId, int pIndex=0) const |
| Returns the source object of the specified
class type at the specified index with which this object connects.
|
|
| 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. |
|
| FBX_DEPRECATED FbxObject * | FindSrcObject (FbxClassId pClassId, const char *pName, int pStartIndex=0) const |
| Searches the source object with the
specified name which is also the specified class type, starting at
the specified index. |
|
| template<class T > | |
| FBX_DEPRECATED bool | DisconnectAllSrcObject (const T *pFBX_TYPE) |
| Disconnects this object from all source
objects of the specified class type. |
|
| template<class T > | |
| bool | DisconnectAllSrcObject () |
| Disconnects this object from all source
objects of the specified class type. |
|
| template<class T > | |
| FBX_DEPRECATED bool | DisconnectAllSrcObject (const T *pFBX_TYPE, const FbxCriteria &pCriteria) |
| Disconnects this object from all source
objects that are of the specified class type and that satisfy the
given criteria. |
|
| template<class T > | |
| bool | DisconnectAllSrcObject (const FbxCriteria &pCriteria) |
| Disconnects this object from all source
objects that are of the specified class type and that satisfy the
given criteria. |
|
| template<class T > | |
| FBX_DEPRECATED int | GetSrcObjectCount (const T *pFBX_TYPE) const |
| Returns the number of source objects of a
specific class type with which this object connects. |
|
| template<class T > | |
| int | GetSrcObjectCount () const |
| Returns the number of source objects of a
specific class type with which this object connects. |
|
| template<class T > | |
| FBX_DEPRECATED int | GetSrcObjectCount (const T *pFBX_TYPE, const FbxCriteria &pCriteria) const |
| Returns the number of source objects with
which this object connects that are the specified class type and
that satisfy the given criteria. |
|
| template<class T > | |
| int | GetSrcObjectCount (const FbxCriteria &pCriteria) const |
| Returns the number of source objects with
which this object connects that are the specified class type and
that satisfy the given criteria. |
|
| template<class T > | |
| FBX_DEPRECATED T * | GetSrcObject (const T *pFBX_TYPE, int pIndex=0) const |
| Returns the source object of the specified
class type at the specified index. |
|
| template<class T > | |
| T * | GetSrcObject (int pIndex=0) const |
| Returns the source object of the specified
class type at the specified index. |
|
| template<class T > | |
| FBX_DEPRECATED T * | GetSrcObject (const T *pFBX_TYPE, const FbxCriteria &pCriteria, int pIndex=0) const |
| Returns the source object that is the
specified class type and that satisfies the given criteria at the
specified index. |
|
| template<class T > | |
| T * | GetSrcObject (const FbxCriteria &pCriteria, int pIndex=0) const |
| Returns the source object that is the
specified class type and that satisfies the given criteria at the
specified index. |
|
| template<class T > | |
| FBX_DEPRECATED T * | FindSrcObject (const T *pFBX_TYPE, const char *pName, int pStartIndex=0) const |
| Searches the source object with the
specified name that is the specified class type, starting at the
specified index. |
|
| template<class T > | |
| T * | FindSrcObject (const char *pName, int pStartIndex=0) const |
| Searches the source object with the
specified name that is the specified class type, starting at the
specified index. |
|
| template<class T > | |
| FBX_DEPRECATED T * | FindSrcObject (const T *pFBX_TYPE, const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const |
| Searches the source object with the
specified name that is the specified class type and that satisfies
the given criteria, starting at the specified index. |
|
| template<class T > | |
| T * | FindSrcObject (const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const |
| Searches the source object with the
specified name that is the specified class type and that satisfies
the given criteria, starting at the specified index. |
|
| bool | ConnectDstObject (FbxObject *pObject, FbxConnection::EType pType=FbxConnection::eNone) |
| Connects this object to one destination
object. |
|
| bool | IsConnectedDstObject (const FbxObject *pObject) const |
| Judges whether this object connects with the
destination object. |
|
| bool | DisconnectDstObject (FbxObject *pObject) |
| Disconnects this object from the destination
object. |
|
| bool | DisconnectAllDstObject () |
| Disconnects this object from all destination
objects. |
|
| bool | DisconnectAllDstObject (const FbxCriteria &pCriteria) |
| Disconnects this object from all destination
objects that satisfy given criteria. |
|
| FBX_DEPRECATED bool | DisconnectAllDstObject (FbxClassId pClassId) |
| Disconnects this object from all destination
objects of the specified class type. |
|
| int | GetDstObjectCount () const |
| Returns the number of destination objects
with which this object connects. |
|
| int | GetDstObjectCount (const FbxCriteria &pCriteria) const |
| Returns the number of destination objects
with which this object connects that satisfy the given criteria.
|
|
| FBX_DEPRECATED int | GetDstObjectCount (FbxClassId pClassId) const |
| Returns the number of destination objects of
the specified class type with which this object connects. |
|
| 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. |
|
| FBX_DEPRECATED FbxObject * | GetDstObject (FbxClassId pClassId, int pIndex=0) const |
| Returns the destination object of the
specified class type with which this object connects at the
specified index. |
|
| 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. |
|
| FBX_DEPRECATED FbxObject * | FindDstObject (FbxClassId pClassId, const char *pName, int pStartIndex=0) const |
| Searches the destination object with the
specified name which is the specified class type, starting at the
specified index. |
|
| template<class T > | |
| FBX_DEPRECATED bool | DisconnectAllDstObject (const T *pFBX_TYPE) |
| Disconnects this object from all destination
objects of the specified class type. |
|
| template<class T > | |
| bool | DisconnectAllDstObject () |
| Disconnects this object from all destination
objects of the specified class type. |
|
| template<class T > | |
| FBX_DEPRECATED bool | DisconnectAllDstObject (const T *pFBX_TYPE, const FbxCriteria &pCriteria) |
| Disconnects this object from all destination
objects that are the specified class type and that satisfy the
given criteria. |
|
| template<class T > | |
| bool | DisconnectAllDstObject (const FbxCriteria &pCriteria) |
| Disconnects this object from all destination
objects that are the specified class type and that satisfy the
given criteria. |
|
| template<class T > | |
| FBX_DEPRECATED int | GetDstObjectCount (const T *pFBX_TYPE) const |
| Returns the number of destination objects of
the specified class type with which this object connects. |
|
| template<class T > | |
| int | GetDstObjectCount () const |
| Returns the number of destination objects of
the specified class type with which this object connects. |
|
| template<class T > | |
| FBX_DEPRECATED int | GetDstObjectCount (const T *pFBX_TYPE, const FbxCriteria &pCriteria) const |
| Returns the number of destination objects
with which this object connects that are the specified class type
and that satisfy the given criteria. |
|
| template<class T > | |
| int | GetDstObjectCount (const FbxCriteria &pCriteria) const |
| Returns the number of destination objects
with which this object connects that are the specified class type
and that satisfy the given criteria. |
|
| template<class T > | |
| FBX_DEPRECATED T * | GetDstObject (const T *pFBX_TYPE, int pIndex=0) const |
| Returns the destination object with which
this object connects that is the specified class type at the
specified index. |
|
| template<class T > | |
| T * | GetDstObject (int pIndex=0) const |
| Returns the destination object with which
this object connects that is the specified class type at the
specified index. |
|
| template<class T > | |
| FBX_DEPRECATED T * | GetDstObject (const T *pFBX_TYPE, const FbxCriteria &pCriteria, int pIndex=0) const |
| Returns the destination object with which
this object connects that is the specified class type and that
satisfies the given criteria at the specified index. |
|
| template<class T > | |
| T * | GetDstObject (const FbxCriteria &pCriteria, int pIndex=0) const |
| Returns the destination object with which
this object connects that is the specified class type and that
satisfies the given criteria at the specified index. |
|
| template<class T > | |
| FBX_DEPRECATED T * | FindDstObject (const T *pFBX_TYPE, const char *pName, int pStartIndex=0) const |
| Searches the destination object with the
specified name which is of the specified class type, starting at
the specified index. |
|
| template<class T > | |
| T * | FindDstObject (const char *pName, int pStartIndex=0) const |
| Searches the destination object with the
specified name which is of the specified class type, starting at
the specified index. |
|
| template<class T > | |
| FBX_DEPRECATED T * | FindDstObject (const T *pFBX_TYPE, const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const |
| Searches the destination object with the
specified name that is the specified class type and that satisfies
the given criteria, starting at the specified index. |
|
| template<class T > | |
| T * | FindDstObject (const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const |
| Searches the destination object with the
specified name that is the specified class type and that satisfies
the given criteria, starting at the specified index. |
|
|
Property Management
|
|
| FbxProperty | GetFirstProperty () const |
| Returns the first property of this object.
|
|
| FbxProperty | GetNextProperty (const FbxProperty &pProperty) const |
| Returns the next property of this object
that follows the specified property. |
|
| FbxProperty | FindProperty (const char *pName, bool pCaseSensitive=true) const |
| Searches a property by name. |
|
| FbxProperty | FindProperty (const char *pName, const FbxDataType &pDataType, bool pCaseSensitive=true) const |
| Searches a property by name and data type.
|
|
| FbxProperty | FindPropertyHierarchical (const char *pName, bool pCaseSensitive=true) const |
| Searches a property by full name. |
|
| FbxProperty | FindPropertyHierarchical (const char *pName, const FbxDataType &pDataType, bool pCaseSensitive=true) const |
| Searches a property by full name and data
type. |
|
| FBX_DEPRECATED FbxProperty & | GetRootProperty () |
| Returns the root property of this object.
|
|
| FBX_DEPRECATED const FbxProperty & | GetRootProperty () const |
| Returns the root property of this object.
|
|
| FbxProperty | GetClassRootProperty () |
| Returns the class root property. |
|
| bool | ConnectSrcProperty (const FbxProperty &pProperty) |
| Connects this object to a source property.
|
|
| bool | IsConnectedSrcProperty (const FbxProperty &pProperty) |
| Determines whether this object connects with
the specified source property. |
|
| bool | DisconnectSrcProperty (const FbxProperty &pProperty) |
| Disconnects this object from the specified
source property. |
|
| int | GetSrcPropertyCount () const |
| Returns the number of source properties with
which this object connects. |
|
| FbxProperty | GetSrcProperty (int pIndex=0) const |
| Returns the source property at the specified
index with which this object connects. |
|
| FbxProperty | FindSrcProperty (const char *pName, int pStartIndex=0) const |
| Searches a source property with which this
object connects that has a specific name, starting at the specified
index. |
|
| bool | ConnectDstProperty (const FbxProperty &pProperty) |
| Connects this object to a destination
property. |
|
| bool | IsConnectedDstProperty (const FbxProperty &pProperty) |
| Determines if this object connects with the
specified destination property. |
|
| bool | DisconnectDstProperty (const FbxProperty &pProperty) |
| Disconnects this object from the specified
destination property. |
|
| int | GetDstPropertyCount () const |
| Returns the number of destination properties
with which this object connects. |
|
| FbxProperty | GetDstProperty (int pIndex=0) const |
| Returns the destination property at the
specified index with which this object connects. |
|
| FbxProperty | FindDstProperty (const char *pName, int pStartIndex=0) const |
| Searches a destination property with which
this object connects that has a specific name, starting at the
specified index. |
|
|
Off-Loading Management
|
|
|
|
| int | ContentUnload () |
| Unloads this object's content using the
offload peripheral that is currently set in the document then
flushes it from memory. |
|
| int | ContentLoad () |
| Loads this object's content using the
offload peripheral that is currently set in the document. |
|
| bool | ContentIsLoaded () const |
| Judges if this object's content is loaded.
|
|
| void | ContentDecrementLockCount () |
| Decreases the content lock count of an
object. |
|
| void | ContentIncrementLockCount () |
| Increases the content lock count of an
object. |
|
| bool | ContentIsLocked () const |
| Judges if this object's content is locked.
|
|
| virtual bool | ContentWriteTo (FbxStream &pStream) const |
| Writes the content of the object to the
given stream. |
|
| virtual bool | ContentReadFrom (const FbxStream &pStream) |
| Reads the content of the object from the
given stream. |
|
|
Logging.
|
|
| void | EmitMessage (FbxMessage *pMessage) const |
| Emits a message in all available message
emitters in the document or SDK manager. |
|
|
Localization helper.
|
|
| virtual const char * | Localize (const char *pID, const char *pDefault=NULL) const |
| Localization helper function, it calls the
implementation of FBX SDK manager. |
|
|
Application Implementation
Management
|
|
| 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. |
|
|
Run-time ClassId Management
|
|
| void | SetRuntimeClassId (const FbxClassId &pClassId) |
| Set the run-time ClassId for this class.
|
|
| FbxClassId | GetRuntimeClassId () const |
| Retrieve the run-time ClassId for this
object. |
|
| bool | IsRuntime (const FbxClassId &pClassId) const |
| Test if this class is a hierarchical
children of the specified class type. |
|
| bool | IsRuntimePlug () const |
| Find out if the ClassId was registered
during run-time rather than at compile time. |
|
Public Attributes |
|
| FbxProperty | RootProperty |
| The root property that holds all children
property for this object. |
|
Protected Member Functions |
|
| virtual void | Construct (const FbxObject *pFrom) |
| Optional constructor override, automatically
called by default constructor. |
|
| virtual void | ConstructProperties (bool pForceSet) |
| Optional property constructor override,
automatically called by default constructor. |
|
| virtual void | Destruct (bool pRecursive) |
| Optional destructor override, automatically
called by default destructor. |
|
| virtual void | ContentClear () |
| Clears this object's content from memory.
|
|
| virtual FbxPeripheral * | GetPeripheral () |
| Retrieves the peripheral of that object.
|
|
Object Flags Management |
|
| enum | EObjectFlag
{ eNone = 0, eInitialized = 1 << 0, eSystem = 1 << 1, eSavable = 1 << 2, eSelected = 1 << 3, eHidden = 1 << 4, eContentLoaded = 1 << 5, eDontLocalize = 1 << 6 } |
| Flags available to control objects. More... |
|
| void | SetObjectFlags (EObjectFlag pFlags, bool pValue) |
| Set the state of object flags. |
|
| bool | GetObjectFlags (EObjectFlag pFlags) const |
| Get the state of object flags. |
|
| void | SetAllObjectFlags (FbxUInt pFlags) |
| Override all object flags at once. |
|
| FbxUInt | GetAllObjectFlags () const |
| Get all object flags at once. |
|
Copying, Cloning and Referencing |
|
| enum | ECloneType { eDeepClone, eReferenceClone } |
| Types of clones that can be created for
FbxObject. More... |
|
| virtual FbxObject & | Copy (const FbxObject &pObject) |
| Copy an object content into this object.
|
|
| 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 EObjectFlag |
Flags available to control objects.
| eNone |
No flags. |
| eInitialized |
Automatically set when FbxObject::Construct() is completed. |
| eSystem |
When set, object is deleted upon FbxManager destroy only. Use carefully! |
| eSavable |
If set, object is stored in FBX file upon export. All objects are savable by default. |
| eSelected |
Used by the selection mechanic to specify a selected object. |
| eHidden |
Used for interface representation; if set, the object should not be visible. |
| eContentLoaded |
Used by load-on-demand mechanic to specify if an object has its content loaded. |
| eDontLocalize |
Used by asset builder; Do not localize this object. |
Definition at line 211 of file fbxobject.h.
{
| enum ECloneType |
Types of clones that can be created for FbxObject.
Definition at line 252 of file fbxobject.h.
| FBX_DEPRECATED bool Is | ( | const FbxClassId & | pClassId | ) | const [inline] |
Test if this class is a hierarchical children of the specified class type.
This is the standard method to differentiate object classes. (Deprecated, please use Is<Type>() instead.)
| pClassId | The class type to test against self. |
true if the object is a hierarchical children of
the type specified.Definition at line 170 of file fbxobject.h.
{ return Is(T::ClassId); }
| FBX_DEPRECATED bool Is | ( | T * | pClassType | ) | const [inline] |
Templated test if this class is a hierarchical children of the specified class type.
(Deprecated, please use Is<Type>() instead.)
| pClassType | A direct pointer to the C++ type of the object to test against. |
true if the object is a hierarchical children of
the type specified.Definition at line 176 of file fbxobject.h.
{ return GetClassId().Is(T::ClassId); }
| bool Is | ( | ) | const [inline] |
Templated test if this class is a hierarchical children of the specified class type.
true if the object is a hierarchical children of
the type specified.Definition at line 181 of file fbxobject.h.
{
| FbxManager* GetFbxManager | ( | ) | const |
Retrieve the FbxManager this object belongs to.
| 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 Destroy | ( | bool | pRecursive = false |
) |
Unregister and delete this object from memory.
This will also breaks all connections as well as removing all the instance of all the properties of this object with the object's class.
| pRecursive | If true, all children (source) objects will also be unregistered and deleted. |
| void ResetProperties | ( | ) |
Reset all the properties of this object to their default values.
| void SetObjectFlags | ( | EObjectFlag | pFlags, |
| bool | pValue | ||
| ) |
Set the state of object flags.
| pFlags | Bit flags which value is going to be changed. |
| pValue | If true, bit flags will be set, otherwise bits
will be un-set. |
| bool GetObjectFlags | ( | EObjectFlag | pFlags | ) | const |
Get the state of object flags.
| pFlags | Bit flags to query. |
true if the specified bit flags are all set.| void SetAllObjectFlags | ( | FbxUInt | pFlags | ) |
Override all object flags at once.
| pFlags | The bit flags to set all the object flags to. |
| FbxUInt GetAllObjectFlags | ( | ) | const |
Copy an object content into this object.
| pObject | The source object to copy data from. |
Reimplemented in FbxMesh.
| virtual FbxObject* Clone | ( | FbxObject::ECloneType | pCloneType =
eDeepClone, |
| FbxObject * | pContainer =
NULL |
||
| ) | const [virtual] |
Creates a clone of this object.
By default, the connections are NOT cloned. If the desired effect is to clone the connections as well, you must clone using the FbxCloneManager (refer to this class documentation for further details).
| 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.
| 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. |
| 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 414 of file fbxobject.h.
{ return GetUserDataPtr(GetUniqueID()); }
| void* GetUserDataPtr | ( | ) | const [inline] |
Returns the data pointer of the user data record whose ID is the object ID.
NULL if
the user data record is not found.Definition at line 419 of file fbxobject.h.
| bool ConnectSrcObject | ( | FbxObject * | pObject, |
| FbxConnection::EType | pType =
FbxConnection::eNone |
||
| ) | [inline] |
Connects this object to a source object.
| 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 431 of file fbxobject.h.
{ return RootProperty.IsConnectedSrcObject(pObject); }
| bool IsConnectedSrcObject | ( | const FbxObject * | pObject | ) | const [inline] |
Judges whether this object connects with the source object.
| pObject | The source object. |
True if this object connects with the source
object, false otherwise.Definition at line 437 of file fbxobject.h.
{ return RootProperty.DisconnectSrcObject(pObject); }
| bool DisconnectSrcObject | ( | FbxObject * | pObject | ) | [inline] |
Disconnects this object from a source object.
| pObject | The source object from which this object will be disconnected. |
True on success, false
otherwise.Definition at line 443 of file fbxobject.h.
{ return RootProperty.DisconnectAllSrcObject(); }
| bool DisconnectAllSrcObject | ( | ) | [inline] |
Disconnects this object from all source objects.
True if it disconnects all source objects
successfully, false otherwise.Definition at line 448 of file fbxobject.h.
{ return RootProperty.DisconnectAllSrcObject(pCriteria); }
| bool DisconnectAllSrcObject | ( | const FbxCriteria & | pCriteria | ) | [inline] |
Disconnects this object from all source objects that satisfy a given criteria.
| pCriteria | The given criteria. |
True if it disconnects all the source objects
successfully, false otherwise.Definition at line 454 of file fbxobject.h.
{ return RootProperty.DisconnectAllSrcObject(FbxCriteria::ObjectType(pClassId)); }
| FBX_DEPRECATED bool DisconnectAllSrcObject | ( | FbxClassId | pClassId | ) | [inline] |
Disconnects this object from all source objects of a specific class type.
(Deprecated, please use DisconnectAllSrcObject<Type>() instead.)
| pClassId | The specific class type. |
True if it disconnects all source objects
successfully, false otherwise.Definition at line 460 of file fbxobject.h.
{ return RootProperty.GetSrcObjectCount(); }
| int GetSrcObjectCount | ( | ) | const [inline] |
Returns the number of source objects with which this object connects.
Definition at line 465 of file fbxobject.h.
{ return RootProperty.GetSrcObjectCount(pCriteria); }
| int GetSrcObjectCount | ( | const FbxCriteria & | pCriteria | ) | const [inline] |
Returns the number of source objects that satisfy the given criteria with which this object connects.
| pCriteria | The given criteria. |
Definition at line 471 of file fbxobject.h.
{ return RootProperty.GetSrcObjectCount(FbxCriteria::ObjectType(pClassId)); }
| FBX_DEPRECATED int GetSrcObjectCount | ( | FbxClassId | pClassId | ) | const [inline] |
Returns the number of source objects of the specific class type with which this object connects.
(Deprecated, please use GetSrcObjectCount<Type>() instead.)
| pClassId | The specific class type. |
Definition at line 477 of file fbxobject.h.
{ return RootProperty.GetSrcObject(pIndex); }
| FbxObject* GetSrcObject | ( | int | pIndex = 0 |
) | const [inline] |
Returns the source object with which this object connects at the specified index.
| pIndex | The specified index whose default value is 0. |
Definition at line 483 of file fbxobject.h.
{ return RootProperty.GetSrcObject(pCriteria,pIndex); }
| FbxObject* GetSrcObject | ( | const FbxCriteria & | pCriteria, |
| int | pIndex = 0 |
||
| ) | const [inline] |
Returns the source object that satisfies the criteria at the specified index with which this object connects.
| pCriteria | The given criteria. |
| pIndex | The specified index whose default value is 0. |
Definition at line 490 of file fbxobject.h.
{ return RootProperty.GetSrcObject(FbxCriteria::ObjectType(pClassId), pIndex); }
| FBX_DEPRECATED FbxObject* GetSrcObject | ( | FbxClassId | pClassId, |
| int | pIndex = 0 |
||
| ) | const [inline] |
Returns the source object of the specified class type at the specified index with which this object connects.
(Deprecated, please use GetSrcObject<Type>() instead.)
| pClassId | The specified class type. |
| pIndex | The specified index whose default value is 0. |
Definition at line 497 of file fbxobject.h.
{ return RootProperty.FindSrcObject(pName,pStartIndex); }
| FbxObject* FindSrcObject | ( | const char * | pName, |
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches the source object with the specified name, starting at the specified index.
| pName | The object name. |
| pStartIndex | The start index. |
Definition at line 504 of file fbxobject.h.
{ return RootProperty.FindSrcObject(pCriteria,pName,pStartIndex); }
| FbxObject* FindSrcObject | ( | const FbxCriteria & | pCriteria, |
| const char * | pName, | ||
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches the source object with the specified name which satisfies the given criteria, starting at the specified index.
| pCriteria | The given criteria. |
| pName | The object name. |
| pStartIndex | The start index. |
Definition at line 512 of file fbxobject.h.
{ return RootProperty.FindSrcObject(FbxCriteria::ObjectType(pClassId), pName, pStartIndex); }
| FBX_DEPRECATED FbxObject* FindSrcObject | ( | FbxClassId | pClassId, |
| const char * | pName, | ||
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches the source object with the specified name which is also the specified class type, starting at the specified index.
(Deprecated, please use FindSrcObject<Type>() instead.)
| pClassId | The specified class type. |
| pName | The object name. |
| pStartIndex | The start index. |
Definition at line 520 of file fbxobject.h.
{ return RootProperty.DisconnectAllSrcObject(pFBX_TYPE); }
| FBX_DEPRECATED bool DisconnectAllSrcObject | ( | const T * | pFBX_TYPE | ) | [inline] |
Disconnects this object from all source objects of the specified class type.
(Deprecated, please use DisconnectAllSrcObject<Type>() instead.)
| pFBX_TYPE | The specified class type. |
True if it disconnects all source objects
successfully, false otherwise.Definition at line 526 of file fbxobject.h.
{ return RootProperty.DisconnectAllSrcObject(FbxCriteria::ObjectType(T::ClassId)); }
| bool DisconnectAllSrcObject | ( | ) | [inline] |
Disconnects this object from all source objects of the specified class type.
true if it disconnects all source objects
successfully, false otherwise.Definition at line 530 of file fbxobject.h.
{ return RootProperty.DisconnectAllSrcObject(pFBX_TYPE,pCriteria); }
| FBX_DEPRECATED bool DisconnectAllSrcObject | ( | const T * | pFBX_TYPE, |
| const FbxCriteria & | pCriteria | ||
| ) | [inline] |
Disconnects this object from all source objects that are of the specified class type and that satisfy the given criteria.
(Deprecated, please use DisconnectAllSrcObject<Type>() instead.)
| pFBX_TYPE | The specified class type. |
| pCriteria | The given criteria. |
True if it disconnects all source objects
successfully, false otherwise.Definition at line 537 of file fbxobject.h.
{ return RootProperty.DisconnectAllSrcObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }
| bool DisconnectAllSrcObject | ( | const FbxCriteria & | pCriteria | ) | [inline] |
Disconnects this object from all source objects that are of the specified class type and that satisfy the given criteria.
| pCriteria | The given criteria. |
true if it disconnects all source objects
successfully, false otherwise.Definition at line 542 of file fbxobject.h.
{ return RootProperty.GetSrcObjectCount(pFBX_TYPE); }
| FBX_DEPRECATED int GetSrcObjectCount | ( | const T * | pFBX_TYPE | ) | const [inline] |
Returns the number of source objects of a specific class type with which this object connects.
(Deprecated, please use GetSrcObjectCount<Type>() instead.)
| pFBX_TYPE | The specified class type. |
Definition at line 547 of file fbxobject.h.
{ return RootProperty.GetSrcObjectCount(FbxCriteria::ObjectType(T::ClassId)); }
| int GetSrcObjectCount | ( | ) | const [inline] |
Returns the number of source objects of a specific class type with which this object connects.
Definition at line 551 of file fbxobject.h.
{ return RootProperty.GetSrcObjectCount(pFBX_TYPE,pCriteria); }
| FBX_DEPRECATED int GetSrcObjectCount | ( | const T * | pFBX_TYPE, |
| const FbxCriteria & | pCriteria | ||
| ) | const [inline] |
Returns the number of source objects with which this object connects that are the specified class type and that satisfy the given criteria.
(Deprecated, please use GetSrcObjectCount<Type>() instead.)
| pFBX_TYPE | The specified class type. |
| pCriteria | The given criteria. |
Definition at line 557 of file fbxobject.h.
{ return RootProperty.GetSrcObjectCount(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }
| int GetSrcObjectCount | ( | const FbxCriteria & | pCriteria | ) | const [inline] |
Returns the number of source objects with which this object connects that are the specified class type and that satisfy the given criteria.
| pCriteria | The given criteria. |
Definition at line 562 of file fbxobject.h.
{ return RootProperty.GetSrcObject(pFBX_TYPE, pIndex); }
| FBX_DEPRECATED T* GetSrcObject | ( | const T * | pFBX_TYPE, |
| int | pIndex = 0 |
||
| ) | const [inline] |
Returns the source object of the specified class type at the specified index.
(Deprecated, please use GetSrcObject<Type>() instead.)
| pFBX_TYPE | The specified class type. |
| pIndex | The specified index whose default value is 0. |
Definition at line 568 of file fbxobject.h.
{ return (T*)RootProperty.GetSrcObject(FbxCriteria::ObjectType(T::ClassId), pIndex); }
| T* GetSrcObject | ( | int | pIndex = 0 |
) | const [inline] |
Returns the source object of the specified class type at the specified index.
| pIndex | The specified index whose default value is 0. |
Definition at line 573 of file fbxobject.h.
{ return RootProperty.GetSrcObject(pFBX_TYPE,pCriteria,pIndex); }
| FBX_DEPRECATED T* GetSrcObject | ( | const T * | pFBX_TYPE, |
| const FbxCriteria & | pCriteria, | ||
| int | pIndex = 0 |
||
| ) | const [inline] |
Returns the source object that is the specified class type and that satisfies the given criteria at the specified index.
(Deprecated, please use GetSrcObject<Type>() instead.)
| pFBX_TYPE | The specified class type. |
| pCriteria | The given criteria. |
| pIndex | The specified index whose default value is 0. |
Definition at line 580 of file fbxobject.h.
{ return (T*)RootProperty.GetSrcObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, pIndex); }
| T* GetSrcObject | ( | const FbxCriteria & | pCriteria, |
| int | pIndex = 0 |
||
| ) | const [inline] |
Returns the source object that is the specified class type and that satisfies the given criteria at the specified index.
| pCriteria | The given criteria. |
| pIndex | The specified index whose default value is 0. |
Definition at line 586 of file fbxobject.h.
{ return RootProperty.FindSrcObject(pFBX_TYPE,pName,pStartIndex); }
| FBX_DEPRECATED T* FindSrcObject | ( | const T * | pFBX_TYPE, |
| const char * | pName, | ||
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches the source object with the specified name that is the specified class type, starting at the specified index.
(Deprecated, please use FindSrcObject<Type>() instead.)
| pFBX_TYPE | The specified class type. |
| pName | The object name. |
| pStartIndex | The start index. |
Definition at line 594 of file fbxobject.h.
{ return (T*)RootProperty.FindSrcObject(FbxCriteria::ObjectType(T::ClassId), pName, pStartIndex); }
| T* FindSrcObject | ( | const char * | pName, |
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches the source object with the specified name that is the specified class type, starting at the specified index.
| pName | The object name. |
| pStartIndex | The start index. |
Definition at line 600 of file fbxobject.h.
{ return RootProperty.FindSrcObject(pFBX_TYPE,pCriteria,pName,pStartIndex); }
| FBX_DEPRECATED T* FindSrcObject | ( | const T * | pFBX_TYPE, |
| const FbxCriteria & | pCriteria, | ||
| const char * | pName, | ||
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches the source object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index.
(Deprecated, please use FindSrcObject<Type>() instead.)
| pFBX_TYPE | The specified class type. |
| pCriteria | The given criteria. |
| pName | The object name. |
| pStartIndex | The start index. |
Definition at line 609 of file fbxobject.h.
{ return (T*)RootProperty.FindSrcObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, pName, pStartIndex); }
| T* FindSrcObject | ( | const FbxCriteria & | pCriteria, |
| const char * | pName, | ||
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches the source object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index.
| pCriteria | The given criteria. |
| pName | The object name. |
| pStartIndex | The start index. |
Definition at line 616 of file fbxobject.h.
| bool ConnectDstObject | ( | FbxObject * | pObject, |
| FbxConnection::EType | pType =
FbxConnection::eNone |
||
| ) | [inline] |
Connects this object to one destination object.
| 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 623 of file fbxobject.h.
{ return RootProperty.IsConnectedDstObject(pObject); }
| bool IsConnectedDstObject | ( | const FbxObject * | pObject | ) | const [inline] |
Judges whether this object connects with the destination object.
| pObject | The destination object. |
True if this object connects with the destination
object, false otherwise.Definition at line 629 of file fbxobject.h.
{ return RootProperty.DisconnectDstObject(pObject); }
| bool DisconnectDstObject | ( | FbxObject * | pObject | ) | [inline] |
Disconnects this object from the destination object.
| pObject | The destination object from which this object disconnects. |
True on success, false
otherwise.Definition at line 635 of file fbxobject.h.
{ return RootProperty.DisconnectAllDstObject(); }
| bool DisconnectAllDstObject | ( | ) | [inline] |
Disconnects this object from all destination objects.
True if it disconnects all destination objects
successfully, false otherwise.Definition at line 640 of file fbxobject.h.
{ return RootProperty.DisconnectAllDstObject(pCriteria); }
| bool DisconnectAllDstObject | ( | const FbxCriteria & | pCriteria | ) | [inline] |
Disconnects this object from all destination objects that satisfy given criteria.
| pCriteria | The given criteria. |
True if it disconnects all destination objects
successfully, false otherwise.Definition at line 646 of file fbxobject.h.
{ return RootProperty.DisconnectAllDstObject(FbxCriteria::ObjectType(pClassId)); }
| FBX_DEPRECATED bool DisconnectAllDstObject | ( | FbxClassId | pClassId | ) | [inline] |
Disconnects this object from all destination objects of the specified class type.
(Deprecated, please use DisconnectAllDstObject<Type>() instead.)
| pClassId | The specified class type. |
True if it disconnects all destination objects of
the specified class type successfully, false
otherwise.Definition at line 652 of file fbxobject.h.
{ return RootProperty.GetDstObjectCount(); }
| int GetDstObjectCount | ( | ) | const [inline] |
Returns the number of destination objects with which this object connects.
Definition at line 657 of file fbxobject.h.
{ return RootProperty.GetDstObjectCount(pCriteria); }
| int GetDstObjectCount | ( | const FbxCriteria & | pCriteria | ) | const [inline] |
Returns the number of destination objects with which this object connects that satisfy the given criteria.
| pCriteria | The given criteria. |
Definition at line 663 of file fbxobject.h.
{ return RootProperty.GetDstObjectCount(FbxCriteria::ObjectType(pClassId)); }
| FBX_DEPRECATED int GetDstObjectCount | ( | FbxClassId | pClassId | ) | const [inline] |
Returns the number of destination objects of the specified class type with which this object connects.
(Deprecated, please use GetDstObjectCount<Type>() instead.)
| pClassId | The specified class type. |
Definition at line 669 of file fbxobject.h.
{ return RootProperty.GetDstObject(pIndex); }
| FbxObject* GetDstObject | ( | int | pIndex = 0 |
) | const [inline] |
Returns the destination object at the specified index with which this object connects.
| pIndex | The specified index whose default value is 0. |
Definition at line 675 of file fbxobject.h.
{ return RootProperty.GetDstObject(pCriteria,pIndex); }
| FbxObject* GetDstObject | ( | const FbxCriteria & | pCriteria, |
| int | pIndex = 0 |
||
| ) | const [inline] |
Returns the destination object with which this object connects that satisfies the given criteria at the specified index.
| pCriteria | The given criteria. |
| pIndex | The specified index whose default value is 0. |
Definition at line 682 of file fbxobject.h.
{ return RootProperty.GetDstObject(FbxCriteria::ObjectType(pClassId), pIndex); }
| FBX_DEPRECATED FbxObject* GetDstObject | ( | FbxClassId | pClassId, |
| int | pIndex = 0 |
||
| ) | const [inline] |
Returns the destination object of the specified class type with which this object connects at the specified index.
(Deprecated, please use GetDstObject<Type>() instead.)
| pClassId | The specified class type. |
| pIndex | The specified index whose default value is 0. |
Definition at line 689 of file fbxobject.h.
{ return RootProperty.FindDstObject(pName,pStartIndex); }
| FbxObject* FindDstObject | ( | const char * | pName, |
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches the destination object with the specified name, starting at the specified index.
| pName | The object name. |
| pStartIndex | The start index. |
Definition at line 696 of file fbxobject.h.
{ return RootProperty.FindDstObject(pCriteria,pName,pStartIndex); }
| FbxObject* FindDstObject | ( | const FbxCriteria & | pCriteria, |
| const char * | pName, | ||
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches the destination object with the specified name which satisfies the given criteria, starting at the specified index.
| pCriteria | The given criteria. |
| pName | The object name. |
| pStartIndex | The start index. |
Definition at line 704 of file fbxobject.h.
{ return RootProperty.FindDstObject(FbxCriteria::ObjectType(pClassId), pName, pStartIndex); }
| FBX_DEPRECATED FbxObject* FindDstObject | ( | FbxClassId | pClassId, |
| const char * | pName, | ||
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches the destination object with the specified name which is the specified class type, starting at the specified index.
(Deprecated, please use FindDstObject<Type>() instead.)
| pClassId | The specified class type. |
| pName | The object name. |
| pStartIndex | The start index. |
Definition at line 712 of file fbxobject.h.
{ return RootProperty.DisconnectAllDstObject(pFBX_TYPE); }
| FBX_DEPRECATED bool DisconnectAllDstObject | ( | const T * | pFBX_TYPE | ) | [inline] |
Disconnects this object from all destination objects of the specified class type.
(Deprecated, please use DisconnectAllDstObject<Type>() instead.)
| pFBX_TYPE | The specified class type. |
true if it disconnects all destination objects of
the specified class type successfully, false
otherwise.Definition at line 718 of file fbxobject.h.
{ return RootProperty.DisconnectAllDstObject(FbxCriteria::ObjectType(T::ClassId)); }
| bool DisconnectAllDstObject | ( | ) | [inline] |
Disconnects this object from all destination objects of the specified class type.
true if it disconnects all destination objects of
the specified class type successfully, false
otherwise.Definition at line 722 of file fbxobject.h.
{ return RootProperty.DisconnectAllDstObject(pFBX_TYPE,pCriteria); }
| FBX_DEPRECATED bool DisconnectAllDstObject | ( | const T * | pFBX_TYPE, |
| const FbxCriteria & | pCriteria | ||
| ) | [inline] |
Disconnects this object from all destination objects that are the specified class type and that satisfy the given criteria.
(Deprecated, please use DisconnectAllDstObject<Type>() instead.)
| pFBX_TYPE | The specified class type. |
| pCriteria | The given criteria. |
true if it disconnects all destination objects
successfully, false otherwise.Definition at line 729 of file fbxobject.h.
{ return RootProperty.DisconnectAllDstObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }
| bool DisconnectAllDstObject | ( | const FbxCriteria & | pCriteria | ) | [inline] |
Disconnects this object from all destination objects that are the specified class type and that satisfy the given criteria.
| pCriteria | The given criteria. |
true if it disconnects all destination objects
successfully, false otherwise.Definition at line 734 of file fbxobject.h.
{ return RootProperty.GetDstObjectCount(pFBX_TYPE); }
| FBX_DEPRECATED int GetDstObjectCount | ( | const T * | pFBX_TYPE | ) | const [inline] |
Returns the number of destination objects of the specified class type with which this object connects.
(Deprecated, please use GetDstObjectCount<Type>() instead.)
| pFBX_TYPE | The specified class type. |
Definition at line 740 of file fbxobject.h.
{ return RootProperty.GetDstObjectCount(FbxCriteria::ObjectType(T::ClassId)); }
| int GetDstObjectCount | ( | ) | const [inline] |
Returns the number of destination objects of the specified class type with which this object connects.
Definition at line 744 of file fbxobject.h.
{ return RootProperty.GetDstObjectCount(pFBX_TYPE,pCriteria); }
| FBX_DEPRECATED int GetDstObjectCount | ( | const T * | pFBX_TYPE, |
| const FbxCriteria & | pCriteria | ||
| ) | const [inline] |
Returns the number of destination objects with which this object connects that are the specified class type and that satisfy the given criteria.
(Deprecated, please use GetDstObjectCount<Type>() instead.)
| pFBX_TYPE | The specified class type. |
| pCriteria | The given criteria. |
Definition at line 751 of file fbxobject.h.
{ return RootProperty.GetDstObjectCount(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }
| int GetDstObjectCount | ( | const FbxCriteria & | pCriteria | ) | const [inline] |
Returns the number of destination objects with which this object connects that are the specified class type and that satisfy the given criteria.
| pCriteria | The given criteria. |
Definition at line 756 of file fbxobject.h.
{ return RootProperty.GetDstObject(pFBX_TYPE,pIndex); }
| FBX_DEPRECATED T* GetDstObject | ( | const T * | pFBX_TYPE, |
| int | pIndex = 0 |
||
| ) | const [inline] |
Returns the destination object with which this object connects that is the specified class type at the specified index.
(Deprecated, please use GetDstObject<Type>() instead.)
| pFBX_TYPE | The specified class type. |
| pIndex | The specified index whose default value is 0. |
Definition at line 763 of file fbxobject.h.
{ return (T*)RootProperty.GetDstObject(FbxCriteria::ObjectType(T::ClassId), pIndex); }
| T* GetDstObject | ( | int | pIndex = 0 |
) | const [inline] |
Returns the destination object with which this object connects that is the specified class type at the specified index.
| pIndex | The specified index whose default value is 0. |
Definition at line 768 of file fbxobject.h.
{ return RootProperty.GetDstObject(pFBX_TYPE,pCriteria,pIndex); }
| FBX_DEPRECATED T* GetDstObject | ( | const T * | pFBX_TYPE, |
| const FbxCriteria & | pCriteria, | ||
| int | pIndex = 0 |
||
| ) | const [inline] |
Returns the destination object with which this object connects that is the specified class type and that satisfies the given criteria at the specified index.
(Deprecated, please use GetDstObject<Type>() instead.)
| pFBX_TYPE | The specified class type. |
| pCriteria | The given criteria. |
| pIndex | The specified index whose default value is 0. |
Definition at line 776 of file fbxobject.h.
{ return (T*)RootProperty.GetDstObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, pIndex); }
| T* GetDstObject | ( | const FbxCriteria & | pCriteria, |
| int | pIndex = 0 |
||
| ) | const [inline] |
Returns the destination object with which this object connects that is the specified class type and that satisfies the given criteria at the specified index.
| pCriteria | The given criteria. |
| pIndex | The specified index whose default value is 0. |
Definition at line 782 of file fbxobject.h.
{ return RootProperty.FindDstObject(pFBX_TYPE,pName,pStartIndex); }
| FBX_DEPRECATED T* FindDstObject | ( | const T * | pFBX_TYPE, |
| const char * | pName, | ||
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches the destination object with the specified name which is of the specified class type, starting at the specified index.
(Deprecated, please use FindDstObject<Type>() instead.)
| pFBX_TYPE | The specified class type. |
| pName | The object name. |
| pStartIndex | The start index. |
Definition at line 790 of file fbxobject.h.
{ return (T*)RootProperty.FindDstObject(FbxCriteria::ObjectType(T::ClassId), pName, pStartIndex); }
| T* FindDstObject | ( | const char * | pName, |
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches the destination object with the specified name which is of the specified class type, starting at the specified index.
| pName | The object name. |
| pStartIndex | The start index. |
Definition at line 796 of file fbxobject.h.
{ return RootProperty.FindDstObject(pFBX_TYPE,pCriteria,pName,pStartIndex); }
| FBX_DEPRECATED T* FindDstObject | ( | const T * | pFBX_TYPE, |
| const FbxCriteria & | pCriteria, | ||
| const char * | pName, | ||
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches the destination object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index.
(Deprecated, please use FindDstObject<Type>() instead.)
| pFBX_TYPE | The specified class type. |
| pCriteria | The given criteria. |
| pName | The object name. |
| pStartIndex | The start index. |
Definition at line 805 of file fbxobject.h.
{ return (T*)RootProperty.FindDstObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, pName, pStartIndex); }
| T* FindDstObject | ( | const FbxCriteria & | pCriteria, |
| const char * | pName, | ||
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches the destination object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index.
| pCriteria | The given criteria. |
| pName | The object name. |
| pStartIndex | The start index. |
Definition at line 812 of file fbxobject.h.
{
| FbxProperty GetFirstProperty | ( | ) | const [inline] |
Returns the first property of this object.
Definition at line 822 of file fbxobject.h.
{
| FbxProperty GetNextProperty | ( | const FbxProperty & | pProperty | ) | const [inline] |
Returns the next property of this object that follows the specified property.
| pProperty | The specified property. |
Definition at line 831 of file fbxobject.h.
{
| 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 841 of file fbxobject.h.
{
| FbxProperty FindProperty | ( | const char * | pName, |
| const FbxDataType & | pDataType, | ||
| bool | pCaseSensitive =
true |
||
| ) | const [inline] |
Searches a property by name and data type.
| pName | The property name. |
| pDataType | The data type of the property. |
| pCaseSensitive | Whether the name is case-sensitive. |
Definition at line 852 of file fbxobject.h.
{
| 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 863 of file fbxobject.h.
{
| FbxProperty FindPropertyHierarchical | ( | const char * | pName, |
| const FbxDataType & | pDataType, | ||
| bool | pCaseSensitive =
true |
||
| ) | const [inline] |
Searches a property by full name and data type.
| 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 875 of file fbxobject.h.
{ return RootProperty; }
| FBX_DEPRECATED FbxProperty& GetRootProperty | ( | ) | [inline] |
Returns the root property of this object.
(Deprecated, use RootProperty instead)
Definition at line 883 of file fbxobject.h.
{ return RootProperty; }
| FBX_DEPRECATED const FbxProperty& GetRootProperty | ( | ) | const [inline] |
Returns the root property of this object.
(Deprecated, use RootProperty instead)
Definition at line 888 of file fbxobject.h.
{ return RootProperty.ConnectSrcProperty(pProperty); }
| FbxProperty GetClassRootProperty | ( | ) |
Returns the class root property.
| 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 900 of file fbxobject.h.
{ return RootProperty.IsConnectedSrcProperty(pProperty); }
| bool IsConnectedSrcProperty | ( | const FbxProperty & | pProperty | ) | [inline] |
Determines whether this object connects with the specified source property.
| pProperty | The specified source property. |
True if this object connects with the specified
source property, false otherwise.Definition at line 906 of file fbxobject.h.
{ return RootProperty.DisconnectSrcProperty(pProperty); }
| bool DisconnectSrcProperty | ( | const FbxProperty & | pProperty | ) | [inline] |
Disconnects this object from the specified source property.
| pProperty | The specified source property. |
True on success, false
otherwise.Definition at line 912 of file fbxobject.h.
{ return RootProperty.GetSrcPropertyCount(); }
| int GetSrcPropertyCount | ( | ) | const [inline] |
Returns the number of source properties with which this object connects.
Definition at line 917 of file fbxobject.h.
{ return RootProperty.GetSrcProperty(pIndex); }
| FbxProperty GetSrcProperty | ( | int | pIndex = 0 |
) | const [inline] |
Returns the source property at the specified index with which this object connects.
| pIndex | The specified index. |
Definition at line 923 of file fbxobject.h.
{ return RootProperty.FindSrcProperty(pName,pStartIndex); }
| FbxProperty FindSrcProperty | ( | const char * | pName, |
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches a source property with which this object connects that has a specific name, starting at the specified index.
| pName | The specified property name. |
| pStartIndex | The start index. |
Definition at line 930 of file fbxobject.h.
{ return RootProperty.ConnectDstProperty(pProperty); }
| bool ConnectDstProperty | ( | const FbxProperty & | pProperty | ) | [inline] |
Connects this object to a destination property.
| pProperty | The destination property with which this object connects. |
True on success, false
otherwise.Definition at line 936 of file fbxobject.h.
{ return RootProperty.IsConnectedDstProperty(pProperty); }
| bool IsConnectedDstProperty | ( | const FbxProperty & | pProperty | ) | [inline] |
Determines if this object connects with the specified destination property.
| pProperty | The specified destination property. |
True if this object connects with the specified
destination property, false otherwise.Definition at line 942 of file fbxobject.h.
{ return RootProperty.DisconnectDstProperty(pProperty); }
| bool DisconnectDstProperty | ( | const FbxProperty & | pProperty | ) | [inline] |
Disconnects this object from the specified destination property.
| pProperty | The specified destination property. |
True on success, false
otherwise.Definition at line 948 of file fbxobject.h.
{ return RootProperty.GetDstPropertyCount(); }
| int GetDstPropertyCount | ( | ) | const [inline] |
Returns the number of destination properties with which this object connects.
Definition at line 953 of file fbxobject.h.
{ return RootProperty.GetDstProperty(pIndex); }
| FbxProperty GetDstProperty | ( | int | pIndex = 0 |
) | const [inline] |
Returns the destination property at the specified index with which this object connects.
| pIndex | The specified index. |
Definition at line 959 of file fbxobject.h.
{ return RootProperty.FindDstProperty(pName,pStartIndex); }
| FbxProperty FindDstProperty | ( | const char * | pName, |
| int | pStartIndex =
0 |
||
| ) | const [inline] |
Searches a destination property with which this object connects that has a specific name, starting at the specified index.
| pName | The specified property name. |
| pStartIndex | The start index. |
Definition at line 966 of file fbxobject.h.
:
| int ContentUnload | ( | ) |
Unloads this object's content using the offload peripheral that is currently set in the document then flushes it from memory.
| 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.
| 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.| void SetRuntimeClassId | ( | const FbxClassId & | pClassId | ) |
Set the run-time ClassId for this class.
In most contexts, users do not have to change the run-time ClassId, they are automatically generated when registered a new class during run-time.
| pClassId | The ClassId to set as the run-time ClassId for this object. |
| FbxClassId GetRuntimeClassId | ( | ) | const |
Retrieve the run-time ClassId for this object.
| bool IsRuntime | ( | const FbxClassId & | pClassId | ) | const |
Test if this class is a hierarchical children of the specified class type.
This test will be performed on the run-time class registered with the FBX SDK Manager rather than the static ClassId generated at compile time.
| pClassId | The class type to test against self. |
| bool IsRuntimePlug | ( | ) | const |
Find out if the ClassId was registered during run-time rather than at compile time.
| virtual void Construct | ( | const FbxObject * | pFrom | ) | [protected, virtual] |
Optional constructor override, automatically called by default constructor.
| pFrom | If not null, the function must take it into account like a copy constructor. |
| virtual void ConstructProperties | ( | bool | pForceSet | ) | [protected, virtual] |
Optional property constructor override, automatically called by default constructor.
| pForceSet | If the property value must be set regardless of default value. |
Reimplemented in FbxControlSetPlug.
| virtual void Destruct | ( | bool | pRecursive | ) | [protected, virtual] |
Optional destructor override, automatically called by default destructor.
| pRecursive | If true, children objects should be destroyed as well. |
Reimplemented in FbxMesh.
| virtual void ContentClear | ( | ) | [protected, virtual] |
Clears this object's content from memory.
This method must be overridden in the derived classes.
| virtual FbxPeripheral* GetPeripheral | ( | ) | [protected, virtual] |
Retrieves the peripheral of that object.
Reimplemented in FbxDocument.
The root property that holds all children property for this object.
Definition at line 1154 of file fbxobject.h.