mr.robotto.engine.events

Class MrEventsListener

java.lang.Object

mr.robotto.engine.events.MrEventsListener

Direct Known Subclasses:

MrDefaultEventListener

public abstract class MrEventsListener
extends java.lang.Object

Class for processing events linked to an object

Constructor Summary

Constructors

Constructor and Description
MrEventsListener() Creates a new Event Listener

Method Summary

Modifier and Type	Method and Description
MrObject	getAttachedObject() Gets the object which this event listener is attached to
MrObjectController	getObjectController() Gets the object controller which this event listener is attached to
java.util.Set<java.lang.String>	getRegisteredEvents() Gets all registered events
boolean	isEventRegistered(java.lang.String evName) Checks if the given event is registered to be processed
protected void	processEvent(java.lang.String eventName, MrBundle eventBundle) Process a certain event
void	queueEvent(java.lang.String eventName, MrBundle eventBundle) Queues a new event to be processed on the OpenGL Thread This method should be always called from a MrEventDispatcher instance
void	registerEvent(java.lang.String eventName) Registers a certain event
protected void	registerEvents(java.util.Set<java.lang.String> events) Register multiple events at once
void	setObjectController(MrObjectController controller) Sets the object controller
java.lang.String	toString()
void	unregisterEvent(java.lang.String eventName) Unregisters a certain event
void	updateEvents() Request to process all queued events This method should not be called by user

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MrEventsListener

public MrEventsListener()

Creates a new Event Listener

Method Detail

getObjectController

public MrObjectController getObjectController()

Gets the object controller which this event listener is attached to

Returns:

setObjectController

public void setObjectController(MrObjectController controller)

Sets the object controller

Parameters:

controller -

getAttachedObject

public MrObject getAttachedObject()

Gets the object which this event listener is attached to

Returns:

isEventRegistered

public boolean isEventRegistered(java.lang.String evName)

Checks if the given event is registered to be processed

Parameters:

evName -

Returns:

getRegisteredEvents

public java.util.Set<java.lang.String> getRegisteredEvents()

Gets all registered events

Returns:

registerEvents

protected void registerEvents(java.util.Set<java.lang.String> events)

Register multiple events at once

Parameters:

events -

registerEvent

public void registerEvent(java.lang.String eventName)

Registers a certain event

Parameters:

eventName -

unregisterEvent

public void unregisterEvent(java.lang.String eventName)

Unregisters a certain event

Parameters:

eventName -

queueEvent

public final void queueEvent(java.lang.String eventName,
                             MrBundle eventBundle)

Queues a new event to be processed on the OpenGL Thread This method should be always called from a MrEventDispatcher instance

Parameters:

eventName -

eventBundle -

processEvent

protected void processEvent(java.lang.String eventName,
                            MrBundle eventBundle)

Process a certain event

Parameters:

eventName - event name received

eventBundle - bundle containing event data

updateEvents

public final void updateEvents()

Request to process all queued events This method should not be called by user

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object