Emini Physics Engine 1.3.5a API Documentation

at.emini.physics2D
Class EventSet

java.lang.Object
  extended by at.emini.physics2D.EventSet

public class EventSet
extends java.lang.Object

The event set manages the events within a world. All events of a world are referenced here. It ensures that each event can be accessed directly or by index(id)

Author:
Alexander Adensamer

Field Summary
protected  java.util.Vector mEvents
          A list of all registered events
 
Constructor Summary
EventSet()
          Default Constructor.
EventSet(EventSet other)
          Copy constructor.
 
Method Summary
 void checkEvents(World world, PhysicsEventListener listener)
          Checks all events for triggering.
 EventSet copy()
          Copies the event set.
 java.util.Vector getEvents()
          Gets the complete list of events.
 boolean isRegistered(Event e)
          Checks whether an event is registered in this set.
 void registerEvent(Event e)
          Registers a new event.
 void registerEvents(java.util.Vector newEvents)
          Registers new events from a vector.
 void removeEvent(Event e)
          Removes an event form the event set.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mEvents

protected java.util.Vector mEvents
A list of all registered events

Constructor Detail

EventSet

public EventSet()
Default Constructor.


EventSet

public EventSet(EventSet other)
Copy constructor.

Parameters:
other - the event set to copy
Method Detail

copy

public EventSet copy()
Copies the event set. Creates a copy of the event set.

Returns:
the copy of the event set.

registerEvent

public void registerEvent(Event e)
Registers a new event.

Parameters:
e - the event to register

registerEvents

public void registerEvents(java.util.Vector newEvents)
Registers new events from a vector. Only events that are not already registered (anywhere), are registered.

Parameters:
newEvents - vector of new events

removeEvent

public void removeEvent(Event e)
Removes an event form the event set.

Parameters:
e - the event to remove

checkEvents

public void checkEvents(World world,
                        PhysicsEventListener listener)
Checks all events for triggering.

Parameters:
world - the world.
listener - the listener to inform about the triggers.

isRegistered

public boolean isRegistered(Event e)
Checks whether an event is registered in this set.

Parameters:
e - the event to check.
Returns:
true if the event is registered here.

getEvents

public java.util.Vector getEvents()
Gets the complete list of events.

Returns:
a list of all events.

Emini Physics Engine 1.3.5a API Documentation

Emini Physics Engine 1.3.5a API Documentation - Copyright 2014 Alexander Adensamer