OrxMouse

Defines
#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_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_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxMouse_IsButtonPressed (orxMOUSE_BUTTON _eButton)
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

---

Define Documentation

#define orxMOUSE_KZ_CONFIG_SECTION   "Mouse"

Definition at line 78 of file orxMouse.h.

#define orxMOUSE_KZ_CONFIG_SHOW_CURSOR   "ShowCursor"

Definition at line 79 of file orxMouse.h.

---

Enumeration Type Documentation

enum orxMOUSE_AXIS

Enumerator:

orxMOUSE_AXIS_X
orxMOUSE_AXIS_Y
orxMOUSE_AXIS_NUMBER
orxMOUSE_AXIS_NONE

Definition at line 68 of file orxMouse.h.

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_WHEEL_UP
orxMOUSE_BUTTON_WHEEL_DOWN
orxMOUSE_BUTTON_NUMBER
orxMOUSE_BUTTON_NONE

Definition at line 53 of file orxMouse.h.

---

Function Documentation

orxDLLAPI void orxFASTCALL orxMouse_Exit

(

)

Exits from the mouse module

orxDLLAPI const orxSTRING orxFASTCALL orxMouse_GetAxisName

(

orxMOUSE_AXIS

_eAxis )

Gets axis literal name

Parameters:

[in]

_eAxis

Concerned axis

Returns:

Axis's name

orxDLLAPI const orxSTRING orxFASTCALL orxMouse_GetButtonName

(

orxMOUSE_BUTTON

_eButton )

Gets button literal name

Parameters:

[in]

_eButton

Concerned button

Returns:

Button's name

orxDLLAPI orxVECTOR* orxFASTCALL orxMouse_GetMoveDelta

(

orxVECTOR *

_pvMoveDelta )

Gets mouse move delta (since last call)

Parameters:

[out]

_pvMoveDelta

Mouse move delta

Returns:

orxVECTOR / orxNULL

orxDLLAPI orxVECTOR* orxFASTCALL orxMouse_GetPosition

(

orxVECTOR *

_pvPosition )

Gets mouse position

Parameters:

[out]

_pvPosition

Mouse position

Returns:

orxVECTOR / orxNULL

orxDLLAPI orxFLOAT orxFASTCALL orxMouse_GetWheelDelta

(

)

Gets mouse wheel delta (since last call)

Returns:

Mouse wheel delta

orxDLLAPI orxSTATUS orxFASTCALL orxMouse_Init

(

)

Inits the mouse module

Returns:

Returns the status of the operation

orxDLLAPI orxBOOL orxFASTCALL orxMouse_IsButtonPressed

(

orxMOUSE_BUTTON

_eButton )

Is mouse button pressed?

Parameters:

[in]

_eButton

Mouse button to check

Returns:

orxTRUE if presse / orxFALSE otherwise

orxDLLAPI orxSTATUS orxFASTCALL orxMouse_SetPosition

(

const orxVECTOR *

_pvPosition )

Sets mouse position

Parameters:

[in]

_pvPosition

Mouse position

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxMouse_Setup

(

)

Mouse module setup

orxDLLAPI orxSTATUS orxFASTCALL orxMouse_ShowCursor

(

orxBOOL

_bShow )

Shows mouse cursor

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE