org.gamecontrolplus.ControlSlider Class Reference

Inheritance diagram for org.gamecontrolplus.ControlSlider:

Public Member Functions
float	getTotalValue ()
void	reset ()
boolean	isRelative ()
String	toText (String tab)
Public Member Functions inherited from org.gamecontrolplus.ControlInput
String	getName ()
float	getValue ()
float	getTolerance ()
void	setTolerance (final float i_tolerance)
float	getMultiplier ()
void	setMultiplier (final float i_multiplier)

Protected Attributes
float	totalValue = 0f
Protected Attributes inherited from org.gamecontrolplus.ControlInput
float	actualValue = 0f
float	tolerance = 0f
float	multiplier = 1f
final String	actualName
int	inputType

Package Functions
	ControlSlider (final Component i_component)
void	update ()
void	updateRelative ()
Package Functions inherited from org.gamecontrolplus.ControlInput
	ControlInput (final Component i_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"
Package Attributes inherited from org.gamecontrolplus.ControlInput
final Component	component

Detailed Description

The slider class is for analog input elements having a value range. Normally this range goes from -1 to 1. You can set a multiplier to increase this range, this is usefull so that you do not have to change the values in your application. You can get the actual value and the total value of a slider. The actual value gives you the current state of the controller. For the total value the actual values for each frame are add. If you not want a slider to react upto a certain value you can set a tolerance value.

Author

Christian Riekoff minor mods by Peter Lager

Constructor & Destructor Documentation

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

package

Initializes a new Slider.

Parameters

i_component

Member Function Documentation

float org.gamecontrolplus.ControlSlider.getTotalValue

(

)

For the total value the values for each frame are add. Use this method to get the total value of a slider.

Returns

float, the total value of a slider

boolean org.gamecontrolplus.ControlSlider.isRelative

(

)

Use this method to see if a slider is relative. A relative sliders value represents always the change between the current state and the last state.

Returns

boolean, true if the slider is relative

void org.gamecontrolplus.ControlSlider.reset

(

)

For the total value the actual values for each frame are add. Use this method to set the totalvalue to 0.

String org.gamecontrolplus.ControlSlider.toText

(

String

tab

)

Get a text description of this slider

Parameters

tab

Returns

void org.gamecontrolplus.ControlSlider.update ( )

packagevirtual

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

Implements org.gamecontrolplus.ControlInput.

Member Data Documentation

float org.gamecontrolplus.ControlSlider.totalValue = 0f

protected

The total Value of the slider