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

KFbxObject Class Reference

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.


Search for all occurrences

Detailed Description

The base class of most FBX objects.

Provides the benefits of connectivity, identity, run-time typing, properties, naming, copying, cloning, selection, and automated file IO. Most of the FBX SDK API deals with 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;
See also:
KFbxPlug, KFbxProperty
Examples:

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>

Inheritance diagram for KFbxObject:
Inheritance graph
[legend]

List of all members.

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
Remarks:
You can modify the unloaded state flag using the SetObjectFlags() method. The ContentIsUnloaded() method below (implemented in this class) is simply a synonym of GetObjectFlags(eCONTENT_UNLOADED_FLAG)
int  ContentUnload ()
  Unloads this object's content using the offload peripheral that is currently set in the document then flushes it from memory.
int  ContentLoad ()
  Loads this object's content using the offload peripheral that is currently set in the document.
bool  ContentIsLoaded () const
  Judges if this object's content is loaded.
void  ContentDecrementLockCount ()
  Decreases the content lock count of an object.
void  ContentIncrementLockCount ()
  Increases the content lock count of an object.
bool  ContentIsLocked () const
  Judges if this object's content is locked.
Off-loading Serialization section.

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

virtual bool  ContentWriteTo (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.

Member Enumeration Documentation

enum ECloneType

Types of clones that can be created for KFbxObject.

Enumerator:
eDEEP_CLONE 

A deep copy of the object.

Changes to either the original or clone do not propagate to each other.

eREFERENCE_CLONE 

Changes to original object propagate to clone.

Changes to clone do not propagate to original.

Definition at line 174 of file kfbxobject.h.

Update ID type.

  • eUpdateId_Object
  • eUpdateId_Dependency
Enumerator:
eUpdateId_Object 
eUpdateId_Dependency 

Definition at line 307 of file kfbxobject.h.

Enumerator:
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]

Constructor & Destructor Documentation

KFbxObject ( KFbxSdkManager pManager,
char const *  pName 
) [protected]

Member Function Documentation

virtual KFbxObject* Clone ( KFbxObject::ECloneType  pCloneType = eDEEP_CLONE,
KFbxObject pContainer = NULL 
) const [virtual]

Creates a clone of this object.

Parameters:
pCloneType The type of clone to be created. By default, the clone type is 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.
Returns:
The new clone, or NULL (if the specified clone type is not supported).
Remarks:
When doing either a "deep" or "reference" clone type, the clone will always get its properties values set from the source object properties values.
Examples:
ExportScene05/main.cxx.
bool IsAReferenceTo ( ) const

Checks if this object is a reference clone of another object.

Returns:
True if this object is a clone of another object, false otherwise
KFbxObject* GetReferenceTo ( ) const

If this object is a reference clone, returns the original object (from which the clone originates).

Returns:
The original object, or NULL (if this object is not a reference clone).
bool IsReferencedBy ( ) const

Checks if any objects are reference cloned from this object.

Returns:
True if there are objects reference cloned from this object, false otherwise.
int GetReferencedByCount ( ) const

Returns the number of objects that are reference clones of this object.

Returns:
The number of objects that are reference clones of this object.
KFbxObject* GetReferencedBy ( int  pIndex ) const

Returns a reference clone of this object at the specified index.

Parameters:
pIndex The specified index, valid values are [0, GetReferencedByCount())
Returns:
The reference clone, or NULL (if pIndex is out of range).
void SetName ( char const *  pName )

Sets the name of this object.

Parameters:
pName The object name as a NULL terminated string.
Examples:
ExportDocument/main.cxx, and ExportScene05/main.cxx.
char const* GetName ( ) const
KString GetNameWithoutNameSpacePrefix ( ) const

Returns the name of the object without the namespace qualifier.

Returns:
The object name without the namespace qualifier.
KString GetNameWithNameSpacePrefix ( ) const

Returns the name of the object with the namespace qualifier.

Returns:
The object name with the namespace qualifier.
void SetInitialName ( char const *  pName )

Sets the initial name of the object.

Parameters:
pName The object's initial name as a NULL terminated string.
char const* GetInitialName ( ) const

Returns the initial name of the object.

Returns:
The object's initial name as a NULL terminated string.
KString GetNameSpaceOnly ( )

Returns the namespace of the object.

Returns:
The object's namespace as a NULL terminated string.
void SetNameSpace ( KString  pNameSpace )

Sets the namespace of the object.

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

Parameters:
identifier The identifier of the namespaces.
Returns:
The array of all namespaces.
KString GetNameOnly ( ) const

Returns only the name (no namespace or prefix) of the object.

Returns:
The name only as a NULL terminated string.
KString GetNameSpacePrefix ( ) const

Returns the namespace qualifier.

Returns:
The namespace qualifier.
static KString RemovePrefix ( char *  pName ) [static]

Removes the prefix of pName.

Parameters:
pName Whose prefix is removed.
Returns:
A temporary string without prefix.
static KString StripPrefix ( KString lName ) [static]

Strips the prefix of pName.

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

Strips the prefix of pName.

Parameters:
pName Whose prefix is stripped.
Returns:
A temporary string stripped of its prefix.
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.

Parameters:
pUpdateId The update ID type.
Returns:
The update ID.

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.

Returns:
2 if the object's content is already unloaded or 1 if this object's content has been successfully unloaded to the current peripheral.
Remarks:
If the content is locked more than once, or the peripheral cannot handle this object's unloading, or if an error occurs, this method returns 0 and does not flush the content.
int ContentLoad ( )

Loads this object's content using the offload peripheral that is currently set in the document.

Returns:
1 if this object's content has been successfully loaded from the current peripheral, 2 if the content is already loaded, and 0 if an error occurs or the object's content is locked.
Remarks:
On a successful Load attempt, the object content is locked.
bool ContentIsLoaded ( ) const

Judges if this object's content is loaded.

Returns:
True if this object's content is loaded, false otherwise.
Remarks:
An object that has not been filled yet must be considered unloaded.
void ContentDecrementLockCount ( )

Decreases the content lock count of an object.

If the content lock count of an object is greater than 0, the content of the object is considered locked.

void ContentIncrementLockCount ( )

Increases the content lock count of an object.

If the content lock count of an object is greater than 0, the content of the object is considered locked.

bool ContentIsLocked ( ) const

Judges if this object's content is locked.

The content is considered locked if the content lock count is greater than 0

Returns:
True if this object's content is locked, false otherwise.
Remarks:
A locked state prevents the object content from being unloaded from memory but does not block the loading.
virtual bool ContentWriteTo ( KFbxStream pStream ) const [virtual]

Writes the content of the object to the given stream.

Parameters:
pStream The destination stream.
Returns:
True if the content is successfully processed by the receiving stream, false otherwise.

Reimplemented in KFbxGeometryBase, and KFbxPatch.

virtual bool ContentReadFrom ( const KFbxStream pStream ) [virtual]

Reads the content of the object from the given stream.

Parameters:
pStream The source stream.
Returns:
True if the object fills itself with the received data from the stream successfully, false otherwise.

Reimplemented in KFbxGeometryBase, and KFbxPatch.

virtual bool GetSelected ( ) [virtual]

Returns if this object is currently in a selected state.

Returns:
True if this object is selected, false otherwise.
virtual void SetSelected ( bool  pSelected ) [virtual]

Sets whether this object is currently selected.

Parameters:
pSelected The selection flag.
KFbxProperty GetFirstProperty ( ) const [inline]

Returns the first property of this object.

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

Definition at line 414 of file kfbxobject.h.

KFbxProperty GetNextProperty ( KFbxProperty const &  pProperty ) const [inline]

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

Parameters:
pProperty The specified property.
Returns:
The next property of this object that follows pProperty.
Examples:
ImportScene/DisplayAnimation.cxx, ImportScene/DisplayGenericInfo.cxx, and ImportScene/DisplayUserProperties.cxx.

Definition at line 423 of file kfbxobject.h.

        {
            return RootProperty.GetNextDescendent(pProperty);
        }
KFbxProperty FindProperty ( const char *  pName,
bool  pCaseSensitive = true 
) const [inline]

Searches a property by name.

Parameters:
pName The property name.
pCaseSensitive Whether the name is case-sensitive.
Returns:
A valid KFbxProperty if found, else an invalid KFbxProperty. See KFbxProperty::IsValid()
Examples:
ExportScene05/main.cxx, ImportScene/DisplayMesh.cxx, ImportScene/DisplayTexture.cxx, UserProperties/main.cxx, and ViewScene/Texture.cxx.

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.

Parameters:
pName The property name.
pDataType The data type of the property.
pCaseSensitive Whether the name is case-sensitive.
Returns:
A valid KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

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.

Parameters:
pName The full name of the property as a NULL terminated string.
pCaseSensitive whether or not the name is case-sensitive.
Returns:
A valid KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()
Examples:
ImportScene/DisplayMaterial.cxx.

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.

Parameters:
pName The full name of the property as a NULL terminated string.
pDataType The data type of the property.
pCaseSensitive whether or not the name is case-sensitive.
Returns:
A valid KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Definition at line 467 of file kfbxobject.h.

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

Returns the root property of this object.

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

Definition at line 475 of file kfbxobject.h.

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

Returns the root property of this object.

Returns:
The root property.

Definition at line 480 of file kfbxobject.h.

{ return RootProperty; }
KFbxProperty GetClassRootProperty ( )

Returns the class root property.

Returns:
The class root property if it exists, else an invalid KFbxProperty. See KFbxProperty::IsValid().
Remarks:
Class KFbxObject and its sub-classes all have a class root property. This class root property contains basic information about the class type, such as the class name.
bool ConnectSrcObject ( KFbxObject pObject,
kFbxConnectionType  pType = eFbxConnectionNone 
) [inline]

Connects this object to a source object.

Parameters:
pObject The source object to which this object connects.
pType The connection type between this object and the source object.
Returns:
True on success, false otherwise.
Examples:
Animation/main.cxx, ExportScene03/main.cxx, ExportScene05/main.cxx, and Layers/main.cxx.

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.

Parameters:
pObject The source object.
Returns:
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.

Parameters:
pObject The source object from which this object will be disconnected.
Returns:
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.

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

Definition at line 515 of file kfbxobject.h.

bool DisconnectAllSrcObject ( KFbxCriteria const &  pCriteria ) [inline]

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

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

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

Parameters:
pClassId The specific class type.
Returns:
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.

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

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

Returns:
The number of source objects with which this object connects.
Examples:
ImportScene/DisplayAnimation.cxx, ImportScene/DisplayGenericInfo.cxx, ImportScene/DisplayMesh.cxx, and ImportScene/DisplayTexture.cxx.

Definition at line 539 of file kfbxobject.h.

int GetSrcObjectCount ( KFbxCriteria const &  pCriteria ) const [inline]

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

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

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

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

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

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

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.

Parameters:
pIndex The specified index whose default value is 0.
Returns:
The source object at the specified index, NULL if not found.
Examples:
ExportScene02/main.cxx, ExportScene03/main.cxx, ImportScene/DisplayAnimation.cxx, ImportScene/DisplayGenericInfo.cxx, ImportScene/DisplayTexture.cxx, ProceduralTexture/main.cxx, and SwitchBinding/main.cxx.

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

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

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

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

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

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

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

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

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.

Parameters:
pCriteria The given criteria.
pName The object name.
pStartIndex The start index.
Returns:
The source object with the name, NULL if not found.

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

Parameters:
pClassId The specified class type.
pName The object name.
pStartIndex The start index.
Returns:
The source object with the name, NULL if not found.

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

Parameters:
pClassId The specified class type.
pCriteria The given criteria.
pName The object name.
pStartIndex The start index.
Returns:
The source object with the name, NULL if not found.

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

Parameters:
pFBX_TYPE The specified class type.
Returns:
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.

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

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

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

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

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

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

Parameters:
pFBX_TYPE The specified class type.
pIndex The specified index whose default value is 0.
Returns:
The source object of a specified class type at the specified index, NULL if not found.

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

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

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

Parameters:
pFBX_TYPE The specified class type.
pName The object name.
pStartIndex The start index.
Returns:
The source object with the name, NULL if not found.

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

Parameters:
pFBX_TYPE The specified class type.
pCriteria The given criteria.
pName The object name.
pStartIndex The start index.
Returns:
The source object with the name, NULL if not found.

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

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

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

Parameters:
pObject The destination object.
Returns:
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.

Parameters:
pObject The destination object from which this object disconnects.
Returns:
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.

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

Definition at line 700 of file kfbxobject.h.

bool DisconnectAllDstObject ( KFbxCriteria const &  pCriteria ) [inline]

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

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

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

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

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

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

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

Returns:
The number of destination objects with which this object connects.

Definition at line 724 of file kfbxobject.h.

int GetDstObjectCount ( KFbxCriteria const &  pCriteria ) const [inline]

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

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

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

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

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

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

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

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

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

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

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

Parameters:
pClassId The specified class type.
pIndex The specified index whose default value is 0.
Returns:
The destination object of the specified class type at the specified index, NULL if not found.

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

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

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

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

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.

Parameters:
pCriteria The given criteria.
pName The object name.
pStartIndex The start index.
Returns:
The destination object with the name, NULL if not found.

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

Parameters:
pClassId The specified class type.
pName The object name.
pStartIndex The start index.
Returns:
The destination object with the name, NULL if not found.

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

Parameters:
pClassId The specified class type.
pCriteria The given criteria.
pName The object name.
pStartIndex The start index.
Returns:
The destination object with the name, NULL if not found.

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

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

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

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

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

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

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

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

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

Parameters:
pFBX_TYPE The specified class type.
pIndex The specified index whose default value is 0.
Returns:
The destination object of the specified class type at the specified index, NULL if not found.

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

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

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

Parameters:
pFBX_TYPE The specified class type.
pName The object name.
pStartIndex The start index.
Returns:
The source object with the name, NULL if not found.

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

Parameters:
pFBX_TYPE The specified class type.
pCriteria The given criteria.
pName The object name.
pStartIndex The start index.
Returns:
The source object with the name, NULL if not found.

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

Parameters:
pProperty The source property with which this object connects.
Returns:
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.

Parameters:
pProperty The specified source property.
Returns:
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.

Parameters:
pProperty The specified source property.
Returns:
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.

Returns:
The number of source properties with which this object connects.

Definition at line 889 of file kfbxobject.h.

KFbxProperty GetSrcProperty ( int  pIndex = 0 ) const [inline]

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

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

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

Parameters:
pName The specified property name.
pStartIndex The start index.
Returns:
The source property with the specified name.

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.

Parameters:
pProperty The destination property with which this object connects.
Returns:
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.

Parameters:
pProperty The specified destination property.
Returns:
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.

Parameters:
pProperty The specified destination property.
Returns:
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.

Returns:
The number of destination properties with which this object connects.

Definition at line 925 of file kfbxobject.h.

KFbxProperty GetDstProperty ( int  pIndex = 0 ) const [inline]

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

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

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

Parameters:
pName The specified property name.
pStartIndex The start index.
Returns:
The destination property with the specified name.

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.

Parameters:
pUserID The ID of the user data record.
pUserData The data pointer of the user data record.
Remarks:
An user data record is composed of an ID and a data pointer. If the user data record identified by pUserID does not exist, a new user data record is created and its data pointer is set as pUserData.
void* GetUserDataPtr ( KFbxObjectID const &  pUserID ) const

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

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

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

Parameters:
pUserData The data pointer of the user data record.
Remarks:
An user data record is composed of an ID and a data pointer. If the user data record identified by pUserID does not exist, a new user data record is created and its data pointer is set as pUserData.

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

Returns:
The data pointer of the user data record, 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.

Returns:
A const pointer to the document that contains this object or 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.

Returns:
A const pointer to the root document that contains this object or NULL if the object does not belong to any document.
Remarks:
It returns this pointer if this object is a document object and does not belong to any document. That means this object is the root document.
KFbxScene* GetScene ( ) const

Returns a const pointer to the scene that contains this object.

Returns:
A pointer to the scene that contains this object or NULL if the object does not belong to any scene.
Examples:
ExportScene01/main.cxx.
void EmitMessage ( KFbxMessage *  pMessage ) const

Emits a message in all available message emitters in the document or SDK manager.

Parameters:
pMessage The message to emit.
Remarks:
The ownership of the message is transferred, don't delete it.
virtual const char* Localize ( const char *  pID,
const char *  pDefault = NULL 
) const [virtual]

Localization helper function, it calls the implementation of FBX SDK manager.

Sub-classes that manage their own localization could over-ride this function.

Parameters:
pID The identifier of the text to be localized.
pDefault The default text. Uses pID as the default text if pDefault is NULL.
Returns:
The localized text or the default text if the text can't be localized, .

Reimplemented in KFbxLibrary.

KFbxLibrary* GetParentLibrary ( ) const

Returns a handle on the parent library of this object.

Returns:
The parent library of this object, or NULL if the parent library doesn't exist.

Reimplemented in KFbxLibrary.

bool AddImplementation ( KFbxImplementation pImplementation )

Adds an implementation.

Parameters:
pImplementation The implementation to be added.
Returns:
True on success, false otherwise.
Remarks:
To succeed this function must be called with an implementation that has not already been added to this node.
bool RemoveImplementation ( KFbxImplementation pImplementation )

Removes an implementation.

Parameters:
pImplementation The implementation to be removed.
Returns:
True on success, false otherwise.
Remarks:
To succeed this function must be called with an implementation that has already been added to this node.
bool HasDefaultImplementation ( void  ) const

Determines if this shading node has a default implementation.

Returns:
True if this shading node has a default implementation, false otherwise.
KFbxImplementation* GetDefaultImplementation ( void  ) const

Returns the default implementation of this shading node.

Returns:
The default implementation of this shading node.
bool SetDefaultImplementation ( KFbxImplementation pImplementation )

Sets the default implementation of this shading node.

Parameters:
pImplementation The implementation to be set.
Returns:
True on success, false otherwise.
Remarks:
To succeed this function must be called with an implementation that has already been added to this node. Only the implementation which has already been added can be set as the default implementation.
int GetImplementationCount ( const KFbxImplementationFilter pCriteria = NULL ) const

Returns the number of implementations that satisfy a given criteria.

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

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

Parameters:
pIndex The specified index.
pCriteria The given criteria.
Returns:
The implementation at the specified index, NULL if not found.
virtual KString GetUrl ( ) const [virtual]

Returns the URL of this object.

Returns:
The URL of this object.
Remarks:
The URL indicates where the object is stored.
virtual bool SetUrl ( char *  pUrl ) [virtual]

Sets the URL of this object.

Parameters:
pUrl The URL to be set.
Returns:
True on success, false otherwise.
Remarks:
The URL indicates where the object is stored.
virtual KFbxObject& Copy ( const KFbxObject pObject ) [virtual]
virtual void ContentClear ( ) [protected, virtual]

Clears this object's content from memory.

This method must be overridden in the derived classes.

Remarks:
This method is called by ContentUnload() if the object content's unloading is successful .

Reimplemented in KFbxGeometryBase.

virtual KFbxPeripheral* GetPeripheral ( ) [protected, virtual]

Retrieves the peripheral of that object.

Returns:
The current peripheral for that object
Remarks:
A peripheral manipulates the content of an object. For instance, a peripheral can load the connections of an object on demand.

Reimplemented in 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.

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

Reimplemented from KFbxPlug.

virtual kFbxClassId GetRuntimeClassId ( ) const [virtual]

Retrieve the run-time ClassId for this object.

Returns:
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]
virtual KStringList GetTypeFlags ( ) const [virtual]
virtual void SetDocument ( KFbxDocument pDocument ) [virtual]
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]
virtual void Destruct ( bool  pRecursive,
bool  pDependents 
) [protected, virtual]
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.

Parameters:
pClassId The ClassId to set as the run-time ClassId for this object.
Returns:
Unused return value, deprecated.
Remarks:
This function is not implemented by KFbxPlug, hence it will always return false. KFbxObject implements this function and always return true.

Reimplemented from KFbxPlug.

virtual bool ConnecNotify ( KFbxConnectEvent const &  pEvent ) [protected, virtual]
virtual kFbxUpdateId IncUpdateId ( eFbxUpdateIdType  pUpdateId = eUpdateId_Object ) [protected, virtual]
virtual bool PropertyNotify ( eFbxPropertyNotify  pType,
KFbxProperty pProperty 
) [protected, virtual]

Friends And Related Function Documentation

friend class KFbxScene [friend]
friend class KFbxProperty [friend]

Reimplemented from KFbxPlug.

Definition at line 1225 of file kfbxobject.h.


Member Data Documentation

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

Examples:
ImportScene/DisplayMaterial.cxx.

Definition at line 1102 of file kfbxobject.h.


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

KFbxObject KFbxObject KFbxObject KFbxObject KFbxObject KFbxObject KFbxObject KFbxObject KFbxObject KFbxObject
KFbxObject KFbxObject KFbxObject KFbxObject KFbxObject KFbxObject KFbxObject KFbxObject KFbxObject KFbxObject