AzToolsFramework::EditorEntityIconComponentRequests Class Reference

#include <EditorEntityIconComponentBus.h>

Inherits AZ::ComponentBus.

Public Member Functions
virtual void	SetEntityIconAsset (const AZ::Data::AssetId &assetId)=0
virtual AZ::Data::AssetId	GetEntityIconAssetId ()=0
virtual AZStd::string	GetEntityIconPath ()=0
virtual int	GetEntityIconTextureId ()=0
virtual bool	IsEntityIconHiddenInViewport ()=0

Detailed Description

EBus calls for setting / getting information about the entity icon.

Member Function Documentation

GetEntityIconAssetId()

virtual AZ::Data::AssetId AzToolsFramework::EditorEntityIconComponentRequests::GetEntityIconAssetId ( )

pure virtual

Get the entity icon asset id. If the returned asset id is invalid, an icon of one of the entity's components will be used instead.

GetEntityIconPath()

virtual AZStd::string AzToolsFramework::EditorEntityIconComponentRequests::GetEntityIconPath ( )

pure virtual

Get the full path of the source icon image associated with the current entity.

GetEntityIconTextureId()

virtual int AzToolsFramework::EditorEntityIconComponentRequests::GetEntityIconTextureId ( )

pure virtual

Get the texture id of this entity icon. The Id is used to lookup the texture in the graphics system.

IsEntityIconHiddenInViewport()

virtual bool AzToolsFramework::EditorEntityIconComponentRequests::IsEntityIconHiddenInViewport ( )

pure virtual

Get the hide flag for the entity icon in viewport.

Returns

A boolean denoting whether the entity icon should be hidden in viewport.

SetEntityIconAsset()

virtual void AzToolsFramework::EditorEntityIconComponentRequests::SetEntityIconAsset ( const AZ::Data::AssetId &  assetId )

pure virtual

Set entity icon by assigning an Entity Icon Asset.

---

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

• Code/Framework/AzToolsFramework/AzToolsFramework/ToolsComponents/EditorEntityIconComponentBus.h