Open 3D Engine LyShine Gem 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.
Public Member Functions | Static Public Attributes | List of all members
UiCursorInterface Class Referenceabstract

Inherits AZ::EBusTraits.

Public Member Functions

virtual void IncrementVisibleCounter ()=0
 
virtual void DecrementVisibleCounter ()=0
 
virtual bool IsUiCursorVisible ()=0
 Query whether the UI Cursor is currently visible.
 
virtual void SetUiCursor (const char *cursorImagePath)=0
 Set the UI cursor image.
 
virtual AZ::Vector2 GetUiCursorPosition ()=0
 
virtual void SetUiCursorPosition (const AZ::Vector2 &)=0
 Set the UI cursor position using normalized coordinates.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 

Member Function Documentation

◆ DecrementVisibleCounter()

virtual void UiCursorInterface::DecrementVisibleCounter ( )
pure virtual

Decrement the UI Cursor visible counter. Should be paired with a call to IncrementVisibleCounter.

◆ GetUiCursorPosition()

virtual AZ::Vector2 UiCursorInterface::GetUiCursorPosition ( )
pure virtual

Get the UI cursor position (in pixels) relative to the top-left corner of the UI overlay viewport

◆ IncrementVisibleCounter()

virtual void UiCursorInterface::IncrementVisibleCounter ( )
pure virtual

Increment the UI Cursor visible counter. Should be paired with a call to DecrementVisibleCounter.

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