Classe utilisée pour gérer les évènements utilisateur. Plus de détails...

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

Graphe de collaboration de castor3d::UserInputListener:

Types publics
using	OnClickActionFunction = std::function< void() >

using	OnSelectActionFunction = std::function< void(int) >

using	OnTextActionFunction = std::function< void(castor::String const &) >

Fonctions membres publiques
Output events
C3D_API void	registerClickAction (castor::String const &p_handler, OnClickActionFunction p_function)

C3D_API void	registerSelectAction (castor::String const &p_handler, OnSelectActionFunction p_function)

C3D_API void	registerTextAction (castor::String const &p_handler, OnTextActionFunction p_function)

C3D_API void	unregisterClickAction (castor::String const &p_handler)

C3D_API void	unregisterSelectAction (castor::String const &p_handler)

C3D_API void	unregisterTextAction (castor::String const &p_handler)

C3D_API void	onClickAction (castor::String const &p_handler)

C3D_API void	onSelectAction (castor::String const &p_handler, int p_index)

C3D_API void	onTextAction (castor::String const &p_handler, castor::String const &p_text)

Mouse input events
C3D_API bool	fireMouseMove (castor::Position const &p_position)

C3D_API bool	fireMouseButtonPushed (MouseButton p_button)

C3D_API bool	fireMouseButtonReleased (MouseButton p_button)

C3D_API bool	fireMouseWheel (castor::Position const &p_offsets)

Keyboard input events
C3D_API bool	fireKeydown (KeyboardKey p_key, bool p_ctrl, bool p_alt, bool p_shift)

C3D_API bool	fireKeyUp (KeyboardKey p_key, bool p_ctrl, bool p_alt, bool p_shift)

C3D_API bool	fireChar (KeyboardKey p_key, castor::String const &p_char)

Overlay events
virtual C3D_API bool	fireMaterialEvent (castor::String const &p_overlay, castor::String const &p_material)

virtual C3D_API bool	fireTextEvent (castor::String const &p_overlay, castor::String const &p_caption)

Fonctions membres protégées
std::vector< EventHandlerSPtr >	doGetHandlers () const

bool	doHasHandlers () const

void	doAddHandler (EventHandlerSPtr p_handler)

void	doRemoveHandler (EventHandlerSPtr p_handler)

Attributs protégés
std::mutex	m_mutexHandlers

std::vector< EventHandlerSPtr >	m_handlers

FrameListenerSPtr	m_frameListener

General
C3D_API	UserInputListener (Engine &engine, castor::String const &p_name)

virtual C3D_API	~UserInputListener ()

C3D_API bool	initialise ()

C3D_API void	cleanup ()

C3D_API void	processEvents ()

castor::Position const &	getMousePosition () const

EventHandlerSPtr	getActiveControl () const

EventHandlerSPtr	getFocusedControl () const

Description détaillée

Classe utilisée pour gérer les évènements utilisateur.

Auteur: Sylvain DOREMUS

Date: 17/04/2016

Version: 0.9.0

Documentation des définitions de type membres

◆ OnClickActionFunction

using castor3d::UserInputListener::OnClickActionFunction = std::function< void() >

◆ OnSelectActionFunction

using castor3d::UserInputListener::OnSelectActionFunction = std::function< void( int ) >

◆ OnTextActionFunction

using castor3d::UserInputListener::OnTextActionFunction = std::function< void( castor::String const & ) >

Documentation des constructeurs et destructeur

◆ UserInputListener()

C3D_API castor3d::UserInputListener::UserInputListener	(	Engine &	engine,
		castor::String const &	p_name
	)

◆ ~UserInputListener()

virtual C3D_API castor3d::UserInputListener::~UserInputListener ( )

virtual

Documentation des fonctions membres

◆ cleanup()

C3D_API void castor3d::UserInputListener::cleanup ( )

◆ doAddHandler()

void castor3d::UserInputListener::doAddHandler ( EventHandlerSPtr p_handler )

inlineprotected

Références m_handlers, et m_mutexHandlers.

◆ doGetHandlers()

std::vector< EventHandlerSPtr > castor3d::UserInputListener::doGetHandlers ( ) const

inlineprotected

Renvoie: Les gestionnaires, de manière thread-safe.

Références m_handlers, et m_mutexHandlers.

◆ doHasHandlers()

bool castor3d::UserInputListener::doHasHandlers ( ) const

inlineprotected

Renvoie: true s'il y a des gestionnaires.

Références m_handlers, et m_mutexHandlers.

◆ doRemoveHandler()

void castor3d::UserInputListener::doRemoveHandler ( EventHandlerSPtr p_handler )

inlineprotected

Références C3D_API, m_handlers, et m_mutexHandlers.

◆ fireChar()

C3D_API bool castor3d::UserInputListener::fireChar	(	KeyboardKey	p_key,
		castor::String const &	p_char
	)

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ fireKeydown()

C3D_API bool castor3d::UserInputListener::fireKeydown	(	KeyboardKey	p_key,
		bool	p_ctrl,
		bool	p_alt,
		bool	p_shift
	)

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ fireKeyUp()

C3D_API bool castor3d::UserInputListener::fireKeyUp	(	KeyboardKey	p_key,
		bool	p_ctrl,
		bool	p_alt,
		bool	p_shift
	)

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ fireMaterialEvent()

virtual C3D_API bool castor3d::UserInputListener::fireMaterialEvent	(	castor::String const &	p_overlay,
		castor::String const &	p_material
	)

virtual

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ fireMouseButtonPushed()

C3D_API bool castor3d::UserInputListener::fireMouseButtonPushed ( MouseButton p_button )

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ fireMouseButtonReleased()

C3D_API bool castor3d::UserInputListener::fireMouseButtonReleased ( MouseButton p_button )

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ fireMouseMove()

C3D_API bool castor3d::UserInputListener::fireMouseMove ( castor::Position const & p_position )

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ fireMouseWheel()

C3D_API bool castor3d::UserInputListener::fireMouseWheel ( castor::Position const & p_offsets )

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ fireTextEvent()

virtual C3D_API bool castor3d::UserInputListener::fireTextEvent	(	castor::String const &	p_overlay,
		castor::String const &	p_caption
	)

virtual

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ getActiveControl()

EventHandlerSPtr castor3d::UserInputListener::getActiveControl ( ) const

inline

Renvoie: Le contrôle actif.

◆ getFocusedControl()

EventHandlerSPtr castor3d::UserInputListener::getFocusedControl ( ) const

inline

Renvoie: Le contrôle ayant le focus.

Références C3D_API, fireChar(), fireKeydown(), fireKeyUp(), fireMaterialEvent(), fireMouseButtonPushed(), fireMouseButtonReleased(), fireMouseMove(), fireMouseWheel(), fireTextEvent(), onClickAction(), onSelectAction(), onTextAction(), registerClickAction(), registerSelectAction(), registerTextAction(), unregisterClickAction(), unregisterSelectAction(), et unregisterTextAction().

Voici le graphe d'appel pour cette fonction :

◆ getMousePosition()

castor::Position const& castor3d::UserInputListener::getMousePosition ( ) const

inline

Renvoie: La position actuelle de la souris.

Références castor3d::MouseState::m_position.

◆ initialise()

C3D_API bool castor3d::UserInputListener::initialise ( )

◆ onClickAction()

C3D_API void castor3d::UserInputListener::onClickAction ( castor::String const & p_handler )

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ onSelectAction()

C3D_API void castor3d::UserInputListener::onSelectAction	(	castor::String const &	p_handler,
		int	p_index
	)

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ onTextAction()

C3D_API void castor3d::UserInputListener::onTextAction	(	castor::String const &	p_handler,
		castor::String const &	p_text
	)

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ processEvents()

C3D_API void castor3d::UserInputListener::processEvents ( )

◆ registerClickAction()

C3D_API void castor3d::UserInputListener::registerClickAction	(	castor::String const &	p_handler,
		OnClickActionFunction	p_function
	)

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ registerSelectAction()

C3D_API void castor3d::UserInputListener::registerSelectAction	(	castor::String const &	p_handler,
		OnSelectActionFunction	p_function
	)

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ registerTextAction()

C3D_API void castor3d::UserInputListener::registerTextAction	(	castor::String const &	p_handler,
		OnTextActionFunction	p_function
	)

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ unregisterClickAction()

C3D_API void castor3d::UserInputListener::unregisterClickAction ( castor::String const & p_handler )

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ unregisterSelectAction()

C3D_API void castor3d::UserInputListener::unregisterSelectAction ( castor::String const & p_handler )

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

◆ unregisterTextAction()

C3D_API void castor3d::UserInputListener::unregisterTextAction ( castor::String const & p_handler )

Référencé par getFocusedControl().

Voici le graphe des appelants de cette fonction :

Documentation des données membres

◆ m_frameListener

FrameListenerSPtr castor3d::UserInputListener::m_frameListener

protected

Le frame listener associé.

◆ m_handlers

std::vector< EventHandlerSPtr > castor3d::UserInputListener::m_handlers

protected

Le tableau de gestionnaires.

Référencé par doAddHandler(), doGetHandlers(), doHasHandlers(), et doRemoveHandler().

◆ m_mutexHandlers

std::mutex castor3d::UserInputListener::m_mutexHandlers

mutableprotected

Le mutex de protection du tableau de gestionnaires.

Référencé par doAddHandler(), doGetHandlers(), doHasHandlers(), et doRemoveHandler().

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

Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Event/UserInput/UserInputListener.hpp

Types publics

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

General

Description détaillée

Documentation des définitions de type membres

◆ OnClickActionFunction

◆ OnSelectActionFunction

◆ OnTextActionFunction

Documentation des constructeurs et destructeur

◆ UserInputListener()

◆ ~UserInputListener()

Documentation des fonctions membres

◆ cleanup()

◆ doAddHandler()

◆ doGetHandlers()

◆ doHasHandlers()

◆ doRemoveHandler()

◆ fireChar()

◆ fireKeydown()

◆ fireKeyUp()

◆ fireMaterialEvent()

◆ fireMouseButtonPushed()

◆ fireMouseButtonReleased()

◆ fireMouseMove()

◆ fireMouseWheel()

◆ fireTextEvent()

◆ getActiveControl()

◆ getFocusedControl()

◆ getMousePosition()

◆ initialise()

◆ onClickAction()

◆ onSelectAction()

◆ onTextAction()

◆ processEvents()

◆ registerClickAction()

◆ registerSelectAction()

◆ registerTextAction()

◆ unregisterClickAction()

◆ unregisterSelectAction()

◆ unregisterTextAction()

Documentation des données membres

◆ m_frameListener

◆ m_handlers

◆ m_mutexHandlers