AgateLib.ImplementationBase.JoystickImpl Class Reference

Class which implements a Joystick. More...

Inheritance diagram for AgateLib.ImplementationBase.JoystickImpl:

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 controlers 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 bool[]	Buttons [get]
	Gets a bool array indicating state of the buttons.
abstract double	Xaxis [get]
	Returns the value of the gamepad x-axis. Ranges are: -1 all the way to the left 0 centered 1 all the way to the right.
abstract double	Yaxis [get]
	Returns the value of the gamepad y-axis. Ranges are: -1 all the way to the top 0 centered 1 all the way to the bottom.
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 controlers which have this capability.

Parameters:

axisIndex

Returns:

Implemented in AgateLib.ImplementationBase.NullJoystickImpl.

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:

Implemented in AgateLib.ImplementationBase.NullJoystickImpl.

abstract void AgateLib.ImplementationBase.JoystickImpl.Poll

(

)

[pure virtual]

Polls the joystick for input.

Implemented in AgateLib.ImplementationBase.NullJoystickImpl.

abstract void AgateLib.ImplementationBase.JoystickImpl.Recalibrate

(

)

[pure virtual]

Recalibrates the joystick.

Implemented in AgateLib.ImplementationBase.NullJoystickImpl.

---

Property Documentation

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

Gets how many axes are on this joystick.

Reimplemented in AgateLib.ImplementationBase.NullJoystickImpl.

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

Need documentation.

Reimplemented in AgateLib.ImplementationBase.NullJoystickImpl.

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

Gets how many buttons are on this joystick.

Reimplemented in AgateLib.ImplementationBase.NullJoystickImpl.

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

Gets a bool array indicating state of the buttons.

Reimplemented in AgateLib.ImplementationBase.NullJoystickImpl.

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

Gets the reported name of the joystick.

Reimplemented in AgateLib.ImplementationBase.NullJoystickImpl.

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

Gets whether or not this joystick is plugged in.

Reimplemented in AgateLib.ImplementationBase.NullJoystickImpl.

abstract double AgateLib.ImplementationBase.JoystickImpl.Xaxis [get]

Returns the value of the gamepad x-axis. Ranges are: -1 all the way to the left 0 centered 1 all the way to the right.

Reimplemented in AgateLib.ImplementationBase.NullJoystickImpl.

abstract double AgateLib.ImplementationBase.JoystickImpl.Yaxis [get]

Returns the value of the gamepad y-axis. Ranges are: -1 all the way to the top 0 centered 1 all the way to the bottom.

Reimplemented in AgateLib.ImplementationBase.NullJoystickImpl.

---

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

• ImplementationBase/JoystickImpl.cs