Open 3D Engine LyShine Gem API Reference 25.10.0
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 | List of all members
UiCanvasManagerInterface Class Referenceabstract

Inherits AZ::EBusTraits.

Public Types

typedef std::vector< AZ::EntityId > CanvasEntityList
 

Public Member Functions

virtual AZ::EntityId CreateCanvas ()=0
 Create a canvas.
 
virtual AZ::EntityId LoadCanvas (const AZStd::string &canvasPathname)=0
 Load a canvas.
 
virtual void UnloadCanvas (AZ::EntityId canvasEntityId)=0
 Unload a canvas.
 
virtual AZ::EntityId FindLoadedCanvasByPathName (const AZStd::string &canvasPathname, bool loadIfNotFound=false)=0
 Find a canvas by path, optionally load the canvas if it was not found.
 
virtual CanvasEntityList GetLoadedCanvases ()=0
 Get a list of canvases that are loaded in game, this is sorted by draw order.
 
virtual void SetLocalUserIdInputFilterForAllCanvases (AzFramework::LocalUserId localUserId)=0
 

Member Function Documentation

◆ SetLocalUserIdInputFilterForAllCanvases()

virtual void UiCanvasManagerInterface::SetLocalUserIdInputFilterForAllCanvases ( AzFramework::LocalUserId  localUserId)
pure virtual

Set the local user id that will be used to filter incoming input events for all canvases. Can be overriden for an individual canvas using UiCanvasInterface::SetLocalUserIdInputFilter.

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