Cori::Core::KeyEvent Class Reference

#include <KeyEvent.hpp>

Inheritance diagram for Cori::Core::KeyEvent:

Collaboration diagram for Cori::Core::KeyEvent:

Public Member Functions
CoriKeycode	GetKeyCode () const
uint32_t	GetCategoryFlags () const override
	Gives the flags of particular Event.
virtual constexpr std::type_index	GetEventType () const =0
	Gives the return type of the Event.
virtual const char *	GetName () const =0
	This will give you the string version of EventType.
virtual std::string	ToString () const
	Returns the name of the Event.
bool	IsInCategory (const EventCategory category) const
	Checks if the Event is in specific category.

Public Attributes
bool	m_Handled = false

Protected Member Functions
	KeyEvent (const CoriKeycode keycode)

Protected Attributes
CoriKeycode	m_KeyCode { CORI_KEY_UNKNOWN }

Detailed Description

Definition at line 7 of file KeyEvent.hpp.

Constructor & Destructor Documentation

KeyEvent()

Cori::Core::KeyEvent::KeyEvent ( const CoriKeycode keycode )

inlineexplicitprotected

Definition at line 12 of file KeyEvent.hpp.

Member Function Documentation

GetCategoryFlags()

uint32_t Cori::Core::KeyEvent::GetCategoryFlags ( ) const

inlineoverridevirtual

Gives the flags of particular Event.

Note

You shouldn't overload this, it is overloaded by EVENT_CLASS_CATEGORY macro!

Returns

Flag variable that stores all the relevant EventCategory flags.

Implements Cori::Core::Event.

Definition at line 10 of file KeyEvent.hpp.

GetEventType()

virtual constexpr std::type_index Cori::Core::Event::GetEventType ( ) const

nodiscardconstexprpure virtualinherited

Gives the return type of the Event.

Note

You shouldn't overload this, it is overloaded by EVENT_CLASS_TYPE macro!

Returns

Type index of derived event type.

Implemented in Cori::Core::KeyPressedEvent, Cori::Core::KeyReleasedEvent, Cori::Core::MouseButtonPressedEvent, Cori::Core::MouseButtonReleasedEvent, Cori::Core::MouseMovedEvent, Cori::Core::MouseScrolledEvent, Cori::Core::WindowCloseEvent, and Cori::Core::WindowResizeEvent.

GetKeyCode()

CoriKeycode Cori::Core::KeyEvent::GetKeyCode ( ) const

inlinenodiscard

Definition at line 9 of file KeyEvent.hpp.

GetName()

virtual const char * Cori::Core::Event::GetName ( ) const

nodiscardpure virtualinherited

This will give you the string version of EventType.

Note

You shouldn't overload this, it is overloaded by EVENT_CLASS_TYPE macro!

Returns

EventType name.

Implemented in Cori::Core::KeyPressedEvent, Cori::Core::KeyReleasedEvent, Cori::Core::MouseButtonPressedEvent, Cori::Core::MouseButtonReleasedEvent, Cori::Core::MouseMovedEvent, Cori::Core::MouseScrolledEvent, Cori::Core::WindowCloseEvent, and Cori::Core::WindowResizeEvent.

IsInCategory()

bool Cori::Core::Event::IsInCategory ( const EventCategory category ) const

inlinenodiscardinherited

Checks if the Event is in specific category.

Parameters

category

Bitmask that we need to check presence of.

Returns

True is present, false otherwise.

Definition at line 59 of file Event.hpp.

Here is the call graph for this function:

ToString()

virtual std::string Cori::Core::Event::ToString ( ) const

inlinenodiscardvirtualinherited

Returns the name of the Event.

Note

This is up to the user to overload, by default return the same thing GetName() does.

Returns

Event name.

Reimplemented in Cori::Core::KeyPressedEvent, Cori::Core::KeyReleasedEvent, Cori::Core::MouseButtonPressedEvent, Cori::Core::MouseButtonReleasedEvent, Cori::Core::MouseMovedEvent, Cori::Core::MouseScrolledEvent, Cori::Core::WindowCloseEvent, and Cori::Core::WindowResizeEvent.

Definition at line 51 of file Event.hpp.

Here is the call graph for this function:

Member Data Documentation

m_Handled

bool Cori::Core::Event::m_Handled = false

inherited

Definition at line 63 of file Event.hpp.

m_KeyCode

CoriKeycode Cori::Core::KeyEvent::m_KeyCode { CORI_KEY_UNKNOWN }

protected

Definition at line 15 of file KeyEvent.hpp.

---

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

• KeyEvent.hpp