org.vrjuggler.vrjconfig.commoneditors
Class EditorHelpers

java.lang.Object
  org.vrjuggler.vrjconfig.commoneditors.EditorHelpers

All Implemented Interfaces:

EditorConstants

public abstract class EditorHelpers
extends Object
implements EditorConstants

A collection of general helper functions that may be of use to authors of custom editors for VRJConfig.

Field Summary

Fields inherited from interface org.vrjuggler.vrjconfig.commoneditors.EditorConstants

ACCUM_ALPHA_SIZE_PROPERTY, ACCUM_BLUE_SIZE_PROPERTY, ACCUM_GREEN_SIZE_PROPERTY, ACCUM_RED_SIZE_PROPERTY, ACTIVE_PROPERTY, ALIAS_TYPE, ANALOG_COUNT_PROPERTY, ANALOG_DEVICE_TYPE, ANALOG_FIRST_PROPERTY, ANALOG_PROXY_TYPE, AUX_BUFFER_COUNT_PROPERTY, BACK_VALUE_INDEX, BASE_FRAME_PROXY_PROPERTY, BORDER_PROPERTY, BUTTON_COUNT_PROPERTY, CAMERA_POS_PROPERTY, CLUSTER_NODE_TYPE, COLOR_ALPHA_SIZE_PROPERTY, COLOR_BLUE_SIZE_PROPERTY, COLOR_GREEN_SIZE_PROPERTY, COLOR_RED_SIZE_PROPERTY, COMMAND_DEVICE_TYPE, COMMON_IMG_ROOT, CUSTOM_SCALE_PROPERTY, DATA_GLOVE_TYPE, DECREMENT_KEYPRESS_PROPERTY, DEFAULT_SIMULATOR_TYPE, DEPTH_BUFFER_SIZE_PROPERTY, DEVICE_PROPERTY, DEVICE_UNITS_PROPERTY, DIGITAL_COUNT_PROPERTY, DIGITAL_DEVICE_TYPE, DIGITAL_FIRST_PROPERTY, DIGITAL_PROXY_TYPE, DIRECTX_JOYSTICK_TYPE, DISPLAY_WINDOW_TYPE, DISPLAY_WINDOWS_PROPERTY, DOWN_VALUE_INDEX, DTK_TYPE, FASTRAK_TYPE, FIRST_MOUSE_BUTTON, FLOCK_TYPE, FORWARD_VALUE_INDEX, FRAME_BUFFER_PROPERTY, FSAA_ENABLE_PROPERTY, GLOVE_DEVICE_TYPE, HEAD_POSITION_PROPERTY, HIDE_MOUSE_PROPERTY, IBOX_TYPE, INCREMENT_KEYPRESS_PROPERTY, INPUT_AREA_TYPE, INPUT_DEVICE_TYPE, INPUT_WINDOW_TYPE, INTEROCULAR_DISTANCE_PROPERTY, INTERSENSE_API_TYPE, INTERSENSE_STATION_TYPE, INTERSENSE_TYPE, KEY_0_INT_VALUE, KEY_0_STRING_VALUE, KEY_1_INT_VALUE, KEY_1_STRING_VALUE, KEY_2_INT_VALUE, KEY_2_STRING_VALUE, KEY_3_INT_VALUE, KEY_3_STRING_VALUE, KEY_4_INT_VALUE, KEY_4_STRING_VALUE, KEY_5_INT_VALUE, KEY_5_STRING_VALUE, KEY_6_INT_VALUE, KEY_6_STRING_VALUE, KEY_7_INT_VALUE, KEY_7_STRING_VALUE, KEY_8_INT_VALUE, KEY_8_STRING_VALUE, KEY_9_INT_VALUE, KEY_9_STRING_VALUE, KEY_A_INT_VALUE, KEY_A_STRING_VALUE, KEY_B_INT_VALUE, KEY_B_STRING_VALUE, KEY_C_INT_VALUE, KEY_C_STRING_VALUE, KEY_D_INT_VALUE, KEY_D_STRING_VALUE, KEY_DOWN_INT_VALUE, KEY_DOWN_STRING_VALUE, KEY_E_INT_VALUE, KEY_E_STRING_VALUE, KEY_ESC_INT_VALUE, KEY_ESC_STRING_VALUE, KEY_F_INT_VALUE, KEY_F_STRING_VALUE, KEY_G_INT_VALUE, KEY_G_STRING_VALUE, KEY_H_INT_VALUE, KEY_H_STRING_VALUE, KEY_I_INT_VALUE, KEY_I_STRING_VALUE, KEY_J_INT_VALUE, KEY_J_STRING_VALUE, KEY_K_INT_VALUE, KEY_K_STRING_VALUE, KEY_L_INT_VALUE, KEY_L_STRING_VALUE, KEY_LEFT_INT_VALUE, KEY_LEFT_STRING_VALUE, KEY_M_INT_VALUE, KEY_M_STRING_VALUE, KEY_MODIFIER_PAIR_TYPE, KEY_N_INT_VALUE, KEY_N_STRING_VALUE, KEY_NONE_INT_VALUE, KEY_NONE_STRING_VALUE, KEY_O_INT_VALUE, KEY_O_STRING_VALUE, KEY_P_INT_VALUE, KEY_P_STRING_VALUE, KEY_PAIR_PROPERTY, KEY_PROPERTY, KEY_Q_INT_VALUE, KEY_Q_STRING_VALUE, KEY_R_INT_VALUE, KEY_R_STRING_VALUE, KEY_RIGHT_INT_VALUE, KEY_RIGHT_STRING_VALUE, KEY_S_INT_VALUE, KEY_S_STRING_VALUE, KEY_T_INT_VALUE, KEY_T_STRING_VALUE, KEY_U_INT_VALUE, KEY_U_STRING_VALUE, KEY_UP_INT_VALUE, KEY_UP_STRING_VALUE, KEY_V_INT_VALUE, KEY_V_STRING_VALUE, KEY_W_INT_VALUE, KEY_W_STRING_VALUE, KEY_X_INT_VALUE, KEY_X_STRING_VALUE, KEY_Y_INT_VALUE, KEY_Y_STRING_VALUE, KEY_Z_INT_VALUE, KEY_Z_STRING_VALUE, KEYBOARD_MOUSE_DEVICE_TYPE, KEYBOARD_MOUSE_PROXY_PTR_PROPERTY, KEYBOARD_MOUSE_PROXY_TYPE, KEYBOARD_MOUSE_PTR_PROPERTY, LAST_MOUSE_BUTTON, LEFT_VALUE_INDEX, LINUX_JOYDEV_TYPE, LOCK_KEY_PROPERTY, LOWER_LEFT_CORNER_PROPERTY, LOWER_RIGHT_CORNER_PROPERTY, MODIFIER_KEY_PROPERTY, MODKEY_ALT_INT_VALUE, MODKEY_ALT_STRING_VALUE, MODKEY_ANY_INT_VALUE, MODKEY_ANY_STRING_VALUE, MODKEY_CTRL_INT_VALUE, MODKEY_CTRL_STRING_VALUE, MODKEY_NONE_INT_VALUE, MODKEY_NONE_STRING_VALUE, MODKEY_SHIFT_INT_VALUE, MODKEY_SHIFT_STRING_VALUE, MOTION_STAR_TYPE, MOUSE_BUT1_INT_VALUE, MOUSE_BUT1_STRING_VALUE, MOUSE_BUT2_INT_VALUE, MOUSE_BUT2_STRING_VALUE, MOUSE_BUT3_INT_VALUE, MOUSE_BUT3_STRING_VALUE, MOUSE_NEGX_INT_VALUE, MOUSE_NEGX_STRING_VALUE, MOUSE_NEGY_INT_VALUE, MOUSE_NEGY_STRING_VALUE, MOUSE_POSX_INT_VALUE, MOUSE_POSX_STRING_VALUE, MOUSE_POSY_INT_VALUE, MOUSE_POSY_STRING_VALUE, OPENGL_FRAME_BUFFER_TYPE, ORIGIN_PROPERTY, PINCH_GLOVE_TYPE, POSITION_FILTERS_PROPERTY, POSITION_PROXY_TYPE, POSITION_TRANSFORM_FILTER_TYPE, POSITIONAL_DEVICE_TYPE, POST_ROTATION_PROPERTY, POST_TRANSLATION_PROPERTY, PRE_ROTATION_PROPERTY, PRE_TRANSLATION_PROPERTY, PROXY_PROPERTY, PROXY_TYPE, PUCK_DEVICE_TYPE, RELATIVE_PROXY_PROPERTY, RIGHT_VALUE_INDEX, ROTATE_CLOCKWISE_VALUE_INDEX, ROTATE_COUNTER_CLOCKWISE_VALUE_INDEX, ROTATE_DOWN_VALUE_INDEX, ROTATE_LEFT_VALUE_INDEX, ROTATE_RIGHT_VALUE_INDEX, ROTATE_UP_VALUE_INDEX, SERIAL_ENCODER_TYPE, SIM_ANALOG_DEVICE_TYPE, SIM_DIGITAL_DEVICE_TYPE, SIM_POS_DEVICE_TYPE, SIM_RELATIVE_POS_DEVICE_TYPE, SIMULATOR_PLUGIN_PROPERTY, SIMULATOR_VIEWPORT_TYPE, SIMULATOR_VIEWPORTS_PROPERTY, SIZE_PROPERTY, SLEEP_TIME_PROPERTY, START_LOCKED_PROPERTY, STATIONS_PROPERTY, STENCIL_BUFFER_SIZE_PROPERTY, STEREO_PROPERTY, STRING_DEVICE_TYPE, SURFACE_VIEWPORT_TYPE, SURFACE_VIEWPORTS_PROPERTY, TRACKD_API_CONTROLLER_TYPE, TRACKD_API_SENSOR_TYPE, TRACKD_CONTROLLER_TYPE, TRACKD_SENSOR_TYPE, TRACKED_PROPERTY, TRACKER_COUNT_PROPERTY, TRACKER_PROXY_PROPERTY, UNIT_PROPERTY, UP_VALUE_INDEX, UPPER_LEFT_CORNER_PROPERTY, UPPER_RIGHT_CORNER_PROPERTY, USE_ANALOG_PROPERTY, USE_DIGITAL_PROPERTY, USER_PROPERTY, USER_TYPE, VERTICAL_FOV_PROPERTY, VIEW_PROPERTY, VISUAL_ID_PROPERTY, VRPN_TYPE, WAND_POS_PROPERTY

Constructor Summary

EditorHelpers()

Method Summary

static int	convertJavaKeyToJuggler(int javaKey) Converts the given Java virtual key or mouse button (as defined in java.awt.event.KeyEvent and java.awt.event.MouseEvent respectively) to the corresponding VR Juggler key value.
static int	convertJavaModifiersToJuggler(int javaModifiers) Converts the given modfier set (a composition of Java modifier masks as defined in java.awt.event.InputEvent) to the equivalent VR Juggler modifier interpretation.
static int	convertJugglerKeyToJava(int jugglerKey) Converts the given VR Juggler key to the corresponding Java virtual key or mouse button (as defined in java.awt.event.KeyEvent and java.awt.event.MouseEvent respectively).
static String	getKeyPressText(ConfigElement keypressElt) Constructs a string describing the given config element of type EditorConstants.KEY_MODIFIER_PAIR_TYPE.
static String	getKeyPressText(int key, int mod) Constructs a string describing the given key+modifier combination.
static String	getModifierText(int mod) Constructs a string describing the given modifier value.
static boolean	isAllowedJavaKey(int javaKey) Determines whether the given Java virtual key or mouse button value (as defined in java.awt.event.Keyevent and java.awt.event.MouseEvent respectively) is allowed to be used with VR Juggler configurations.
static boolean	isJavaKey(int v) Determines whether the given value represents a Java virtual key.
static boolean	isJavaMouseButton(int v) Determines whether the given value represents a Java mouse button.
static boolean	isJugglerKey(int v) Determines whether the given value represents a VR Juggler key (in other words, not a VR Juggler mouse button or VR Juggler mouse motion).
static boolean	isJugglerMouseButton(int v) Determines whether the given value represents a VR Juggler mouse button.
static boolean	isJugglerMouseMotion(int v) Determines whether the given value represents a VR Juggler mouse motion.

Methods inherited from class java.lang.Object

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

Constructor Detail

EditorHelpers

public EditorHelpers()

Method Detail

convertJavaKeyToJuggler

public static int convertJavaKeyToJuggler(int javaKey)

Converts the given Java virtual key or mouse button (as defined in java.awt.event.KeyEvent and java.awt.event.MouseEvent respectively) to the corresponding VR Juggler key value.

Parameters:

javaKey - the Java vritual key or mouse button value to convert to a VR Juggler key value

Returns:

The VR Juggler version of the given Java virtual key or mouse button value or -1 if no such value is defined

See Also:

KeyEvent, MouseEvent

convertJugglerKeyToJava

public static int convertJugglerKeyToJava(int jugglerKey)

Converts the given VR Juggler key to the corresponding Java virtual key or mouse button (as defined in java.awt.event.KeyEvent and java.awt.event.MouseEvent respectively).

Parameters:

jugglerKey - the VR Juggler key value to convert to the Java virtual key or mouse button value

Returns:

The Java version of the given VR Juggler key or -1 if no such Java virtual key or mouse button value is defined

See Also:

KeyEvent, MouseEvent

convertJavaModifiersToJuggler

public static int convertJavaModifiersToJuggler(int javaModifiers)

Converts the given modfier set (a composition of Java modifier masks as defined in java.awt.event.InputEvent) to the equivalent VR Juggler modifier interpretation. If the modifier set contains multiple modifiers, the value returned will be EditorConstants.MODKEY_ANY_INT_VALUE.

Parameters:

javaModifiers - the modifier set that is a bitmask of values such as java.awt.event.InputEvent.CTRL_MASK and/or java.awt.event.InputEvent.ALT_MASK

Returns:

One of EditorConstants.MODKEY_ANY_INT_VALUE, EditorConstants.MODKEY_ALT_INT_VALUE, EditorConstants.MODKEY_CTRL_INT_VALUE, EditorConstants.MODKEY_SHIFT_INT_VALUE, or EditorConstants.MODKEY_NONE_INT_VALUE.

See Also:

InputEvent, InputEvent.getModifiers()

isAllowedJavaKey

public static boolean isAllowedJavaKey(int javaKey)

Determines whether the given Java virtual key or mouse button value (as defined in java.awt.event.Keyevent and java.awt.event.MouseEvent respectively) is allowed to be used with VR Juggler configurations.

See Also:

KeyEvent, MouseEvent, convertJavaKeyToJuggler(int), convertJavaModifiersToJuggler(int)

isJugglerMouseButton

public static boolean isJugglerMouseButton(int v)

Determines whether the given value represents a VR Juggler mouse button.

isJugglerMouseMotion

public static boolean isJugglerMouseMotion(int v)

Determines whether the given value represents a VR Juggler mouse motion.

isJugglerKey

public static boolean isJugglerKey(int v)

Determines whether the given value represents a VR Juggler key (in other words, not a VR Juggler mouse button or VR Juggler mouse motion).

isJavaMouseButton

public static boolean isJavaMouseButton(int v)

Determines whether the given value represents a Java mouse button.

See Also:

MouseEvent

isJavaKey

public static boolean isJavaKey(int v)

Determines whether the given value represents a Java virtual key.

See Also:

KeyEvent

getKeyPressText

public static String getKeyPressText(ConfigElement keypressElt)

Constructs a string describing the given config element of type EditorConstants.KEY_MODIFIER_PAIR_TYPE.

Parameters:

keypressElt - a config element of type EditorConstants.KEY_MODIFIER_PAIR_TYPE

Returns:

A string describing the key+modifier combination of the form "Ctrl+Right", "Any Modifier+5", or "K".

getKeyPressText

public static String getKeyPressText(int key,
                                     int mod)

Constructs a string describing the given key+modifier combination. The key and modifier values must be VR Juggler key values.

Parameters:

key - a VR Juggler key value (including mouse buttons and mouse motions)

mod - a VR Juggler modifier key value

Returns:

A string describing the key+modifier combination of the form "Ctrl+Right", "Any Modifier+5", or "K".

See Also:

convertJavaKeyToJuggler(int), convertJavaModifiersToJuggler(int)

getModifierText

public static String getModifierText(int mod)

Constructs a string describing the given modifier value. The modifier value must be a VR Juggler modifier key value.

Parameters:

mod - a VR Juggler modifier key value

Returns:

A string describing the key+modifier combination of the form "Ctrl+", "Any Modifier+", etc.

See Also:

convertJavaModifiersToJuggler(int)