KFbxPlug Class Reference
#include <kfbxplug.h>
Inherited by KFbxObject, and KFbxProperty.
Inheritance diagram for KFbxPlug:
Detailed Description
Base class to handle plug connections.
- Remarks:
- This class is for the FBX SDK internal use only.
Definition at line 190 of file kfbxplug.h.
Constructor and Destructors. | |
| virtual void | Destroy (bool pRecursive=false, bool pDependents=false) |
| Delete the object and Unregister from the FbxSdkManager. | |
Object ownership and type management. | |
| virtual KFbxSdkManager * | GetFbxSdkManager () |
| Get the KFbxSdkManager that created this object. | |
| virtual bool | Is (kFbxClassId pClassId) const |
| Test if the class is a hierarchical children of the specified class type. | |
| template<class T> | |
| bool | Is (T *pFBX_TYPE) const |
| Get the KFbxSdkManager that created this object. | |
| virtual bool | IsRuntime (kFbxClassId pClassId) const |
| Get the KFbxSdkManager that created this object. | |
| virtual bool | SetRuntimeClassId (kFbxClassId pClassId) |
| Get the KFbxSdkManager that created this object. | |
| virtual kFbxClassId | GetRuntimeClassId () const |
| Get the KFbxSdkManager that created this object. | |
User-specific Data | |
| virtual void | SetUserDataPtr (void *pUserData) |
| Store a pointer to an application-specific memory region. | |
| virtual void * | GetUserDataPtr () |
| Retrieve the application-specific pointer stored in this KFbxObject. | |
General Object Connection and Relationship Management | |
| int | GetSrcObjectCount () const |
| template<class T> | |
| int | GetSrcObjectCount (T const *pFBX_TYPE) const |
| KFbxObject * | GetSrcObject (int pIndex=0) const |
| template<class T> | |
| T * | GetSrcObject (T const *pFBX_TYPE, int pIndex=0) const |
| KFbxObject * | FindSrcObject (const char *pName, int pStartIndex=0) const |
| template<class T> | |
| T * | FindSrcObject (T const *pFBX_TYPE, const char *pName, int pStartIndex=0) const |
| bool | DisconnectAllSrcObject () |
| template<class T> | |
| bool | DisconnectAllSrcObject (T const *pFBX_TYPE) |
| int | GetDstObjectCount () const |
| template<class T> | |
| int | GetDstObjectCount (T const *pFBX_TYPE) const |
| KFbxObject * | GetDstObject (int pIndex=0) const |
| template<class T> | |
| T * | GetDstObject (T const *pFBX_TYPE, int pIndex=0) const |
| KFbxObject * | FindDstObject (const char *pName, int pStartIndex=0) const |
| template<class T> | |
| T * | FindDstObject (T const *pFBX_TYPE, const char *pName, int pStartIndex=0) const |
| bool | DisconnectAllDstObject () |
| template<class T> | |
| bool | DisconnectAllDstObject (T const *pFBX_TYPE) |
Public Member Functions | |
| virtual kFbxClassId | GetNewFbxClassId () const |
Static Public Attributes | |
| static kFbxClassId | ClassId |
Member Function Documentation
| virtual void Destroy | ( | bool | pRecursive = false, |
|
| bool | pDependents = false | |||
| ) | [virtual] |
| virtual KFbxSdkManager* GetFbxSdkManager | ( | ) | [inline, virtual] |
Get the KFbxSdkManager that created this object.
- Returns:
- Pointer to the KFbxSdkManager
Definition at line 213 of file kfbxplug.h.
| virtual bool Is | ( | kFbxClassId | pClassId | ) | const [inline, virtual] |
Test if the class is a hierarchical children of the specified class type.
- Parameters:
-
pClassId ClassId representing the class type
- Returns:
- Returns true if the object is of the type specified
Definition at line 218 of file kfbxplug.h.
Referenced by KFbxCast().
| bool Is | ( | T * | pFBX_TYPE | ) | const [inline] |
Get the KFbxSdkManager that created this object.
- Returns:
- Pointer to the KFbxSdkManager
Definition at line 219 of file kfbxplug.h.
| virtual bool IsRuntime | ( | kFbxClassId | pClassId | ) | const [inline, virtual] |
Get the KFbxSdkManager that created this object.
- Returns:
- Pointer to the KFbxSdkManager
Definition at line 220 of file kfbxplug.h.
| virtual bool SetRuntimeClassId | ( | kFbxClassId | pClassId | ) | [virtual] |
| virtual kFbxClassId GetRuntimeClassId | ( | ) | const [virtual] |
| virtual void SetUserDataPtr | ( | void * | pUserData | ) | [virtual] |
Store a pointer to an application-specific memory region.
- Parameters:
-
pUserData A pointer to be carry over by the KFbxObject.
- Remarks:
- The FBX SDK make no use of this pointer, it's the application responsability to allocate/free the memory referenced by this pointer.
Reimplemented in KFbxObject, and KFbxProperty.
| virtual void* GetUserDataPtr | ( | ) | [virtual] |
Retrieve the application-specific pointer stored in this KFbxObject.
- Returns:
- Return the pointer previously stored by SetUserData(), or
NULLif the pointer was not set.
Reimplemented in KFbxObject, and KFbxProperty.