Murl::Input::IMouseDevice Interface Referenceabstract

The IMouseDevice interface. More...

#include "murl_input_i_mouse_device.h"

Inheritance diagram for Murl::Input::IMouseDevice:

Public Member Functions

virtual Bool WasMoved () const =0
 Check if the mouse device was moved in the most recent tick. More...
 
virtual Real GetPositionX () const =0
 Get the mouse x-position on the display surface. More...
 
virtual Real GetPositionY () const =0
 Get the mouse y-position on the display surface. More...
 
virtual Bool IsPositionXInRange () const =0
 Check if the mouse x-position is in range of the display surface. More...
 
virtual Bool IsPositionYInRange () const =0
 Check if the mouse y-position is in range of the display surface. More...
 
- Public Member Functions inherited from Murl::Input::IDevice
virtual const StringGetName () const =0
 Get the device name. More...
 
virtual UInt32 GetId () const =0
 Get the unique device identifier. More...
 
virtual Bool HasUpdate () const =0
 Check if the device has received new data since the last Update(). More...
 
virtual void LogicUpdate ()=0
 Is executed in the logic thread context each logic tick.
 
virtual void ConfigChanged (const IAppConfiguration *appConfig)=0
 Notification of changed configuration. More...
 
- Public Member Functions inherited from Murl::Input::IMouseButtons
virtual UInt32 GetNumberOfButtons () const =0
 Get the number of buttons available in the device. More...
 
virtual Bool IsButtonPressed (IEnums::MouseButton button) const =0
 Check if a specified mouse button is pressed. More...
 
virtual Bool WasButtonPressed (IEnums::MouseButton button) const =0
 Check if a specified mouse button was pressed in the most recent tick. More...
 
virtual Bool WasButtonReleased (IEnums::MouseButton button) const =0
 Check if a specified mouse button was released in the most recent tick. More...
 

Detailed Description

The IMouseDevice interface.

Member Function Documentation

◆ WasMoved()

virtual Bool Murl::Input::IMouseDevice::WasMoved ( ) const
pure virtual

Check if the mouse device was moved in the most recent tick.

Returns
true if the mouse device was moved in the most recent tick.

◆ GetPositionX()

virtual Real Murl::Input::IMouseDevice::GetPositionX ( ) const
pure virtual

Get the mouse x-position on the display surface.

Returns
The x-position in range [-1.0 left .. 1.0 right].

◆ GetPositionY()

virtual Real Murl::Input::IMouseDevice::GetPositionY ( ) const
pure virtual

Get the mouse y-position on the display surface.

Returns
The y-position in range [-1.0 bottom .. 1.0 top].

◆ IsPositionXInRange()

virtual Bool Murl::Input::IMouseDevice::IsPositionXInRange ( ) const
pure virtual

Check if the mouse x-position is in range of the display surface.

If the mouse cursor is moved out of the display surface (e.g. the window), the mouse positions are clipped to range [-1.0, 1.0]. This method can be used to detect this case.

Returns
true if the mouse x-position is in range.

◆ IsPositionYInRange()

virtual Bool Murl::Input::IMouseDevice::IsPositionYInRange ( ) const
pure virtual

Check if the mouse y-position is in range of the display surface.

If the mouse cursor is moved out of the display surface (e.g. the window), the mouse positions are clipped to range [-1.0, 1.0]. This method can be used to detect this case.

Returns
true if the mouse y-position is in range.

The documentation for this interface was generated from the following file:
  • murl_input_i_mouse_device.h


Copyright © 2011-2018 Spraylight GmbH.