Dragengine.Commands.Binding Class Reference

Binding of command to input event on device. More...

Inheritance diagram for Dragengine.Commands.Binding:

Public Member Functions
bool	equals (Object other)
	Bindings are equal. More...
Command	getCommand ()
	Bound command. More...
String	getDeviceID ()
	Input device identifier. More...
int	getDeviceIndex ()
	Device index or -1 if not set. More...
InputDevice	getInputDevice ()
	Device or null if not set. More...
InputDeviceAxis	getInputDeviceAxis ()
	Device axis or null if not set. More...
InputDeviceButton	getInputDeviceButton ()
	Device button or null if not set. More...
InputDeviceFeedback	getInputDeviceFeedback ()
	Device feedback or null if not set. More...
bool	getInverseAxis ()
	Inverse axis. More...
bool	getSimulateAxisPressed ()
	Axis pressed simulation state. More...
String	getSourceID ()
	Axis or button identifier. More...
int	getSourceIndex ()
	Source index or -1 if not set. More...
InputEventSource	getSystem ()
	System or null if not set. More...
Binding	new (Binding binding)
	Create copy of binding. More...
Binding	new (Binding binding, Command command)
	Create copy of binding with different command. More...
Binding	new (String deviceID, String sourceID, Command command, bool inverseAxis)
	Create binding. More...
void	setDeviceIndex (int index)
	Set device index or -1 if not set. More...
void	setSimulateAxisPressed (bool pressed)
	Set axis pressed simulation state. More...
void	setSourceIndex (int index)
	Set source index or -1 if not set. More...
void	setSystem (InputEventSource system)
	Set system or null if not set. More...

Public Attributes
Command	pCommand
String	pDeviceID
int	pDeviceIndex
bool	pInverseAxis
bool	pSimulateAxisPressed
String	pSourceID
int	pSourceIndex
InputEventSource	pSystem

Detailed Description

Binding of command to input event on device.

Bindings are identified by device and either axis or button identifier. For quicker access the device and button index are used.

Member Function Documentation

equals()

bool Dragengine.Commands.Binding.equals

(

Object

other

)

Bindings are equal.

getCommand()

Command Dragengine.Commands.Binding.getCommand

(

)

Bound command.

getDeviceID()

String Dragengine.Commands.Binding.getDeviceID

(

)

Input device identifier.

getDeviceIndex()

int Dragengine.Commands.Binding.getDeviceIndex

(

)

Device index or -1 if not set.

getInputDevice()

InputDevice Dragengine.Commands.Binding.getInputDevice

(

)

Device or null if not set.

Version

1.6

getInputDeviceAxis()

InputDeviceAxis Dragengine.Commands.Binding.getInputDeviceAxis

(

)

Device axis or null if not set.

Version

1.6

getInputDeviceButton()

InputDeviceButton Dragengine.Commands.Binding.getInputDeviceButton

(

)

Device button or null if not set.

Version

1.6

getInputDeviceFeedback()

InputDeviceFeedback Dragengine.Commands.Binding.getInputDeviceFeedback

(

)

Device feedback or null if not set.

Version

1.6

getInverseAxis()

bool Dragengine.Commands.Binding.getInverseAxis

(

)

Inverse axis.

getSimulateAxisPressed()

bool Dragengine.Commands.Binding.getSimulateAxisPressed

(

)

Axis pressed simulation state.

getSourceID()

String Dragengine.Commands.Binding.getSourceID

(

)

Axis or button identifier.

getSourceIndex()

int Dragengine.Commands.Binding.getSourceIndex

(

)

Source index or -1 if not set.

getSystem()

InputEventSource Dragengine.Commands.Binding.getSystem

(

)

System or null if not set.

Version

1.6

new() [1/3]

Binding Dragengine.Commands.Binding.new

(

Binding

binding

)

Create copy of binding.

new() [2/3]

Binding Dragengine.Commands.Binding.new	(	Binding	binding,
		Command	command
	)

Create copy of binding with different command.

new() [3/3]

Binding Dragengine.Commands.Binding.new	(	String	deviceID,
		String	sourceID,
		Command	command,
		bool	inverseAxis
	)

Create binding.

setDeviceIndex()

void Dragengine.Commands.Binding.setDeviceIndex

(

int

index

)

Set device index or -1 if not set.

setSimulateAxisPressed()

void Dragengine.Commands.Binding.setSimulateAxisPressed

(

bool

pressed

)

Set axis pressed simulation state.

setSourceIndex()

void Dragengine.Commands.Binding.setSourceIndex

(

int

index

)

Set source index or -1 if not set.

setSystem()

void Dragengine.Commands.Binding.setSystem

(

InputEventSource

system

)

Set system or null if not set.

Version

1.6

Member Data Documentation

pCommand

Command Dragengine.Commands.Binding.pCommand

pDeviceID

String Dragengine.Commands.Binding.pDeviceID

pDeviceIndex

int Dragengine.Commands.Binding.pDeviceIndex

pInverseAxis

bool Dragengine.Commands.Binding.pInverseAxis

pSimulateAxisPressed

bool Dragengine.Commands.Binding.pSimulateAxisPressed

pSourceID

String Dragengine.Commands.Binding.pSourceID

pSourceIndex

int Dragengine.Commands.Binding.pSourceIndex

pSystem

InputEventSource Dragengine.Commands.Binding.pSystem

---

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

• Binding.ds