Open 3D Engine AzToolsFramework API Reference 26.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AzToolsFramework::InvalidClick Class Referenceabstract

An interface to provide invalid click feedback in the editor viewport. More...

#include <InvalidClicks.h>

Inherited by AzToolsFramework::ExpandingFadingCircles, and AzToolsFramework::FadingText.

Public Member Functions

 AZ_DISABLE_COPY (InvalidClick)
 
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

An interface to provide invalid click feedback in the editor viewport.

Member Function Documentation

◆ Begin()

virtual void AzToolsFramework::InvalidClick::Begin ( const AzFramework::ScreenPoint &  screenPoint)
pure virtual

Begin the feedback.

Parameters
screenPointThe position of the click in screen coordinates.

Implemented in AzToolsFramework::ExpandingFadingCircles, and AzToolsFramework::FadingText.

◆ Display()

virtual void AzToolsFramework::InvalidClick::Display ( const AzFramework::ViewportInfo &  viewportInfo,
AzFramework::DebugDisplayRequests &  debugDisplay 
)
pure virtual

Display the click feedback in the viewport.

Implemented in AzToolsFramework::ExpandingFadingCircles, and AzToolsFramework::FadingText.

◆ Update()

virtual void AzToolsFramework::InvalidClick::Update ( float  deltaTime)
pure virtual

Update the invalid click feedback.

Implemented in AzToolsFramework::ExpandingFadingCircles, and AzToolsFramework::FadingText.

◆ Updating()

virtual bool AzToolsFramework::InvalidClick::Updating ( )
pure virtual

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

Implemented in AzToolsFramework::ExpandingFadingCircles, and AzToolsFramework::FadingText.

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