Open 3D Engine AzToolsFramework API Reference 26.05.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 | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
AzToolsFramework::AssetBrowser::AssetBrowserEntry Class Referenceabstract

AssetBrowserEntry is a base class for asset tree view entry. More...

#include <AssetBrowserEntry.h>

Inherits QObject.

Inherited by AzToolsFramework::AssetBrowser::FolderAssetBrowserEntry, AzToolsFramework::AssetBrowser::ProductAssetBrowserEntry, AzToolsFramework::AssetBrowser::RootAssetBrowserEntry, and AzToolsFramework::AssetBrowser::SourceAssetBrowserEntry.

Public Types

enum class  AssetEntrySortMode {
  Name , FileType , LastModified , Size ,
  Vertices , Dimensions
}
 
enum class  AssetEntryType { Root , Folder , Source , Product }
 
enum class  Column {
  Name , Path , SourceID , Fingerprint ,
  Guid , ScanFolderID , ProductID , JobID ,
  SubID , AssetType , ClassID , DisplayName ,
  Type , DiskSize , Vertices , ApproxSize ,
  SourceControlStatus , Count
}
 

Public Member Functions

 AZ_RTTI (AssetBrowserEntry, "{67679F9E-055D-43BE-A2D0-FB4720E5302A}")
 
virtual QVariant data (int column) const
 
int row () const
 
virtual AssetEntryType GetEntryType () const =0
 
const AZStd::string & GetName () const
 Actual name of the asset or folder.
 
const AZ::u32 GetGroupNameCrc () const
 Group name CRC provided by asset type info.
 
const QString & GetGroupName () const
 Group name provided by asset type info.
 
const QString & GetDisplayName () const
 Display name represents how entry is shown in asset browser.
 
const QString & GetDisplayPath () const
 
const AZStd::string & GetRelativePath () const
 Return path relative to scan folder.
 
const AZStd::string & GetVisiblePath () const
 Return path visible to asset browser.
 
const AZStd::string & GetFullPath () const
 
const size_t GetDiskSize () const
 Return the size on disk of the asset.
 
const AZ::u64 GetModificationTime () const
 Return the time the file was last modified.
 
const AZ::Vector3 & GetDimension () const
 Returns the dimension of the model.
 
const uint32_t GetNumVertices () const
 Returns the number of vertices in the model.
 
const QString & GetEntryTypeAsString () const
 
void VisitUp (const AZStd::function< bool(const AssetBrowserEntry *)> &visitorFn) const
 
void VisitDown (const AZStd::function< bool(const AssetBrowserEntry *)> &visitorFn) const
 
template<typename EntryType >
void GetChildren (AZStd::vector< const EntryType * > &entries) const
 Get immediate children of specific type.
 
template<typename EntryType >
void GetChildrenRecursively (AZStd::vector< const EntryType * > &entries) const
 Recurse through the tree down to get all entries of specific type.
 
const AssetBrowserEntry * GetChild (int index) const
 Get child by index.
 
AssetBrowserEntry * GetChild (int index)
 
int GetChildCount () const
 Get number of children.
 
AssetBrowserEntry * GetParent () const
 Get immediate parent.
 
virtual SharedThumbnailKey GetThumbnailKey () const
 
void SetThumbnailKey (SharedThumbnailKey thumbnailKey)
 
virtual SharedThumbnailKey CreateThumbnailKey ()=0
 
void SetDisplayName (const QString name)
 
void SetIconPath (const AZ::IO::Path path)
 
AZ::IO::Path GetIconPath () const
 
bool lessThan (const AssetBrowserEntry *other, const AssetBrowserEntry::AssetEntrySortMode sortColumn, const QCollator &collator) const
 
void SetFullPath (const AZ::IO::Path &fullPath)
 

Static Public Member Functions

static QString AssetEntryTypeToString (AssetEntryType assetEntryType)
 
static bool FromMimeData (const QMimeData *mimeData, AZStd::vector< const AssetBrowserEntry * > &entries)
 
static QString GetMimeType ()
 
static const AZStd::string ExtensionToType (AZStd::string_view str)
 
template<typename EntryType >
static void ForEachEntryInMimeData (const QMimeData *mimeData, AZStd::function< void(const EntryType *)> callbackFunction)
 ! Utility function: Given a Qt QMimeData pointer, your callbackFunction will be called for each entry of that type it finds in there.
 

Static Public Attributes

static const char * m_columnNames [static_cast< int >(Column::Count)]
 

Protected Member Functions

virtual void AddChild (AssetBrowserEntry *child)
 
void RemoveChild (AssetBrowserEntry *child)
 
void RemoveChildren ()
 
virtual void UpdateChildPaths (AssetBrowserEntry *child) const
 When child is added, its paths are updated relative to this entry.
 
virtual void PathsUpdated ()
 
virtual void SetThumbnailDirty ()
 

Protected Attributes

AZStd::string m_name
 
AZ::u32 m_groupNameCrc { 0 }
 
QString m_groupName
 
QString m_displayName
 
QString m_displayPath
 
QString m_entryType
 
AZ::IO::Path m_relativePath
 
AZ::IO::Path m_visiblePath
 
AZ::IO::Path m_fullPath
 
AZ::IO::Path m_iconPath
 
AZ::u64 m_modificationTime
 
size_t m_diskSize
 
AZ::Vector3 m_dimension { AZ::GetFloatQNaN(), AZ::GetFloatQNaN(), AZ::GetFloatQNaN() }
 
uint32_t m_vertices { 0 }
 
AZStd::vector< AssetBrowserEntry * > m_children
 
AssetBrowserEntry * m_parentAssetEntry = nullptr
 

Friends

class AssetBrowserModel
 
class AssetBrowserFilterModel
 
class RootAssetBrowserEntry
 
class FolderAssetBrowserEntry
 
class SourceAssetBrowserEntry
 
class ProductAssetBrowserEntry
 

Detailed Description

AssetBrowserEntry is a base class for asset tree view entry.

Member Function Documentation

◆ FromMimeData()

static bool AzToolsFramework::AssetBrowser::AssetBrowserEntry::FromMimeData ( const QMimeData *  mimeData,
AZStd::vector< const AssetBrowserEntry * > &  entries 
)
static
Deprecated:
: Use "AssetBrowserEntryUtils::FromMimeData" instead

◆ GetDisplayPath()

const QString & AzToolsFramework::AssetBrowser::AssetBrowserEntry::GetDisplayPath ( ) const

Display name represents how the path to the file is shown in the asset browser. It does not include the file name of the entry.

◆ GetFullPath()

const AZStd::string & AzToolsFramework::AssetBrowser::AssetBrowserEntry::GetFullPath ( ) const

Return absolute path to this file. Note that this decodes it to native slashes and resolves any aliases.

◆ UpdateChildPaths()

virtual void AzToolsFramework::AssetBrowser::AssetBrowserEntry::UpdateChildPaths ( AssetBrowserEntry *  child) const
protectedvirtual

When child is added, its paths are updated relative to this entry.

Reimplemented in AzToolsFramework::AssetBrowser::FolderAssetBrowserEntry, and AzToolsFramework::AssetBrowser::RootAssetBrowserEntry.

◆ VisitDown()

void AzToolsFramework::AssetBrowser::AssetBrowserEntry::VisitDown ( const AZStd::function< bool(const AssetBrowserEntry *)> &  visitorFn) const

Recursively call the visitor function for the current entry and all of its children. Returning false from the visitor function stops recursion.

◆ VisitUp()

void AzToolsFramework::AssetBrowser::AssetBrowserEntry::VisitUp ( const AZStd::function< bool(const AssetBrowserEntry *)> &  visitorFn) const

Recursively call the visitor function for the current entry and all of its parents. Returning false from the visitor function stops recursion.

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