This reference page is linked to from the following overview topics: MotionBuilder 2014, Overview of the Architecture.
PropertyEvent: Base event class.
User could register custom callback function to FBPropertyEvent and perform necessary custom tasks.
Multiple callbacks could be registered to single event, and they will called in the reverse order of registration.
User could add python callbacks via pyfbsdk (if exposed). Those python callbacks which throws exceptions will be unregistered automatically
Definition at line 495 of file fbproperties.h.
#include <fbproperties.h>
Public Member Functions | |
FBPropertyEvent () | |
Constructor. | |
FBPropertyEvent * | Init (FBComponent *pComponent, HIRegister pParent, const char *pName, int pType, int pSubType=K_INT_MAX) |
Property initialization function. | |
FBPropertyEvent * | InitGlobal (const char *pName, const char *pGlobalEventName) |
Property initialization function, for global events. | |
virtual | ~FBPropertyEvent () |
Destructor. | |
virtual void | InvalidateParent () |
Invalidate parent, removing internal register parent. | |
virtual FBPropertyType | GetPropertyType () override |
Get the property's type. | |
virtual void | Add (HICallback pOwner, kICallbackHandler pHandler) |
Add/Remove a callback. | |
virtual void | Remove (HICallback pOwner, kICallbackHandler pHandler) |
Protected Attributes | |
HIRegister | mParentRegister |
Internal callback register. | |
int | mType |
Type of event. | |
int | mSubType |
SubType of event. |
FBPropertyEvent | ( | ) |
Constructor.
virtual ~FBPropertyEvent | ( | ) | [virtual] |
Destructor.
FBPropertyEvent* Init | ( | FBComponent * | pComponent, |
HIRegister | pParent, | ||
const char * | pName, | ||
int | pType, | ||
int | pSubType = K_INT_MAX |
||
) |
Property initialization function.
pComponent | Owner component. |
pParent | Internal register interface of object owner. |
pName | Name of FBPropertyEvent |
pType | Type of event. |
pSubType | SubType of event(default=K_INT_MAX). |
FBPropertyEvent* InitGlobal | ( | const char * | pName, |
const char * | pGlobalEventName | ||
) |
Property initialization function, for global events.
pName | Name of FBPropertyEvent |
pGlobalEventName | Name of global event. |
virtual void Add | ( | HICallback | pOwner, |
kICallbackHandler | pHandler | ||
) | [virtual] |
Add/Remove a callback.
pOwner | Callback owner. |
pHandler | Callback handler. |
Reimplemented in FBPropertyEventAnimationNode, FBPropertyEventUIIdle, FBPropertyEventVideoFrameRendering, FBPropertyEventConnectionNotify, FBPropertyEventConnectionDataNotify, FBPropertyEventConnectionStateNotify, FBPropertyEventConnectionKeyingNotify, FBPropertyEventCallbackEvalPipeline, FBPropertyEventCallbackRenderPipeline, and FBPropertyEventCallbackSynPoint.
virtual void Remove | ( | HICallback | pOwner, |
kICallbackHandler | pHandler | ||
) | [virtual] |
Reimplemented in FBPropertyEventAnimationNode, FBPropertyEventUIIdle, FBPropertyEventVideoFrameRendering, FBPropertyEventConnectionNotify, FBPropertyEventConnectionDataNotify, FBPropertyEventConnectionStateNotify, FBPropertyEventConnectionKeyingNotify, FBPropertyEventCallbackEvalPipeline, FBPropertyEventCallbackRenderPipeline, and FBPropertyEventCallbackSynPoint.
virtual void InvalidateParent | ( | ) | [virtual] |
Invalidate parent, removing internal register parent.
virtual FBPropertyType GetPropertyType | ( | ) | [inline, override, virtual] |
Get the property's type.
Reimplemented from FBProperty.
Definition at line 545 of file fbproperties.h.
{ return kFBPT_event; }
HIRegister mParentRegister [protected] |
Internal callback register.
Definition at line 500 of file fbproperties.h.
int mType [protected] |
int mSubType [protected] |