gamepad key events use the key codes defined in gamepad::GamepadKeys More...

#include <gamepad_server.h>

Inheritance diagram for cgv::gui::gamepad_key_event:

Public Member Functions
	gamepad_key_event (void *_device_handle, const gamepad::gamepad_state &_state, unsigned short _key=0, KeyAction _action=KA_PRESS, unsigned char _char=0, double _time=0)
	construct a key event from its textual description
void *	get_device_handle () const
	return the device id, by default returns 0
const gamepad::gamepad_state &	get_state () const
	access to current gamepad state
void	stream_out (std::ostream &os) const
	write to stream
Public Member Functions inherited from cgv::gui::key_event
	key_event (unsigned short _key=0, KeyAction _action=KA_PRESS, unsigned char _char=0, unsigned char _modifiers=0, unsigned char _toggle_keys=0, double _time=0, int _x=0, int _y=0)
	construct a key event from its textual description
void	stream_out (std::ostream &os) const
	write to stream
void	stream_in (std::istream &is)
	read from stream
unsigned short	get_key () const
	return the key being a capital letter, digit or a value from the Keys enum
void	set_key (unsigned short _key)
	set the key
KeyAction	get_action () const
	return the key event action
void	set_action (KeyAction _action)
	set the key event action
unsigned char	get_char () const
	return the key as a character
void	set_char (unsigned char _char)
	set the alpha numeric character
short	get_x () const
	current mouse x position (origin is top-left of window)
short	get_y () const
	current mouse y position (origin is top-left of window)
Public Member Functions inherited from cgv::gui::event
	event (unsigned int _kind=EID_NONE, unsigned char _modifiers=0, unsigned char _toggle_keys=0, double _time=0)
	construct event from its kind
virtual	~event ()
	virtual destructor for events
virtual void *	get_device_id () const
	return the device id, by default returns 0
void	set_kind (unsigned char _kind)
	set the kind of the event
unsigned	get_kind () const
	return, what kind of event this is, typically a value from the EventId enum
void	set_flags (unsigned char _flags)
	return the set the event flags
unsigned	get_flags () const
	return the event flags
void	set_modifiers (unsigned char _modifiers)
	set the modifiers
unsigned char	get_modifiers () const
	return the active modifiers as values from EventModifier combined with a logical or-operation
void	set_toggle_keys (unsigned char _toggle_keys)
	set the state of the toggle keys
unsigned char	get_toggle_keys () const
	return the state of the toggle keys as values from EventToggleKeys combined with a logical or-operation
void	set_time (const double &_time)
	set the time of the event
double	get_time () const
	return the time of the event in seconds

Protected Attributes
void *	device_handle
	store id of gamepad
const gamepad::gamepad_state &	state
	public access to game state allows skipping of library dependency
Protected Attributes inherited from cgv::gui::key_event
unsigned short	key
	store the pressed key
unsigned char	action
	store whether
unsigned char	character
	store the corresponding ascii character
short	x
	x position of mouse pointer
short	y
	y position of mouse pointer
Protected Attributes inherited from cgv::gui::event
unsigned char	kind
	store which kind of event we have
unsigned char	flags
	store event flags
unsigned char	modifiers
	store the active modifiers
unsigned char	toggle_keys
	store the active toggle keys
double	time
	store the time of the event in seconds

Detailed Description

gamepad key events use the key codes defined in gamepad::GamepadKeys

Definition at line 16 of file gamepad_server.h.

Constructor & Destructor Documentation

◆ gamepad_key_event()

cgv::gui::gamepad_key_event::gamepad_key_event	(	void *	_device_handle,
		const gamepad::gamepad_state &	_state,
		unsigned short	_key = 0,
		KeyAction	_action = KA_PRESS,
		unsigned char	_char = 0,
		double	_time = 0 )

construct a key event from its textual description

Definition at line 10 of file gamepad_server.cxx.

References device_handle, cgv::gui::EF_PAD, cgv::gui::event::flags, cgv::gui::key_event::key_event(), and state.

Member Function Documentation

◆ get_device_handle()

void * cgv::gui::gamepad_key_event::get_device_handle ( ) const

inline

return the device id, by default returns 0

Definition at line 27 of file gamepad_server.h.

References device_handle.

◆ get_state()

const gamepad::gamepad_state & cgv::gui::gamepad_key_event::get_state ( ) const

inline

access to current gamepad state

Definition at line 29 of file gamepad_server.h.

References state.

◆ stream_out()

void cgv::gui::gamepad_key_event::stream_out ( std::ostream & os ) const

virtual

write to stream

Reimplemented from cgv::gui::event.

Definition at line 17 of file gamepad_server.cxx.

References cgv::gui::key_event::action, device_handle, cgv::gui::key_event::get_char(), cgv::gui::KA_PRESS, cgv::gui::KA_RELEASE, cgv::gui::KA_REPEAT, cgv::gui::key_event::key, and cgv::gui::event::stream_out().

Member Data Documentation

◆ device_handle

void* cgv::gui::gamepad_key_event::device_handle

protected

store id of gamepad

Definition at line 20 of file gamepad_server.h.

Referenced by gamepad_key_event(), get_device_handle(), and stream_out().

◆ state

const gamepad::gamepad_state& cgv::gui::gamepad_key_event::state

protected

public access to game state allows skipping of library dependency

Definition at line 22 of file gamepad_server.h.

Referenced by gamepad_key_event(), and get_state().

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

libs/cg_gamepad/gamepad_server.h
libs/cg_gamepad/gamepad_server.cxx

Public Member Functions

Protected Attributes