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

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

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

Types publics
using	ClientMouseFunction = EventHandler::ClientMouseFunction

using	ClientKeyboardFunction = EventHandler::ClientKeyboardFunction

using	ClientHandlerFunction = EventHandler::ClientHandlerFunction

using	NonClientMouseFunction = std::function< void(DerivedSPtr, MouseEvent const &) >

using	NonClientKeyboardFunction = std::function< void(DerivedSPtr, KeyboardEvent const &) >

using	NonClientHandlerFunction = std::function< void(DerivedSPtr, HandlerEvent const &) >

using	OnNonClientMouseEvent = Castor::Signal< NonClientMouseFunction >

using	OnNonClientKeyboardEvent = Castor::Signal< NonClientKeyboardFunction >

using	OnNonClientHandlerEvent = Castor::Signal< 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 = std::function< void(MouseEvent const &) >

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

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

using	OnClientMouseEvent = Castor::Signal< ClientMouseFunction >

using	OnClientKeyboardEvent = Castor::Signal< ClientKeyboardFunction >

using	OnClientHandlerEvent = Castor::Signal< ClientHandlerFunction >

using	OnClientMouseEventConnection = OnClientMouseEvent::connection

using	OnClientKeyboardEventConnection = OnClientKeyboardEvent::connection

using	OnClientHandlerEventConnection = OnClientHandlerEvent::connection

Fonctions membres publiques
	DECLARE_SMART_PTR (Derived)

	NonClientEventHandler (bool p_catchMouseEvents)

void	ConnectNC (MouseEventType p_event, NonClientMouseFunction p_function)

void	ConnectNC (KeyboardEventType p_event, NonClientKeyboardFunction p_function)

void	ConnectNC (HandlerEventType p_event, NonClientHandlerFunction p_function)

Fonctions membres publiques hérités de Castor3D::EventHandler
	EventHandler (bool p_catchMouseEvents)

virtual	~EventHandler ()

void	ProcessEvents ()

void	PushEvent (MouseEvent const &p_event)

void	Connect (MouseEventType p_event, ClientMouseFunction p_function)

void	PushEvent (KeyboardEvent const &p_event)

void	Connect (KeyboardEventType p_event, ClientKeyboardFunction p_function)

bool	CatchesMouseEvents () const

void	SetCatchesMouseEvents (bool p_value)

void	PushEvent (HandlerEvent const &p_event)

void	Connect (HandlerEventType p_event, ClientHandlerFunction p_function)

bool	CatchesTabKey () const

bool	CatchesReturnKey () const

Types protégés
using	EventHandlerFunction = EventHandler::EventHandlerFunction

using	EventQueue = EventHandler::EventQueue

Types protégés hérités de Castor3D::EventHandler
using	EventHandlerFunction = std::function< void() >

using	EventQueue = std::deque< std::pair< UserInputEventSPtr, EventHandlerFunction > >

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

std::array< std::vector< OnNonClientMouseEventConnection >, size_t(MouseEventType::eCount) >	m_ncMouseSlotsConnections

std::array< OnNonClientKeyboardEvent, size_t(KeyboardEventType::eCount) >	m_ncKeyboardSlots

std::array< std::vector< OnNonClientKeyboardEventConnection >, size_t(KeyboardEventType::eCount) >	m_ncKeyboardSlotsConnections

std::array< OnNonClientHandlerEvent, size_t(HandlerEventType::eCount) >	m_ncHandlerSlots

std::array< std::vector< OnNonClientHandlerEventConnection >, size_t(HandlerEventType::eCount) >	m_ncHandlerSlotsConnections

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

Membres hérités additionnels
Fonctions membres protégées hérités de Castor3D::EventHandler
void	ProcessMouseEvent (MouseEventSPtr p_event)

void	ProcessKeyboardEvent (KeyboardEventSPtr p_event)

void	ProcessHandlerEvent (HandlerEventSPtr p_event)

Description détaillée

template<class Derived>
class Castor3D::NonClientEventHandler< Derived >

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

Auteur: Sylvain DOREMUS

Date: 17/04/2016

Version: 0.9.0

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

◆ 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 = std::function< void( DerivedSPtr, 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 = std::function< void( DerivedSPtr, 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 = std::function< void( DerivedSPtr, 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::Signal< 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::Signal< 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::Signal< 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 ( bool p_catchMouseEvents )

inlineexplicit

Documentation des fonctions membres

◆ ConnectNC() [1/3]

template<class Derived >

void Castor3D::NonClientEventHandler< Derived >::ConnectNC	(	MouseEventType	p_event,
		NonClientMouseFunction	p_function
	)

inline

◆ ConnectNC() [2/3]

template<class Derived >

void Castor3D::NonClientEventHandler< Derived >::ConnectNC	(	KeyboardEventType	p_event,
		NonClientKeyboardFunction	p_function
	)

inline

◆ ConnectNC() [3/3]

template<class Derived >

void Castor3D::NonClientEventHandler< Derived >::ConnectNC	(	HandlerEventType	p_event,
		NonClientHandlerFunction	p_function
	)

inline

◆ DECLARE_SMART_PTR()

template<class Derived >

Castor3D::NonClientEventHandler< Derived >::DECLARE_SMART_PTR ( Derived )

Documentation des données membres

◆ m_ncHandlerSlots

template<class Derived >

std::array< OnNonClientHandlerEvent, size_t( HandlerEventType::eCount ) > Castor3D::NonClientEventHandler< Derived >::m_ncHandlerSlots

protected

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

◆ m_ncHandlerSlotsConnections

template<class Derived >

std::array< std::vector< OnNonClientHandlerEventConnection >, size_t( HandlerEventType::eCount ) > Castor3D::NonClientEventHandler< Derived >::m_ncHandlerSlotsConnections

protected

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

◆ m_ncKeyboardSlots

template<class Derived >

std::array< OnNonClientKeyboardEvent, size_t( KeyboardEventType::eCount ) > Castor3D::NonClientEventHandler< Derived >::m_ncKeyboardSlots

protected

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

◆ m_ncKeyboardSlotsConnections

template<class Derived >

std::array< std::vector< OnNonClientKeyboardEventConnection >, size_t( KeyboardEventType::eCount ) > Castor3D::NonClientEventHandler< Derived >::m_ncKeyboardSlotsConnections

protected

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

◆ m_ncMouseSlots

template<class Derived >

std::array< OnNonClientMouseEvent, size_t( MouseEventType::eCount ) > Castor3D::NonClientEventHandler< Derived >::m_ncMouseSlots

protected

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

◆ m_ncMouseSlotsConnections

template<class Derived >

std::array< std::vector< OnNonClientMouseEventConnection >, size_t( MouseEventType::eCount ) > Castor3D::NonClientEventHandler< Derived >::m_ncMouseSlotsConnections

protected

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

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

Y:/software/perso/Castor3D/source/Core/Castor3D/Src/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

template<class Derived> class Castor3D::NonClientEventHandler< Derived >

Documentation des définitions de type membres

◆ ClientHandlerFunction

◆ ClientKeyboardFunction

◆ ClientMouseFunction

◆ 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]

◆ DECLARE_SMART_PTR()

Documentation des données membres

◆ m_ncHandlerSlots

◆ m_ncHandlerSlotsConnections

◆ m_ncKeyboardSlots

◆ m_ncKeyboardSlotsConnections

◆ m_ncMouseSlots

◆ m_ncMouseSlotsConnections

template<class Derived>
class Castor3D::NonClientEventHandler< Derived >