This reference page is linked to from the following overview topics: What's New: 3ds Max 2009 SDK.
#include <ISceneEventManager.h>
Inheritance diagram for
ISceneEventManager:
Public Types |
|
|
typedef SceneEventNamespace::CallbackKey |
CallbackKey |
Public Member Functions |
|
| virtual CallbackKey | RegisterCallback (ISceneEventCallback *callback, BOOL polling=FALSE, DWORD delayMilliseconds=0, BOOL mouseUp=FALSE)=0 |
| Registers a scene event callback, including
NodeEventCallback objects. |
|
| virtual void | UnRegisterCallback (CallbackKey callbackKey)=0 |
| Unregister a callback object. |
|
| virtual ISceneEventCallback * | GetCallbackByKey (CallbackKey callbackKey)=0 |
| Returns a callback object, given its key ID.
|
|
| virtual CallbackKey | GetKeyByCallback (ISceneEventCallback *callback)=0 |
| Returns a callback key ID, given a
registered callback object. |
|
| virtual void | TriggerMessages (CallbackKey callbackKey)=0 |
| Triggers messages about all events gathered
for a callback, immediately This may be used with callbacks in any
mode, but is particularly necessary to trigger messages for
callbacks in polling mode. |
|
| virtual void | ResetMessages (CallbackKey callbackKey)=0 |
| Clears out all gathered messages for a
callback The currently gathered events will not be included in the
next batch of messages for the callback. |
|
Member Typedef Documentation
Member Function Documentation
| virtual CallbackKey RegisterCallback | ( | ISceneEventCallback * | callback, |
| BOOL | polling = FALSE, |
||
| DWORD | delayMilliseconds =
0, |
||
| BOOL | mouseUp =
FALSE |
||
| ) | [pure virtual] |
Registers a scene event callback, including NodeEventCallback objects.
- Parameters:
-
[in] callback The callback object. This may be any scene event callback type, including NodeEventCallback. [in] polling In polling mode, messages are sent only when TriggerMessages() is called. Otherwise, messages are sent immediately after the given delay and mouseUp conditions are met. Polling mode cannot be used if a delay or mouseUp is specified. [in] delayMilliseconds If delay is zero, messages are triggered immediately when an event is completed. If delay is nonzero, messages are delayed until the specified time passes with no events (an uninterrupted period with no event noise). [in] mouseUp If mouseUp is true, messages are delayed until the mouse is up.
- Returns:
- The callback key ID (zero on failure)
| virtual void UnRegisterCallback | ( | CallbackKey | callbackKey | ) | [pure virtual] |
Unregister a callback object.
- Parameters:
-
[in] callbackKey The callback key ID
| virtual ISceneEventCallback* GetCallbackByKey | ( | CallbackKey | callbackKey | ) | [pure virtual] |
Returns a callback object, given its key ID.
- Parameters:
-
[in] callbackKey The callback key ID
- Returns:
- The callback object
| virtual CallbackKey GetKeyByCallback | ( | ISceneEventCallback * | callback | ) | [pure virtual] |
Returns a callback key ID, given a registered callback object.
- Parameters:
-
[in] callback The callback object.
- Returns:
- The callback key ID (zero on failure)
| virtual void TriggerMessages | ( | CallbackKey | callbackKey | ) | [pure virtual] |
Triggers messages about all events gathered for a callback, immediately This may be used with callbacks in any mode, but is particularly necessary to trigger messages for callbacks in polling mode.
- Parameters:
-
[in] callbackKey The callback key ID
| virtual void ResetMessages | ( | CallbackKey | callbackKey | ) | [pure virtual] |
Clears out all gathered messages for a callback The currently gathered events will not be included in the next batch of messages for the callback.
- Parameters:
-
[in] callbackKey The callback key ID
