kerosin::InputServer::Input Struct Reference

this defines the input data structure, encapsulating all input events generated by the devices. More...

#include <inputserver.h>

List of all members.

Public Member Functions
	Input (EType t=eUnknown, TInputCode c=0, int i=-1)
	this initializes values indicating an invalid input event
bool	KeyPress () const
	returns true if the input represents a key press event
bool	KeyRelease () const
	returns true if the input represents a key release event
Public Attributes
EType	type
	this indicates the input data type
TInputCode	code
	the IC_ code of the button or the axis (see inputconst.h)
int	id
	this is a user defined value the Input event evaluated to, or -1 to indicate a raw Input event.
union {
long   l
	this is used to encode a button event.
float   f
	this is used to encode a position on an axis.
}	data
	union for additional data

---

Detailed Description

this defines the input data structure, encapsulating all input events generated by the devices.

Definition at line 102 of file inputserver.h.

---

Constructor & Destructor Documentation

kerosin::InputServer::Input::Input (  EType  t = eUnknown, TInputCode  c = 0, int  i = -1 )  [inline]

this initializes values indicating an invalid input event Definition at line 130 of file inputserver.h.

---

Member Function Documentation

bool kerosin::InputServer::Input::KeyPress (   )  const [inline]

returns true if the input represents a key press event Definition at line 134 of file inputserver.h. References data. Referenced by SoccerInput::ProcessInput().

bool kerosin::InputServer::Input::KeyRelease (   )  const [inline]

returns true if the input represents a key release event Definition at line 137 of file inputserver.h. References data.

---

Member Data Documentation

TInputCode kerosin::InputServer::Input::code

the IC_ code of the button or the axis (see inputconst.h) Definition at line 109 of file inputserver.h. Referenced by MouseSDL::EventFilter(), TimerSDL::GetInput(), kerosin::InputServer::GetInput(), and kerosin::InputServer::Invoke().

union { ... } kerosin::InputServer::Input::data

union for additional data Referenced by MouseSDL::EventFilter(), KeyboardSDL::EventFilter(), TimerSDL::GetInput(), kerosin::InputServer::GetInput(), kerosin::InputServer::Invoke(), KeyPress(), KeyRelease(), and kerosin::InputControl::StartCycle().

float kerosin::InputServer::Input::f

this is used to encode a position on an axis. Definition at line 125 of file inputserver.h.

int kerosin::InputServer::Input::id

this is a user defined value the Input event evaluated to, or -1 to indicate a raw Input event. Definition at line 114 of file inputserver.h. Referenced by kerosin::InputServer::GetInput(), kerosin::InputServer::Invoke(), SoccerInput::ProcessInput(), and kerosin::InputControl::StartCycle().

long kerosin::InputServer::Input::l

this is used to encode a button event. currently only 1 for 'pressed' and 0 for 'released' are used Definition at line 122 of file inputserver.h.

EType kerosin::InputServer::Input::type

this indicates the input data type Definition at line 106 of file inputserver.h. Referenced by TimerSDL::GetInput(), kerosin::InputServer::GetInput(), and kerosin::InputServer::Invoke().

---

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

• inputserver.h

---