Open 3D Engine LyShine Gem API Reference  24.09
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 Member Functions | Protected Member Functions | Protected Attributes | List of all members
UiTooltipComponent Class Reference

Inherits AZ::Component, UiCanvasUpdateNotificationBus::Handler, UiInteractableNotificationBus::Handler, UiCanvasInputNotificationBus::Handler, UiTooltipDisplayNotificationBus::Handler, UiTooltipDataPopulatorBus::Handler, and UiTooltipBus::Handler.

Public Member Functions

 AZ_COMPONENT (UiTooltipComponent, LyShine::UiTooltipComponentUuid, AZ::Component)
 
void Update (float deltaTime) override
 
void OnHoverStart () override
 
void OnHoverEnd () override
 
void OnPressed () override
 
void OnReleased () override
 
void OnCanvasPrimaryReleased (AZ::EntityId entityId) override
 
void OnHiding () override
 
void OnHidden () override
 
void PushDataToDisplayElement (AZ::EntityId displayEntityId) override
 
AZStd::string GetText () override
 
void SetText (const AZStd::string &text) override
 

Static Public Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

void Activate () override
 
void Deactivate () override
 
 AZ_DISABLE_COPY_MOVE (UiTooltipComponent)
 
void HideDisplayElement ()
 
void HandleDisplayElementHidden ()
 
void TriggerTooltip (UiTooltipDisplayInterface::TriggerMode triggerMode)
 
bool IsTriggered ()
 
bool IsTriggeredWithMode (UiTooltipDisplayInterface::TriggerMode triggerMode)
 
UiTooltipDisplayInterface::TriggerMode GetDisplayElementTriggerMode ()
 

Protected Attributes

AZStd::string m_text
 The tooltip text.
 
AZ::EntityId m_curDisplayElementId
 
UiTooltipDisplayInterface::TriggerMode m_curTriggerMode
 
The documentation for this class was generated from the following file: