AgateLib.ImplementationBase.JoystickImpl Class Reference

Class which implements a Joystick. More...

List of all members.

Public Member Functions
abstract bool	GetButtonState (int buttonIndex)
	Gets the state of the specified button.
abstract double	GetAxisValue (int axisIndex)
	Gets the currentFrame value for the given axis. Axis 0 is always the x-axis, axis 1 is always the y-axis on controllers which have this capability.
abstract void	Recalibrate ()
	Recalibrates the joystick.
abstract void	Poll ()
	Polls the joystick for input.
Properties
abstract int	AxisCount [get]
	Gets how many axes are on this joystick.
abstract int	ButtonCount [get]
	Gets how many buttons are on this joystick.
abstract string	Name [get]
	Gets the reported name of the joystick.
abstract double	AxisThreshold [get, set]
	Need documentation.
abstract bool	PluggedIn [get]
	Gets whether or not this joystick is plugged in.

---

Detailed Description

Class which implements a Joystick.

---

Member Function Documentation

abstract double AgateLib.ImplementationBase.JoystickImpl.GetAxisValue

(

int

axisIndex

)

[pure virtual]

Gets the currentFrame value for the given axis. Axis 0 is always the x-axis, axis 1 is always the y-axis on controllers which have this capability.

Parameters:

axisIndex

Returns:

abstract bool AgateLib.ImplementationBase.JoystickImpl.GetButtonState

(

int

buttonIndex

)

[pure virtual]

Gets the state of the specified button.

Parameters:

buttonIndex

Index of the button to check. Valid values are from 0 to ButtonCount - 1.

Returns:

abstract void AgateLib.ImplementationBase.JoystickImpl.Poll

(

)

[pure virtual]

Polls the joystick for input.

abstract void AgateLib.ImplementationBase.JoystickImpl.Recalibrate

(

)

[pure virtual]

Recalibrates the joystick.

---

Property Documentation

abstract int AgateLib.ImplementationBase.JoystickImpl.AxisCount [get]

Gets how many axes are on this joystick.

abstract double AgateLib.ImplementationBase.JoystickImpl.AxisThreshold [get, set]

Need documentation.

abstract int AgateLib.ImplementationBase.JoystickImpl.ButtonCount [get]

Gets how many buttons are on this joystick.

abstract string AgateLib.ImplementationBase.JoystickImpl.Name [get]

Gets the reported name of the joystick.

abstract bool AgateLib.ImplementationBase.JoystickImpl.PluggedIn [get]

Gets whether or not this joystick is plugged in.

---

The documentation for this class was generated from the following file:

• ImplementationBase/JoystickImpl.cs