Description d'un gestionnaire d'évènements, classe pouvant recevoir des évènements. Plus de détails...

#include <EventHandler.hpp>

Graphe d'héritage de castor3d::NonClientEventHandler< Derived >:

[légende]

Graphe de collaboration de castor3d::NonClientEventHandler< Derived >:

[légende]

Types publics
using	DerivedPtr = Derived *

using	ClientMouseFunction = EventHandler::ClientMouseFunction

using	ClientKeyboardFunction = EventHandler::ClientKeyboardFunction

using	ClientHandlerFunction = EventHandler::ClientHandlerFunction

using	NonClientMouseFunction = castor::Function< void( DerivedPtr, MouseEvent const & ) >

using	NonClientKeyboardFunction = castor::Function< void( DerivedPtr, KeyboardEvent const & ) >

using	NonClientHandlerFunction = castor::Function< void( DerivedPtr, HandlerEvent const & ) >

using	OnNonClientMouseEvent = castor::SignalT< NonClientMouseFunction >

using	OnNonClientKeyboardEvent = castor::SignalT< NonClientKeyboardFunction >

using	OnNonClientHandlerEvent = castor::SignalT< NonClientHandlerFunction >

using	OnNonClientMouseEventConnection = typename OnNonClientMouseEvent::connection

using	OnNonClientKeyboardEventConnection = typename OnNonClientKeyboardEvent::connection

using	OnNonClientHandlerEventConnection = typename OnNonClientHandlerEvent::connection

Types publics hérités de castor3d::EventHandler
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
	NonClientEventHandler (castor::String const &name, bool catchMouseEvents)
	Constructeur.

void	connectNC (MouseEventType event, NonClientMouseFunction function)
	Connecte un fonction à un évènement souris non client.

void	connectNC (KeyboardEventType event, NonClientKeyboardFunction function)
	Connecte un fonction à un évènement clavier non client.

void	connectNC (HandlerEventType event, NonClientHandlerFunction function)
	Connecte un fonction à un évènement gestionnaire non client.

Fonctions membres publiques hérités de castor3d::EventHandler
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)

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

	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 ()

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.

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 = EventHandler::EventHandlerFunction

using	EventQueue = EventHandler::EventQueue

Types protégés hérités de castor3d::EventHandler
using	EventHandlerFunction = castor::Function< void() >

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

Attributs protégés
castor::Array< OnNonClientMouseEvent, size_t(MouseEventType::eCount) >	m_ncMouseSlots

castor::Array< castor::Vector< OnNonClientMouseEventConnection >, size_t(MouseEventType::eCount) >	m_ncMouseSlotsConnections

castor::Array< OnNonClientKeyboardEvent, size_t(KeyboardEventType::eCount) >	m_ncKeyboardSlots

castor::Array< castor::Vector< OnNonClientKeyboardEventConnection >, size_t(KeyboardEventType::eCount) >	m_ncKeyboardSlotsConnections

castor::Array< OnNonClientHandlerEvent, size_t(HandlerEventType::eCount) >	m_ncHandlerSlots

castor::Array< castor::Vector< OnNonClientHandlerEventConnection >, size_t(HandlerEventType::eCount) >	m_ncHandlerSlotsConnections

Attributs protégés hérités de castor3d::EventHandler
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

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

Membres hérités additionnels
Attributs publics hérités de castor3d::EventHandler
OnEnable	onEnable

Fonctions membres protégées hérités de castor3d::EventHandler
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.

Description détaillée

template<class Derived>
class castor3d::NonClientEventHandler< Derived >

Description d'un gestionnaire d'évènements, classe pouvant recevoir des évènements.

Documentation des définitions de type membres

◆ ClientHandlerFunction

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::ClientHandlerFunction = EventHandler::ClientHandlerFunction

◆ ClientKeyboardFunction

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::ClientKeyboardFunction = EventHandler::ClientKeyboardFunction

◆ ClientMouseFunction

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::ClientMouseFunction = EventHandler::ClientMouseFunction

◆ DerivedPtr

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::DerivedPtr = Derived *

◆ EventHandlerFunction

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::EventHandlerFunction = EventHandler::EventHandlerFunction

protected

◆ EventQueue

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::EventQueue = EventHandler::EventQueue

protected

◆ NonClientHandlerFunction

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::NonClientHandlerFunction = castor::Function< void( DerivedPtr, HandlerEvent const & ) >

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

◆ NonClientKeyboardFunction

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::NonClientKeyboardFunction = castor::Function< void( DerivedPtr, KeyboardEvent const & ) >

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

◆ NonClientMouseFunction

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::NonClientMouseFunction = castor::Function< void( DerivedPtr, MouseEvent const & ) >

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

◆ OnNonClientHandlerEvent

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::OnNonClientHandlerEvent = castor::SignalT< NonClientHandlerFunction >

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

◆ OnNonClientHandlerEventConnection

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::OnNonClientHandlerEventConnection = typename OnNonClientHandlerEvent::connection

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

◆ OnNonClientKeyboardEvent

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::OnNonClientKeyboardEvent = castor::SignalT< NonClientKeyboardFunction >

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

◆ OnNonClientKeyboardEventConnection

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::OnNonClientKeyboardEventConnection = typename OnNonClientKeyboardEvent::connection

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

◆ OnNonClientMouseEvent

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::OnNonClientMouseEvent = castor::SignalT< NonClientMouseFunction >

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

◆ OnNonClientMouseEventConnection

template<class Derived >

using castor3d::NonClientEventHandler< Derived >::OnNonClientMouseEventConnection = typename OnNonClientMouseEvent::connection

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

Documentation des constructeurs et destructeur

◆ NonClientEventHandler()

template<class Derived >

castor3d::NonClientEventHandler< Derived >::NonClientEventHandler	(	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.

Documentation des fonctions membres

◆ connectNC() [1/3]

template<class Derived >

void castor3d::NonClientEventHandler< Derived >::connectNC	(	HandlerEventType	event,
		NonClientHandlerFunction	function )

inline

Connecte un fonction à un évènement gestionnaire non client.

Paramètres

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

Références castor3d::EventHandler::connect(), castor3d::NonClientEventHandler< Derived >::m_ncHandlerSlots, et castor3d::NonClientEventHandler< Derived >::m_ncHandlerSlotsConnections.

Voici le graphe d'appel pour cette fonction :

◆ connectNC() [2/3]

template<class Derived >

void castor3d::NonClientEventHandler< Derived >::connectNC	(	KeyboardEventType	event,
		NonClientKeyboardFunction	function )

inline

Connecte un fonction à un évènement clavier non client.

Paramètres

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

Références castor3d::EventHandler::connect(), castor3d::NonClientEventHandler< Derived >::m_ncKeyboardSlots, et castor3d::NonClientEventHandler< Derived >::m_ncKeyboardSlotsConnections.

Voici le graphe d'appel pour cette fonction :

◆ connectNC() [3/3]

template<class Derived >

void castor3d::NonClientEventHandler< Derived >::connectNC	(	MouseEventType	event,
		NonClientMouseFunction	function )

inline

Connecte un fonction à un évènement souris non client.

Paramètres

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

Références castor3d::EventHandler::connect(), castor3d::NonClientEventHandler< Derived >::m_ncMouseSlots, et castor3d::NonClientEventHandler< Derived >::m_ncMouseSlotsConnections.

Voici le graphe d'appel pour cette fonction :

Documentation des données membres

◆ m_ncHandlerSlots

template<class Derived >

castor::Array< OnNonClientHandlerEvent, size_t( HandlerEventType::eCount ) > castor3d::NonClientEventHandler< Derived >::m_ncHandlerSlots

protected

Les slots d'évènements de gestionnaire non clients.

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

◆ m_ncHandlerSlotsConnections

template<class Derived >

castor::Array< castor::Vector< OnNonClientHandlerEventConnection >, size_t( HandlerEventType::eCount ) > castor3d::NonClientEventHandler< Derived >::m_ncHandlerSlotsConnections

protected

Les slots d'évènements de gestionnaire non clients.

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

◆ m_ncKeyboardSlots

template<class Derived >

castor::Array< OnNonClientKeyboardEvent, size_t( KeyboardEventType::eCount ) > castor3d::NonClientEventHandler< Derived >::m_ncKeyboardSlots

protected

Les slots d'évènements clavier non clients.

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

◆ m_ncKeyboardSlotsConnections

template<class Derived >

castor::Array< castor::Vector< OnNonClientKeyboardEventConnection >, size_t( KeyboardEventType::eCount ) > castor3d::NonClientEventHandler< Derived >::m_ncKeyboardSlotsConnections

protected

Les slots d'évènements clavier non clients.

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

◆ m_ncMouseSlots

template<class Derived >

castor::Array< OnNonClientMouseEvent, size_t( MouseEventType::eCount ) > castor3d::NonClientEventHandler< Derived >::m_ncMouseSlots

protected

Les slots d'évènements souris non clients.

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

◆ m_ncMouseSlotsConnections

template<class Derived >

castor::Array< castor::Vector< OnNonClientMouseEventConnection >, size_t( MouseEventType::eCount ) > castor3d::NonClientEventHandler< Derived >::m_ncMouseSlotsConnections

protected

Les slots d'évènements souris non clients.

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

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

Attributs protégés

Membres hérités additionnels

Description détaillée

Documentation des définitions de type membres

◆ ClientHandlerFunction

◆ ClientKeyboardFunction

◆ ClientMouseFunction

◆ DerivedPtr

◆ EventHandlerFunction

◆ EventQueue

◆ NonClientHandlerFunction

◆ NonClientKeyboardFunction

◆ NonClientMouseFunction

◆ OnNonClientHandlerEvent

◆ OnNonClientHandlerEventConnection

◆ OnNonClientKeyboardEvent

◆ OnNonClientKeyboardEventConnection

◆ OnNonClientMouseEvent

◆ OnNonClientMouseEventConnection

Documentation des constructeurs et destructeur

◆ NonClientEventHandler()

Documentation des fonctions membres

◆ connectNC() [1/3]

◆ connectNC() [2/3]

◆ connectNC() [3/3]

Documentation des données membres

◆ m_ncHandlerSlots

◆ m_ncHandlerSlotsConnections

◆ m_ncKeyboardSlots

◆ m_ncKeyboardSlotsConnections

◆ m_ncMouseSlots

◆ m_ncMouseSlotsConnections