cgv
Loading...
Searching...
No Matches
cgv::gui::gamepad_throttle_event Class Reference

gamepad extension of throttle events More...

#include <gamepad_server.h>

Inheritance diagram for cgv::gui::gamepad_throttle_event:
cgv::gui::throttle_event cgv::gui::event

Public Member Functions

 gamepad_throttle_event (void *_device_handle, gamepad::gamepad_state &_state, float _x, float _dx, unsigned _player_index=0, unsigned _controller_index=0, unsigned _throttle_index=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::throttle_event
 throttle_event (float _x, float _dx, unsigned _player_index=0, unsigned _controller_index=0, unsigned _throttle_index=0, double _time=0)
 construct a throttle event from value and value change
unsigned get_player_index () const
 return player index
unsigned get_controller_index () const
 return controller index
unsigned get_throttle_index () const
 return throttle index
void stream_out (std::ostream &os) const
 write to stream
void stream_in (std::istream &is)
 read from stream
float get_value () const
 return the current value of the throttle
float get_value_change () const
 return the change of value of the throttle
float get_last_value () const
 return the last value of the throttle
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::throttle_event
unsigned char player_index
unsigned char controller_index
unsigned char throttle_index
float x
float dx
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 extension of throttle events

Definition at line 35 of file gamepad_server.h.

Constructor & Destructor Documentation

◆ gamepad_throttle_event()

cgv::gui::gamepad_throttle_event::gamepad_throttle_event ( void * _device_handle,
gamepad::gamepad_state & _state,
float _x,
float _dx,
unsigned _player_index = 0,
unsigned _controller_index = 0,
unsigned _throttle_index = 0,
double _time = 0 )

construct a key event from its textual description

Definition at line 37 of file gamepad_server.cxx.

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

Member Function Documentation

◆ get_device_handle()

void * cgv::gui::gamepad_throttle_event::get_device_handle ( ) const
inline

return the device id, by default returns 0

Definition at line 47 of file gamepad_server.h.

References device_handle.

◆ get_state()

const gamepad::gamepad_state & cgv::gui::gamepad_throttle_event::get_state ( ) const
inline

access to current gamepad state

Definition at line 49 of file gamepad_server.h.

References state.

◆ stream_out()

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

write to stream

Reimplemented from cgv::gui::event.

Definition at line 45 of file gamepad_server.cxx.

References device_handle, and cgv::gui::throttle_event::stream_out().

Member Data Documentation

◆ device_handle

void* cgv::gui::gamepad_throttle_event::device_handle
protected

store id of gamepad

Definition at line 39 of file gamepad_server.h.

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

◆ state

const gamepad::gamepad_state& cgv::gui::gamepad_throttle_event::state
protected

public access to game state allows skipping of library dependency

Definition at line 41 of file gamepad_server.h.

Referenced by gamepad_throttle_event(), and get_state().


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