Inputable Class Reference

#include <Inputable.h>

Inheritance diagram for Inputable:

Collaboration diagram for Inputable:

Classes
struct	RegistrationData

Public Types
using	RegistrationID = std::pair< InputKey, KeyEvent >
using	RegDataMap = std::map< RegistrationID, RegistrationData >
using	RegDataMapPair = std::pair< RegistrationID, RegistrationData >

Public Member Functions
	Inputable ()
	Inputable (const Inputable &)=delete
Inputable &	operator= (const Inputable &)=delete
virtual	~Inputable ()
virtual void	KeyPressed (AZUL_KEY k)
	Callback for KeyPressed event on a keyboard key. To be overridden by the user.
virtual void	KeyReleased (AZUL_KEY k)
	Callback for KeyReleased event on a keyboard key. To be overridden by the user.
virtual void	KeyPressed (AZUL_MOUSE m)
	Callback for KeyPressed event on a mouse button. To be overridden by the user.
virtual void	KeyReleased (AZUL_MOUSE m)
	Callback for KeyReleased event on a mouse button. To be overridden by the user.
void	SubmitRegistration (AZUL_KEY k, KeyEvent ev)
	Submit input registration for the specified AZUL_KEY and KeyEvent to the currently active Scene.
void	SubmitDeregistration (AZUL_KEY k, KeyEvent ev)
	Submit input deregistration for the specified AZUL_KEY and KeyEvent from the currently active Scene.
void	SubmitRegistration (AZUL_MOUSE m, KeyEvent ev)
	Submit input registration for the specified AZUL_MOUSE and KeyEvent to the currently active Scene.
void	SubmitDeregistration (AZUL_MOUSE m, KeyEvent ev)
	Submit input deregistration for the specified AZUL_MOUSE and KeyEvent from the currently active Scene.

Private Member Functions
RegistrationData &	GetRegData (InputKey k, KeyEvent ev)
void	privSubmitRegistration (InputKey k, KeyEvent ev)
void	privSubmitDeregistration (InputKey k, KeyEvent ev)
void	RegisterToScene (InputKey k, KeyEvent ev)
void	DeregisterFromScene (InputKey k, KeyEvent ev)
KeyListener::StorageListRef	GetDeregRef (InputKey k, KeyEvent ev)
void	SetDeregRef (InputKey k, KeyEvent ev, KeyListener::StorageListRef ref)

Private Attributes
RegDataMap	m_regData

Friends
class	InputableAttorney

Member Typedef Documentation

RegDataMap

using Inputable::RegDataMap = std::map<RegistrationID, RegistrationData>

RegDataMapPair

using Inputable::RegDataMapPair = std::pair<RegistrationID, RegistrationData>

RegistrationID

using Inputable::RegistrationID = std::pair<InputKey, KeyEvent>

Constructor & Destructor Documentation

Inputable() [1/2]

Inputable::Inputable ( )

inline

Inputable() [2/2]

Inputable::Inputable ( const Inputable &  )

delete

~Inputable()

Inputable::~Inputable ( )

virtual

Member Function Documentation

DeregisterFromScene()

void Inputable::DeregisterFromScene ( InputKey  k, KeyEvent  ev  )

private

GetDeregRef()

KeyListener::StorageListRef Inputable::GetDeregRef ( InputKey  k, KeyEvent  ev  )

private

GetRegData()

Inputable::RegistrationData & Inputable::GetRegData ( InputKey  k, KeyEvent  ev  )

private

KeyPressed() [1/2]

virtual void Inputable::KeyPressed ( AZUL_KEY  k )

inlinevirtual

Callback for KeyPressed event on a keyboard key. To be overridden by the user.

Haru, 3/19/2023.

Parameters

k	The AZUL_KEY that triggered the callback.

KeyPressed() [2/2]

virtual void Inputable::KeyPressed ( AZUL_MOUSE  m )

inlinevirtual

Callback for KeyPressed event on a mouse button. To be overridden by the user.

Haru, 3/19/2023.

Parameters

m	The AZUL_MOUSE that triggered the callback.

KeyReleased() [1/2]

virtual void Inputable::KeyReleased ( AZUL_KEY  k )

inlinevirtual

Callback for KeyReleased event on a keyboard key. To be overridden by the user.

Haru, 3/19/2023.

Parameters

k	The AZUL_KEY that triggered the callback.

KeyReleased() [2/2]

virtual void Inputable::KeyReleased ( AZUL_MOUSE  m )

inlinevirtual

Callback for KeyReleased event on a mouse button. To be overridden by the user.

Haru, 3/19/2023.

Parameters

m	The AZUL_MOUSE that triggered the callback.

operator=()

Inputable & Inputable::operator= ( const Inputable &  )

delete

privSubmitDeregistration()

void Inputable::privSubmitDeregistration ( InputKey  k, KeyEvent  ev  )

private

privSubmitRegistration()

void Inputable::privSubmitRegistration ( InputKey  k, KeyEvent  ev  )

private

RegisterToScene()

void Inputable::RegisterToScene ( InputKey  k, KeyEvent  ev  )

private

SetDeregRef()

void Inputable::SetDeregRef ( InputKey  k, KeyEvent  ev, KeyListener::StorageListRef  ref  )

private

SubmitDeregistration() [1/2]

void Inputable::SubmitDeregistration	(	AZUL_KEY	k,
		KeyEvent	ev
	)

Submit input deregistration for the specified AZUL_KEY and KeyEvent from the currently active Scene.

Haru, 3/19/2023.

Parameters

k	The AZUL_KEY to deregister from.
ev	The KeyEvent to deregister from.

SubmitDeregistration() [2/2]

void Inputable::SubmitDeregistration	(	AZUL_MOUSE	m,
		KeyEvent	ev
	)

Submit input deregistration for the specified AZUL_MOUSE and KeyEvent from the currently active Scene.

Haru, 3/19/2023.

Parameters

m	The AZUL_MOUSE to deregister from.
ev	The KeyEvent to deregister from.

SubmitRegistration() [1/2]

void Inputable::SubmitRegistration	(	AZUL_KEY	k,
		KeyEvent	ev
	)

Submit input registration for the specified AZUL_KEY and KeyEvent to the currently active Scene.

Haru, 3/19/2023.

Parameters

k	The AZUL_KEY to register for.
ev	The KeyEvent to register for.

SubmitRegistration() [2/2]

void Inputable::SubmitRegistration	(	AZUL_MOUSE	m,
		KeyEvent	ev
	)

Submit input registration for the specified AZUL_MOUSE and KeyEvent to the currently active Scene.

Haru, 3/19/2023.

Parameters

m	An AZUL_MOUSE to register for.
ev	The KeyEvent to register for.

Friends And Related Function Documentation

InputableAttorney

friend class InputableAttorney

friend

Member Data Documentation

m_regData

RegDataMap Inputable::m_regData

private

---

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

• Inputable.h
• Inputable.cpp