Castor3D 0.15.0
Multiplatform 3D engine
Fonctions membres publiques | Liste de tous les membres
Référence de la classe castor3d::RenderWindow::InputListener

#include <RenderWindow.hpp>

Graphe d'héritage de castor3d::RenderWindow::InputListener:
Inheritance graph
[légende]
Graphe de collaboration de castor3d::RenderWindow::InputListener:
Collaboration graph
[légende]

Fonctions membres publiques

 InputListener (Engine &engine, RenderWindow &window)
 
- Fonctions membres publiques hérités de castor3d::UserInputListener
C3D_API UserInputListener (Engine &engine, castor::String const &name)
 Constructeur.
 
virtual C3D_API ~UserInputListener ()
 Destructeur.
 
C3D_API bool initialise ()
 Initialise le listener.
 
C3D_API void cleanup ()
 Nettoie le listener.
 
C3D_API void processEvents ()
 Traite tous les évènements.
 
castor::Position const & getMousePosition () const
 
EventHandlerRPtr getActiveControl () const
 
EventHandlerRPtr getFocusedControl () const
 
FrameListenergetFrameListener () const
 
C3D_API void registerMouseMoveAction (castor::String const &handler, OnMouseMoveActionFunction function)
 Enregistre une fonction à appeler lorsqu'un évènement de déplacement de souris est lancé par le handler donné.
 
C3D_API void registerClickAction (castor::String const &handler, OnClickActionFunction function)
 Enregistre une fonction à appeler lorsqu'un évènement de clic de souris est lancé par le handler donné.
 
C3D_API void registerSelectAction (castor::String const &handler, OnSelectActionFunction function)
 Enregistre une fonction à appeler lorsqu'un évènement de sélection est lancé par le handler donné.
 
C3D_API void registerTextAction (castor::String const &handler, OnTextActionFunction function)
 Enregistre une fonction à appeler lorsqu'un évènement de texte est lancé par le handler donné.
 
C3D_API void registerExpandAction (castor::String const &handler, OnExpandActionFunction function)
 Enregistre une fonction à appeler lorsqu'un évènement d'expansion est lancé par le handler donné.
 
C3D_API void registerCursorAction (OnCursorActionFunction function)
 Enregistre une fonction à appeler lorsqu'un évènement de curseur de souris est lancé par le handler donné.
 
C3D_API void registerClipboardTextAction (OnClipboardTextActionFunction function)
 Enregistre une fonction à appeler lorsqu'un évènement de presse-papier est lancé par le handler donné.
 
C3D_API void unregisterMouseMoveAction (castor::String const &handler)
 Désenregistre la fonction à appeler lorsqu'un évènement de déplacement de souris est lancé par le handler donné.
 
C3D_API void unregisterClickAction (castor::String const &handler)
 Désenregistre la fonction à appeler lorsqu'un évènement de clic de souris est lancé par le handler donné.
 
C3D_API void unregisterSelectAction (castor::String const &handler)
 Désenregistre la fonction à appeler lorsqu'un évènement de sélection est lancé par le handler donné.
 
C3D_API void unregisterTextAction (castor::String const &handler)
 Désenregistre la fonction à appeler lorsqu'un évènement de texte est lancé par le handler donné.
 
C3D_API void unregisterExpandAction (castor::String const &handler)
 Désenregistre la fonction à appeler lorsqu'un évènement d'expansion est lancé par le handler donné.
 
C3D_API void unregisterCursorAction ()
 Désenregistre la fonction à appeler lorsqu'un évènement de curseur de souris est lancé par le handler donné.
 
C3D_API void unregisterClipboardTextAction ()
 Désenregistre la fonction à appeler lorsqu'un évènement de presse-papier est lancé par le handler donné.
 
C3D_API void onMouseMoveAction (castor::String const &handler) const
 Evènement lancé par le handler si la souris est déplacée au dessus de sa surface.
 
C3D_API void onClickAction (castor::String const &handler) const
 Evènement lancé par le handler s'il est cliqué et qu'il le supporte.
 
C3D_API void onSelectAction (castor::String const &handler, int index) const
 Evènement lancé par le handler lorsqu'un de ses sous éléments est sélectionné.
 
C3D_API void onTextAction (castor::String const &handler, castor::U32String const &text) const
 Evènement lancé par le handler lorsque son texte a changé.
 
C3D_API void onExpandAction (castor::String const &handler, bool expand) const
 Evènement lancé par le handler lorsque son expansion est changée.
 
C3D_API void onCursorAction (MouseCursor cursor) const
 Evènement lorsque le cureur de souris est changé.
 
C3D_API castor::U32String onClipboardTextAction (bool set, castor::U32String text) const
 Evènement lancé lorsqu'une interaction avec le presse-papier est demandée.
 
C3D_API void enableHandler (castor::String const &handler)
 Active un handler.
 
C3D_API void disableHandler (castor::String const &handler)
 Désactive un handler.
 
C3D_API bool fireMouseMove (castor::Position const &position, bool ctrl, bool alt, bool shift)
 Lance un évènement de déplacement de souris.
 
C3D_API bool fireMouseButtonPushed (MouseButton button, bool ctrl, bool alt, bool shift)
 Lance un évènement de bouton de souris appuyé.
 
C3D_API bool fireMouseButtonReleased (MouseButton button, bool ctrl, bool alt, bool shift)
 Lance un évènement de bouton de souris relâché.
 
C3D_API bool fireMouseWheel (castor::Position const &offsets, bool ctrl, bool alt, bool shift)
 Lance un évènement de molette de souris.
 
C3D_API bool fireKeydown (KeyboardKey key, bool ctrl, bool alt, bool shift)
 Lance un évènement de touche de clavier appuyée.
 
C3D_API bool fireKeyUp (KeyboardKey key, bool ctrl, bool alt, bool shift)
 Lance un évènement de touche de clavier relâchée.
 
C3D_API bool fireChar (KeyboardKey key, castor::String const &c)
 Lance un évènement de caractère imprimable.
 

Membres hérités additionnels

- Types publics hérités de castor3d::UserInputListener
using OnClickActionFunction = std::function< void() >
 
using OnMouseMoveActionFunction = std::function< void(castor::Position const &) >
 
using OnSelectActionFunction = std::function< void(int) >
 
using OnTextActionFunction = std::function< void(castor::U32String const &) >
 
using OnExpandActionFunction = std::function< void(bool) >
 
using OnClipboardTextActionFunction = std::function< castor::U32String(bool, castor::U32String) >
 
using OnCursorActionFunction = std::function< void(MouseCursor) >
 
- Fonctions membres protégées hérités de castor3d::UserInputListener
std::vector< EventHandlerRPtr > doGetHandlers () const
 
bool doHasHandlers () const
 
EventHandlerRPtr doAddHandler (EventHandlerUPtr handler)
 Supprime un gestionnaire.
 
void doRemoveHandlerNL (EventHandler const &handler)
 Supprime un gestionnaire.
 
void doRemoveHandler (EventHandler const &handler)
 Supprime un gestionnaire.
 
- Attributs protégés hérités de castor3d::UserInputListener
std::mutex m_mutexHandlers
 
std::vector< EventHandlerUPtr > m_handlers
 
FrameListenerRPtr m_frameListener
 

Documentation des constructeurs et destructeur

◆ InputListener()

castor3d::RenderWindow::InputListener::InputListener ( Engine engine,
RenderWindow window 
)
inline

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