net.java.games.input.Component Interface Reference

Inheritance diagram for net.java.games.input.Component:

Classes
class	Identifier
class	POV

Public Member Functions
abstract Identifier	getIdentifier ()
abstract boolean	isRelative ()
abstract boolean	isAnalog ()
abstract float	getDeadZone ()
abstract float	getPollData ()
abstract String	getName ()

Detailed Description

An axis is a single button, slider, or dial, which has a single range. An axis can hold information for motion (linear or rotational), velocity, force, or acceleration.

Member Function Documentation

abstract float net.java.games.input.Component.getDeadZone ( )

pure virtual

Returns the suggested dead zone for this axis. Dead zone is the amount polled data can vary before considered a significant change in value. An application can safely ignore changes less than this value in the positive or negative direction.

See Also

getPollData

Implemented in net.java.games.input.AbstractComponent, net.java.games.input.LinuxComponent, and net.java.games.input.DIComponent.

abstract Identifier net.java.games.input.Component.getIdentifier ( )

pure virtual

Returns the identifier of the axis.

Implemented in net.java.games.input.AbstractComponent.

abstract String net.java.games.input.Component.getName ( )

pure virtual

Returns a human-readable name for this axis.

Implemented in net.java.games.input.AbstractComponent.

abstract float net.java.games.input.Component.getPollData ( )

pure virtual

Returns the data from the last time the control has been polled. If this axis is a button, the value returned will be either 0.0f or 1.0f. If this axis is normalized, the value returned will be between -1.0f and 1.0f.

See Also

Controller::poll

Implemented in net.java.games.input.AbstractComponent.

abstract boolean net.java.games.input.Component.isAnalog ( )

pure virtual

Returns whether or not the axis is analog, or false if it is digital.

Implemented in net.java.games.input.RawMouse.Button, net.java.games.input.RawMouse.Axis, net.java.games.input.RawKeyboard.Key, net.java.games.input.AbstractComponent, net.java.games.input.DIComponent, net.java.games.input.LinuxComponent, net.java.games.input.OSXComponent, and net.java.games.input.LinuxJoystickAxis.

abstract boolean net.java.games.input.Component.isRelative ( )

pure virtual

Returns true if data returned from poll is relative to the last call, or false if data is absolute.

Implemented in net.java.games.input.RawMouse.Button, net.java.games.input.RawMouse.Axis, net.java.games.input.RawKeyboard.Key, net.java.games.input.DIComponent, net.java.games.input.LinuxComponent, net.java.games.input.OSXComponent, net.java.games.input.LinuxJoystickAxis, and net.java.games.input.LinuxJoystickButton.