com.openinventor.inventor.events

Class SoKeyboardEvent

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.events.SoEvent

com.openinventor.inventor.events.SoButtonEvent

com.openinventor.inventor.events.SoKeyboardEvent

public class SoKeyboardEvent
extends SoButtonEvent

Keyboard key press and release events. SoKeyboardEvent represents keyboard key press and release events in the Open Inventor event model.

Add an SoEventCallback node to the scene graph to handle Open Inventor events.

See also:

SoEvent, SoButtonEvent, SoLocation2Event, SoMotion3Event, SoMouseButtonEvent, SoSpaceballButtonEvent, SoHandleEventAction, SoEventCallback, SoSelection, SoInteraction, SoWinDevice

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoKeyboardEvent.Keys The keyboard keys.

Nested classes/interfaces inherited from class com.openinventor.inventor.events.SoButtonEvent

SoButtonEvent.States

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoKeyboardEvent() Constructor.

Method Summary

Modifier and Type	Method and Description
SoKeyboardEvent.Keys	getKey() Gets which key generated the event.
static SoKeyboardEvent.Keys	getKeySym(int key)
byte	getPrintableCharacter() Convenience routine that returns the character representing the key, if it's printable.
static boolean	isKeyPressEvent(SoEvent e, SoKeyboardEvent.Keys whichKey) Returns whether the passed event is a keyboard press event of the passed key.
static boolean	isKeyReleaseEvent(SoEvent e, SoKeyboardEvent.Keys whichKey) Returns whether the passed event is a keyboard release event of the passed key.
void	setKey(SoKeyboardEvent.Keys whichKey) Sets which key generated the event.

Methods inherited from class com.openinventor.inventor.events.SoButtonEvent

getState, setState

Methods inherited from class com.openinventor.inventor.events.SoEvent

getNormalizedPosition, getPosition, getPosition, getPositionFloat, getPositionFloat, getTime, setAltDown, setButton1Down, setCtrlDown, setPosition, setPosition, setShiftDown, setTime, wasAltDown, wasButton1Down, wasCtrlDown, wasShiftDown

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getNativeResourceHandle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SoKeyboardEvent

public SoKeyboardEvent()

Constructor.

Method Detail

getKeySym

public static SoKeyboardEvent.Keys getKeySym(int key)

setKey

public void setKey(SoKeyboardEvent.Keys whichKey)

Sets which key generated the event.

isKeyPressEvent

public static boolean isKeyPressEvent(SoEvent e,
                                      SoKeyboardEvent.Keys whichKey)

Returns whether the passed event is a keyboard press event of the passed key. When SoKeyboardEvent.ANY is passed, this returns true if the event represents a keyboard press of any key.

getKey

public SoKeyboardEvent.Keys getKey()

Gets which key generated the event.

isKeyReleaseEvent

public static boolean isKeyReleaseEvent(SoEvent e,
                                        SoKeyboardEvent.Keys whichKey)

Returns whether the passed event is a keyboard release event of the passed key. When SoKeyboardEvent.ANY is passed, this returns true if the event represents a keyboard release of any key.

getPrintableCharacter

public byte getPrintableCharacter()

Convenience routine that returns the character representing the key, if it's printable. If not, this returns NULL ('\0').