Aether3D Game Engine
Public Member Functions | List of all members
MouseInput Class Reference

Reads mouse. More...

#include <MouseInput.hpp>

Public Member Functions

virtual void GetPosition (int &outX, int &outY) const
 
virtual void SetPosition (int x, int y) const
 
virtual void SetRelative (bool enable) const
 
virtual void ShowCursor (bool enable) const
 
virtual bool IsDown (ae3d::mouseinput::Enum button) const
 

Detailed Description

Reads mouse.

Member Function Documentation

virtual void MouseInput::GetPosition ( int &  outX,
int &  outY 
) const
virtual
Parameters
outXIf relative movement is false, cursor's X screen coordinate relative to upper-left corner is returned here.
outYIf relative movement is false, cursor's Y screen coordinate relative to upper-left corner is returned here.
virtual bool MouseInput::IsDown ( ae3d::mouseinput::Enum  button) const
virtual
Parameters
buttonButton.
Returns
True, if button is down, false otherwise.
virtual void MouseInput::SetPosition ( int  x,
int  y 
) const
virtual
Parameters
xX screen coordinate.
yY screen coordinate.
virtual void MouseInput::SetRelative ( bool  enable) const
virtual
Parameters
enableRelative movement status. If true, GetPosition returns values relative to the prior state. Defaults to false.
virtual void MouseInput::ShowCursor ( bool  enable) const
virtual
Parameters
enableTrue, if cursor will be shown, false otherwise.

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