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

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.HoverEvent
All Implemented Interfaces:
java.io.Serializable

public class HoverEvent
extends SceneEvent

Event when the user input (e.g. mouse pointer) starts and stops hovering above an Entity. 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
HoverEvent()
          Default constructor
HoverEvent(org.jdesktop.mtgame.Entity entity, boolean isStart, java.awt.event.MouseEvent mouseEvent)
          Constructor, takes the Enitity over which the hovering takes place and whether hovering is starting or stopping and the mouse event that caused the hover.
 
Method Summary
 Event clone(Event event)
          Copy the members of this class into the given event.
 java.awt.event.MouseEvent getMouseEvent()
          Returns the mouse event that resulted in this hover event.
 boolean isStart()
          Returns true if this is a hover start event, false if it is a hover stop 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

HoverEvent

public HoverEvent()
Default constructor


HoverEvent

public HoverEvent(org.jdesktop.mtgame.Entity entity,
                  boolean isStart,
                  java.awt.event.MouseEvent mouseEvent)
Constructor, takes the Enitity over which the hovering takes place and whether hovering is starting or stopping and the mouse event that caused the hover.

Method Detail

isStart

public boolean isStart()
Returns true if this is a hover start event, false if it is a hover stop event.

Returns:
True for hover start, false for hover stop

getMouseEvent

public java.awt.event.MouseEvent getMouseEvent()
Returns the mouse event that resulted in this hover event.

Returns:
The MouseEvent object

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