AzToolsFramework::FadingText Class Reference

#include <InvalidClicks.h>

Inherits AzToolsFramework::InvalidClick.

Public Member Functions
	FadingText (AZStd::string message)
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 fading text where an invalid click happened.

Note

There is only one fading text, each click will update its position.

Member Function Documentation

Begin()

void AzToolsFramework::FadingText::Begin ( const AzFramework::ScreenPoint &  screenPoint )

overridevirtual

Begin the feedback.

Parameters

screenPoint

The position of the click in screen coordinates.

Implements AzToolsFramework::InvalidClick.

Display()

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

overridevirtual

Display the click feedback in the viewport.

Implements AzToolsFramework::InvalidClick.

Update()

void AzToolsFramework::FadingText::Update ( float  deltaTime )

overridevirtual

Update the invalid click feedback.

Implements AzToolsFramework::InvalidClick.

Updating()

bool AzToolsFramework::FadingText::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:

• Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/InvalidClicks.h