Class Index | File Index

Classes


Namespace mmir.InputManager


Defined in: inputManager.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
The InputManager handles input events.
Method Summary
Method Attributes Method Name and Description
 
 
init()
 
raise(eventName, eventData)
This function raises an event.
Namespace Detail
mmir.InputManager
The InputManager handles input events.

On initialization, the InputManager also creates the mmir.InputEngine, and returns it as the second argument of the #init() function's callback (or the Promise's triggered callbacks). In addition, the InputEngine is exported as module "inputEngine" via RequireJS' define() function.

//initialization of inputManager
require('inputManager').init().then( function(inputManagerInstance, inputEngineInstance){
		//do something
});
Requires:
jQuery.Deferred
jQuery.extend
Method Detail
getInstance()
Deprecated:
instead: use mmir.InputManager object directly.

{Deferred} init()
Returns:
{Deferred}

raise(eventName, eventData)
This function raises an event.
Parameters:
{String} eventName
The name of the event which is to be raised
{Object} eventData Optional
OPTIONAL Data belonging to the event
Throws:
{Error}
if this function is invoked while the internal event/state engine (i.e. mmir.InputEngine is not initialized yet

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Feb 26 2016 21:33:47 GMT+0100 (Mitteleuropäische Zeit)