SAssetFilterBar

Navigation

API > API/Editor > API/Editor/EditorWidgets

An Asset Filter Bar widget, which can be used to filter items of type [FilterType] given a list of custom filters along with built in support for AssetType filters Use the GetAllActiveFilters() and GetCombinedBackendFilter() functions to get all the custom and asset filters respectively NOTE: GetCombinedBackendFilter returns an FARFilter, and it is on the user of this widget to compile it/use it to filter their items. If you want more straightforward filtering, look at SFilterBar which streamlines this Use MakeAddFilterButton() to make the button that summons the dropdown showing all the filters Sample Usage: void OnFilterChangedDelegate() { TSharedPtr< TFilterCollection > ActiveFilters = MyFilterBar->GetAllActiveFilters(); FARFilter CombinedBackEndFilter = MyFilterBar->GetCombinedBackendFilter() TArray MyUnfilteredItems; TArray FilteredItems;

for(FilterType& MyItem : MyUnfilteredItems) { if(CompileAndRunFARFilter(CombinedBackEndFilter, MyItem) && ActiveFilters.PassesAllFilters(MyItem)) { FilteredItems.Add(MyItem); } } }

Syntax

template<typename FilterType>  
class SAssetFilterBar :  
    public SBasicFilterBar< FilterType > ,  
    public FFilterBarBase  
Copy full snippet

template<typename FilterType> class SAssetFilterBar :     public SBasicFilterBar< FilterType > ,     public FFilterBarBase

Inheritance Hierarchy

• FFilterBarBase → SAssetFilterBar
• FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SBasicFilterBar → SAssetFilterBar
• FSlateControlledConstruction → SWidget → SCompoundWidget → SBasicFilterBar → SAssetFilterBar

Derived Classes

• SFilterBar

Destructors

Classes

Structs

Typedefs

Variables

Protected

Functions

Public

Overridden from SBasicFilterBar

Protected

Overridden from SWidget

See Also

• SFilterBar in EditorWidgets

• which is a simplified version of this widget for most use cases which is probably what you want to use

• SBasicFilterBar in ToolWidgets if you want a simple FilterBar without AssetType Filters (usable in non editor builds)

• SFilterList in ContentBrowser for an extremely complex example of how to use this widget

• though for most cases you probably want to use SFilterBar NOTE: The filter functions create copies

• so you want to use SAssetFilterBar> etc instead of SAssetFilterBar when possible NOTE: You will need to also add "ToolWidgets" as a dependency to your module to use this widget Sample Usage: SAssignNew(MyFilterBar

• SAssetFilterBar) .OnFilterChanged() // A delegate for when the list of filters changes .CustomFilters() // An array of filters available to this FilterBar (

• FGenericFilter to create simple delegate based filters)