Input Class Reference

#include <platformInput.h>

Static Public Member Functions
static void	init ()
static void	destroy ()
static bool	enable ()
static void	disable ()
static void	activate ()
static void	deactivate ()
static void	reactivate ()
static void	enableMouse ()
static void	disableMouse ()
static void	enableKeyboard ()
static void	disableKeyboard ()
static bool	activateKeyboard ()
static void	deactivateKeyboard ()
static bool	enableJoystick ()
static void	disableJoystick ()
static void	echoInputState ()
static U16	getAscii (U16 keyCode, KEY_STATE keyState)
static U16	getKeyCode (U16 asciiCode)
static bool	isEnabled ()
static bool	isActive ()
static bool	isMouseEnabled ()
static bool	isKeyboardEnabled ()
static void	process ()
static void	setCursorPos (S32 x, S32 y)
static void	setCursorState (bool on)
	If True, turns off the platform cursor.
static void	setCursorShape (U32 cursorID)
static void	pushCursor (S32 cursorID)
	Push a cursor shape using the Cursor Manager.
static void	popCursor ()
	Pop the current cursor off of the Cursor Manager stack.
static void	refreshCursor ()
	Refresh the current cursor's shape.
static U32	getDoubleClickTime ()
static S32	getDoubleClickWidth ()
static S32	getDoubleClickHeight ()
static InputManager *	getManager ()
	Return InputManager Singleton.
static CursorManager *	getCursorManager ()
	Return CursorManager Singleton.
static U8	getModifierKeys ()
static void	setModifierKeys (U8 mod)

Static Protected Attributes
static InputManager *	smManager = NULL
	Input Manager Singleton.
static CursorManager *	smCursorManager = 0
	Cursor Manager Singleton.
static bool	smActive = false
	Is Input Active.
static bool	smLastKeyboardActivated
static U8	smModifierKeys
	Current Modifier Keys Pressed.
static bool	smLastMouseActivated
static bool	smLastJoystickActivated
static bool	smCursorGuard
	Used by Mac to prevent over hiding the cursor.

Member Function Documentation

activate()

void activate ( )

static

activateKeyboard()

bool activateKeyboard ( )

static

deactivate()

void deactivate ( )

static

deactivateKeyboard()

void deactivateKeyboard ( )

static

destroy()

void destroy ( )

static

disable()

void disable ( )

static

disableJoystick()

void disableJoystick ( )

static

disableKeyboard()

void disableKeyboard ( )

static

disableMouse()

void disableMouse ( )

static

echoInputState()

void echoInputState ( )

static

enable()

bool enable ( )

static

Initial value:

{
   if (gInputEnabled)
      Input::disable()

enableJoystick()

bool enableJoystick ( )

static

enableKeyboard()

void enableKeyboard ( )

static

enableMouse()

void enableMouse ( )

static

getAscii()

U16 getAscii ( U16 keyCode, KEY_STATE keyState )

static

getCursorManager()

CursorManager * getCursorManager ( )

static

Return CursorManager Singleton.

getDoubleClickHeight()

S32 getDoubleClickHeight ( )

static

getDoubleClickTime()

U32 getDoubleClickTime ( )

static

getDoubleClickWidth()

S32 getDoubleClickWidth ( )

static

getKeyCode()

U16 getKeyCode ( U16 asciiCode )

static

getManager()

InputManager * getManager ( )

static

Return InputManager Singleton.

getModifierKeys()

U8 getModifierKeys ( )

inlinestatic

init()

void init ( )

static

isActive()

bool isActive ( )

static

isEnabled()

bool isEnabled ( )

static

isKeyboardEnabled()

bool isKeyboardEnabled ( )

static

isMouseEnabled()

bool isMouseEnabled ( )

static

popCursor()

void popCursor ( )

static

Pop the current cursor off of the Cursor Manager stack.

process()

void process ( )

static

pushCursor()

void pushCursor ( S32 cursorID )

static

Push a cursor shape using the Cursor Manager.

reactivate()

void reactivate ( )

static

refreshCursor()

void refreshCursor ( )

static

Refresh the current cursor's shape.

setCursorPos()

void setCursorPos ( S32 x, S32 y )

static

setCursorShape()

void setCursorShape ( U32 cursorID )

static

Initial value:

{
   return true

setCursorState()

void setCursorState ( bool on )

static

If True, turns off the platform cursor.

setModifierKeys()

void setModifierKeys ( U8 mod )

inlinestatic

Member Data Documentation

smActive

bool smActive = false

staticprotected

Is Input Active.

smCursorGuard

bool smCursorGuard

staticprotected

Used by Mac to prevent over hiding the cursor.

smCursorManager

CursorManager * smCursorManager = 0

staticprotected

Cursor Manager Singleton.

smLastJoystickActivated

bool smLastJoystickActivated

staticprotected

smLastKeyboardActivated

bool smLastKeyboardActivated

staticprotected

smLastMouseActivated

bool smLastMouseActivated

staticprotected

smManager

InputManager * smManager = NULL

staticprotected

Input Manager Singleton.

smModifierKeys

U8 smModifierKeys

staticprotected

Current Modifier Keys Pressed.

---

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

• platform/platformInput.h
• platform/CursorManager.cc
• platformAndroid/AndroidInput.cpp
• platformAndroid/AndroidPlatform.cpp
• platformEmscripten/EmscriptenInput.cpp
• platformEmscripten/EmscriptenPlatform.cpp