Annwvyn::AnnMouseEvent Class Reference

A mouse event information object. More...

#include <AnnEvents.hpp>

Inheritance diagram for Annwvyn::AnnMouseEvent:
Collaboration diagram for Annwvyn::AnnMouseEvent:

Public Member Functions

 AnnMouseEvent ()
 
bool getButtonState (MouseButtonId id)
 
AnnMouseAxis getAxis (MouseAxisID id)
 
- Public Member Functions inherited from Annwvyn::AnnEvent
 AnnEvent ()
 Event constructor. More...
 
AnnEventType getType () const
 

Private Member Functions

void setButtonStatus (MouseButtonId id, bool value)
 
void setAxisInformation (MouseAxisID id, AnnMouseAxis information)
 

Private Attributes

AnnMouseAxis axes [AxisCount]
 
bool buttonsStatus [ButtonCount]
 

Friends

class AnnEventManager
 

Additional Inherited Members

- Protected Attributes inherited from Annwvyn::AnnEvent
AnnEventType type
 

Detailed Description

A mouse event information object.

Definition at line 124 of file AnnEvents.hpp.

Constructor & Destructor Documentation

◆ AnnMouseEvent()

AnnMouseEvent::AnnMouseEvent ( )

Definition at line 111 of file AnnEvents.cpp.

Member Function Documentation

◆ getAxis()

AnnMouseAxis AnnMouseEvent::getAxis ( MouseAxisID  id)

Get given axis data

Parameters
idId of the axis

Definition at line 130 of file AnnEvents.cpp.

◆ getButtonState()

bool AnnMouseEvent::getButtonState ( MouseButtonId  id)

Returns true if given button is pressed

Parameters
idId of the button

Definition at line 120 of file AnnEvents.cpp.

◆ setAxisInformation()

void AnnMouseEvent::setAxisInformation ( MouseAxisID  id,
AnnMouseAxis  information 
)
private

Set the information about an axis

Parameters
idId of a specific axis
informationThe information object of the given axis

Definition at line 146 of file AnnEvents.cpp.

◆ setButtonStatus()

void AnnMouseEvent::setButtonStatus ( MouseButtonId  id,
bool  value 
)
private

Set the status of a button

Parameters
idId of a specific button
valueCurrent pressed/released state of that button

Definition at line 140 of file AnnEvents.cpp.

Friends And Related Function Documentation

◆ AnnEventManager

friend class AnnEventManager
friend

Definition at line 140 of file AnnEvents.hpp.

Member Data Documentation

◆ axes

AnnMouseAxis Annwvyn::AnnMouseEvent::axes[AxisCount]
private

Definition at line 137 of file AnnEvents.hpp.

◆ buttonsStatus

bool Annwvyn::AnnMouseEvent::buttonsStatus[ButtonCount]
private

Definition at line 138 of file AnnEvents.hpp.


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