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::SourceFileDetails Struct Reference

#include <AssetBrowserBus.h>

Public Member Functions

 SourceFileDetails (const char *thumbnailPath)
 Update this constructor or add more constructors if you add fields so that existing ones continue to work.
 
SourceFileDetailsoperator= (SourceFileDetails &&other)
 
 SourceFileDetails (const SourceFileDetails &other)=default
 
 SourceFileDetails (SourceFileDetails &&other)
 
SourceFileDetailsoperator= (const SourceFileDetails &other)=default
 

Public Attributes

AZStd::string m_sourceThumbnailPath
 

Detailed Description

used by the API to (optionally) let systems describe details about source files see /ref AssetBrowserInteractionNotifications to see how it is used. The intended behavior of this is that listeners respond with a SourceFileDetails struct which has only the field(s) filled in which they can fill in, and the system combines all responses to fill in details from many systems. More fields may be added to SourceFileDetails as more systems require other kinds of details.

Member Function Documentation

◆ operator=()

SourceFileDetails & AzToolsFramework::AssetBrowser::SourceFileDetails::operator= ( SourceFileDetails &&  other)
inline

this is the function that will be used to "fold" multiple returned values from other results onto one canonical result containing all the result fields. This function gets called repeatedly, once for every responding listener and can be used to avoid allocations.

Member Data Documentation

◆ m_sourceThumbnailPath

AZStd::string AzToolsFramework::AssetBrowser::SourceFileDetails::m_sourceThumbnailPath

An openable path to a resource that can be used as the thumbnail for this type of file. This can be a Qt resource system string like ":/tools/something.png" for resources embedded in your dlls, or an absolute path, or relative source asset path like "editor/icons/whatever.png"


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