org.gamecontrolplus.ControlInput Class Reference

Inheritance diagram for org.gamecontrolplus.ControlInput:

Public Member Functions
String	getName ()
float	getValue ()
float	getTolerance ()
void	setTolerance (final float i_tolerance)
float	getMultiplier ()
void	setMultiplier (final float i_multiplier)

Protected Attributes
float	actualValue = 0f
float	tolerance = 0f
float	multiplier = 1f
final String	actualName
int	inputType

Package Functions
	ControlInput (final Component i_component)
abstract void	update ()

Package Attributes
final Component	component

Additional Inherited Members
Public Attributes inherited from org.gamecontrolplus.gui.KConstants
final float	INPUT_UI_HEIGHT = 24
final float	DESC_UI_HEIGHT = 30
final float	ELEMENT_UI_GAP = 4
final float	INPUT_UI_LENGTH = 220
final float	DESC_UI_LENGTH = 300
final float	TEXTFIELD_GAP = 4
final float	INICATOR_D = 12
final float	CONNECTOR_SIZE_R = 10
final float	CONNECTOR_SIZE_R2 = CONNECTOR_SIZE_R * CONNECTOR_SIZE_R
final float	CONNECTOR_SIZE_D = 2 * CONNECTOR_SIZE_R
final int	INPUT = 0x01
final int	DESC = 0x02
final float	FONT_SIZE = 12
final int	PANEL_WIDTH = 320
final int	PANEL_HEIGHT = 280
final int	UI_BUTTON = 0x01
final int	UI_COOLIEHAT = 0x02
final int	UI_SLIDER = 0x03
final int	UI_DESCRIPTOR = 0x04
final int[]	UI_E_BACK = new int[] { 0, 0xFFFFD0D0, 0xFFD0FFD0, 0xFFD0D0FF, 0xFFFFD0D0 }
final int	BACKGROUND = 0xFFF0FFF0
final int	PANEL = 0xFF208020
final int	BORDER = 0xFF4040A0
final int	CONNECTION = 0xFF8080A0
final int	HIGHLIGHT = 0xFFFF40FF
final int	NAME_AREA = 0xFFC8C8FF
final int	CONNECTOR = 0xFFFFC0FF
final int	TEXTFILL = 0xFF000080
final int	PRESSED = 0xFFFF3030
final int	RELEASED = 0xFF802020
final int	SLIDER_CURSOR = 0xFFFF4040
int	WORKING = 0
int	CANCELLED = 1
int	FINISHED = 2
int	NOT_OVER = 0x0000
int	OVER_CONNECTOR = 0x0100
int	ON_PRESS = 0
int	ON_RELEASE = 1
int	WHILE_PRESS = 2
int	BUTTON_TYPE = 1
int	HAT_TYPE = 2
int	SLIDER_TYPE = 3
String	SEPARATOR = "\t"

Detailed Description

Base class for input elements of a controller.

Constructor & Destructor Documentation

org.gamecontrolplus.ControlInput.ControlInput ( final Component  i_component )

package

Initializes a new Slider.

Parameters

i_component

Member Function Documentation

float org.gamecontrolplus.ControlInput.getMultiplier

(

)

This value has no significance except for the ControlSlider and ControlHat classes.

String org.gamecontrolplus.ControlInput.getName

(

)

Returns the name of the input.

Returns

String, the name of the input element application

float org.gamecontrolplus.ControlInput.getTolerance

(

)

This value has no significance except for the ControlSlider class.

float org.gamecontrolplus.ControlInput.getValue

(

)

Gives you the current value of an input.

Returns

float, the actual value of the slider

void org.gamecontrolplus.ControlInput.setMultiplier

(

final float

i_multiplier

)

Multiplier is only used by the ControlSlider and ControlHat classes but is placed here for convenience of use.
The value of a slider, and the X and Y values of a hat normally have a value in the range -1.0f and 1.0f.
You can change this range by setting a multiplier with a value not equal to 1.

By default the multiplier is 1.0.

Parameters

i_multiplier

float, the new multiplier for a Slider or Hat

void org.gamecontrolplus.ControlInput.setTolerance

(

final float

i_tolerance

)

Tolerance is only used by the ControlSlider class but is placed here for convenience of use.
If you not want a slider to react up to a certain value you can set a tolerance value. Use this method to set the tolerance. By default this value is set to 0.

Parameters

i_tolerance

float, the new tolerance for the slider

abstract void org.gamecontrolplus.ControlInput.update ( )

packagepure virtual

This method is called before each frame to update the slider values.

Implemented in org.gamecontrolplus.ControlHat, org.gamecontrolplus.ControlSlider, org.gamecontrolplus.ControlButton, and org.gamecontrolplus.ControlRelativeSlider.

Member Data Documentation

final String org.gamecontrolplus.ControlInput.actualName

protected

The name of the Input component provided by JInput. This maybe different for different OS.

float org.gamecontrolplus.ControlInput.actualValue = 0f

protected

The current state of the input

final Component org.gamecontrolplus.ControlInput.component

package

JInput Component representing this Slider

int org.gamecontrolplus.ControlInput.inputType

protected

One of BUTTON_TYPE, HAT_TYPE or SLIDER_TYPE

float org.gamecontrolplus.ControlInput.multiplier = 1f

protected

Included for all inputs for convenience but only used by the ControlSlider and ControlHat classes.
The value of a slider is a relative value between -1.0f and 1.0f with the multiplier you can increase and decrease this range.

float org.gamecontrolplus.ControlInput.tolerance = 0f

protected

Included for all inputs for convenience but only used by the ControlSlider.
Tolerance is minimum under which the input is set to zero.