org.jdesktop.wonderland.client.scenemanager.event
Class EnterExitEvent

java.lang.Object
  extended by org.jdesktop.wonderland.client.input.Event
      extended by org.jdesktop.wonderland.client.scenemanager.event.SceneEvent
          extended by org.jdesktop.wonderland.client.scenemanager.event.EnterExitEvent
All Implemented Interfaces:
java.io.Serializable

public class EnterExitEvent
extends SceneEvent

Event when the user has entered/exited an Entity. Note that this event represents when the user input has entered/exited an Entity (e.g. via a mouse event), and has nothing to do with a user's avatar. The Entity in question is given as the first element of the list returned by the getEntityList() method.

Author:
Jordan Slott
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.jdesktop.wonderland.client.input.Event
entity, EVENT_CLASS_ID, isFocussed
 
Constructor Summary
EnterExitEvent()
          Default constructor
EnterExitEvent(org.jdesktop.mtgame.Entity entity, boolean isEnter)
          Constructor, takes the Enitity that has been entered/exited.
 
Method Summary
 Event clone(Event event)
          Copy the members of this class into the given event.
 boolean isEnter()
          Returns true if this is an enter event, false if it is an exit event.
 
Methods inherited from class org.jdesktop.wonderland.client.scenemanager.event.SceneEvent
getCellForEntity, getEntityList, getPrimaryCell, getPrimaryEntity
 
Methods inherited from class org.jdesktop.wonderland.client.input.Event
allocateEventClassID, free, getClassID, getEntity, isFocussed, setEntity, setFocussed
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EnterExitEvent

public EnterExitEvent()
Default constructor


EnterExitEvent

public EnterExitEvent(org.jdesktop.mtgame.Entity entity,
                      boolean isEnter)
Constructor, takes the Enitity that has been entered/exited.

Method Detail

isEnter

public boolean isEnter()
Returns true if this is an enter event, false if it is an exit event.

Returns:
True for enter, false for exit

clone

public Event clone(Event event)
Copy the members of this class into the given event.
If event is null, a new event of this class is created and returned.
If event is null, a new event of this class is created and returned.

Overrides:
clone in class SceneEvent


Open Wonderland - http://openwonderland.org