This reference page is linked to from the following overview topics: List of Python FBX classes.
Detailed Description
Top level class for any FBX object that requires ClassId functionality.
For more information about ClassId, please refer to the kFbxClassId documentation.
- See also:
- kFbxClassId, KFbxObject
Definition at line 267 of file kfbxplug.h.
#include <kfbxplug.h>
Public Member Functions |
|
| virtual void | Destroy (bool pRecursive=false, bool pDependents=false) |
| Unregister and delete this object. |
|
| virtual KFbxSdkManager * | GetFbxSdkManager () const |
| Retrieve the FBX SDK Manager associated to
this object. |
|
| virtual bool | Is (kFbxClassId pClassId) const |
| Test if this class is a hierarchical
children of the specified class type. |
|
| template<class T > | |
| bool | Is (T *pFBX_TYPE) const |
| Templated test if this class is a
hierarchical children of the specified class type. |
|
| virtual bool | IsRuntime (kFbxClassId pClassId) const |
| Test if this class is a hierarchical
children of the specified class type. |
|
| virtual bool | SetRuntimeClassId (kFbxClassId pClassId) |
| Set the run-time ClassId for this class.
|
|
| virtual kFbxClassId | GetRuntimeClassId () const |
| Retrieve the run-time ClassId for this
object. |
|
| virtual bool | IsRuntimePlug () const |
| Find out if the ClassId was registered
during run-time rather than at compile time. |
|
Static Public Member Functions |
|
| static void | SetWipeMode (bool pState) |
| static bool | GetWipeMode () |
Protected Member Functions |
|
| KFbxPlug () | |
| KFbxPlug (KFbxSdkManager &pManager, const char *pName) | |
| virtual | ~KFbxPlug () |
| virtual void | Construct (const KFbxPlug *pFrom) |
| virtual void | Destruct (bool pRecursive, bool pDependents) |
Friends |
|
| class | KFbxProperty |
| class | KFbxObject |
Constructor & Destructor Documentation
| KFbxPlug | ( | ) | [inline, protected] |
Definition at line 344 of file kfbxplug.h.
{}
| KFbxPlug | ( | KFbxSdkManager & | pManager, |
| const char * | pName | ||
| ) | [inline, protected] |
Definition at line 345 of file kfbxplug.h.
{}
| virtual ~KFbxPlug | ( | ) | [inline, protected, virtual] |
Definition at line 346 of file kfbxplug.h.
{}
Member Function Documentation
| virtual void Destroy | ( | bool | pRecursive =
false, |
| bool | pDependents =
false |
||
| ) | [virtual] |
Unregister and delete this object.
This will also breaks all connections to this object as well as removing all the instance of all the properties of this object with the object's class.
- Parameters:
-
pRecursive Unused parameter, deprecated. pDependents Unused parameter, deprecated.
| virtual KFbxSdkManager* GetFbxSdkManager | ( | ) | const [inline, 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 in KFbxObject.
Definition at line 283 of file kfbxplug.h.
{ return 0; }
| virtual bool Is | ( | kFbxClassId | pClassId | ) | const [inline, virtual] |
Test if this class is a hierarchical children of the specified class type.
This is the standard method to differentiate object classes.
- Parameters:
-
pClassId The class type to test against self.
- Returns:
- True if the object is a hierarchical children of the type specified.
- Remarks:
- This function will perform a complete search until it reaches the top level class, but it will stop as soon as one ClassId matches the test.
- Examples:
- ImportScene/DisplayMaterial.cxx.
Definition at line 290 of file kfbxplug.h.
{ return GetClassId().Is(pClassId); }
| bool Is | ( | T * | pFBX_TYPE | ) | const [inline] |
Templated test if this class is a hierarchical children of the specified class type.
- Parameters:
-
pFBX_TYPE A direct pointer to the C++ type of the object to test against.
- Returns:
- True if the object is a hierarchical children of the type specified.
- Remarks:
- This function will perform a complete search until it reaches the top level class, but it will stop as soon as one ClassId matches the test.
Definition at line 297 of file kfbxplug.h.
{ return Is(T::ClassId); }
| virtual bool IsRuntime | ( | kFbxClassId | pClassId | ) | const [inline, virtual] |
Test if this class is a hierarchical children of the specified class type.
This test will be performed on the run-time class registered with the FBX SDK Manager rather than the static ClassId generated at compile time.
- Parameters:
-
pClassId The class type to test against self.
- Returns:
- True if the object is a hierarchical children of the type specified.
- Remarks:
- This function will perform a complete search until it reaches the top level class, but it will stop as soon as one ClassId matches the test.
Definition at line 305 of file kfbxplug.h.
{ return GetRuntimeClassId().Is(pClassId); }
| virtual bool SetRuntimeClassId | ( | kFbxClassId | pClassId | ) | [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 in KFbxObject.
| virtual kFbxClassId GetRuntimeClassId | ( | ) | const [virtual] |
Retrieve the run-time ClassId for this object.
- Returns:
- The run-time ClassId for this object.
Reimplemented in KFbxObject.
| virtual bool IsRuntimePlug | ( | ) | const [inline, virtual] |
Find out if the ClassId was registered during run-time rather than at compile time.
- Returns:
- True if the run-time ClassId is inequal to the ClassId.
Definition at line 324 of file kfbxplug.h.
{ return !( GetRuntimeClassId() == GetClassId() ); }
| static void SetWipeMode | ( | bool | pState | ) | [inline, static] |
Definition at line 335 of file kfbxplug.h.
{ KFbxPlug::sgWipeMode = pState; }
| static bool GetWipeMode | ( | ) | [inline, static] |
Definition at line 336 of file kfbxplug.h.
{ return KFbxPlug::sgWipeMode; }
| virtual void Construct | ( | const KFbxPlug * | pFrom | ) | [protected, virtual] |
| virtual void Destruct | ( | bool | pRecursive, |
| bool | pDependents | ||
| ) | [protected, virtual] |
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, KFbxObject, KFbxPatch, KFbxPose, KFbxReference, KFbxSubdiv, and KFbxThumbnail.
Friends And Related Function Documentation
friend class KFbxProperty
[friend] |
friend class KFbxObject [friend] |
Reimplemented in KFbxAnimCurveBase, KFbxAnimCurveNode, KFbxAnimLayer, and KFbxAnimStack.
Definition at line 351 of file kfbxplug.h.
The documentation for this class was generated from the following file:
- fbxfilesdk/kfbxplugins/kfbxplug.h
