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.
AzToolsFramework::AssetBrowser::Previewer Class Referenceabstract

#include <Previewer.h>

Inherits QWidget.

Inherited by AzToolsFramework::AssetBrowser::EmptyPreviewer.

Public Member Functions

 Previewer (QWidget *parent=nullptr)
 
virtual void Clear () const =0
 Clear previewer.
 
virtual void Display (const AssetBrowserEntry *entry)=0
 Display asset preview for specific asset browser entry.
 
virtual const QString & GetName () const =0
 Get name of the previewer (this should be unique to other previewers)
 

Detailed Description

A base class for Asset Browser previewer. To implement your custom previewer:

  1. Derive your previewer widget from this class.
  2. Implement custom PreviewerFactory.
  3. Register PreviewerFactory with PreviewerRequestBus::RegisterFactory EBus. Note: if there are multiple factories handling same entry type, last one registered will be selected.

Member Function Documentation

◆ Clear()

virtual void AzToolsFramework::AssetBrowser::Previewer::Clear ( ) const
pure virtual

Clear previewer.

Implemented in AzToolsFramework::AssetBrowser::EmptyPreviewer.

◆ Display()

virtual void AzToolsFramework::AssetBrowser::Previewer::Display ( const AssetBrowserEntry entry)
pure virtual

Display asset preview for specific asset browser entry.

Implemented in AzToolsFramework::AssetBrowser::EmptyPreviewer.

◆ GetName()

virtual const QString & AzToolsFramework::AssetBrowser::Previewer::GetName ( ) const
pure virtual

Get name of the previewer (this should be unique to other previewers)

Implemented in AzToolsFramework::AssetBrowser::EmptyPreviewer.


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