OrxMouse

Macros
#define	orxMOUSE_KZ_CONFIG_GRAB   "Grab"
#define	orxMOUSE_KZ_CONFIG_SECTION   "Mouse"
#define	orxMOUSE_KZ_CONFIG_SHOW_CURSOR   "ShowCursor"

Enumerations
enum	orxMOUSE_AXIS { orxMOUSE_AXIS_X = 0 , orxMOUSE_AXIS_Y , orxMOUSE_AXIS_NUMBER , orxMOUSE_AXIS_NONE = orxENUM_NONE }
enum	orxMOUSE_BUTTON {   orxMOUSE_BUTTON_LEFT = 0 , orxMOUSE_BUTTON_RIGHT , orxMOUSE_BUTTON_MIDDLE , orxMOUSE_BUTTON_EXTRA_1 ,   orxMOUSE_BUTTON_EXTRA_2 , orxMOUSE_BUTTON_EXTRA_3 , orxMOUSE_BUTTON_EXTRA_4 , orxMOUSE_BUTTON_EXTRA_5 ,   orxMOUSE_BUTTON_WHEEL_UP , orxMOUSE_BUTTON_WHEEL_DOWN , orxMOUSE_BUTTON_NUMBER , orxMOUSE_BUTTON_NONE = orxENUM_NONE }

Functions
orxDLLAPI void orxFASTCALL	orxMouse_Exit ()
orxDLLAPI const orxSTRING orxFASTCALL	orxMouse_GetAxisName (orxMOUSE_AXIS _eAxis)
orxDLLAPI const orxSTRING orxFASTCALL	orxMouse_GetButtonName (orxMOUSE_BUTTON _eButton)
orxDLLAPI orxVECTOR *orxFASTCALL	orxMouse_GetMoveDelta (orxVECTOR *_pvMoveDelta)
orxDLLAPI orxVECTOR *orxFASTCALL	orxMouse_GetPosition (orxVECTOR *_pvPosition)
orxDLLAPI orxFLOAT orxFASTCALL	orxMouse_GetWheelDelta ()
orxDLLAPI orxSTATUS orxFASTCALL	orxMouse_Grab (orxBOOL _bGrab)
orxDLLAPI orxSTATUS orxFASTCALL	orxMouse_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxMouse_IsButtonPressed (orxMOUSE_BUTTON _eButton)
orxDLLAPI orxSTATUS orxFASTCALL	orxMouse_SetCursor (const orxSTRING _zName, const orxVECTOR *_pvPivot)
orxDLLAPI orxSTATUS orxFASTCALL	orxMouse_SetPosition (const orxVECTOR *_pvPosition)
orxDLLAPI void orxFASTCALL	orxMouse_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL	orxMouse_ShowCursor (orxBOOL _bShow)

Detailed Description

Mouse plugin module Plugin module that handles mouse-like peripherals

Macro Definition Documentation

orxMOUSE_KZ_CONFIG_GRAB

#define orxMOUSE_KZ_CONFIG_GRAB   "Grab"

Definition at line 84 of file orxMouse.h.

orxMOUSE_KZ_CONFIG_SECTION

#define orxMOUSE_KZ_CONFIG_SECTION   "Mouse"

Definition at line 82 of file orxMouse.h.

orxMOUSE_KZ_CONFIG_SHOW_CURSOR

#define orxMOUSE_KZ_CONFIG_SHOW_CURSOR   "ShowCursor"

Definition at line 83 of file orxMouse.h.

Enumeration Type Documentation

orxMOUSE_AXIS

enum orxMOUSE_AXIS

Enumerator
orxMOUSE_AXIS_X
orxMOUSE_AXIS_Y
orxMOUSE_AXIS_NUMBER
orxMOUSE_AXIS_NONE

Definition at line 72 of file orxMouse.h.

orxMOUSE_BUTTON

enum orxMOUSE_BUTTON

Button enum

Enumerator
orxMOUSE_BUTTON_LEFT
orxMOUSE_BUTTON_RIGHT
orxMOUSE_BUTTON_MIDDLE
orxMOUSE_BUTTON_EXTRA_1
orxMOUSE_BUTTON_EXTRA_2
orxMOUSE_BUTTON_EXTRA_3
orxMOUSE_BUTTON_EXTRA_4
orxMOUSE_BUTTON_EXTRA_5
orxMOUSE_BUTTON_WHEEL_UP
orxMOUSE_BUTTON_WHEEL_DOWN
orxMOUSE_BUTTON_NUMBER
orxMOUSE_BUTTON_NONE

Definition at line 54 of file orxMouse.h.

Function Documentation

orxMouse_Exit()

orxDLLAPI void orxFASTCALL orxMouse_Exit ( )

extern

Exits from the mouse module

orxMouse_GetAxisName()

orxDLLAPI const orxSTRING orxFASTCALL orxMouse_GetAxisName ( orxMOUSE_AXIS _eAxis )

extern

Gets axis literal name

Parameters

[in]

_eAxis

Concerned axis

Returns

Axis's name

orxMouse_GetButtonName()

orxDLLAPI const orxSTRING orxFASTCALL orxMouse_GetButtonName ( orxMOUSE_BUTTON _eButton )

extern

Gets button literal name

Parameters

[in]

_eButton

Concerned button

Returns

Button's name

orxMouse_GetMoveDelta()

orxDLLAPI orxVECTOR *orxFASTCALL orxMouse_GetMoveDelta ( orxVECTOR * _pvMoveDelta )

extern

Gets mouse move delta (since last call)

Parameters

[out]

_pvMoveDelta

Mouse move delta

Returns

orxVECTOR / orxNULL

orxMouse_GetPosition()

orxDLLAPI orxVECTOR *orxFASTCALL orxMouse_GetPosition ( orxVECTOR * _pvPosition )

extern

Gets mouse position

Parameters

[out]

_pvPosition

Mouse position

Returns

orxVECTOR / orxNULL

orxMouse_GetWheelDelta()

orxDLLAPI orxFLOAT orxFASTCALL orxMouse_GetWheelDelta ( )

extern

Gets mouse wheel delta (since last call)

Returns

Mouse wheel delta

orxMouse_Grab()

orxDLLAPI orxSTATUS orxFASTCALL orxMouse_Grab ( orxBOOL _bGrab )

extern

Grabs the mouse

Parameters

[in]

_bGrab

Grab / Release

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxMouse_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxMouse_Init ( )

extern

Inits the mouse module

Returns

Returns the status of the operation

orxMouse_IsButtonPressed()

orxDLLAPI orxBOOL orxFASTCALL orxMouse_IsButtonPressed ( orxMOUSE_BUTTON _eButton )

extern

Is mouse button pressed?

Parameters

[in]

_eButton

Mouse button to check

Returns

orxTRUE if pressed / orxFALSE otherwise

orxMouse_SetCursor()

orxDLLAPI orxSTATUS orxFASTCALL orxMouse_SetCursor ( const orxSTRING _zName, const orxVECTOR * _pvPivot )

extern

Sets mouse (hardware) cursor

Parameters

[in]	_zName	Cursor's name can be: a standard name (arrow, ibeam, hand, crosshair, resize_ns, resize_ew, resize_nesw, resize_nwse, resize_all or not_allowed), a file name or orxNULL to reset the hardware cursor to default
[in]	_pvPivot	Cursor's pivot (aka hotspot), orxNULL will default to (0, 0)

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxMouse_SetPosition()

orxDLLAPI orxSTATUS orxFASTCALL orxMouse_SetPosition ( const orxVECTOR * _pvPosition )

extern

Sets mouse position

Parameters

[in]

_pvPosition

Mouse position

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxMouse_Setup()

orxDLLAPI void orxFASTCALL orxMouse_Setup ( )

extern

Mouse module setup

orxMouse_ShowCursor()

orxDLLAPI orxSTATUS orxFASTCALL orxMouse_ShowCursor ( orxBOOL _bShow )

extern

Shows mouse (hardware) cursor

Parameters

[in]

_bShow

Show / Hide

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE