Public Member Functions | Static Public Attributes

fl7::input::Mouse Class Reference

#include <Mouse.h>

List of all members.

Public Member Functions

 Mouse (void)
 ~Mouse (void)
const ml7::Vector2GetResolution () const
const ml7::Vector2GetPosition () const
const ml7::Vector2GetOldPosition () const
const ml7::Vector2GetClickPosition () const
const ml7::Vector2GetLastClickPosition () const
float GetLastClickTime () const
float GetSensitivity () const
float GetDoubleClickTime () const
float GetWheelAmount () const
float GetButtonState (const unsigned index) const
float GetOldButtonState (const unsigned index) const
float GetButtonActionTime (const unsigned index) const
unsigned GetButtonCount () const
bool HasMoved () const
bool IsButtonDown (const unsigned index) const
bool IsButtonPressed (const unsigned index) const
bool IsButtonReleased (const unsigned index) const
bool IsButtonInAction (const unsigned index)
bool IsClicked () const
bool IsDoubleClicked () const
bool IsInAction () const
void SetResolution (const ml7::Vector2 &resolution)
void SetPosition (const ml7::Vector2 &position)
void SetSensitivity (const float sensitivity)
void SetDoubleClickTime (const float double_click_time)
void UpdateState (const float time)

Static Public Attributes

static const unsigned LEFT_BUTTON = 0
static const unsigned RIGHT_BUTTON = 1

Constructor & Destructor Documentation

fl7::input::Mouse::Mouse ( void   ) 

Default constructor.

fl7::input::Mouse::~Mouse ( void   ) 

Destructor.


Member Function Documentation

float fl7::input::Mouse::GetButtonActionTime ( const unsigned  index  )  const

Returns the time (in seconds) a specific button is in action (or 0). The button is identified by its index.

unsigned fl7::input::Mouse::GetButtonCount (  )  const [inline]

Returns the number of buttons.

float fl7::input::Mouse::GetButtonState ( const unsigned  index  )  const

Returns the current state of a specific button. The button is identified by its index.

const ml7::Vector2& fl7::input::Mouse::GetClickPosition (  )  const [inline]

Returns the position of the mouse when the left button has been pressed down.

float fl7::input::Mouse::GetDoubleClickTime (  )  const [inline]

Returns the maximum time between two left clicks resulting in a double-click.

const ml7::Vector2& fl7::input::Mouse::GetLastClickPosition (  )  const [inline]

Returns the position of the last left click.

float fl7::input::Mouse::GetLastClickTime (  )  const [inline]

Returns the time elapsed since the last left click.

float fl7::input::Mouse::GetOldButtonState ( const unsigned  index  )  const

Returns the previous state of a specific button. The button is identified by its index.

const ml7::Vector2& fl7::input::Mouse::GetOldPosition (  )  const [inline]

Returns the previous position of the mouse cursor (in screen coordinates).

const ml7::Vector2& fl7::input::Mouse::GetPosition (  )  const [inline]

Returns the position of the mouse cursor (in screen coordinates).

const ml7::Vector2& fl7::input::Mouse::GetResolution (  )  const [inline]

Returns the (imaginary) screen resolution.

float fl7::input::Mouse::GetSensitivity (  )  const [inline]

Returns the sensitivity of the mouse cursor. A value > 1 speeds the cursor movement up. A value < 1 slows the cursor movement down.

float fl7::input::Mouse::GetWheelAmount (  )  const [inline]

Returns the amount the mouse wheel has been moved.

bool fl7::input::Mouse::HasMoved (  )  const [inline]

Returns true, if the position has changed.

bool fl7::input::Mouse::IsButtonDown ( const unsigned  index  )  const

Returns true, if a specific button is down. The button is identified by its index.

bool fl7::input::Mouse::IsButtonInAction ( const unsigned  index  ) 

Returns true, if a given button has been pressed or is still down since a certain amount of time. If the button is still down, the function does not inherently return true: The function only returns true periodically. The button is identified by its index.

bool fl7::input::Mouse::IsButtonPressed ( const unsigned  index  )  const

Returns true, if a specific button has been pressed. The button is identified by its index.

bool fl7::input::Mouse::IsButtonReleased ( const unsigned  index  )  const

Returns true, if a specific button has been released. The button is identified by its index.

bool fl7::input::Mouse::IsClicked (  )  const

Returns true, if the mouse has been clicked. That is, if the left mouse button has been pressed and released at the same position, regardless of whether the mouse has been moved between these two events.

bool fl7::input::Mouse::IsDoubleClicked (  )  const

Returns true, if the mouse has been double-clicked. That is, if the left mouse button has been pressed and released at the same position as the last click and the time elapsed sine the last click does not exceed the "double-click time".

bool fl7::input::Mouse::IsInAction (  )  const

Periodically returns true, while the left mouse button is down and the position of the mouse has not changed over time.

void fl7::input::Mouse::SetDoubleClickTime ( const float  double_click_time  )  [inline]

Sets the maximum time between two clicks resulting in a double-click.

void fl7::input::Mouse::SetPosition ( const ml7::Vector2 position  ) 

Sets the position of the mouse cursor (in screen coordinates).

void fl7::input::Mouse::SetResolution ( const ml7::Vector2 resolution  )  [inline]

Sets the (imaginary) screen resolution.

void fl7::input::Mouse::SetSensitivity ( const float  sensitivity  )  [inline]

Sezs the sensitivity of the mouse cursor. A value > 1 speeds the cursor movement up. A value < 1 slows the cursor movement down.

void fl7::input::Mouse::UpdateState ( const float  time  ) 

Updates the state of the mouse (axes, buttons, etc.).


Member Data Documentation

const unsigned fl7::input::Mouse::LEFT_BUTTON = 0 [static]
const unsigned fl7::input::Mouse::RIGHT_BUTTON = 1 [static]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines