Open 3D Engine AzToolsFramework 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 | Protected Member Functions | Protected Attributes | List of all members
AzToolsFramework::Thumbnailer::ThumbnailCache< ThumbnailType, Hasher, EqualKey > Class Template Referenceabstract

ThumbnailCache manages thumbnails of specific type, derive your custom provider from this. More...

#include <Thumbnail.h>

Inherits AzToolsFramework::Thumbnailer::ThumbnailProvider, and AZ::TickBus::Handler.

Public Member Functions

void OnTick (float deltaTime, AZ::ScriptTimePoint time) override
 
bool GetThumbnail (SharedThumbnailKey key, SharedThumbnail &thumbnail) override
 
- Public Member Functions inherited from AzToolsFramework::Thumbnailer::ThumbnailProvider
virtual bool GetThumbnail (SharedThumbnailKey key, SharedThumbnail &thumbnail)=0
 
virtual int GetPriority () const
 
virtual const char * GetProviderName () const =0
 A unique ThumbnailProvider name identifyier.
 

Protected Member Functions

virtual bool IsSupportedThumbnail (SharedThumbnailKey key) const =0
 Check if thumbnail key is handled by this provider, overload in derived class.
 

Protected Attributes

AZStd::unordered_map< SharedThumbnailKey, SharedThumbnail, Hasher, EqualKey > m_cache
 

Detailed Description

template<class ThumbnailType, class Hasher = AZStd::hash<SharedThumbnailKey>, class EqualKey = AZStd::equal_to<SharedThumbnailKey>>
class AzToolsFramework::Thumbnailer::ThumbnailCache< ThumbnailType, Hasher, EqualKey >

ThumbnailCache manages thumbnails of specific type, derive your custom provider from this.

Member Function Documentation

◆ GetThumbnail()

template<class ThumbnailType , class Hasher , class EqualKey >
bool AzToolsFramework::Thumbnailer::ThumbnailCache< ThumbnailType, Hasher, EqualKey >::GetThumbnail ( SharedThumbnailKey  key,
SharedThumbnail &  thumbnail 
)
overridevirtual

Implements AzToolsFramework::Thumbnailer::ThumbnailProvider.

◆ IsSupportedThumbnail()

template<class ThumbnailType , class Hasher = AZStd::hash<SharedThumbnailKey>, class EqualKey = AZStd::equal_to<SharedThumbnailKey>>
virtual bool AzToolsFramework::Thumbnailer::ThumbnailCache< ThumbnailType, Hasher, EqualKey >::IsSupportedThumbnail ( SharedThumbnailKey  key) const
protectedpure virtual

Check if thumbnail key is handled by this provider, overload in derived class.

Implemented in AzToolsFramework::AssetBrowser::FolderThumbnailCache, AzToolsFramework::AssetBrowser::SourceThumbnailCache, AzToolsFramework::Thumbnailer::SourceControlThumbnailCache, and AzToolsFramework::AssetBrowser::ProductThumbnailCache.

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