Mindshifter.IInputManager Interface Reference

IInputManager defines an interface to the InputManager class. More...

Inherited by Mindshifter.InputManager.

Inheritance diagram for Mindshifter.IInputManager:

[legend]List of all members.

Public Member Functions
void	PushActionMap (ActionMap map)
	Pushes an ActionMap onto the action map stack.
ActionMap	PopActionMap ()
	Pops the topmost ActionMap from the ActionMap stack.
bool	Key (Keys key)
	Returns true if the specified keyboard key is pressed.
bool	KeyDown (Keys key)
	Returns true if a key down event occurred for the specified key.
bool	KeyUp (Keys key)
	Returns true if a key up event occurred for the specified key.
bool	MouseButton (MouseButtons button)
	Returns true if the specified mouse button is pressed.
bool	MouseDown (MouseButtons button)
	Returns true if a mouse down event occurred for the specified mouse button.
bool	MouseUp (MouseButtons button)
	Returns true if a mouse up event occurred for the specified mouse button.
Properties
KeyboardState	Keyboard [get]
	Gets the current keyboard state.
MouseState	Mouse [get]
	Gets the current mouse state.
int	DX [get]
	Gets the change in the mouse x position since input was last updated.
int	DY [get]
	Gets the change in the mouse y position since input was last updated.
int	DZ [get]
	Gets the change in the mouse scroll wheel position since input was last updated.
int	X [get]
	Gets the x position of the mouse.
int	Y [get]
	Gets the y position of the mouse.
int	Z [get]
	Gets the scroll wheel value of the mouse.
bool	this [Keys key] [get]
	Returns true if the specified mouse button is pressed.
ActionMap	ActionMap [get]
	Gets the active ActionMap.

---

Detailed Description

IInputManager defines an interface to the InputManager class.

---

Member Function Documentation

void Mindshifter.IInputManager.PushActionMap

(

ActionMap

map

)

Pushes an ActionMap onto the action map stack.

Parameters:

map

The ActionMap to push onto the ActionMap stack

Implemented in Mindshifter.InputManager.

ActionMap Mindshifter.IInputManager.PopActionMap

(

)

Pops the topmost ActionMap from the ActionMap stack.

Returns:

The ActionMap that was popped from the ActionMap stack

Implemented in Mindshifter.InputManager.

bool Mindshifter.IInputManager.Key

(

Keys

key

)

Returns true if the specified keyboard key is pressed.

Parameters:

key

The key to test for a key pressed state

Returns:

True if the specified keyboard key is pressed, false otherwise

bool Mindshifter.IInputManager.KeyDown

(

Keys

key

)

Returns true if a key down event occurred for the specified key.

Parameters:

key

The key to test for a key down event

Returns:

True if the specified keyboard key triggered a key down event, false otherwise

bool Mindshifter.IInputManager.KeyUp

(

Keys

key

)

Returns true if a key up event occurred for the specified key.

Parameters:

key

The key to test for a key up event

Returns:

True if the specified keyboard key triggered a key up event, false otherwise

bool Mindshifter.IInputManager.MouseButton

(

MouseButtons

button

)

Returns true if the specified mouse button is pressed.

Parameters:

button

The mouse button to test for a button pressed state

Returns:

True if the specified mouse button is pressed, false otherwise

Implemented in Mindshifter.InputManager.

bool Mindshifter.IInputManager.MouseDown

(

MouseButtons

button

)

Returns true if a mouse down event occurred for the specified mouse button.

Parameters:

button

The mouse button to test for a mouse down event

Returns:

True if the specified mouse button triggered a mouse down event

Implemented in Mindshifter.InputManager.

bool Mindshifter.IInputManager.MouseUp

(

MouseButtons

button

)

Returns true if a mouse up event occurred for the specified mouse button.

Parameters:

button

The mouse button to test for a mouse up event

Returns:

True if the specified mouse button triggered a mouse up event

Implemented in Mindshifter.InputManager.

---

Property Documentation

KeyboardState Mindshifter.IInputManager.Keyboard [get]

Gets the current keyboard state.

Implemented in Mindshifter.InputManager.

MouseState Mindshifter.IInputManager.Mouse [get]

Gets the current mouse state.

Implemented in Mindshifter.InputManager.

int Mindshifter.IInputManager.DX [get]

Gets the change in the mouse x position since input was last updated.

Implemented in Mindshifter.InputManager.

int Mindshifter.IInputManager.DY [get]

Gets the change in the mouse y position since input was last updated.

Implemented in Mindshifter.InputManager.

int Mindshifter.IInputManager.DZ [get]

Gets the change in the mouse scroll wheel position since input was last updated.

Implemented in Mindshifter.InputManager.

int Mindshifter.IInputManager.X [get]

Gets the x position of the mouse.

Implemented in Mindshifter.InputManager.

int Mindshifter.IInputManager.Y [get]

Gets the y position of the mouse.

Implemented in Mindshifter.InputManager.

int Mindshifter.IInputManager.Z [get]

Gets the scroll wheel value of the mouse.

Implemented in Mindshifter.InputManager.

bool Mindshifter.IInputManager::this

(

)

[get]

Returns true if the specified mouse button is pressed.

Parameters:

key

The key to test for a key pressed state

Returns:

True if the specified keyboard key is pressed, false otherwise

Implemented in Mindshifter.InputManager.

ActionMap Mindshifter.IInputManager.ActionMap [get]

Gets the active ActionMap.

Implemented in Mindshifter.InputManager.

---

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

• Desktop/Dev/InputManager/InputManager/IInputManager.cs

---