Référence de la classe castor3d::EventHandler

#include <EventHandler.hpp>

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

Graphe de collaboration de castor3d::EventHandler:

Types publics
using	ClientMouseFunction = std::function< void(MouseEvent const &) >
using	ClientKeyboardFunction = std::function< void(KeyboardEvent const &) >
using	ClientHandlerFunction = std::function< void(HandlerEvent const &) >
using	EnableFunction = std::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
General
	EventHandler (castor::String const &name, bool catchMouseEvents)
virtual	~EventHandler ()
void	processEvents ()
Mouse events
void	pushEvent (MouseEvent const &event)
void	connect (MouseEventType event, ClientMouseFunction function)

Types protégés
using	EventHandlerFunction = std::function< void() >
using	EventQueue = std::deque< std::pair< UserInputEventSPtr, EventHandlerFunction > >

Keyboard events
OnEnable	onEnable
std::array< OnClientMouseEvent, size_t(MouseEventType::eCount) >	m_mouseSlots
std::array< std::vector< OnClientMouseEventConnection >, size_t(MouseEventType::eCount) >	m_mouseSlotsConnections
std::array< OnClientKeyboardEvent, size_t(KeyboardEventType::eCount) >	m_keyboardSlots
std::array< std::vector< OnClientKeyboardEventConnection >, size_t(KeyboardEventType::eCount) >	m_keyboardSlotsConnections
std::array< OnClientHandlerEvent, size_t(HandlerEventType::eCount) >	m_handlerSlots
std::array< std::vector< OnClientHandlerEventConnection >, size_t(HandlerEventType::eCount) >	m_handlerSlotsConnections
void	pushEvent (KeyboardEvent const &event)
void	connect (KeyboardEventType event, ClientKeyboardFunction function)
bool	catchesMouseEvents () const
void	setCatchesMouseEvents (bool value)
bool	isEnabled () const
void	enable ()
void	disable ()
void	pushEvent (HandlerEvent const &event)
void	connect (HandlerEventType event, ClientHandlerFunction function)
bool	catchesTabKey () const
bool	catchesReturnKey () const
void	processMouseEvent (MouseEventSPtr event)
void	processKeyboardEvent (KeyboardEventSPtr event)
void	processHandlerEvent (HandlerEventSPtr event)

Documentation des définitions de type membres

ClientHandlerFunction

using castor3d::EventHandler::ClientHandlerFunction = std::function< void( HandlerEvent const & ) >

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

ClientKeyboardFunction

using castor3d::EventHandler::ClientKeyboardFunction = std::function< void( KeyboardEvent const & ) >

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

ClientMouseFunction

using castor3d::EventHandler::ClientMouseFunction = std::function< void( MouseEvent const & ) >

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

EnableFunction

using castor3d::EventHandler::EnableFunction = std::function< void( bool ) >

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

EventHandlerFunction

using castor3d::EventHandler::EventHandlerFunction = std::function< void() >

protected

EventQueue

using castor3d::EventHandler::EventQueue = std::deque< std::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

~EventHandler()

virtual castor3d::EventHandler::~EventHandler ( )

inlinevirtual

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

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

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

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

Référencé par connect(), 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

processHandlerEvent()

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

inlineprotected

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

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

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

Références processHandlerEvent().

Voici le graphe d'appel pour cette fonction :

pushEvent() [2/3]

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

inline

Références processKeyboardEvent().

Voici le graphe d'appel pour cette fonction :

pushEvent() [3/3]

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

inline

Références processMouseEvent().

Voici le graphe d'appel pour cette fonction :

setCatchesMouseEvents()

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

inline

Documentation des données membres

m_handlerSlots

std::array< OnClientHandlerEvent, size_t( HandlerEventType::eCount ) > castor3d::EventHandler::m_handlerSlots

protected

Les slots d'évènements clavier.

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

m_handlerSlotsConnections

std::array< std::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

std::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

std::array< std::vector< OnClientKeyboardEventConnection >, size_t( KeyboardEventType::eCount ) > castor3d::EventHandler::m_keyboardSlotsConnections

protected

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

Référencé par connect().

m_mouseSlots

std::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

std::array< std::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 :

• Event/UserInput/EventHandler.hpp