inviwo::MouseEvent Class Reference

Inheritance diagram for inviwo::MouseEvent:

Public Member Functions
	MouseEvent (MouseButton button=MouseButton::Left, MouseState state=MouseState::Press, MouseButtons buttonState=MouseButtons(flags::empty), KeyModifiers modifiers=KeyModifiers(flags::empty), dvec2 normalizedPosition=dvec2(0), uvec2 canvasSize=uvec2(0), double depth=1.0)
	MouseEvent (const MouseEvent &rhs)=default
MouseEvent &	operator= (const MouseEvent &that)=default
virtual MouseEvent *	clone () const override
MouseButton	button () const
void	setButton (MouseButton button)
MouseState	state () const
void	setState (MouseState state)
virtual uint64_t	hash () const override
virtual void	print (std::ostream &ss) const override
Public Member Functions inherited from inviwo::MouseInteractionEvent
	MouseInteractionEvent (MouseButtons buttonState=MouseButtons(flags::empty), KeyModifiers modifiers=KeyModifiers(flags::empty), dvec2 normalizedPosition=dvec2(0), uvec2 canvasSize=uvec2(1), double depth=1.0)
	MouseInteractionEvent (const MouseInteractionEvent &rhs)=default
MouseInteractionEvent &	operator= (const MouseInteractionEvent &that)=default
MouseButtons	buttonState () const
void	setButtonState (MouseButtons buttonState)
dvec2	pos () const
void	setPos (dvec2 pos)
uvec2	canvasSize () const
void	setCanvasSize (uvec2 size)
double	depth () const
void	setDepth (double depth)
dvec2	posNormalized () const
void	setPosNormalized (dvec2 pos)
dvec3	ndc () const
double	x () const
double	y () const
std::string	buttonName () const
void	setMouseCursor (MouseCursor cursor) const
void	setMouseCursorCallback (MouseCursorCallback callback)
const MouseCursorCallback &	getMouseCursorCallback () const
Public Member Functions inherited from inviwo::InteractionEvent
	InteractionEvent (KeyModifiers modifiers=KeyModifiers(flags::empty))
	InteractionEvent (const InteractionEvent &rhs)=default
InteractionEvent &	operator= (const InteractionEvent &that)=default
KeyModifiers	modifiers () const
void	setModifiers (KeyModifiers modifiers)
std::string	modifierNames () const
void	setToolTip (std::string_view tooltip) const
void	setToolTipCallback (ToolTipCallback callback)
const ToolTipCallback &	getToolTipCallback () const
void	showContextMenu (std::span< ContextMenuEntry > entries, ContextMenuCategories categories=ContextMenuCategory::Callback)
void	setContextMenuCallback (ContextMenuCallback callback)
const ContextMenuCallback &	getContexMenuCallback () const
Public Member Functions inherited from inviwo::Event
virtual bool	shouldPropagateTo (Inport *inport, Processor *processor, Outport *source)
bool	markAsUsed ()
bool	markAsUnused ()
bool	setUsed (bool isUsed)
bool	hasBeenUsed () const
bool	markAsVisited (Processor *)
void	markAsVisited (Event &)
bool	hasVisitedProcessor (Processor *) const
const std::vector< Processor * > &	getVisitedProcessors () const
template<typename EventType>
EventType *	getAs ()
template<typename EventType>
const EventType *	getAs () const

Static Public Member Functions
static constexpr uint64_t	chash ()

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

Member Function Documentation

button()

MouseButton inviwo::MouseEvent::button

(

)

const

The button responsible for the current event.

clone()

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

overridevirtual

Implements inviwo::MouseInteractionEvent.

hash()

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

overridevirtual

Implements inviwo::Event.

print()

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

overridevirtual

Reimplemented from inviwo::Event.

state()

MouseState inviwo::MouseEvent::state

(

)

const

The state of the button that generated the event.

---

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

• mouseevent.h