org.vrjuggler.vrjconfig.commoneditors
Class DeviceConfig

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

All Implemented Interfaces:

EditorConstants

public class DeviceConfig
extends Object
implements EditorConstants

This is a helper class designed to collect together all the config elements associated with a given config element for a Juggler device type. It finds all the proxies pointing at the given config element and all the aliases that refer to those proxies.

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

DeviceConfig(ConfigContext ctx, ConfigElement deviceElt)
Simple constructor for a device type's config element.

DeviceConfig(ConfigContext ctx, ConfigElement deviceElt, ConfigDefinition proxyType)
Simple constructor for a device type's config element.

DeviceConfig(ConfigContext ctx, ConfigElement deviceElt, ConfigElement[] proxyElts)
Device + proxy list constructor.

DeviceConfig(ConfigContext ctx, ConfigElement deviceElt, ConfigElement[] proxyElts, ConfigElement[] aliasElts)
Device + proxy list + alias list constructor.

DeviceConfig(ConfigContext ctx, ConfigElement deviceElt, List proxyElts)
Device + proxy list constructor.

DeviceConfig(ConfigContext ctx, ConfigElement deviceElt, List proxyElts, List aliasElts)
Device + proxy list + alias list constructor.

DeviceConfig(ConfigContext ctx, ConfigElement deviceElt, String proxyTypeName)
Simple constructor for a device type's config element.

Method Summary

List	getAliases() Returns the list of aliases referring to this device's proxy config elements.
List	getAliases(ConfigElement proxyElt) Returns the list of aliases referring to the given proxy config element.
ConfigElement	getDevice() Returns the config element for this device's configuration.
List	getProxies() Returns the list of proxies referring to this device's config element.
String	toString() Presents a string representation of this device's configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceConfig

public DeviceConfig(ConfigContext ctx,
                    ConfigElement deviceElt)

Simple constructor for a device type's config element. This looks in the context for all proxies pointing at the given device's config element and all aliases referring to those discovered proxies.

Parameters:

ctx - the context where the config element is used

deviceElt - the config element for a Juggler device type

DeviceConfig

public DeviceConfig(ConfigContext ctx,
                    ConfigElement deviceElt,
                    String proxyTypeName)

Simple constructor for a device type's config element. This looks in the context for all proxies of then given type pointing at the given device's config element and all aliases referring to those discovered proxies. For device types that allow multiple proxy types to be used, use the constructor overload that performs an untyped proxy search.

Parameters:

ctx - the context where the config element is used

deviceElt - the config element for a Juggler device type

proxyTypeName - the name of the proxy type that can point at deviceElt

See Also:

DeviceConfig(ConfigContext,ConfigElement)

DeviceConfig

public DeviceConfig(ConfigContext ctx,
                    ConfigElement deviceElt,
                    ConfigDefinition proxyType)

Simple constructor for a device type's config element. This looks in the context for all proxies of then given type pointing at the given device's config element and all aliases referring to those discovered proxies. For device types that allow multiple proxy types to be used, use the constructor overload that performs an untyped proxy search.

Parameters:

ctx - the context where the config element is used

deviceElt - the config element for a Juggler device type

proxyType - the config definition for the proxy type that can point at deviceElt

See Also:

DeviceConfig(ConfigContext,ConfigElement)

DeviceConfig

public DeviceConfig(ConfigContext ctx,
                    ConfigElement deviceElt,
                    List proxyElts)

Device + proxy list constructor. This constructor assumes that the given list of proxy config elements is both correct (the proxies refer to the given input device config element) and complete (the proxies in the list are all those proxies in the context that refer to the given input device config element). This looks in the context for all aliases referring to the given list of proxies.

Parameters:

ctx - the context where the config element is used

deviceElt - the config element for a Juggler device type

proxyElts - the complete list of proxy config elements in ctx that point to deviceElt

DeviceConfig

public DeviceConfig(ConfigContext ctx,
                    ConfigElement deviceElt,
                    ConfigElement[] proxyElts)

Device + proxy list constructor. This constructor assumes that the given list of proxy config elements is both correct (the proxies refer to the given input device config element) and complete (the proxies in the list are all those proxies in the context that refer to the given input device config element). This looks in the context for all aliases referring to the given list of proxies.

Parameters:

ctx - the context where the config element is used

deviceElt - the config element for a Juggler device type

proxyElts - the complete array of proxy config elements in ctx that point to deviceElt

DeviceConfig

public DeviceConfig(ConfigContext ctx,
                    ConfigElement deviceElt,
                    List proxyElts,
                    List aliasElts)

Device + proxy list + alias list constructor. This constructor assumes that the given lists of proxy and alias config elements are correct (the proxies refer to the given input device config element and the aliases refer to the given list of proxies) and complete (the proxies in the list are all those proxies in the context that refer to the given input device config element and the aliases are all those in the context that refer to those proxies).

Parameters:

ctx - the context where the config element is used

deviceElt - the config element for a Juggler device type

proxyElts - the complete list of proxy config elements in ctx that point to deviceElt

aliasElts - the complete list of alias config elements in ctx that refer to the proxies in proxyElts

DeviceConfig

public DeviceConfig(ConfigContext ctx,
                    ConfigElement deviceElt,
                    ConfigElement[] proxyElts,
                    ConfigElement[] aliasElts)

Device + proxy list + alias list constructor. This constructor assumes that the given lists of proxy and alias config elements are correct (the proxies refer to the given input device config element and the aliases refer to the given list of proxies) and complete (the proxies in the list are all those proxies in the context that refer to the given input device config element and the aliases are all those in the context that refer to those proxies).

Parameters:

ctx - the context where the config element is used

deviceElt - the config element for a Juggler device type

proxyElts - the complete array of proxy config elements in ctx that point to simDeviceElt

aliasElts - the complete array of alias config elements in ctx that refer to the proxies in proxyElts

Method Detail

getAliases

public List getAliases()

Returns the list of aliases referring to this device's proxy config elements.

getAliases

public List getAliases(ConfigElement proxyElt)

Returns the list of aliases referring to the given proxy config element. The proxy config element should be in the List returned by getProxies(). If it is not, then null is guaranteed to be returned.

getProxies

public List getProxies()

Returns the list of proxies referring to this device's config element.

getDevice

public ConfigElement getDevice()

Returns the config element for this device's configuration.

toString

public String toString()

Presents a string representation of this device's configuration.

Overrides:

toString in class Object