net.java.games.input

Interface Component

All Known Implementing Classes:

AbstractComponent

public interface Component

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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Component.Identifier Identifiers for different Axes.
static class	Component.POV POV enum for different positions.

Method Summary

Modifier and Type	Method and Description
float	getDeadZone() Returns the suggested dead zone for this axis.
Component.Identifier	getIdentifier() Returns the identifier of the axis.
java.lang.String	getName() Returns a human-readable name for this axis.
float	getPollData() Returns the data from the last time the control has been polled.
boolean	isAnalog() Returns whether or not the axis is analog, or false if it is digital.
boolean	isRelative() Returns true if data returned from poll is relative to the last call, or false if data is absolute.

Method Detail

getIdentifier

Component.Identifier getIdentifier()

Returns the identifier of the axis.

isRelative

boolean isRelative()

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

isAnalog

boolean isAnalog()

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

getDeadZone

float getDeadZone()

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()

getPollData

float getPollData()

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()

getName

java.lang.String getName()

Returns a human-readable name for this axis.