AgateLib.InputLib.Old.Input Class Reference

Static class which contains basic functions for handling non-keyboard and mouse input. More...

List of all members.

Public Member Functions
delegate void	InputSystemDelegate ()
	Delegate for DisposeInput event.
Static Public Member Functions
static void	Initialize (InputTypeID inputType)
	Initializes the input system by instantiating the driver with the given InputTypeID. The input driver must be registered with the Registrar class.
static void	Dispose ()
	Disposes of the input driver.
static void	InitializeJoysticks ()
	Initializes all joysticks.
static void	PollJoysticks ()
	Polls all joysticks for input now.
Properties
static InputImpl	Impl [get]
	Gets the object which handles all of the actual calls to Input functions.
static int	JoystickCount [get]
	Counts the number of joysticks attached to the system.
static IList< Joystick >	Joysticks [get]
	Returns a list of joysticks which can be iterated through, or accessed like an array.
static int	MinJoysticks [get, set]
	Minimum number of joysticks for the system to have. If there aren't enough physical joysticks attached to the system, NullJoysticks will be created to emulate a joystick which does nothing. (this is to avoid NullReferenceExceptions).
static double	PollInterval [get, set]
	Gets or sets the interval in milliseconds for the time between automatic joystick polls.
static double	PollFrequency [get, set]
	Gets or sets the number of times per second that joysticks should be polled.
Events
static InputSystemDelegate	DisposeInput
	Event raised when Input.Dispose() is called.

---

Detailed Description

Static class which contains basic functions for handling non-keyboard and mouse input.

---

Member Function Documentation

static void AgateLib.InputLib.Old.Input.Dispose

(

)

[static]

Disposes of the input driver.

static void AgateLib.InputLib.Old.Input.Initialize

(

InputTypeID

inputType

)

[static]

Initializes the input system by instantiating the driver with the given InputTypeID. The input driver must be registered with the Registrar class.

Parameters:

inputType

static void AgateLib.InputLib.Old.Input.InitializeJoysticks

(

)

[static]

Initializes all joysticks.

delegate void AgateLib.InputLib.Old.Input.InputSystemDelegate

(

)

Delegate for DisposeInput event.

static void AgateLib.InputLib.Old.Input.PollJoysticks

(

)

[static]

Polls all joysticks for input now.

---

Property Documentation

InputImpl AgateLib.InputLib.Old.Input.Impl [static, get]

Gets the object which handles all of the actual calls to Input functions.

int AgateLib.InputLib.Old.Input.JoystickCount [static, get]

Counts the number of joysticks attached to the system.

IList<Joystick> AgateLib.InputLib.Old.Input.Joysticks [static, get]

Returns a list of joysticks which can be iterated through, or accessed like an array.

int AgateLib.InputLib.Old.Input.MinJoysticks [static, get, set]

Minimum number of joysticks for the system to have. If there aren't enough physical joysticks attached to the system, NullJoysticks will be created to emulate a joystick which does nothing. (this is to avoid NullReferenceExceptions).

[Experimental - The API may be changed in the future, or this feature may be removed.]

double AgateLib.InputLib.Old.Input.PollFrequency [static, get, set]

Gets or sets the number of times per second that joysticks should be polled.

double AgateLib.InputLib.Old.Input.PollInterval [static, get, set]

Gets or sets the interval in milliseconds for the time between automatic joystick polls.

---

Event Documentation

InputSystemDelegate AgateLib.InputLib.Old.Input.DisposeInput [static]

Event raised when Input.Dispose() is called.

---

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

• InputLib/Old/Input.cs