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 Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
UiImageSequenceComponent Class Reference

Image component capable of indexing and displaying from multiple image files in a directory. More...

#include <UiImageSequenceComponent.h>

Inherits AZ::Component, UiVisualBus::Handler, UiRenderBus::Handler, UiImageSequenceBus::Handler, UiIndexableImageBus::Handler, UiTransformChangeNotificationBus::Handler, UiCanvasPixelAlignmentNotificationBus::Handler, and UiEditorRefreshDirectoryNotificationBus::Handler.

Public Types

using TextureAssetRef = AzFramework::SimpleAssetReference< LmbrCentral::TextureAsset >
 
using ImageList = AZStd::vector< TextureAssetRef >
 
using SpriteList = AZStd::vector< ISprite * >
 

Public Member Functions

 AZ_COMPONENT (UiImageSequenceComponent, LyShine::UiImageSequenceComponentUuid, AZ::Component)
 
void OnRefreshDirectory () override
 
void ResetOverrides () override
 
void SetOverrideColor (const AZ::Color &) override
 
void SetOverrideAlpha (float) override
 
void SetOverrideSprite (ISprite *, AZ::u32) override
 
void Render (LyShine::IRenderGraph *renderGraph) override
 
ImageType GetImageType () override
 
void SetImageType (ImageType imageType) override
 
void SetImageIndex (AZ::u32 index) override
 
const AZ::u32 GetImageIndex () override
 
const AZ::u32 GetImageIndexCount () override
 
AZStd::string GetImageIndexAlias (AZ::u32 index) override
 
void SetImageIndexAlias (AZ::u32 index, const AZStd::string &alias) override
 
AZ::u32 GetImageIndexFromAlias (const AZStd::string &alias) override
 
void OnCanvasSpaceRectChanged (AZ::EntityId entityId, const UiTransformInterface::Rect &oldRect, const UiTransformInterface::Rect &newRect) override
 
void OnTransformToViewportChanged () override
 
void OnCanvasPixelAlignmentChange () override
 

Static Public Member Functions

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

Protected Member Functions

void Init () override
 
void Activate () override
 
void Deactivate () override
 

Detailed Description

Image component capable of indexing and displaying from multiple image files in a directory.

This component offers functionality similar to a sprite-sheet being used with an image component. Instead of indexing multiple images mapped within a single sprite-sheet, this component indexes multiple image files.

Note that this only supports fixed image types - the image component is more fully featured for rendering images.

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