Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzToolsFramework::ViewportInteraction::MouseInteractionEvent Struct Reference

#include <ViewportTypes.h>

Public Member Functions

 MouseInteractionEvent (MouseInteraction mouseInteraction, const MouseEvent mouseEvent, const bool captured)
 Constructor to create a default MouseInteractionEvent.
 
 MouseInteractionEvent (MouseInteraction mouseInteraction, const float wheelDelta)
 Special constructor for mouse wheel event.
 

Static Public Member Functions

static void Reflect (AZ::SerializeContext &context)
 

Public Attributes

MouseInteraction m_mouseInteraction
 Mouse state.
 
MouseEvent m_mouseEvent
 Mouse event.
 
bool m_captured = false
 Is the mouse cursor being captured during the event.
 

Friends

float MouseWheelDelta (const MouseInteractionEvent &mouseInteractionEvent)
 Checked access to mouse wheel delta - ensure event originated from the mouse wheel.
 

Detailed Description

Structure to compose MouseInteraction (mouse state) and MouseEvent (MouseEvent::MouseUp/MouseEvent::DownMove etc.)

Friends And Related Function Documentation

◆ MouseWheelDelta

float MouseWheelDelta ( const MouseInteractionEvent mouseInteractionEvent)
friend

Checked access to mouse wheel delta - ensure event originated from the mouse wheel.

Special friend function to return the mouse wheel delta (scroll amount) if the event was of type MouseEvent::Wheel.


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