This reference page is linked to from the following overview topics: FBX SDK 2011, 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 KFbxObject pointers when it comes to manipulate objects in its simplest form.
The KFbxObject class inherits from KFbxPlug, 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 KFbxObject 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.
KFbxObject provide a property (KFbxProperty) 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 KFbxObject { KFBXOBJECT_DECLARE(MyClass, KFbxObject); //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(KFbxSdkManager& pManager, char const* pName); };
//Implementation KFBXOBJECT_IMPLEMENT(MyClass); MyClass::MyClass(KFbxSdkManager& pManager, char const* pName) : KFbxObject(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(KFbxObject)); //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;
ExportDocument/main.cxx, ExportScene03/main.cxx, ExportScene03/MyKFbxMesh.cxx, ExportScene03/MyKFbxMesh.h, ImportScene/DisplayCommon.cxx, ImportScene/DisplayGenericInfo.cxx, ImportScene/DisplayUserProperties.cxx, and Transformations/DisplayCommon.cxx.
Definition at line 163 of file kfbxobject.h.
#include <kfbxobject.h>
Public Types |
|
enum | EObjectFlag
{ eNONE = 0x00000000, eSYSTEM_FLAG = 0x00000001, eSAVABLE_FLAG = 0x00000002, eHIDDEN_FLAG = 0x00000008, eSYSTEM_FLAGS = 0x0000ffff, eUSER_FLAGS = 0x000f0000, eSYSTEM_RUNTIME_FLAGS = 0x0ff00000, eCONTENT_LOADED_FLAG = 0x00100000, eUSER_RUNTIME_FIRST_FLAG = 0x10000000, eUSER_RUNTIME_FLAGS = 0xf0000000, eRUNTIME_FLAGS = 0xfff00000 } |
Public Member Functions |
|
virtual KFbxObject & | Copy (const KFbxObject &pObject) |
Copy an object content into this object.
|
|
virtual bool | Compare (KFbxObject *pOtherObject, eFbxCompare pCompareMethod=eFbxCompareProperties) |
virtual KFbxSdkManager * | GetFbxSdkManager () const |
Retrieve the FBX SDK Manager associated to
this object. |
|
virtual kFbxClassId | GetRuntimeClassId () const |
Retrieve the run-time ClassId for this
object. |
|
void | SetObjectFlags (EObjectFlag pFlags, bool pValue) |
bool | GetObjectFlags (EObjectFlag pFlags) const |
void | SetObjectFlags (kUInt pFlags) |
kUInt | GetObjectFlags () const |
bool | operator== (KFbxObject const &pObject) |
bool | operator!= (KFbxObject const &pObject) |
virtual const char * | GetTypeName () const |
virtual KStringList | GetTypeFlags () const |
virtual void | SetDocument (KFbxDocument *pDocument) |
KFbxObjectHandle & | 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 (KFbxStream &pStream) const |
Writes the content of the object to the
given stream. |
|
virtual bool | ContentReadFrom (const KFbxStream &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
|
|
KFbxProperty | GetFirstProperty () const |
Returns the first property of this object.
|
|
KFbxProperty | GetNextProperty (KFbxProperty const &pProperty) const |
Returns the next property of this object
that follows the specified property. |
|
KFbxProperty | FindProperty (const char *pName, bool pCaseSensitive=true) const |
Searches a property by name. |
|
KFbxProperty | FindProperty (const char *pName, KFbxDataType const &pDataType, bool pCaseSensitive=true) const |
Searches a property by name and data type.
|
|
KFbxProperty | FindPropertyHierarchical (const char *pName, bool pCaseSensitive=true) const |
Searches a property by full name. |
|
KFbxProperty | FindPropertyHierarchical (const char *pName, KFbxDataType const &pDataType, bool pCaseSensitive=true) const |
Searches a property by full name and data
type. |
|
KFbxProperty & | GetRootProperty () |
Returns the root property of this object.
|
|
const KFbxProperty & | GetRootProperty () const |
Returns the root property of this object.
|
|
KFbxProperty | GetClassRootProperty () |
Returns the class root property. |
|
General Object Connection and Relationship
Management
|
|
bool | ConnectSrcObject (KFbxObject *pObject, kFbxConnectionType pType=eFbxConnectionNone) |
Connects this object to a source object.
|
|
bool | IsConnectedSrcObject (const KFbxObject *pObject) const |
Judges whether this object connects with the
source object. |
|
bool | DisconnectSrcObject (KFbxObject *pObject) |
Disconnects this object from a source
object. |
|
bool | DisconnectAllSrcObject () |
Disconnects this object from all source
objects. |
|
bool | DisconnectAllSrcObject (KFbxCriteria const &pCriteria) |
Disconnects this object from all source
objects that satisfy a given criteria. |
|
bool | DisconnectAllSrcObject (kFbxClassId pClassId) |
Disconnects this object from all source
objects of a specific class type. |
|
bool | DisconnectAllSrcObject (kFbxClassId pClassId, KFbxCriteria const &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 (KFbxCriteria const &pCriteria) const |
Returns the number of source objects that
satisfy the given criteria with which this object connects.
|
|
int | GetSrcObjectCount (kFbxClassId pClassId) const |
Returns the number of source objects of the
specific class type with which this object connects. |
|
int | GetSrcObjectCount (kFbxClassId pClassId, KFbxCriteria const &pCriteria) const |
Returns the number of source objects that
satisfy the given criteria and that are the specified class type.
|
|
KFbxObject * | GetSrcObject (int pIndex=0) const |
Returns the source object with which this
object connects at the specified index. |
|
KFbxObject * | GetSrcObject (KFbxCriteria const &pCriteria, int pIndex=0) const |
Returns the source object that satisfies the
criteria at the specified index with which this object connects.
|
|
KFbxObject * | GetSrcObject (kFbxClassId pClassId, int pIndex=0) const |
Returns the source object of the specified
class type at the specified index with which this object connects.
|
|
KFbxObject * | GetSrcObject (kFbxClassId pClassId, KFbxCriteria const &pCriteria, int pIndex=0) const |
Returns the source object of the specified
class type that satisfies the given criteria at the specified
index. |
|
KFbxObject * | FindSrcObject (const char *pName, int pStartIndex=0) const |
Searches the source object with the
specified name, starting at the specified index. |
|
KFbxObject * | FindSrcObject (KFbxCriteria const &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. |
|
KFbxObject * | FindSrcObject (kFbxClassId 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. |
|
KFbxObject * | FindSrcObject (kFbxClassId pClassId, KFbxCriteria const &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 (T const *pFBX_TYPE) |
Disconnects this object from all source
objects of the specified class type. |
|
template<class T > | |
bool | DisconnectAllSrcObject (T const *pFBX_TYPE, KFbxCriteria const &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 (T const *pFBX_TYPE) const |
Returns the number of source objects of a
specific class type with which this object connects. |
|
template<class T > | |
int | GetSrcObjectCount (T const *pFBX_TYPE, KFbxCriteria const &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 (T const *pFBX_TYPE, int pIndex=0) const |
Returns the source object of the specified
class type at the specified index. |
|
template<class T > | |
T * | GetSrcObject (T const *pFBX_TYPE, KFbxCriteria const &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 (T const *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 (T const *pFBX_TYPE, KFbxCriteria const &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 (KFbxObject *pObject, kFbxConnectionType pType=eFbxConnectionNone) |
Connects this object to one destination
object. |
|
bool | IsConnectedDstObject (const KFbxObject *pObject) const |
Judges whether this object connects with the
destination object. |
|
bool | DisconnectDstObject (KFbxObject *pObject) |
Disconnects this object from the destination
object. |
|
bool | DisconnectAllDstObject () |
Disconnects this object from all destination
objects. |
|
bool | DisconnectAllDstObject (KFbxCriteria const &pCriteria) |
Disconnects this object from all destination
objects that satisfy given criteria. |
|
bool | DisconnectAllDstObject (kFbxClassId pClassId) |
Disconnects this object from all destination
objects of the specified class type. |
|
bool | DisconnectAllDstObject (kFbxClassId pClassId, KFbxCriteria const &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 (KFbxCriteria const &pCriteria) const |
Returns the number of destination objects
with which this object connects that satisfy the given criteria.
|
|
int | GetDstObjectCount (kFbxClassId pClassId) const |
Returns the number of destination objects of
the specified class type with which this object connects. |
|
int | GetDstObjectCount (kFbxClassId pClassId, KFbxCriteria const &pCriteria) const |
Returns the number of destination objects of
the specified class type with which this object connects that also
satisfy the given criteria . |
|
KFbxObject * | GetDstObject (int pIndex=0) const |
Returns the destination object at the
specified index with which this object connects. |
|
KFbxObject * | GetDstObject (KFbxCriteria const &pCriteria, int pIndex=0) const |
Returns the destination object with which
this object connects that satisfies the given criteria at the
specified index. |
|
KFbxObject * | GetDstObject (kFbxClassId pClassId, int pIndex=0) const |
Returns the destination object of the
specified class type with which this object connects at the
specified index. |
|
KFbxObject * | GetDstObject (kFbxClassId pClassId, KFbxCriteria const &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. |
|
KFbxObject * | FindDstObject (const char *pName, int pStartIndex=0) const |
Searches the destination object with the
specified name, starting at the specified index. |
|
KFbxObject * | FindDstObject (KFbxCriteria const &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. |
|
KFbxObject * | FindDstObject (kFbxClassId 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. |
|
KFbxObject * | FindDstObject (kFbxClassId pClassId, KFbxCriteria const &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 (T const *pFBX_TYPE) |
Disconnects this object from all destination
objects of the specified class type. |
|
template<class T > | |
bool | DisconnectAllDstObject (T const *pFBX_TYPE, KFbxCriteria const &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 (T const *pFBX_TYPE) const |
Returns the number of destination objects of
the specified class type with which this object connects. |
|
template<class T > | |
int | GetDstObjectCount (T const *pFBX_TYPE, KFbxCriteria const &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 (T const *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 (T const *pFBX_TYPE, KFbxCriteria const &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 (T const *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 (T const *pFBX_TYPE, KFbxCriteria const &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 (KFbxProperty const &pProperty) |
Connects this object to a source property.
|
|
bool | IsConnectedSrcProperty (KFbxProperty const &pProperty) |
Determines whether this object connects with
the specified source property. |
|
bool | DisconnectSrcProperty (KFbxProperty const &pProperty) |
Disconnects this object from the specified
source property. |
|
int | GetSrcPropertyCount () const |
Returns the number of source properties with
which this object connects. |
|
KFbxProperty | GetSrcProperty (int pIndex=0) const |
Returns the source property at the specified
index with which this object connects. |
|
KFbxProperty | 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 (KFbxProperty const &pProperty) |
Connects this object to a destination
property. |
|
bool | IsConnectedDstProperty (KFbxProperty const &pProperty) |
Determines if this object connects with the
specified destination property. |
|
bool | DisconnectDstProperty (KFbxProperty const &pProperty) |
Disconnects this object from the specified
destination property. |
|
int | GetDstPropertyCount () const |
Returns the number of destination properties
with which this object connects. |
|
KFbxProperty | GetDstProperty (int pIndex=0) const |
Returns the destination property at the
specified index with which this object connects. |
|
KFbxProperty | 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 (KFbxObjectID const &pUserID, void *pUserData) |
Sets the data pointer for an user data
record whose ID is pUserID. |
|
void * | GetUserDataPtr (KFbxObjectID const &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
|
|
KFbxDocument * | GetDocument () const |
Returns a const pointer to the document that
contains this object. |
|
KFbxDocument * | GetRootDocument () const |
Returns a const pointer to the root document
that contains this object. |
|
KFbxScene * | GetScene () const |
Returns a const pointer to the scene that
contains this object. |
|
Logging.
|
|
void | EmitMessage (KFbxMessage *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
|
|
KFbxLibrary * | GetParentLibrary () const |
Returns a handle on the parent library of
this object. |
|
bool | AddImplementation (KFbxImplementation *pImplementation) |
Adds an implementation. |
|
bool | RemoveImplementation (KFbxImplementation *pImplementation) |
Removes an implementation. |
|
bool | HasDefaultImplementation (void) const |
Determines if this shading node has a
default implementation. |
|
KFbxImplementation * | GetDefaultImplementation (void) const |
Returns the default implementation of this
shading node. |
|
bool | SetDefaultImplementation (KFbxImplementation *pImplementation) |
Sets the default implementation of this
shading node. |
|
int | GetImplementationCount (const KFbxImplementationFilter *pCriteria=NULL) const |
Returns the number of implementations that
satisfy a given criteria. |
|
KFbxImplementation * | GetImplementation (int pIndex, const KFbxImplementationFilter *pCriteria=NULL) const |
Returns the implementation at the specified
index that satisfies the given criteria. |
|
Object Storage && Retrieval
|
|
virtual KString | GetUrl () const |
Returns the URL of this object. |
|
virtual bool | SetUrl (char *pUrl) |
Sets the URL of this object. |
|
Public Attributes |
|
KFbxProperty | RootProperty |
The root property that holds all children
property for this object. |
|
Protected Types |
|
enum | eFbxPropertyNotify { eFbxProperty_SetRequest, eFbxProperty_Set, eFbxProperty_Get } |
Protected Member Functions |
|
virtual void | ContentClear () |
Clears this object's content from memory.
|
|
virtual KFbxPeripheral * | GetPeripheral () |
Retrieves the peripheral of that object.
|
|
KFbxObject (KFbxSdkManager &pManager, char const *pName) | |
virtual void | Construct (const KFbxObject *pFrom) |
virtual bool | ConstructProperties (bool pForceSet) |
virtual void | Destruct (bool pRecursive, bool pDependents) |
bool | Copyable (const KFbxObject &pObject) |
virtual bool | SetRuntimeClassId (kFbxClassId pClassId) |
Set the run-time ClassId for this class.
|
|
virtual bool | ConnecNotify (KFbxConnectEvent const &pEvent) |
virtual kFbxUpdateId | IncUpdateId (eFbxUpdateIdType pUpdateId=eUpdateId_Object) |
virtual bool | PropertyNotify (eFbxPropertyNotify pType, KFbxProperty *pProperty) |
Friends |
|
class | KFbxScene |
class | KFbxProperty |
Cloning and references |
|
enum | ECloneType { eDEEP_CLONE, eREFERENCE_CLONE } |
Types of clones that can be created for KFbxObject. More... |
|
virtual KFbxObject * | Clone (KFbxObject::ECloneType pCloneType=eDEEP_CLONE, KFbxObject *pContainer=NULL) const |
Creates a clone of this object. |
|
bool | IsAReferenceTo () const |
Checks if this object is a reference clone
of another object. |
|
KFbxObject * | 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. |
|
KFbxObject * | GetReferencedBy (int pIndex) const |
Returns a reference clone of this object at
the specified index. |
|
Object Name Management |
|
void | SetName (char const *pName) |
Sets the name of this object. |
|
char const * | GetName () const |
Returns the full name of this object.
|
|
KString | GetNameWithoutNameSpacePrefix () const |
Returns the name of the object without the
namespace qualifier. |
|
KString | GetNameWithNameSpacePrefix () const |
Returns the name of the object with the
namespace qualifier. |
|
void | SetInitialName (char const *pName) |
Sets the initial name of the object.
|
|
char const * | GetInitialName () const |
Returns the initial name of the object.
|
|
KString | GetNameSpaceOnly () |
Returns the namespace of the object.
|
|
void | SetNameSpace (KString pNameSpace) |
Sets the namespace of the object. |
|
KArrayTemplate< KString * > | GetNameSpaceArray (char identifier) |
Returns an array of all the namespaces for
this object. |
|
KString | GetNameOnly () const |
Returns only the name (no namespace or
prefix) of the object. |
|
KString | GetNameSpacePrefix () const |
Returns the namespace qualifier. |
|
KFbxObjectID const & | GetUniqueID () const |
Returns the unique ID of this object.
|
|
static KString | RemovePrefix (char *pName) |
Removes the prefix of pName. |
|
static KString | StripPrefix (KString &lName) |
Strips the prefix of pName. |
|
static KString | StripPrefix (const char *pName) |
Strips the prefix of pName. |
|
UpdateId Management |
|
enum | eFbxUpdateIdType { eUpdateId_Object, eUpdateId_Dependency } |
Update ID type. More... |
|
virtual kFbxUpdateId | GetUpdateId (eFbxUpdateIdType pUpdateId=eUpdateId_Object) const |
Returns the update ID of this object.
|
enum ECloneType |
Types of clones that can be created for KFbxObject.
Definition at line 174 of file kfbxobject.h.
enum eFbxUpdateIdType |
enum EObjectFlag |
eNONE | |
eSYSTEM_FLAG | |
eSAVABLE_FLAG | |
eHIDDEN_FLAG | |
eSYSTEM_FLAGS | |
eUSER_FLAGS | |
eSYSTEM_RUNTIME_FLAGS | |
eCONTENT_LOADED_FLAG | |
eUSER_RUNTIME_FIRST_FLAG | |
eUSER_RUNTIME_FLAGS | |
eRUNTIME_FLAGS |
Definition at line 1132 of file kfbxobject.h.
{ eNONE = 0x00000000, eSYSTEM_FLAG = 0x00000001, eSAVABLE_FLAG = 0x00000002, eHIDDEN_FLAG = 0x00000008, eSYSTEM_FLAGS = 0x0000ffff, eUSER_FLAGS = 0x000f0000, // These flags are not saved to the fbx file eSYSTEM_RUNTIME_FLAGS = 0x0ff00000, eCONTENT_LOADED_FLAG = 0x00100000, eUSER_RUNTIME_FIRST_FLAG= 0x10000000, eUSER_RUNTIME_FLAGS = 0xf0000000, eRUNTIME_FLAGS = 0xfff00000 } EObjectFlag;
enum eFbxPropertyNotify
[protected] |
Definition at line 1209 of file kfbxobject.h.
KFbxObject | ( | KFbxSdkManager & | pManager, |
char const * | pName | ||
) | [protected] |
virtual KFbxObject* Clone | ( | KFbxObject::ECloneType | pCloneType =
eDEEP_CLONE , |
KFbxObject * | pContainer =
NULL |
||
) | const [virtual] |
Creates a clone of this object.
pCloneType | The type of clone to be created. By default, the clone type is eDEEP_CLONE. |
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
otherwiseKFbxObject* 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.
KFbxObject* 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 | ( | char const * | pName | ) |
Sets the name of this object.
pName | The object name as a NULL terminated string. |
char const* GetName | ( | ) | const |
Returns the full name of this object.
NULL
terminated string.Reimplemented in KFbxKFCurveFilter, KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.
KString GetNameWithoutNameSpacePrefix | ( | ) | const |
Returns the name of the object without the namespace qualifier.
KString GetNameWithNameSpacePrefix | ( | ) | const |
Returns the name of the object with the namespace qualifier.
void SetInitialName | ( | char const * | pName | ) |
Sets the initial name of the object.
pName | The object's initial name as a NULL terminated
string. |
char const* GetInitialName | ( | ) | const |
Returns the initial name of the object.
NULL
terminated
string.KString GetNameSpaceOnly | ( | ) |
Returns the namespace of the object.
NULL
terminated
string.void SetNameSpace | ( | KString | pNameSpace | ) |
Sets the namespace of the object.
pNameSpace | The object's namespace as a NULL terminated
string. |
KArrayTemplate<KString*> GetNameSpaceArray | ( | char | identifier | ) |
Returns an array of all the namespaces for this object.
identifier | The identifier of the namespaces. |
KString GetNameOnly | ( | ) | const |
Returns only the name (no namespace or prefix) of the object.
NULL
terminated string.KString GetNameSpacePrefix | ( | ) | const |
static KString 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 KString StripPrefix | ( | const char * | pName | ) | [static] |
Strips the prefix of pName.
pName | Whose prefix is stripped. |
KFbxObjectID const& GetUniqueID | ( | ) | const |
Returns the unique ID of this object.
virtual kFbxUpdateId GetUpdateId | ( | eFbxUpdateIdType | pUpdateId =
eUpdateId_Object |
) | const [virtual] |
Returns the update ID of this object.
pUpdateId | The update ID type. |
Reimplemented in KFbxNode.
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 | ( | KFbxStream & | 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 KFbxGeometryBase, and KFbxPatch.
virtual bool ContentReadFrom | ( | const KFbxStream & | 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 KFbxGeometryBase, and KFbxPatch.
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. |
KFbxProperty GetFirstProperty | ( | ) | const [inline] |
Returns the first property of this object.
Definition at line 414 of file kfbxobject.h.
{ return RootProperty.GetFirstDescendent(); }
KFbxProperty GetNextProperty | ( | KFbxProperty const & | pProperty | ) | const [inline] |
Returns the next property of this object that follows the specified property.
pProperty | The specified property. |
Definition at line 423 of file kfbxobject.h.
{ return RootProperty.GetNextDescendent(pProperty); }
KFbxProperty 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 433 of file kfbxobject.h.
{ return RootProperty.Find(pName, pCaseSensitive ); }
KFbxProperty FindProperty | ( | const char * | pName, |
KFbxDataType const & | 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 444 of file kfbxobject.h.
{ return RootProperty.Find(pName, pDataType, pCaseSensitive ); }
KFbxProperty 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 455 of file kfbxobject.h.
{ return RootProperty.FindHierarchical(pName, pCaseSensitive ); }
KFbxProperty FindPropertyHierarchical | ( | const char * | pName, |
KFbxDataType const & | 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 467 of file kfbxobject.h.
{ return RootProperty.FindHierarchical(pName, pDataType, pCaseSensitive ); }
KFbxProperty& GetRootProperty | ( | ) | [inline] |
Returns the root property of this object.
Definition at line 475 of file kfbxobject.h.
{ return RootProperty; }
const KFbxProperty& GetRootProperty | ( | ) | const [inline] |
Returns the root property of this object.
Definition at line 480 of file kfbxobject.h.
{ return RootProperty; }
KFbxProperty GetClassRootProperty | ( | ) |
Returns the class root property.
bool ConnectSrcObject | ( | KFbxObject * | pObject, |
kFbxConnectionType | pType =
eFbxConnectionNone |
||
) | [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 498 of file kfbxobject.h.
{ return RootProperty.ConnectSrcObject(pObject,pType); }
bool IsConnectedSrcObject | ( | const KFbxObject * | 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 504 of file kfbxobject.h.
{ return RootProperty.IsConnectedSrcObject(pObject); }
bool DisconnectSrcObject | ( | KFbxObject * | 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 510 of file kfbxobject.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 515 of file kfbxobject.h.
{ return RootProperty.DisconnectAllSrcObject(); }
bool DisconnectAllSrcObject | ( | KFbxCriteria const & | 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 521 of file kfbxobject.h.
{ return RootProperty.DisconnectAllSrcObject(pCriteria); }
bool DisconnectAllSrcObject | ( | kFbxClassId | 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 527 of file kfbxobject.h.
{ return RootProperty.DisconnectAllSrcObject(pClassId); }
bool DisconnectAllSrcObject | ( | kFbxClassId | pClassId, |
KFbxCriteria const & | 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 534 of file kfbxobject.h.
{ return RootProperty.DisconnectAllSrcObject(pClassId,pCriteria); }
int GetSrcObjectCount | ( | ) | const [inline] |
Returns the number of source objects with which this object connects.
Definition at line 539 of file kfbxobject.h.
{ return RootProperty.GetSrcObjectCount(); }
int GetSrcObjectCount | ( | KFbxCriteria const & | 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 545 of file kfbxobject.h.
{ return RootProperty.GetSrcObjectCount(pCriteria); }
int GetSrcObjectCount | ( | kFbxClassId | 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 551 of file kfbxobject.h.
{ return RootProperty.GetSrcObjectCount(pClassId); }
int GetSrcObjectCount | ( | kFbxClassId | pClassId, |
KFbxCriteria const & | 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 558 of file kfbxobject.h.
{ return RootProperty.GetSrcObjectCount(pClassId,pCriteria); }
KFbxObject* 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 564 of file kfbxobject.h.
{ return RootProperty.GetSrcObject(pIndex); }
KFbxObject* GetSrcObject | ( | KFbxCriteria const & | 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 571 of file kfbxobject.h.
{ return RootProperty.GetSrcObject(pCriteria,pIndex); }
KFbxObject* GetSrcObject | ( | kFbxClassId | 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 578 of file kfbxobject.h.
{ return RootProperty.GetSrcObject(pClassId,pIndex); }
KFbxObject* GetSrcObject | ( | kFbxClassId | pClassId, |
KFbxCriteria const & | 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 586 of file kfbxobject.h.
{ return RootProperty.GetSrcObject(pClassId,pCriteria,pIndex); }
KFbxObject* 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 593 of file kfbxobject.h.
{ return RootProperty.FindSrcObject(pName,pStartIndex); }
KFbxObject* FindSrcObject | ( | KFbxCriteria const & | 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 601 of file kfbxobject.h.
{ return RootProperty.FindSrcObject(pCriteria,pName,pStartIndex); }
KFbxObject* FindSrcObject | ( | kFbxClassId | 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 609 of file kfbxobject.h.
{ return RootProperty.FindSrcObject(pClassId,pName,pStartIndex); }
KFbxObject* FindSrcObject | ( | kFbxClassId | pClassId, |
KFbxCriteria const & | 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 618 of file kfbxobject.h.
{ return RootProperty.FindSrcObject(pClassId,pCriteria,pName,pStartIndex); }
bool DisconnectAllSrcObject | ( | T const * | 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 624 of file kfbxobject.h.
{ return RootProperty.DisconnectAllSrcObject(pFBX_TYPE); }
bool DisconnectAllSrcObject | ( | T const * | pFBX_TYPE, |
KFbxCriteria const & | 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 631 of file kfbxobject.h.
{ return RootProperty.DisconnectAllSrcObject(pFBX_TYPE,pCriteria); }
int GetSrcObjectCount | ( | T const * | 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 637 of file kfbxobject.h.
{ return RootProperty.GetSrcObjectCount(pFBX_TYPE); }
int GetSrcObjectCount | ( | T const * | pFBX_TYPE, |
KFbxCriteria const & | 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 644 of file kfbxobject.h.
{ return RootProperty.GetSrcObjectCount(pFBX_TYPE,pCriteria); }
T* GetSrcObject | ( | T const * | 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 651 of file kfbxobject.h.
{ return RootProperty.GetSrcObject(pFBX_TYPE,pIndex); }
T* GetSrcObject | ( | T const * | pFBX_TYPE, |
KFbxCriteria const & | 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 659 of file kfbxobject.h.
{ return RootProperty.GetSrcObject(pFBX_TYPE,pCriteria,pIndex); }
T* FindSrcObject | ( | T const * | 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 667 of file kfbxobject.h.
{ return RootProperty.FindSrcObject(pFBX_TYPE,pName,pStartIndex); }
T* FindSrcObject | ( | T const * | pFBX_TYPE, |
KFbxCriteria const & | 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 676 of file kfbxobject.h.
{ return RootProperty.FindSrcObject(pFBX_TYPE,pCriteria,pName,pStartIndex); }
bool ConnectDstObject | ( | KFbxObject * | pObject, |
kFbxConnectionType | pType =
eFbxConnectionNone |
||
) | [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 683 of file kfbxobject.h.
{ return RootProperty.ConnectDstObject(pObject,pType); }
bool IsConnectedDstObject | ( | const KFbxObject * | 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 689 of file kfbxobject.h.
{ return RootProperty.IsConnectedDstObject(pObject); }
bool DisconnectDstObject | ( | KFbxObject * | 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 695 of file kfbxobject.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 700 of file kfbxobject.h.
{ return RootProperty.DisconnectAllDstObject(); }
bool DisconnectAllDstObject | ( | KFbxCriteria const & | 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 706 of file kfbxobject.h.
{ return RootProperty.DisconnectAllDstObject(pCriteria); }
bool DisconnectAllDstObject | ( | kFbxClassId | 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 712 of file kfbxobject.h.
{ return RootProperty.DisconnectAllDstObject(pClassId); }
bool DisconnectAllDstObject | ( | kFbxClassId | pClassId, |
KFbxCriteria const & | 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 719 of file kfbxobject.h.
{ return RootProperty.DisconnectAllDstObject(pClassId,pCriteria); }
int GetDstObjectCount | ( | ) | const [inline] |
Returns the number of destination objects with which this object connects.
Definition at line 724 of file kfbxobject.h.
{ return RootProperty.GetDstObjectCount(); }
int GetDstObjectCount | ( | KFbxCriteria const & | 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 730 of file kfbxobject.h.
{ return RootProperty.GetDstObjectCount(pCriteria); }
int GetDstObjectCount | ( | kFbxClassId | 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 736 of file kfbxobject.h.
{ return RootProperty.GetDstObjectCount(pClassId); }
int GetDstObjectCount | ( | kFbxClassId | pClassId, |
KFbxCriteria const & | 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 743 of file kfbxobject.h.
{ return RootProperty.GetDstObjectCount(pClassId,pCriteria); }
KFbxObject* 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 749 of file kfbxobject.h.
{ return RootProperty.GetDstObject(pIndex); }
KFbxObject* GetDstObject | ( | KFbxCriteria const & | 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 756 of file kfbxobject.h.
{ return RootProperty.GetDstObject(pCriteria,pIndex); }
KFbxObject* GetDstObject | ( | kFbxClassId | 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 763 of file kfbxobject.h.
{ return RootProperty.GetDstObject(pClassId,pIndex); }
KFbxObject* GetDstObject | ( | kFbxClassId | pClassId, |
KFbxCriteria const & | 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 771 of file kfbxobject.h.
{ return RootProperty.GetDstObject(pClassId,pCriteria,pIndex); }
KFbxObject* 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 778 of file kfbxobject.h.
{ return RootProperty.FindDstObject(pName,pStartIndex); }
KFbxObject* FindDstObject | ( | KFbxCriteria const & | 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 786 of file kfbxobject.h.
{ return RootProperty.FindDstObject(pCriteria,pName,pStartIndex); }
KFbxObject* FindDstObject | ( | kFbxClassId | 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 794 of file kfbxobject.h.
{ return RootProperty.FindDstObject(pClassId,pName,pStartIndex); }
KFbxObject* FindDstObject | ( | kFbxClassId | pClassId, |
KFbxCriteria const & | 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 803 of file kfbxobject.h.
{ return RootProperty.FindDstObject(pClassId,pCriteria,pName,pStartIndex); }
bool DisconnectAllDstObject | ( | T const * | 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 809 of file kfbxobject.h.
{ return RootProperty.DisconnectAllDstObject(pFBX_TYPE); }
bool DisconnectAllDstObject | ( | T const * | pFBX_TYPE, |
KFbxCriteria const & | 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 816 of file kfbxobject.h.
{ return RootProperty.DisconnectAllDstObject(pFBX_TYPE,pCriteria); }
int GetDstObjectCount | ( | T const * | 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 822 of file kfbxobject.h.
{ return RootProperty.GetDstObjectCount(pFBX_TYPE); }
int GetDstObjectCount | ( | T const * | pFBX_TYPE, |
KFbxCriteria const & | 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 829 of file kfbxobject.h.
{ return RootProperty.GetDstObjectCount(pFBX_TYPE,pCriteria); }
T* GetDstObject | ( | T const * | 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 836 of file kfbxobject.h.
{ return RootProperty.GetDstObject(pFBX_TYPE,pIndex); }
T* GetDstObject | ( | T const * | pFBX_TYPE, |
KFbxCriteria const & | 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 844 of file kfbxobject.h.
{ return RootProperty.GetDstObject(pFBX_TYPE,pCriteria,pIndex); }
T* FindDstObject | ( | T const * | 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 852 of file kfbxobject.h.
{ return RootProperty.FindDstObject(pFBX_TYPE,pName,pStartIndex); }
T* FindDstObject | ( | T const * | pFBX_TYPE, |
KFbxCriteria const & | 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 861 of file kfbxobject.h.
{ return RootProperty.FindDstObject(pFBX_TYPE,pCriteria,pName,pStartIndex); }
bool ConnectSrcProperty | ( | KFbxProperty const & | 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 872 of file kfbxobject.h.
{ return RootProperty.ConnectSrcProperty(pProperty); }
bool IsConnectedSrcProperty | ( | KFbxProperty const & | 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 878 of file kfbxobject.h.
{ return RootProperty.IsConnectedSrcProperty(pProperty); }
bool DisconnectSrcProperty | ( | KFbxProperty const & | pProperty | ) | [inline] |
Disconnects this object from the specified source property.
pProperty | The specified source property. |
True
on success, false
otherwise.Definition at line 884 of file kfbxobject.h.
{ return RootProperty.DisconnectSrcProperty(pProperty); }
int GetSrcPropertyCount | ( | ) | const [inline] |
Returns the number of source properties with which this object connects.
Definition at line 889 of file kfbxobject.h.
{ return RootProperty.GetSrcPropertyCount(); }
KFbxProperty 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 895 of file kfbxobject.h.
{ return RootProperty.GetSrcProperty(pIndex); }
KFbxProperty 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 902 of file kfbxobject.h.
{ return RootProperty.FindSrcProperty(pName,pStartIndex); }
bool ConnectDstProperty | ( | KFbxProperty const & | 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 908 of file kfbxobject.h.
{ return RootProperty.ConnectDstProperty(pProperty); }
bool IsConnectedDstProperty | ( | KFbxProperty const & | 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 914 of file kfbxobject.h.
{ return RootProperty.IsConnectedDstProperty(pProperty); }
bool DisconnectDstProperty | ( | KFbxProperty const & | pProperty | ) | [inline] |
Disconnects this object from the specified destination property.
pProperty | The specified destination property. |
True
on success, false
otherwise.Definition at line 920 of file kfbxobject.h.
{ return RootProperty.DisconnectDstProperty(pProperty); }
int GetDstPropertyCount | ( | ) | const [inline] |
Returns the number of destination properties with which this object connects.
Definition at line 925 of file kfbxobject.h.
{ return RootProperty.GetDstPropertyCount(); }
KFbxProperty 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 931 of file kfbxobject.h.
{ return RootProperty.GetDstProperty(pIndex); }
KFbxProperty 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 938 of file kfbxobject.h.
{ return RootProperty.FindDstProperty(pName,pStartIndex); }
void SetUserDataPtr | ( | KFbxObjectID const & | 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 | ( | KFbxObjectID const & | 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 964 of file kfbxobject.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 969 of file kfbxobject.h.
{ return GetUserDataPtr(GetUniqueID()); }
KFbxDocument* GetDocument | ( | ) | const |
Returns a const pointer to the document that contains this object.
NULL
if the object does not belong to any
document.KFbxDocument* GetRootDocument | ( | ) | const |
Returns a const pointer to the root document that contains this object.
NULL
if the object does not belong to any
document.KFbxScene* 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 | ( | KFbxMessage * | 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 KFbxLibrary.
KFbxLibrary* GetParentLibrary | ( | ) | const |
Returns a handle on the parent library of this object.
NULL
if the
parent library doesn't exist.Reimplemented in KFbxLibrary.
bool AddImplementation | ( | KFbxImplementation * | pImplementation | ) |
Adds an implementation.
pImplementation | The implementation to be added. |
True
on success, false
otherwise.bool RemoveImplementation | ( | KFbxImplementation * | 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.KFbxImplementation* GetDefaultImplementation | ( | void | ) | const |
Returns the default implementation of this shading node.
bool SetDefaultImplementation | ( | KFbxImplementation * | pImplementation | ) |
Sets the default implementation of this shading node.
pImplementation | The implementation to be set. |
True
on success, false
otherwise.int GetImplementationCount | ( | const KFbxImplementationFilter * | pCriteria = NULL |
) | const |
Returns the number of implementations that satisfy a given criteria.
pCriteria | The given criteria. |
KFbxImplementation* GetImplementation | ( | int | pIndex, |
const KFbxImplementationFilter * | pCriteria =
NULL |
||
) | const |
Returns the implementation at the specified index that satisfies the given criteria.
pIndex | The specified index. |
pCriteria | The given criteria. |
virtual KString 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.virtual KFbxObject& Copy | ( | const KFbxObject & | pObject | ) | [virtual] |
Copy an object content into this object.
pObject | The source object to copy data from. |
Reimplemented in KFbxDocument, KFbxDocumentInfo, KFbxCharacter, KFbxCharacterPose, KFbxAnimCurveNode, KFbxAnimStack, KFbxBindingTableBase, KFbxBlendShape, KFbxBlendShapeChannel, KFbxCachedEffect, KFbxCamera, KFbxCameraSwitcher, KFbxCluster, KFbxFileTexture, KFbxGeometry, KFbxGeometryBase, KFbxGeometryWeightedMap, KFbxGlobalSettings, KFbxLayerContainer, KFbxLine, KFbxLodGroup, KFbxCameraManipulator, KFbxMarker, KFbxMesh, KFbxNode, KFbxNull, KFbxNurb, KFbxNurbsCurve, KFbxNurbsSurface, KFbxPatch, KFbxPose, KFbxProceduralTexture, KFbxScene, KFbxShape, KFbxSkeleton, KFbxSkin, KFbxTexture, KFbxThumbnail, KFbxBoundary, KFbxTrimNurbsSurface, KFbxVertexCacheDeformer, and KFbxVideo.
virtual void ContentClear | ( | ) | [protected, virtual] |
Clears this object's content from memory.
This method must be overridden in the derived classes.
Reimplemented in KFbxGeometryBase.
virtual KFbxPeripheral* GetPeripheral | ( | ) | [protected, virtual] |
Retrieves the peripheral of that object.
Reimplemented in KFbxDocument.
virtual bool Compare | ( | KFbxObject * | pOtherObject, |
eFbxCompare | pCompareMethod =
eFbxCompareProperties |
||
) | [virtual] |
virtual KFbxSdkManager* GetFbxSdkManager | ( | ) | const [virtual] |
Retrieve the FBX SDK Manager associated to this object.
There is no implementation at the level of KFbxPlug. A basic implementation is available at the KFbxObject level.
Reimplemented from KFbxPlug.
virtual kFbxClassId GetRuntimeClassId | ( | ) | const [virtual] |
Retrieve the run-time ClassId for this object.
Reimplemented from KFbxPlug.
void SetObjectFlags | ( | EObjectFlag | pFlags, |
bool | pValue | ||
) |
bool GetObjectFlags | ( | EObjectFlag | pFlags | ) | const |
void SetObjectFlags | ( | kUInt | pFlags | ) |
kUInt GetObjectFlags | ( | ) | const |
bool operator== | ( | KFbxObject const & | pObject | ) |
bool operator!= | ( | KFbxObject const & | pObject | ) |
virtual const char* GetTypeName | ( | ) | const [virtual] |
Reimplemented in KFbxCachedEffect, KFbxMarker, KFbxNode, KFbxPose, and KFbxSkeleton.
virtual KStringList GetTypeFlags | ( | ) | const [virtual] |
Reimplemented in KFbxCharacter, KFbxControlSetPlug, KFbxBlendShape, KFbxBlendShapeChannel, KFbxCachedEffect, KFbxCamera, KFbxCameraStereo, KFbxCluster, KFbxDeformer, KFbxGenericNode, KFbxLight, KFbxLodGroup, KFbxMarker, KFbxNode, KFbxNull, KFbxOpticalReference, KFbxShape, KFbxSkeleton, KFbxSkin, KFbxSubDeformer, KFbxVertexCacheDeformer, and KFbxVideo.
virtual void SetDocument | ( | KFbxDocument * | pDocument | ) | [virtual] |
Reimplemented in KFbxDocument, KFbxGeometry, and KFbxLayerContainer.
KFbxObjectHandle& GetPropertyHandle | ( | ) | [inline] |
Definition at line 1178 of file kfbxobject.h.
{ return RootProperty.mPropertyHandle; }
void WipeAllConnections | ( | ) |
virtual void Construct | ( | const KFbxObject * | pFrom | ) | [protected, virtual] |
virtual bool ConstructProperties | ( | bool | pForceSet | ) | [protected, virtual] |
Reimplemented in KFbxDocument, KFbxDocumentInfo, KFbxProcessorXRefCopy, KFbxProcessorXRefCopyUserLibrary, KFbxIOSettings, KFbxAnimCurveNode, KFbxAnimStack, KFbxBindingOperator, KFbxBlendShapeChannel, KFbxCache, KFbxCachedEffect, KFbxCamera, KFbxCameraStereo, KFbxCameraSwitcher, KFbxCluster, KFbxConstraint, KFbxConstraintAim, KFbxConstraintParent, KFbxConstraintPosition, KFbxConstraintRotation, KFbxConstraintScale, KFbxConstraintSingleChainIK, KFbxContainer, KFbxContainerTemplate, KFbxDisplayLayer, KFbxFileTexture, KFbxGeometryBase, KFbxGlobalSettings, KFbxImplementation, KFbxLight, KFbxLine, KFbxLodGroup, KFbxMarker, KFbxNode, KFbxNodeAttribute, KFbxNull, KFbxProceduralTexture, KFbxReference, KFbxSelectionSet, KFbxShape, KFbxSkeleton, KFbxSurfaceLambert, KFbxSurfaceMaterial, KFbxSurfacePhong, KFbxTexture, KFbxThumbnail, KFbxVertexCacheDeformer, and KFbxVideo.
virtual void Destruct | ( | bool | pRecursive, |
bool | pDependents | ||
) | [protected, virtual] |
Reimplemented from KFbxPlug.
Reimplemented in KFbxDocument, KFbxCharacter, KFbxExporter, KFbxImporter, KFbxIOSettings, KFbxAnimCurve, KFbxAnimCurveKFCurve, KFbxAnimCurveNode, KFbxAnimEvaluator, KFbxBindingOperator, KFbxCache, KFbxCameraSwitcher, KFbxContainerTemplate, KFbxGeometry, KFbxGeometryWeightedMap, KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, KFbxKFCurveFilterScale, KFbxLayerContainer, KFbxLibrary, KFbxLine, KFbxMesh, KFbxNode, KFbxNurb, KFbxNurbsCurve, KFbxNurbsSurface, KFbxPatch, KFbxPose, KFbxReference, KFbxSubdiv, and KFbxThumbnail.
bool Copyable | ( | const KFbxObject & | pObject | ) | [protected] |
virtual bool SetRuntimeClassId | ( | kFbxClassId | 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 KFbxPlug.
virtual bool ConnecNotify | ( | KFbxConnectEvent const & | pEvent | ) | [protected, virtual] |
Reimplemented in KFbxDocument, KFbxCharacter, KFbxLayerContainer, KFbxLayeredTexture, KFbxSelectionNode, and KFbxVideo.
virtual kFbxUpdateId IncUpdateId | ( | eFbxUpdateIdType | pUpdateId =
eUpdateId_Object |
) | [protected, virtual] |
virtual bool PropertyNotify | ( | eFbxPropertyNotify | pType, |
KFbxProperty * | pProperty | ||
) | [protected, virtual] |
Reimplemented in KFbxNode, and KFbxTexture.
friend class KFbxScene [friend] |
Reimplemented in KFbxCharacter, KFbxCharacterPose, KFbxControlSetPlug, KFbxBlendShape, KFbxBlendShapeChannel, KFbxCluster, KFbxConstraint, KFbxDeformer, KFbxGenericNode, KFbxGeometry, KFbxGlobalSettings, KFbxLayerContainer, KFbxNode, KFbxNodeAttribute, KFbxSkin, and KFbxSubDeformer.
Definition at line 1224 of file kfbxobject.h.
friend class KFbxProperty
[friend] |
Reimplemented from KFbxPlug.
Definition at line 1225 of file kfbxobject.h.
The root property that holds all children property for this object.
Definition at line 1102 of file kfbxobject.h.