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::ExpandingFadingCircles Class Reference

Display expanding fading circles for every click of the mouse that is invalid. More...

#include <InvalidClicks.h>

Inherits AzToolsFramework::InvalidClick.

Public Member Functions

void Begin (const AzFramework::ScreenPoint &screenPoint) override
 
void Update (float deltaTime) override
 Update the invalid click feedback.
 
bool Updating () override
 Report if the click feedback is running or not (returning false will signal the TickBus can be disconnected from).
 
void Display (const AzFramework::ViewportInfo &viewportInfo, AzFramework::DebugDisplayRequests &debugDisplay) override
 Display the click feedback in the viewport.
 
virtual void Begin (const AzFramework::ScreenPoint &screenPoint)=0
 
virtual void Update (float deltaTime)=0
 Update the invalid click feedback.
 
virtual bool Updating ()=0
 Report if the click feedback is running or not (returning false will signal the TickBus can be disconnected from).
 
virtual void Display (const AzFramework::ViewportInfo &viewportInfo, AzFramework::DebugDisplayRequests &debugDisplay)=0
 Display the click feedback in the viewport.
 

Detailed Description

Display expanding fading circles for every click of the mouse that is invalid.

Member Function Documentation

◆ Begin()

void AzToolsFramework::ExpandingFadingCircles::Begin ( const AzFramework::ScreenPoint &  screenPoint)
overridevirtual

Begin the feedback.

Parameters
screenPointThe position of the click in screen coordinates.

Implements AzToolsFramework::InvalidClick.

◆ Display()

void AzToolsFramework::ExpandingFadingCircles::Display ( const AzFramework::ViewportInfo &  viewportInfo,
AzFramework::DebugDisplayRequests &  debugDisplay 
)
overridevirtual

Display the click feedback in the viewport.

Implements AzToolsFramework::InvalidClick.

◆ Update()

void AzToolsFramework::ExpandingFadingCircles::Update ( float  deltaTime)
overridevirtual

Update the invalid click feedback.

Implements AzToolsFramework::InvalidClick.

◆ Updating()

bool AzToolsFramework::ExpandingFadingCircles::Updating ( )
overridevirtual

Report if the click feedback is running or not (returning false will signal the TickBus can be disconnected from).

Implements AzToolsFramework::InvalidClick.


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