DigitalSpaces::DIUserInput1 Struct Reference
[User Input Interfaces]

#include <Interfaces.h>

Inherits DigitalSpaces::DIObjectBase.

---

Detailed Description

DInterface for polling input based events by name.

Event names are created by mapping within the .space file.

Todo:

This system needs revision.

Example configuration in the .space format (not complete):

		<configuration id="{B11EFB3C-E3C6-4df8-9BBD-61F56B82F70B}" >
			<map signal="FORWARD" >
				<event code="KC_E" type="switch" multiplier="100.0" />
				<event code="KC_UP" type="switch" multiplier="10" />
			</map>
			<map signal="TURN_LEFT" >
				<event code="MA_X_NEG" type="switch" multiplier="0.1" />
			</map>
			<map signal="MOUSE_X_ABS">
				<event code="MA_X" type="switch" multiplier="1.0" />
			</map>
			<map signal="MOUSE_Y_ABS">
				<event code="MA_Y" type="switch" multiplier="1.0" />
			</map>
			<map signal="MOUSE_CLICK">
				<event code="MB_1" type="switch" multiplier="1.0" />
			</map>
		</configuration>
		

MOUSE_X_ABS, MOUSE_Y_ABS and MOUSE_CLICK should always be defined, as these signals are used by the GUI.

<event code=""> values supported by the current implementation (UserInput_DirectInput) are:

• KC_ESCAPE
• KC_1
• KC_2
• KC_3
• KC_4
• KC_5
• KC_6
• KC_7
• KC_8
• KC_9
• KC_0
• KC_MINUS
• KC_EQUALS
• KC_BACK
• KC_TAB
• KC_Q
• KC_W
• KC_E
• KC_R
• KC_T
• KC_Y
• KC_U
• KC_I
• KC_O
• KC_P
• KC_LBRACKET
• KC_RBRACKET
• KC_RETURN
• KC_LCONTROL
• KC_A
• KC_S
• KC_D
• KC_F
• KC_G
• KC_H
• KC_J
• KC_K
• KC_L
• KC_SEMICOLON
• KC_APOSTROPHE
• KC_GRAVE
• KC_LSHIFT
• KC_BACKSLASH
• KC_Z
• KC_X
• KC_C
• KC_V
• KC_B
• KC_N
• KC_M
• KC_COMMA
• KC_PERIOD
• KC_SLASH
• KC_RSHIFT
• KC_MULTIPLY
• KC_LMENU
• KC_SPACE
• KC_CAPITAL
• KC_F1
• KC_F2
• KC_F3
• KC_F4
• KC_F5
• KC_F6
• KC_F7
• KC_F8
• KC_F9
• KC_F10
• KC_NUMLOCK
• KC_SCROLL
• KC_NUMPAD7
• KC_NUMPAD8
• KC_NUMPAD9
• KC_SUBTRACT
• KC_NUMPAD4
• KC_NUMPAD5
• KC_NUMPAD6
• KC_ADD
• KC_NUMPAD1
• KC_NUMPAD2
• KC_NUMPAD3
• KC_NUMPAD0
• KC_DECIMAL
• KC_OEM_102
• KC_F11
• KC_F12
• KC_F13
• KC_F14
• KC_F15
• KC_KANA
• KC_ABNT_C1
• KC_CONVERT
• KC_NOCONVERT
• KC_YEN
• KC_ABNT_C2
• KC_NUMPADEQUALS
• KC_PREVTRACK
• KC_AT
• KC_COLON
• KC_UNDERLINE
• KC_KANJI
• KC_STOP
• KC_AX
• KC_UNLABELED
• KC_NEXTTRACK
• KC_NUMPADENTER
• KC_RCONTROL
• KC_MUTE
• KC_CALCULATOR
• KC_PLAYPAUSE
• KC_MEDIASTOP
• KC_VOLUMEDOWN
• KC_VOLUMEUP
• KC_WEBHOME
• KC_NUMPADCOMMA
• KC_DIVIDE
• KC_SYSRQ
• KC_RMENU
• KC_PAUSE
• KC_HOME
• KC_UP
• KC_PGUP
• KC_LEFT
• KC_RIGHT
• KC_END
• KC_DOWN
• KC_PGDOWN
• KC_INSERT
• KC_DELETE
• KC_LWIN
• KC_RWIN
• KC_APPS
• KC_POWER
• KC_SLEEP
• KC_WAKE
• KC_WEBSEARCH
• KC_WEBFAVORITES
• KC_WEBREFRESH
• KC_WEBSTOP
• KC_WEBFORWARD
• KC_WEBBACK
• KC_MYCOMPUTER
• KC_MAIL
• KC_MEDIASELECT
• MA_X (Mouse X Axis motion)
• MA_X_POS (Mouse X Axis Positive motion)
• MA_X_NEG (Mouse X Axis Negative motion)
• MA_Y (MOuse Y Axis motion)
• MA_Y_POS (Mouse Y Axis Positive motion)
• MA_Y_NEG (Mouse Y Axis Negative motion)
• MB_1 (Mouse Button 1)
• MB_2 (Mouse Button 2)
• MB_3 (Mouse Button 3)

The existing implementation (UserInput_DirectInput) also always supports reading a joystick using:

• HAPTIC_XAXIS (return values range from -32768 to 32768)
• HAPTIC_YAXIS (return values range from -32768 to 32768)
• HAPTIC_ZAXIS (return values range from -32768 to 32768)
• HAPTIC_XTWIST (return values range from -32768 to 32768)
• HAPTIC_YTWIST (return values range from -32768 to 32768)
• HAPTIC_ZTWIST (return values range from -32768 to 32768)
• HAPTIC_THROTTLE (return values range from -32768 to 32768)
• HAPTIC_BUTTON# (with # ranging from 0 to 127)
• HAPTIC_POV# (with # ranging from 0 to 3)

There is also a hardcoded map from the Print Screen keyboard button to PRINT_SCREEN.

Each of these hard coded signal names can also be supplimented by using a <map signal="HAPTIC_XAXIS"> configuration. This can be used to provide keyboard keys that are detected as joystick motions. Note that you will need to use a large multiplier, such as 30000. Also note that the system will interpret a keypress as going from zero to this multiplier value immediately, not as a ramped increase. Also, if the keyboard and joystick are used at the same time, the values are added. Not only will pushing Backward on the joystick and Forward on the keyboard cause an approximately 0 value for the HAPTIC_YAXIS, pressing Forward on both will actually produce values in excess of the 32767 limit.

Public Member Functions
float	QuerySignal (const char *sSignal)
	Returns a floating point value indicating the value of the specified signal.

---

Member Function Documentation

float DigitalSpaces::DIUserInput1::QuerySignal

(

const char *

sSignal

)

Returns a floating point value indicating the value of the specified signal.

If the specified signal is not recognised, a value of 0.0 should be returned.

---

The documentation for this struct was generated from the following file:

• CoreInterfaces/Interfaces.h