scv::KeyEvent Struct Reference

Contains information about a keyboard event. More...

#include <KeyEvent.h>

Public Types
enum	State { UP, DOWN }

Public Member Functions
	KeyEvent (int key, int mod, bool special, KeyEvent::State state)
std::string	getKeyString () const
	Returns a (usually) human-readable name for the key.
bool	operator== (const KeyEvent &rhs)

Public Attributes
const bool	special
	If true, key is a special function key (arrow, Fn, etc.)
const int	keycode
	The key pressed. If special is true then it is one of the GLUT_KEY_ constants in the GLUT header, else it is an ASCII code.
const int	modifiers
	OR-ed mask of GLUT_ACTIVE_ constants indicating the modifier keys held when the key was pressed.
const KeyEvent::State	state
	Indicates if the key is being pressed or released.

Detailed Description

Contains information about a keyboard event.

Member Enumeration Documentation

enum scv::KeyEvent::State

Enumerator:

UP
DOWN

Constructor & Destructor Documentation

scv::KeyEvent::KeyEvent	(	int	key,
		int	mod,
		bool	special,
		KeyEvent::State	state
	)

Member Function Documentation

std::string scv::KeyEvent::getKeyString

(

)

const

Returns a (usually) human-readable name for the key.

bool scv::KeyEvent::operator==

(

const KeyEvent &

rhs

)

Member Data Documentation

const int scv::KeyEvent::keycode

The key pressed. If special is true then it is one of the GLUT_KEY_ constants in the GLUT header, else it is an ASCII code.

const int scv::KeyEvent::modifiers

OR-ed mask of GLUT_ACTIVE_ constants indicating the modifier keys held when the key was pressed.

const bool scv::KeyEvent::special

If true, key is a special function key (arrow, Fn, etc.)

const KeyEvent::State scv::KeyEvent::state

Indicates if the key is being pressed or released.

---

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

• include/SCV/KeyEvent.h
• SCV/src/KeyEvent.cpp