org.jdesktop.wonderland.client.jme.input
Class InputEvent3D

java.lang.Object
  extended by org.jdesktop.wonderland.client.input.Event
      extended by org.jdesktop.wonderland.client.jme.input.InputEvent3D
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
KeyEvent3D, MouseEvent3D

public abstract class InputEvent3D
extends Event

The abstract and super class for all the input events.

Author:
deronj
See Also:
Serialized Form

Nested Class Summary
static class InputEvent3D.ModifierId
          Enum values which indicate which modifiers keys are held down for this event.
 
Field Summary
protected  java.awt.event.InputEvent awtEvent
          The originating AWT input event.
 
Fields inherited from class org.jdesktop.wonderland.client.input.Event
entity, EVENT_CLASS_ID, isFocussed
 
Constructor Summary
protected InputEvent3D()
          Default constructor (for cloning)
  InputEvent3D(java.awt.event.InputEvent awtEvent)
          Create a new instance of Event3D.
 
Method Summary
 Event clone(Event event)
          Copy the members of this class into the given event.
 java.awt.event.InputEvent getAwtEvent()
          Returns the associated AWT input event
 int getID()
          Returns the ID of the associated AWT input event.
 InputEvent3D.ModifierId[] getModifiersEx(InputEvent3D.ModifierId[] ret)
          Returns a set of the extended modifiers this event.
 org.jdesktop.mtgame.PickInfo getPickInfo()
          INTERNAL ONLY.
 long getWhen()
          Returns the time stamp of when this event occurred
 void setPickInfo(org.jdesktop.mtgame.PickInfo pickInfo)
          INTERNAL ONLY.
 
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
 

Field Detail

awtEvent

protected java.awt.event.InputEvent awtEvent
The originating AWT input event.

Constructor Detail

InputEvent3D

protected InputEvent3D()
Default constructor (for cloning)


InputEvent3D

public InputEvent3D(java.awt.event.InputEvent awtEvent)
Create a new instance of Event3D.

Parameters:
awtEvent - The AWT input event which generates this 3D input event.
Method Detail

getID

public int getID()
Returns the ID of the associated AWT input event.


getAwtEvent

public java.awt.event.InputEvent getAwtEvent()
Returns the associated AWT input event


getWhen

public long getWhen()
Returns the time stamp of when this event occurred

Returns:
time stamp for event

getModifiersEx

public InputEvent3D.ModifierId[] getModifiersEx(InputEvent3D.ModifierId[] ret)
Returns a set of the extended modifiers this event. Extended modifiers represent the state of all modal keys, such as ALT, CTRL, META, and the mouse buttons just after the event occurred.

Parameters:
ret - an array to fill in the resutl. If it is too small, a new array with enough size will be allocated.
Returns:
an array of ModifierId objects that represents the modifiers status.
See Also:
InputEvent

clone

public Event clone(Event event)
Copy the members of this class into the given event.

Overrides:
clone in class Event

setPickInfo

public void setPickInfo(org.jdesktop.mtgame.PickInfo pickInfo)
INTERNAL ONLY.
Used by the input system to specify the pickInfo for this input event.


getPickInfo

public org.jdesktop.mtgame.PickInfo getPickInfo()
INTERNAL ONLY.
Returns the pickInfo for this event. This provides full event information to Wonderland components which need it, such as the World Builder.



Open Wonderland - http://openwonderland.org