AzToolsFramework::AssetBrowser::AssetBrowserEntryFilter Class Reference

#include <Filter.h>

Inherits QObject.

Inherited by AzToolsFramework::AssetBrowser::AssetGroupFilter, AzToolsFramework::AssetBrowser::AssetTypeFilter, AzToolsFramework::AssetBrowser::CleanerProductsFilter, AzToolsFramework::AssetBrowser::CompositeFilter, AzToolsFramework::AssetBrowser::CustomFilter, AzToolsFramework::AssetBrowser::EntryTypeFilter, AzToolsFramework::AssetBrowser::InverseFilter, AzToolsFramework::AssetBrowser::RegExpFilter, and AzToolsFramework::AssetBrowser::StringFilter.

Public Types
enum class	PropagateDirection : uint32_t { None , Up , Down , Both }
	Propagate direction allows match satisfaction based on entry parents and/or children.

Signals
void	updatedSignal () const

Public Member Functions
virtual AssetBrowserEntryFilter *	Clone () const =0
bool	Match (const AssetBrowserEntry *entry) const
	Check if entry matches filter.
bool	MatchWithoutPropagation (const AssetBrowserEntry *entry) const
	Check if the entry matches filter without propagation (i.e. it's an exact match and it doesn't match only.
void	Filter (AZStd::unordered_set< const AssetBrowserEntry * > &result, const AssetBrowserEntry *entry) const
	Retrieve all matching entries that are either entry itself or its parents or children.
QString	GetName () const
	Filter name is used to uniquely identify the filter.
void	SetName (const QString &name)
const QString &	GetTag () const
	Tags are used for identifying filter groups.
void	SetTag (const QString &tag)
void	SetFilterPropagation (PropagateDirection direction)

Protected Attributes
QString	m_name
QString	m_tag
PropagateDirection	m_direction { PropagateDirection::None }

Detailed Description

Filters are used to fascilitate searching asset browser for specific asset They are also used for enforcing selection constraints for asset picking

Member Function Documentation

Clone()

virtual AssetBrowserEntryFilter * AzToolsFramework::AssetBrowser::AssetBrowserEntryFilter::Clone ( ) const

pure virtual

Cloning function that must be overridden for certain asset browser views that duplicate and modify incoming filters This should be implemented using a copy constructor, which is currently not possible because inheriting QObject prevents it.

Implemented in AzToolsFramework::AssetBrowser::StringFilter, AzToolsFramework::AssetBrowser::CustomFilter, AzToolsFramework::AssetBrowser::RegExpFilter, AzToolsFramework::AssetBrowser::AssetTypeFilter, AzToolsFramework::AssetBrowser::AssetGroupFilter, AzToolsFramework::AssetBrowser::EntryTypeFilter, AzToolsFramework::AssetBrowser::CompositeFilter, AzToolsFramework::AssetBrowser::InverseFilter, and AzToolsFramework::AssetBrowser::CleanerProductsFilter.

updatedSignal

void AzToolsFramework::AssetBrowser::AssetBrowserEntryFilter::updatedSignal ( ) const

signal

Emitted every time a filter is updated, in case of composite filter, the signal is propagated to the top level filter so only one listener needs to connected

---

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

• Code/Framework/AzToolsFramework/AzToolsFramework/AssetBrowser/Search/Filter.h