Castor3D: Référence de la classe Castor3D::UserInputListener

Castor3D ..

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:

Fonctions membres publiques
Mouse 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 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)

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

void	DoAddHandler (EventHandlerSPtr p_handler)

void	DoRemoveHandler (EventHandlerSPtr p_handler)

Attributs protégés
std::mutex	m_mutexHandlers
	Le mutex de protection du tableau de gestionnaires. Plus de détails...

std::vector< EventHandlerSPtr >	m_handlers
	Le tableau de gestionnaires. Plus de détails...

General
C3D_API	UserInputListener (Engine &p_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 constructeurs et destructeur

◆ UserInputListener()

C3D_API Castor3D::UserInputListener::UserInputListener	(	Engine &	p_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

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 :

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

◆ GetActiveControl()

EventHandlerSPtr Castor3D::UserInputListener::GetActiveControl ( ) const

inline

Retrieves the active control

Renvoie: The control

◆ GetFocusedControl()

EventHandlerSPtr Castor3D::UserInputListener::GetFocusedControl ( ) const

inline

Retrieves the focused control

Renvoie: The control

Références C3D_API, FireChar(), FireKeyDown(), FireKeyUp(), FireMouseButtonPushed(), FireMouseButtonReleased(), FireMouseMove(), et FireMouseWheel().

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

◆ ProcessEvents()

C3D_API void Castor3D::UserInputListener::ProcessEvents ( )

Documentation des données membres

◆ m_handlers

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

protected

Le tableau de gestionnaires.

Référencé par DoAddHandler(), DoGetHandlers(), 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(), et DoRemoveHandler().

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/UserInputListener.hpp