ERY.AgateLib.ImplBase.JoystickImpl Class Reference

Class which implements a Joystick. More...

Inherited by ERY.AgateLib.ImplBase.NullJoystickImpl.

List of all members.

Public Member Functions

abstract void Recalibrate ()
 Recalibrates the joystick.
abstract void Poll ()
 Polls the joystick for input.
abstract double GetAxisValue (int axisIndex)
 Gets the current 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.

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 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 void ERY.AgateLib.ImplBase.JoystickImpl.Recalibrate (  )  [pure virtual]

Recalibrates the joystick.

Implemented in ERY.AgateLib.ImplBase.NullJoystickImpl.

abstract void ERY.AgateLib.ImplBase.JoystickImpl.Poll (  )  [pure virtual]

Polls the joystick for input.

Implemented in ERY.AgateLib.ImplBase.NullJoystickImpl.

abstract double ERY.AgateLib.ImplBase.JoystickImpl.GetAxisValue ( int  axisIndex  )  [pure virtual]

Gets the current 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 ERY.AgateLib.ImplBase.NullJoystickImpl.


Property Documentation

abstract int ERY.AgateLib.ImplBase.JoystickImpl.AxisCount [get]

Gets how many axes are on this joystick.

Reimplemented in ERY.AgateLib.ImplBase.NullJoystickImpl.

abstract int ERY.AgateLib.ImplBase.JoystickImpl.ButtonCount [get]

Gets how many buttons are on this joystick.

Reimplemented in ERY.AgateLib.ImplBase.NullJoystickImpl.

abstract bool [] ERY.AgateLib.ImplBase.JoystickImpl.Buttons [get]

Gets a bool array indicating state of the buttons.

Reimplemented in ERY.AgateLib.ImplBase.NullJoystickImpl.

abstract double ERY.AgateLib.ImplBase.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 ERY.AgateLib.ImplBase.NullJoystickImpl.

abstract double ERY.AgateLib.ImplBase.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 ERY.AgateLib.ImplBase.NullJoystickImpl.

abstract double ERY.AgateLib.ImplBase.JoystickImpl.AxisThreshold [get, set]

Need documentation.

Reimplemented in ERY.AgateLib.ImplBase.NullJoystickImpl.

abstract bool ERY.AgateLib.ImplBase.JoystickImpl.PluggedIn [get]

Gets whether or not this joystick is plugged in.

Reimplemented in ERY.AgateLib.ImplBase.NullJoystickImpl.


The documentation for this class was generated from the following file:
AgateLib
Awesome Game and Tool Engine Library
SourceForge.net Logo