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.
UiCanvasOnMeshComponent Class Reference

Inherits AZ::Component, UiCanvasOnMeshBus::Handler, UiCanvasAssetRefNotificationBus::Handler, and UiCanvasManagerNotificationBus::Handler.

Public Member Functions

 AZ_COMPONENT (UiCanvasOnMeshComponent, "{0C1B2542-6813-451A-BD11-42F92DD48E36}")
 
bool ProcessHitInputEvent (const AzFramework::InputChannel::Snapshot &inputSnapshot, const AzFramework::RenderGeometry::RayRequest &rayRequest) override
 
void OnCanvasLoadedIntoEntity (AZ::EntityId uiCanvasEntity) override
 
void OnCanvasReloaded (AZ::EntityId canvasEntityId) 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
 
bool CalculateUVFromRayIntersection (const AzFramework::RenderGeometry::RayRequest &rayRequest, AZ::Vector2 &outUv)
 
AZ::EntityId GetCanvas ()
 
 AZ_DISABLE_COPY_MOVE (UiCanvasOnMeshComponent)
 

Protected Attributes

AZ::Data::Asset< AZ::RPI::AttachmentImageAsset > m_attachmentImageAssetOverride
 Render target asset to use (overrides the render target asset in the UI canvas)
 

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