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.
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
UiSystemToolsInterface Class Referenceabstract

#include <UiSystemToolsBus.h>

Inherits AZ::EBusTraits.

Classes

class  CanvasAssetHandle
 

Public Types

using MutexType = AZStd::recursive_mutex
 

Public Member Functions

virtual CanvasAssetHandle * LoadCanvasFromStream (AZ::IO::GenericStream &stream, const AZ::ObjectStream::FilterDescriptor &filterDesc)=0
 
virtual void SaveCanvasToStream (CanvasAssetHandle *canvas, AZ::IO::FileIOStream &stream)=0
 Save a canvas to a stream.
 
virtual AZ::SliceComponent * GetRootSliceSliceComponent (CanvasAssetHandle *canvas)=0
 Get the slice component for a loaded canvas.
 
virtual AZ::Entity * GetRootSliceEntity (CanvasAssetHandle *canvas)=0
 Get the slice entity for a loaded canvas.
 
virtual AZ::Entity * GetCanvasEntity (CanvasAssetHandle *canvas)=0
 Get the canvas entity for a loaded canvas.
 
virtual void ReplaceRootSliceSliceComponent (CanvasAssetHandle *canvas, AZ::SliceComponent *newSliceComponent)=0
 
virtual void ReplaceCanvasEntity (CanvasAssetHandle *canvas, AZ::Entity *newCanvasEntity)=0
 
virtual void DestroyCanvas (CanvasAssetHandle *canvas)=0
 Delete the canvas file object and its canvas entity and slice entity.
 

Static Public Attributes

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

Detailed Description

Bus interface for tools to talk to the LyShine system It is valid to use this bus from resource compilers or the UI Editor

Member Function Documentation

◆ LoadCanvasFromStream()

virtual CanvasAssetHandle* UiSystemToolsInterface::LoadCanvasFromStream ( AZ::IO::GenericStream &  stream,
const AZ::ObjectStream::FilterDescriptor &  filterDesc 
)
pure virtual

Load a canvas but do not init or activate the entities The CanvasAssetHandle is an opaque pointer only valid to be passed to the methods below.

◆ ReplaceCanvasEntity()

virtual void UiSystemToolsInterface::ReplaceCanvasEntity ( CanvasAssetHandle *  canvas,
AZ::Entity *  newCanvasEntity 
)
pure virtual

Replace the canvas entity with a new one. The old canvas entity is not deleted. The client is responsible for that.

◆ ReplaceRootSliceSliceComponent()

virtual void UiSystemToolsInterface::ReplaceRootSliceSliceComponent ( CanvasAssetHandle *  canvas,
AZ::SliceComponent *  newSliceComponent 
)
pure virtual

Replace the slice component with a new one. The old slice component is not deleted. The client is responsible for that.

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