Public Member Functions | Protected Attributes

FBPropertyEvent Class Reference

This reference page is linked to from the following overview topics: MotionBuilder 2014, Overview of the Architecture.


Search for all occurrences

Detailed Description

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>

Inheritance diagram for FBPropertyEvent:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBPropertyEvent ()
 Constructor.
FBPropertyEventInit (FBComponent *pComponent, HIRegister pParent, const char *pName, int pType, int pSubType=K_INT_MAX)
 Property initialization function.
FBPropertyEventInitGlobal (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.

Constructor & Destructor Documentation

Constructor.

virtual ~FBPropertyEvent ( ) [virtual]

Destructor.


Member Function Documentation

FBPropertyEvent* Init ( FBComponent pComponent,
HIRegister  pParent,
const char *  pName,
int  pType,
int  pSubType = K_INT_MAX 
)

Property initialization function.

Parameters:
pComponentOwner component.
pParentInternal register interface of object owner.
pNameName of FBPropertyEvent
pTypeType of event.
pSubTypeSubType of event(default=K_INT_MAX).
Returns:
Pointer to this FBPropertyEvent
FBPropertyEvent* InitGlobal ( const char *  pName,
const char *  pGlobalEventName 
)

Property initialization function, for global events.

Parameters:
pNameName of FBPropertyEvent
pGlobalEventNameName of global event.
Returns:
Pointer to this FBPropertyEvent
virtual void Add ( HICallback  pOwner,
kICallbackHandler  pHandler 
) [virtual]
virtual void Remove ( HICallback  pOwner,
kICallbackHandler  pHandler 
) [virtual]
virtual void InvalidateParent ( ) [virtual]

Invalidate parent, removing internal register parent.

virtual FBPropertyType GetPropertyType ( ) [inline, override, virtual]

Get the property's type.

Returns:
The property's type.

Reimplemented from FBProperty.

Definition at line 545 of file fbproperties.h.

{ return kFBPT_event; }

Member Data Documentation

HIRegister mParentRegister [protected]

Internal callback register.

Definition at line 500 of file fbproperties.h.

int mType [protected]

Type of event.

Definition at line 502 of file fbproperties.h.

int mSubType [protected]

SubType of event.

Definition at line 504 of file fbproperties.h.


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

FBPropertyEvent FBPropertyEvent FBPropertyEvent FBPropertyEvent FBPropertyEvent FBPropertyEvent FBPropertyEvent FBPropertyEvent FBPropertyEvent FBPropertyEvent
FBPropertyEvent FBPropertyEvent FBPropertyEvent FBPropertyEvent FBPropertyEvent FBPropertyEvent FBPropertyEvent FBPropertyEvent FBPropertyEvent FBPropertyEvent