inviwo::KeyboardEvent Class Reference

#include <inviwo/core/interaction/events/keyboardevent.h>

Inheritance diagram for inviwo::KeyboardEvent:

Public Member Functions
virtual KeyboardEvent *	clone () const override
uint32_t	getNativeVirtualKey () const
virtual uint64_t	hash () const override
virtual IvwKey	key () const
	KeyboardEvent (const KeyboardEvent &rhs)=default
	KeyboardEvent (IvwKey key=IvwKey::Unknown, KeyState state=KeyState::Press, KeyModifiers modifiers=KeyModifiers(flags::empty), uint32_t nativeVirtualKey=0, const std::string &utfText="")
KeyboardEvent &	operator= (const KeyboardEvent &that)=default
virtual void	print (std::ostream &ss) const override
void	setKey (IvwKey key)
void	setNativeVirtualKey (uint32_t key)
void	setState (KeyState state)
void	setText (const std::string &text)
KeyState	state () const
std::string	text () const
Public Member Functions inherited from inviwo::InteractionEvent
const ContextMenuCallback &	getContexMenuCallback () const
const ToolTipCallback &	getToolTipCallback () const
	InteractionEvent (const InteractionEvent &rhs)=default
	InteractionEvent (KeyModifiers modifiers=KeyModifiers(flags::empty))
std::string	modifierNames () const
KeyModifiers	modifiers () const
InteractionEvent &	operator= (const InteractionEvent &that)=default
void	setContextMenuCallback (ContextMenuCallback callback)
void	setModifiers (KeyModifiers modifiers)
void	setToolTip (std::string_view tooltip) const
void	setToolTipCallback (ToolTipCallback callback)
void	showContextMenu (std::span< ContextMenuEntry > entries, ContextMenuCategories categories=ContextMenuCategory::Callback)
Public Member Functions inherited from inviwo::Event
template<typename EventType>
EventType *	getAs ()
template<typename EventType>
const EventType *	getAs () const
const std::vector< Processor * > &	getVisitedProcessors () const
bool	hasBeenUsed () const
bool	hasVisitedProcessor (Processor *) const
bool	markAsUnused ()
bool	markAsUsed ()
void	markAsVisited (Event &)
bool	markAsVisited (Processor *)
bool	setUsed (bool isUsed)
virtual bool	shouldPropagateTo (Inport *inport, Processor *processor, Outport *source)

Static Public Member Functions
static constexpr uint64_t	chash ()

Additional Inherited Members
Public Types inherited from inviwo::InteractionEvent
using	ContextMenuCallback
using	ToolTipCallback = std::function<void(std::string_view)>
Protected Member Functions inherited from inviwo::Event
	Event (const Event &rhs)=default
Event &	operator= (const Event &that)=default
Protected Attributes inherited from inviwo::InteractionEvent
ContextMenuCallback	contextMenuCallback_
KeyModifiers	modifiers_
ToolTipCallback	tooltip_

Detailed Description

Generated when keys are pressed and released.

Constructor & Destructor Documentation

KeyboardEvent()

inviwo::KeyboardEvent::KeyboardEvent	(	IvwKey	key = IvwKey::Unknown,
		KeyState	state = KeyState::Press,
		KeyModifiers	modifiers = KeyModifiers(flags::empty),
		uint32_t	nativeVirtualKey = 0,
		const std::string &	utfText = "" )

Parameters

key	Enumerate representation of pressed key
state	Pressed of released key
modifiers	Modifier keys, e.g. shift, held while pressing key
nativeVirtualKey	Platform dependent scancode of pressed key
utfText	Unicode representation of pressed keys

Member Function Documentation

clone()

virtual KeyboardEvent * inviwo::KeyboardEvent::clone ( ) const

overridevirtual

Implements inviwo::InteractionEvent.

hash()

virtual uint64_t inviwo::KeyboardEvent::hash ( ) const

overridevirtual

Implements inviwo::Event.

print()

virtual void inviwo::KeyboardEvent::print ( std::ostream & ss ) const

overridevirtual

Reimplemented from inviwo::Event.

---

The documentation for this class was generated from the following file:

• include/inviwo/core/interaction/events/keyboardevent.h