JInput 2.0.10 · net.java.games.input.AbstractComponent

Modifier and Type	Field and Description
private float	event_value
private boolean	has_polled
private final Component.Identifier	id
private final String	name Human-readable name for this Axis
private float	value

Access	Constructor and Description
protected	AbstractComponent(String A name for the axis name, Component.Identifier id) Protected constructor

Method Summary

Modifier and Type	Method and Description
public float	Returns: 0.0f by default, can be overridden getDeadZone() Implements net.java.games.input.Component.getDeadZone. Returns the suggested dead zone for this axis.
pack-priv final float	getEventValue()
public Component.Identifier	getIdentifier() Implements net.java.games.input.Component.getIdentifier. Returns the type or identifier of the axis.
public String	getName() Implements net.java.games.input.Component.getName. Returns a human-readable name for this axis.
public final float	Returns: The data from the last time the control has been polled. getPollData() Implements net.java.games.input.Component.getPollData. Returns the data from the last time the control has been polled.
public boolean	Returns: false by default, can be overridden isAnalog() Implements net.java.games.input.Component.isAnalog. Returns whether or not the axis is analog, or false if it is digital.
protected abstract float	poll()
pack-priv final void	resetHasPolled()
pack-priv final void	setEventValue(float event_value)
pack-priv final void	setPollData(float value)
public String	toString() Overrides java.lang.Object.toString. Returns a non-localized string description of this axis.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

event_value	back to summary
private float event_value

has_polled	back to summary
private boolean has_polled

id	back to summary
private final Component.Identifier id

name	back to summary
private final String name Human-readable name for this Axis

value	back to summary
private float value

AbstractComponent	back to summary
protected AbstractComponent(String name, Component.Identifier id) Protected constructor Parameters name:String A name for the axis

Method Detail

getDeadZone	back to summary
public float getDeadZone() Implements net.java.games.input.Component.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. Returns:float 0.0f by default, can be overridden

getDeadZone

back to summary

public float getDeadZone()

Implements net.java.games.input.Component.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.

Returns:float: 0.0f by default, can be overridden

getEventValue	back to summary
pack-priv final float getEventValue()

getIdentifier	back to summary
public Component.Identifier getIdentifier() Implements net.java.games.input.Component.getIdentifier. Returns the type or identifier of the axis.

getIdentifier

back to summary

public Component.Identifier getIdentifier()

Implements net.java.games.input.Component.getIdentifier.

Returns the type or identifier of the axis.

getName	back to summary
public String getName() Implements net.java.games.input.Component.getName. Returns a human-readable name for this axis.

getName

back to summary

public String getName()

Implements net.java.games.input.Component.getName.

Returns a human-readable name for this axis.

getPollData	back to summary
public final float getPollData() Implements net.java.games.input.Component.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 normalised, the value returned will be between -1.0f and 1.0f. Returns:float The data from the last time the control has been polled.

getPollData

back to summary

public final float getPollData()

Implements net.java.games.input.Component.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 normalised, the value returned will be between -1.0f and 1.0f.

Returns:float: The data from the last time the control has been polled.

isAnalog	back to summary
public boolean isAnalog() Implements net.java.games.input.Component.isAnalog. Returns whether or not the axis is analog, or false if it is digital. Returns:boolean false by default, can be overridden

isAnalog

back to summary

public boolean isAnalog()

Implements net.java.games.input.Component.isAnalog.

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

Returns:boolean: false by default, can be overridden

poll	back to summary
protected abstract float poll() throws IOException

resetHasPolled	back to summary
pack-priv final void resetHasPolled()

setEventValue	back to summary
pack-priv final void setEventValue(float event_value)

setPollData	back to summary
pack-priv final void setPollData(float value)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a non-localized string description of this axis. Returns:String Doc from java.lang.Object.toString. a string representation of the object

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a non-localized string description of this axis.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

public abstract Class AbstractComponent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail