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.
AzToolsFramework::AssetBrowser::CompositeFilter Class Reference

CompositeFilter performs an AND/OR operation between multiple subfilters. More...

#include <Filter.h>

Inherits AzToolsFramework::AssetBrowser::AssetBrowserEntryFilter.

Public Types

enum class  LogicOperatorType : uint32_t { OR , AND }
 
- Public Types inherited from AzToolsFramework::AssetBrowser::AssetBrowserEntryFilter
enum class  PropagateDirection : uint32_t { None , Up , Down , Both }
 Propagate direction allows match satisfaction based on entry parents and/or children.
 

Public Member Functions

 CompositeFilter (LogicOperatorType logicOperator)
 
AssetBrowserEntryFilterClone () const override
 
void AddFilter (FilterConstType filter)
 
void RemoveFilter (FilterConstType filter)
 
void RemoveAllFilters ()
 
void SetLogicOperator (LogicOperatorType logicOperator)
 
const QList< FilterConstType > & GetSubFilters () const
 
void SetEmptyResult (bool result)
 Return value if there are no subfilters present.
 
- Public Member Functions inherited from AzToolsFramework::AssetBrowser::AssetBrowserEntryFilter
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)
 

Additional Inherited Members

- Signals inherited from AzToolsFramework::AssetBrowser::AssetBrowserEntryFilter
void updatedSignal () const
 
- Protected Attributes inherited from AzToolsFramework::AssetBrowser::AssetBrowserEntryFilter
QString m_name
 
QString m_tag
 
PropagateDirection m_direction { PropagateDirection::None }
 

Detailed Description

CompositeFilter performs an AND/OR operation between multiple subfilters.

Member Function Documentation

◆ Clone()

AssetBrowserEntryFilter * AzToolsFramework::AssetBrowser::CompositeFilter::Clone ( ) const
overridevirtual

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.

Implements AzToolsFramework::AssetBrowser::AssetBrowserEntryFilter.


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