#include <EventHandler.hpp>

Graphe d'héritage de castor3d::EventHandler:

[légende]

Graphe de collaboration de castor3d::EventHandler:

[légende]

Types publics
using	ClientMouseFunction = castor::Function< void( MouseEvent const & ) >

using	ClientKeyboardFunction = castor::Function< void( KeyboardEvent const & ) >

using	ClientHandlerFunction = castor::Function< void( HandlerEvent const & ) >

using	EnableFunction = castor::Function< void( bool ) >

using	OnClientMouseEvent = castor::SignalT< ClientMouseFunction >

using	OnClientKeyboardEvent = castor::SignalT< ClientKeyboardFunction >

using	OnClientHandlerEvent = castor::SignalT< ClientHandlerFunction >

using	OnEnable = castor::SignalT< EnableFunction >

using	OnClientMouseEventConnection = OnClientMouseEvent::connection

using	OnClientKeyboardEventConnection = OnClientKeyboardEvent::connection

using	OnClientHandlerEventConnection = OnClientHandlerEvent::connection

using	OnEnableConnection = OnEnable::connection

Fonctions membres publiques
Mouse events
void	pushEvent (MouseEvent const &event)
	Ajoute un évènement de souris à la file.

void	connect (MouseEventType event, ClientMouseFunction function)
	Connecte un fonction à un évènement souris.

bool	catchesMouseEvents () const

void	setCatchesMouseEvents (bool value)

Keyboard events
void	pushEvent (KeyboardEvent const &event)
	Ajoute un évènement de clavier à la file.

void	connect (KeyboardEventType event, ClientKeyboardFunction function)
	Connecte un fonction à un évènement clavier.

bool	catchesTabKey () const

bool	catchesReturnKey () const

Fonctions membres publiques hérités de castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructeur.

T const &	getName () const noexcept
	Récupère le nom.

void	rename (T name) noexcept

Types protégés
using	EventHandlerFunction = castor::Function< void() >

using	EventQueue = castor::Deque< castor::Pair< UserInputEventSPtr, EventHandlerFunction > >

General
OnEnable	onEnable

	EventHandler (castor::String const &name, bool catchMouseEvents)
	Constructeur.

virtual	~EventHandler () noexcept
	Destructeur.

void	processEvents ()
	Traite tous les évènement dans la file.

bool	isEnabled () const

void	enable ()

void	disable ()

Handler events
castor::Array< OnClientMouseEvent, size_t(MouseEventType::eCount) >	m_mouseSlots

castor::Array< castor::Vector< OnClientMouseEventConnection >, size_t(MouseEventType::eCount) >	m_mouseSlotsConnections

castor::Array< OnClientKeyboardEvent, size_t(KeyboardEventType::eCount) >	m_keyboardSlots

castor::Array< castor::Vector< OnClientKeyboardEventConnection >, size_t(KeyboardEventType::eCount) >	m_keyboardSlotsConnections

castor::Array< OnClientHandlerEvent, size_t(HandlerEventType::eCount) >	m_handlerSlots

castor::Array< castor::Vector< OnClientHandlerEventConnection >, size_t(HandlerEventType::eCount) >	m_handlerSlotsConnections

void	pushEvent (HandlerEvent const &event)
	Ajoute un évènement de gestionnaire à la file.

void	connect (HandlerEventType event, ClientHandlerFunction function)
	Connecte un fonction à un évènement gestionnaire.

void	processMouseEvent (MouseEventSPtr event)
	Fonction de traitement d'un évènement souris.

void	processKeyboardEvent (KeyboardEventSPtr event)
	Fonction de traitement d'un évènement clavier.

void	processHandlerEvent (HandlerEventSPtr event)
	Fonction de traitement d'un évènement de gestionnaire.

Membres hérités additionnels
Attributs protégés hérités de castor::NamedBaseT< T >
T	m_name

Documentation des définitions de type membres

◆ ClientHandlerFunction

using castor3d::EventHandler::ClientHandlerFunction = castor::Function< void( HandlerEvent const & ) >

Définition d'une fonction de traitement d'évènement de gestionnaire.

◆ ClientKeyboardFunction

using castor3d::EventHandler::ClientKeyboardFunction = castor::Function< void( KeyboardEvent const & ) >

Définition d'une fonction de traitement d'évènement de clavier.

◆ ClientMouseFunction

using castor3d::EventHandler::ClientMouseFunction = castor::Function< void( MouseEvent const & ) >

Définition d'une fonction de traitement d'évènement de souris.

◆ EnableFunction

using castor3d::EventHandler::EnableFunction = castor::Function< void( bool ) >

Fonction de signal d'activation/désactivation du gestionnaire.

◆ EventHandlerFunction

using castor3d::EventHandler::EventHandlerFunction = castor::Function< void() >

protected

◆ EventQueue

using castor3d::EventHandler::EventQueue = castor::Deque< castor::Pair< UserInputEventSPtr, EventHandlerFunction > >

protected

◆ OnClientHandlerEvent

using castor3d::EventHandler::OnClientHandlerEvent = castor::SignalT< ClientHandlerFunction >

Définition d'un signal d'évènement de gestionnaire.

◆ OnClientHandlerEventConnection

using castor3d::EventHandler::OnClientHandlerEventConnection = OnClientHandlerEvent::connection

Définition d'une connexion au signal d'évènement de gestionnaire.

◆ OnClientKeyboardEvent

using castor3d::EventHandler::OnClientKeyboardEvent = castor::SignalT< ClientKeyboardFunction >

Définition d'un signal d'évènement de clavier.

◆ OnClientKeyboardEventConnection

using castor3d::EventHandler::OnClientKeyboardEventConnection = OnClientKeyboardEvent::connection

Définition d'une connexion au signal d'évènement de clavier.

◆ OnClientMouseEvent

using castor3d::EventHandler::OnClientMouseEvent = castor::SignalT< ClientMouseFunction >

Définition d'un signal d'évènement de souris.

◆ OnClientMouseEventConnection

using castor3d::EventHandler::OnClientMouseEventConnection = OnClientMouseEvent::connection

Définition d'une connexion au signal d'évènement de souris.

◆ OnEnable

using castor3d::EventHandler::OnEnable = castor::SignalT< EnableFunction >

Signal d'activation/désactivation du gestionnaire.

◆ OnEnableConnection

using castor3d::EventHandler::OnEnableConnection = OnEnable::connection

Connection au signal d'activation/désactivation du gestionnaire.

Documentation des constructeurs et destructeur

◆ EventHandler()

castor3d::EventHandler::EventHandler	(	castor::String const &	name,
		bool	catchMouseEvents )

inlineexplicit

Constructeur.

Paramètres

[in]	name	Le nom du gestionnaire.
[in]	catchMouseEvents	Dit si le gestionnaire d'évènements récupère les évènements souris.

◆ ~EventHandler()

virtual castor3d::EventHandler::~EventHandler ( )

inlinevirtualnoexcept

Destructeur.

Références castor::makeUniqueLock().

Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

◆ catchesMouseEvents()

bool castor3d::EventHandler::catchesMouseEvents ( ) const

inline

◆ catchesReturnKey()

bool castor3d::EventHandler::catchesReturnKey ( ) const

inline

◆ catchesTabKey()

bool castor3d::EventHandler::catchesTabKey ( ) const

inline

◆ connect() [1/3]

void castor3d::EventHandler::connect	(	HandlerEventType	event,
		ClientHandlerFunction	function )

inline

Connecte un fonction à un évènement gestionnaire.

Paramètres

[in]	event	Le type d'évènement.
[in]	function	La fonction.

Références connect(), m_handlerSlots, et m_handlerSlotsConnections.

Voici le graphe d'appel pour cette fonction :

◆ connect() [2/3]

void castor3d::EventHandler::connect	(	KeyboardEventType	event,
		ClientKeyboardFunction	function )

inline

Connecte un fonction à un évènement clavier.

Paramètres

[in]	event	Le type d'évènement.
[in]	function	La fonction.

Références connect(), m_keyboardSlots, et m_keyboardSlotsConnections.

Voici le graphe d'appel pour cette fonction :

◆ connect() [3/3]

void castor3d::EventHandler::connect	(	MouseEventType	event,
		ClientMouseFunction	function )

inline

Connecte un fonction à un évènement souris.

Paramètres

[in]	event	Le type d'évènement.
[in]	function	La fonction.

Références connect(), m_mouseSlots, et m_mouseSlotsConnections.

Référencé par connect(), connect(), connect(), castor3d::NonClientEventHandler< Derived >::connectNC(), castor3d::NonClientEventHandler< Derived >::connectNC(), et castor3d::NonClientEventHandler< Derived >::connectNC().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ disable()

void castor3d::EventHandler::disable ( )

inline

Références onEnable.

◆ enable()

void castor3d::EventHandler::enable ( )

inline

Références onEnable.

◆ isEnabled()

bool castor3d::EventHandler::isEnabled ( ) const

inline

◆ processEvents()

void castor3d::EventHandler::processEvents ( )

inline

Traite tous les évènement dans la file.

◆ processHandlerEvent()

void castor3d::EventHandler::processHandlerEvent ( HandlerEventSPtr event )

inlineprotected

Fonction de traitement d'un évènement de gestionnaire.

Paramètres

[in] event L'évènement.

Références m_handlerSlots.

Référencé par pushEvent().

Voici le graphe des appelants de cette fonction :

◆ processKeyboardEvent()

void castor3d::EventHandler::processKeyboardEvent ( KeyboardEventSPtr event )

inlineprotected

Fonction de traitement d'un évènement clavier.

Paramètres

[in] event L'évènement.

Références m_keyboardSlots.

Référencé par pushEvent().

Voici le graphe des appelants de cette fonction :

◆ processMouseEvent()

void castor3d::EventHandler::processMouseEvent ( MouseEventSPtr event )

inlineprotected

Fonction de traitement d'un évènement souris.

Paramètres

[in] event L'évènement.

Références m_mouseSlots.

Référencé par pushEvent().

Voici le graphe des appelants de cette fonction :

◆ pushEvent() [1/3]

void castor3d::EventHandler::pushEvent ( HandlerEvent const & event )

inline

Ajoute un évènement de gestionnaire à la file.

Paramètres

[in] event L'évènement.

Références castor::makeUniqueLock(), et processHandlerEvent().

Voici le graphe d'appel pour cette fonction :

◆ pushEvent() [2/3]

void castor3d::EventHandler::pushEvent ( KeyboardEvent const & event )

inline

Ajoute un évènement de clavier à la file.

Paramètres

[in] event L'évènement.

Références castor::makeUniqueLock(), et processKeyboardEvent().

Voici le graphe d'appel pour cette fonction :

◆ pushEvent() [3/3]

void castor3d::EventHandler::pushEvent ( MouseEvent const & event )

inline

Ajoute un évènement de souris à la file.

Paramètres

[in] event L'évènement.

Références castor::makeUniqueLock(), et processMouseEvent().

Voici le graphe d'appel pour cette fonction :

◆ setCatchesMouseEvents()

void castor3d::EventHandler::setCatchesMouseEvents ( bool value )

inline

Documentation des données membres

◆ m_handlerSlots

castor::Array< OnClientHandlerEvent, size_t( HandlerEventType::eCount ) > castor3d::EventHandler::m_handlerSlots

protected

Les slots d'évènements de gestionnaire.

Référencé par connect(), et processHandlerEvent().

◆ m_handlerSlotsConnections

castor::Array< castor::Vector< OnClientHandlerEventConnection >, size_t( HandlerEventType::eCount ) > castor3d::EventHandler::m_handlerSlotsConnections

protected

Les connexions aux slots d'évènements de gestionnaire.

Référencé par connect().

◆ m_keyboardSlots

castor::Array< OnClientKeyboardEvent, size_t( KeyboardEventType::eCount ) > castor3d::EventHandler::m_keyboardSlots

protected

Les slots d'évènements clavier.

Référencé par connect(), et processKeyboardEvent().

◆ m_keyboardSlotsConnections

castor::Array< castor::Vector< OnClientKeyboardEventConnection >, size_t( KeyboardEventType::eCount ) > castor3d::EventHandler::m_keyboardSlotsConnections

protected

Les connexions aux slots d'évènements de clavier.

Référencé par connect().

◆ m_mouseSlots

castor::Array< OnClientMouseEvent, size_t( MouseEventType::eCount ) > castor3d::EventHandler::m_mouseSlots

protected

Les slots d'évènements souris.

Référencé par connect(), et processMouseEvent().

◆ m_mouseSlotsConnections

castor::Array< castor::Vector< OnClientMouseEventConnection >, size_t( MouseEventType::eCount ) > castor3d::EventHandler::m_mouseSlotsConnections

protected

Les connexions aux slots d'évènements souris.

Référencé par connect().

◆ onEnable

OnEnable castor3d::EventHandler::onEnable

Référencé par disable(), et enable().

La documentation de cette classe a été générée à partir du fichier suivant :

Castor3D/Event/UserInput/EventHandler.hpp

Types publics

Fonctions membres publiques

Types protégés

General

Handler events

Membres hérités additionnels

Documentation des définitions de type membres

◆ ClientHandlerFunction

◆ ClientKeyboardFunction

◆ ClientMouseFunction

◆ EnableFunction

◆ EventHandlerFunction

◆ EventQueue

◆ OnClientHandlerEvent

◆ OnClientHandlerEventConnection

◆ OnClientKeyboardEvent

◆ OnClientKeyboardEventConnection

◆ OnClientMouseEvent

◆ OnClientMouseEventConnection

◆ OnEnable

◆ OnEnableConnection

Documentation des constructeurs et destructeur

◆ EventHandler()

◆ ~EventHandler()

Documentation des fonctions membres

◆ catchesMouseEvents()

◆ catchesReturnKey()

◆ catchesTabKey()

◆ connect() [1/3]

◆ connect() [2/3]

◆ connect() [3/3]

◆ disable()

◆ enable()

◆ isEnabled()

◆ processEvents()

◆ processHandlerEvent()

◆ processKeyboardEvent()

◆ processMouseEvent()

◆ pushEvent() [1/3]

◆ pushEvent() [2/3]

◆ pushEvent() [3/3]

◆ setCatchesMouseEvents()

Documentation des données membres

◆ m_handlerSlots

◆ m_handlerSlotsConnections

◆ m_keyboardSlots

◆ m_keyboardSlotsConnections

◆ m_mouseSlots

◆ m_mouseSlotsConnections

◆ onEnable