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
UiIndexableImageInterface Class Referenceabstract

Defines an interface for working with indexable image types, such as sprite-sheets or image sequences. More...

#include <UiIndexableImageBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void SetImageIndex (AZ::u32 index)=0
 Sets the index of the image to display.
 
virtual const AZ::u32 GetImageIndex ()=0
 Gets the index of the image to display.
 
virtual const AZ::u32 GetImageIndexCount ()=0
 Gets the number of indices for this image.
 
virtual AZStd::string GetImageIndexAlias (AZ::u32 index)=0
 Given an index, return its alias (if defined)
 
virtual void SetImageIndexAlias (AZ::u32 index, const AZStd::string &alias)=0
 Given an index, set an alias for it.
 
virtual AZ::u32 GetImageIndexFromAlias (const AZStd::string &alias)=0
 Given an alias, return the index that corresponds to it.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 Only one component on a entity can implement the events.
 

Detailed Description

Defines an interface for working with indexable image types, such as sprite-sheets or image sequences.

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