Murl::IMouse Interface Reference

The mouse device interface. More...

#include "murl_i_mouse.h"

Inherited by Murl::Input::MouseDevice.

Public Types
enum	EventAction {   EVENT_ACTION_NONE , EVENT_ACTION_BUTTON_DOWN , EVENT_ACTION_BUTTON_UP , EVENT_ACTION_MOVE ,   EVENT_ACTION_FLUSH , NUM_EVENT_ACTIONS }
	Definition of event actions. More...

Public Member Functions
virtual void	PostEvent (EventAction action, IEnums::MouseButton button, Real posX, Real posY)=0
	Post the current mouse state. More...

Detailed Description

The mouse device interface.

Used by the platform to post events to the device.

Member Enumeration Documentation

EventAction

enum Murl::IMouse::EventAction

Definition of event actions.

Enumerator
EVENT_ACTION_NONE	No action.
EVENT_ACTION_BUTTON_DOWN	Mouse button is pressed, positions are evaluated.
EVENT_ACTION_BUTTON_UP	Mouse button is released, positions are evaluated.
EVENT_ACTION_MOVE	Mouse button not evaluated, positions are evaluated.
EVENT_ACTION_FLUSH	Flush all button states to the up state. This is useful in rare cases, e.g. if the platform is loosing events when changing from window to full screen mode.

Member Function Documentation

PostEvent()

virtual void Murl::IMouse::PostEvent ( EventAction  action, IEnums::MouseButton  button, Real  posX, Real  posY  )

pure virtual

Post the current mouse state.

Mouse positions are clipped by the mouse device and should be reported as is, e.g. if the mouse cursor is moved out of the display surface the platform should report the calculated values < -1.0 or > 1.0.

Parameters

action	The event action, see enum EventAction.
button	The mouse button identifier.
posX	The mouse x-position on the display surface in range [-1.0 left .. 1.0 right].
posY	The mouse y-position on the display surface in range [-1.0 bottom .. 1.0 top].

---

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

• murl_i_mouse.h