The InputEvent class is the base class for input events such as MouseEvent, TouchEvent, and KeyboardEvent. More...

#include <hps.h>

Inheritance diagram for HPS::InputEvent:

[legend]

Collaboration diagram for HPS::InputEvent:

Public Types
enum	Status : uint32_t { Status::InProgress, Status::Completed, Status::Failed }
	Event Status - returned from a notifier to give the status of the event. More...

Public Member Functions
	InputEvent ()
	This constructor creates a default InputEvent object. More...

	InputEvent (ModifierKeys const &in_modifiers)
	This constructor creates a new InputEvent with the specified modifier keys initialized. More...

	~InputEvent ()

Event *	Clone () const
	Allocates and returns a copy of this InputEvent. More...

virtual bool	Equals (InputEvent const &in_that) const
	Check if the source object is equivalent to this object. More...

virtual bool	operator== (InputEvent const &in_that) const
	Check if the source object is equivalent to this object. More...

virtual bool	operator!= (InputEvent const &in_that) const
	Check if the source object is not equivalent to this object. More...

ModifierKeys	GetModifierKeys () const
	Queries which modifier keys are active. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

virtual bool	Drop (Event const *in_that_event) const
	This optional function is used to determine if the current event can be dropped based on the following event in the queue. More...

virtual intptr_t	Freshen () const
	This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available. More...

intptr_t	GetChannel () const
	Returns the channel ID assigned to an event. More...

Time	GetTimeStamp () const
	Returns the time an event was injected into the event queue. More...

bool	IsConsumable () const
	Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway. More...

Static Public Member Functions
static void *	operator new (size_t in_size)

static void	operator delete (void *in_ptr, size_t in_size) throw ()

Public Attributes
ModifierKeys	ModifierKeyState
	The modifier keys which are active for this InputEvent. More...

Protected Attributes
intptr_t	channel

bool	consumable

Detailed Description

The InputEvent class is the base class for input events such as MouseEvent, TouchEvent, and KeyboardEvent.

It contains functionality which is common to all input event types, namely the state of modifier keys.

Member Enumeration Documentation

◆ Status

enum HPS::Event::Status : uint32_t

stronginherited

Event Status - returned from a notifier to give the status of the event.

Enumerator
InProgress	Event is still in progress.
Completed	Event has completed.
Failed	Event failed.

Constructor & Destructor Documentation

◆ InputEvent() [1/2]

HPS::InputEvent::InputEvent ( )

inline

This constructor creates a default InputEvent object.

◆ InputEvent() [2/2]

HPS::InputEvent::InputEvent ( ModifierKeys const & in_modifiers )

inline

This constructor creates a new InputEvent with the specified modifier keys initialized.

Parameters

in_modifiers The modifier keys associated with the new Event.

◆ ~InputEvent()

HPS::InputEvent::~InputEvent ( )

Member Function Documentation

◆ Clone()

Event* HPS::InputEvent::Clone ( ) const

inlinevirtual

Allocates and returns a copy of this InputEvent.

Returns: A copy of this InputEvent.

Implements HPS::Event.

Reimplemented in HPS::KeyboardEvent, HPS::MouseEvent, and HPS::TouchEvent.

◆ Drop()

virtual bool HPS::Event::Drop ( Event const * in_that_event ) const

inlinevirtualinherited

This optional function is used to determine if the current event can be dropped based on the following event in the queue.

Reimplemented in HPS::MouseEvent, HPS::TouchEvent, HPS::TimerTickEvent, HPS::SmoothTransitionCompleteEvent, and HPS::CameraChangedEvent.

◆ Equals()

virtual bool HPS::InputEvent::Equals ( InputEvent const & in_that ) const

inlinevirtual

Check if the source object is equivalent to this object.

Parameters

in_kit The source object to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

Reimplemented in HPS::KeyboardEvent, HPS::MouseEvent, and HPS::TouchEvent.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Freshen()

virtual intptr_t HPS::Event::Freshen ( ) const

inlinevirtualinherited

This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available.

Returns: A cookie representing the freshen category. Zero indicates a non-freshening event.

Reimplemented in HPS::MouseEvent, HPS::TimerTickEvent, and HPS::CameraChangedEvent.

◆ GetChannel()

intptr_t HPS::Event::GetChannel ( ) const

inlineinherited

Returns the channel ID assigned to an event.

Here is the caller graph for this function:

◆ GetClassID()

intptr_t HPS::Event::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Here is the caller graph for this function:

◆ GetModifierKeys()

ModifierKeys HPS::InputEvent::GetModifierKeys ( ) const

inline

Queries which modifier keys are active.

Returns: A ModifierKeys object, which represents which modifier keys are active

◆ GetTimeStamp()

Time HPS::Event::GetTimeStamp ( ) const

inlineinherited

Returns the time an event was injected into the event queue.

◆ IsConsumable()

bool HPS::Event::IsConsumable ( ) const

inlineinherited

Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway.

◆ operator delete()

static void HPS::Event::operator delete	(	void *	in_ptr,
		size_t	in_size
	)
throw	(
	)

inlinestaticinherited

Here is the call graph for this function:

◆ operator new()

static void* HPS::Event::operator new ( size_t in_size )

inlinestaticinherited

Here is the call graph for this function:

◆ operator!=()

virtual bool HPS::InputEvent::operator!= ( InputEvent const & in_that ) const

inlinevirtual

Check if the source object is not equivalent to this object.

Parameters

in_that The source object to compare to this object.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator==()

virtual bool HPS::InputEvent::operator== ( InputEvent const & in_that ) const

inlinevirtual

Check if the source object is equivalent to this object.

Parameters

in_that The source object to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

Member Data Documentation

◆ channel

intptr_t HPS::Event::channel

protectedinherited

◆ consumable

bool HPS::Event::consumable

protectedinherited

◆ ModifierKeyState

ModifierKeys HPS::InputEvent::ModifierKeyState

The modifier keys which are active for this InputEvent.

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

hps.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Status

Constructor & Destructor Documentation

◆ InputEvent() [1/2]

◆ InputEvent() [2/2]

◆ ~InputEvent()

Member Function Documentation

◆ Clone()

◆ Drop()

◆ Equals()

◆ Freshen()

◆ GetChannel()

◆ GetClassID()

◆ GetModifierKeys()

◆ GetTimeStamp()

◆ IsConsumable()

◆ operator delete()

◆ operator new()

◆ operator!=()

◆ operator==()

Member Data Documentation

◆ channel

◆ consumable

◆ ModifierKeyState