Annwvyn::AnnMouseAxis Class Reference

A mouse axis information object. More...

#include <AnnEvents.hpp>

Public Member Functions

 AnnMouseAxis ()
 Construct a mouse axis information object. More...
 
MouseAxisID getMouseAxisId () const
 Return the id of the axis that object represent. More...
 
int getRelValue () const
 Relative value in arbitrary unit. More...
 
int getAbsValue () const
 Absolute value in arbitrary unit. More...
 

Private Member Functions

void setAxis (MouseAxisID ax)
 Set the id of the axis. More...
 
void setRelValue (int rel)
 Set the relative value of the axis. More...
 
void setAbsValue (int abs)
 Set the absolute value of the axis. More...
 
 AnnMouseAxis (MouseAxisID ax, int rel, int abs)
 Private magic one line constructor !!!! ;-) More...
 

Private Attributes

MouseAxisID id
 ID of the axis. More...
 
int rel
 Relative value. More...
 
int abs
 Absolute value (if applicable) More...
 

Friends

class AnnEventManager
 Give access to private fields to the EventManager. More...
 
class AnnMouseEvent
 Give access to private fields to the MouseEvent class. More...
 

Detailed Description

A mouse axis information object.

Definition at line 89 of file AnnEvents.hpp.

Constructor & Destructor Documentation

◆ AnnMouseAxis() [1/2]

AnnMouseAxis::AnnMouseAxis ( )

Construct a mouse axis information object.

Definition at line 67 of file AnnEvents.cpp.

Here is the call graph for this function:

◆ AnnMouseAxis() [2/2]

AnnMouseAxis::AnnMouseAxis ( MouseAxisID  ax,
int  rel,
int  abs 
)
private

Private magic one line constructor !!!! ;-)

Definition at line 74 of file AnnEvents.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ getAbsValue()

int AnnMouseAxis::getAbsValue ( ) const

Absolute value in arbitrary unit.

Definition at line 106 of file AnnEvents.cpp.

◆ getMouseAxisId()

MouseAxisID AnnMouseAxis::getMouseAxisId ( ) const

Return the id of the axis that object represent.

Definition at line 96 of file AnnEvents.cpp.

◆ getRelValue()

int AnnMouseAxis::getRelValue ( ) const

Relative value in arbitrary unit.

Definition at line 101 of file AnnEvents.cpp.

◆ setAbsValue()

void AnnMouseAxis::setAbsValue ( int  abs)
private

Set the absolute value of the axis.

Definition at line 91 of file AnnEvents.cpp.

Here is the caller graph for this function:

◆ setAxis()

void AnnMouseAxis::setAxis ( MouseAxisID  ax)
private

Set the id of the axis.

Definition at line 81 of file AnnEvents.cpp.

Here is the caller graph for this function:

◆ setRelValue()

void AnnMouseAxis::setRelValue ( int  rel)
private

Set the relative value of the axis.

Definition at line 86 of file AnnEvents.cpp.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ AnnEventManager

friend class AnnEventManager
friend

Give access to private fields to the EventManager.

Definition at line 103 of file AnnEvents.hpp.

◆ AnnMouseEvent

friend class AnnMouseEvent
friend

Give access to private fields to the MouseEvent class.

Definition at line 105 of file AnnEvents.hpp.

Member Data Documentation

◆ abs

int Annwvyn::AnnMouseAxis::abs
private

Absolute value (if applicable)

Definition at line 111 of file AnnEvents.hpp.

◆ id

MouseAxisID Annwvyn::AnnMouseAxis::id
private

ID of the axis.

Definition at line 107 of file AnnEvents.hpp.

◆ rel

int Annwvyn::AnnMouseAxis::rel
private

Relative value.

Definition at line 109 of file AnnEvents.hpp.


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