ISceneEventManager Class Reference

#include <ISceneEventManager.h>

Inheritance diagram for ISceneEventManager:

Public Types
typedef SceneEventNamespace::CallbackKey	CallbackKey
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

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.
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor.
UtilExport BaseInterface *	GetInterface (Interface_ID id) override
virtual UtilExport Interface_ID	GetID ()
virtual LifetimeType	LifetimeControl ()
virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Member Typedef Documentation

CallbackKey

typedef SceneEventNamespace::CallbackKey CallbackKey

Member Function Documentation

RegisterCallback()

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)

UnRegisterCallback()

virtual void UnRegisterCallback ( CallbackKey  callbackKey )

pure virtual

Unregister a callback object.

Parameters

[in]

callbackKey

The callback key ID

GetCallbackByKey()

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

GetKeyByCallback()

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)

TriggerMessages()

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

ResetMessages()

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