Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::MouseInteractionEvent Class Referenceabstract
+ Inheritance diagram for inviwo::MouseInteractionEvent:

Public Types

using MouseCursorCallback = std::function<void(MouseCursor)>
 
- Public Types inherited from inviwo::InteractionEvent
using ContextMenuCallback
 
using ToolTipCallback = std::function<void(std::string_view)>
 

Public Member Functions

std::string buttonName () const
 
MouseButtons buttonState () const
 
uvec2 canvasSize () const
 
virtual MouseInteractionEventclone () const override=0
 
double depth () const
 
const MouseCursorCallback & getMouseCursorCallback () const
 
 MouseInteractionEvent (const MouseInteractionEvent &rhs)=default
 
 MouseInteractionEvent (MouseButtons buttonState=MouseButtons(flags::empty), KeyModifiers modifiers=KeyModifiers(flags::empty), dvec2 normalizedPosition=dvec2(0), uvec2 canvasSize=uvec2(1), double depth=1.0)
 
dvec3 ndc () const
 
MouseInteractionEventoperator= (const MouseInteractionEvent &that)=default
 
dvec2 pos () const
 
dvec2 posNormalized () const
 
void setButtonState (MouseButtons buttonState)
 
void setCanvasSize (uvec2 size)
 
void setDepth (double depth)
 
void setMouseCursor (MouseCursor cursor) const
 
void setMouseCursorCallback (MouseCursorCallback callback)
 
void setNdc (dvec3 ndc)
 
void setPos (dvec2 pos)
 
void setPosNormalized (dvec2 pos)
 
double x () const
 
double y () 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))
 
KeyModifiers modifiers () const
 
InteractionEventoperator= (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
 
virtual uint64_t hash () const =0
 
bool hasVisitedProcessor (Processor *) const
 
bool markAsUnused ()
 
bool markAsUsed ()
 
void markAsVisited (const Event &)
 
bool markAsVisited (Processor *)
 
virtual void print (fmt::memory_buffer &buff) const =0
 
bool setUsed (bool isUsed)
 
virtual bool shouldPropagateTo (Inport *inport, Processor *processor, Outport *source)
 

Additional Inherited Members

- Protected Member Functions inherited from inviwo::Event
 Event (const Event &rhs)=default
 
Eventoperator= (const Event &that)=default
 
- Protected Attributes inherited from inviwo::InteractionEvent
ContextMenuCallback contextMenuCallback_
 
KeyModifiers modifiers_
 
ToolTipCallback tooltip_
 

Member Function Documentation

◆ buttonState()

MouseButtons inviwo::MouseInteractionEvent::buttonState ( ) const

Get all the pressed buttons.

◆ canvasSize()

uvec2 inviwo::MouseInteractionEvent::canvasSize ( ) const

The size of the canvas where the event occurred.

◆ clone()

virtual MouseInteractionEvent * inviwo::MouseInteractionEvent::clone ( ) const
overridepure virtual

◆ depth()

double inviwo::MouseInteractionEvent::depth ( ) const

Retrieve depth value in normalized device coordinates at mouse position. Defined in [-1 1], where -1 is the near plane and 1 is the far plane. Will be 1 if no depth value is available. The depth is then defined to be positive inwards by default, resulting in a left handed coordinate system together with the position.

◆ ndc()

dvec3 inviwo::MouseInteractionEvent::ndc ( ) const

Returns the normalized device coordinates. Position and depth normalized to the range of (-1,1) In in a left handed coordinate system. The lower left near will be (-1,-1,-1) And the upper right far (1,1,1)

◆ pos()

dvec2 inviwo::MouseInteractionEvent::pos ( ) const

Position of the mouse in the canvas. The lower left corner is (0,0) the upper right corner is (canvasSize.x, canvasSize.y) This is in accordance with the positioning within an Inviwo Layer and an OpenGL texture. But opposite to QT which has (0,0) at the top left corner. The depth is then defined to be positive inwards by default, resulting in a left handed coordinate system.

◆ posNormalized()

dvec2 inviwo::MouseInteractionEvent::posNormalized ( ) const

Returns the position normalized to the range (0,1). The lower left will be (0,0) And the upper right (1,1)

◆ setMouseCursor()

void inviwo::MouseInteractionEvent::setMouseCursor ( MouseCursor cursor) const

Change the current mouse cursor using the optionally set mouse cursor callback. If no mouse cursor callback is set, the function does nothing.

◆ setMouseCursorCallback()

void inviwo::MouseInteractionEvent::setMouseCursorCallback ( MouseCursorCallback callback)

Set a mouse cursor call back function. The function should change the mouse cursor with the one given cursor. This function is usually called by the originating event canvas, and not any regular user code.


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