1. Epic GamesDeveloper
  3. SAssetView

SAssetView

A widget to display a list of filtered assets

API > API/Editor > API/Editor/ContentBrowser

A widget to display a list of filtered assets

   
Name SAssetView
Type class
Header File /Engine/Source/Editor/ContentBrowser/Public/SAssetView.h
Include Path #include "SAssetView.h"

Syntax

class SAssetView : public SCompoundWidget

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

SAssetView()

 SAssetView SAssetView.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~SAssetView()

   SAssetView.h  

Structs

Name Remarks
FArguments  
FCreateDeferredItemData A struct to hold data for the deferred creation of a file or folder item
FQuickJumpData Struct holding the data for the asset quick-jump

Constants

Name Type Remarks Include Path
AssetViewOptionsMenuRegistration FDelayedAutoRegisterHelper Registers the menu used by the settings button SAssetView.h
NavigationBarMenuExtensionRegistration FDelayedAutoRegisterHelper Extend the bottom navigation bar SAssetView.h
TileViewHeightPadding int32 Vertical padding for the TileViewItem SAssetView.h
TileViewWidthPadding int32 Horizontal padding for the TileViewItem SAssetView.h
ToolBarMenuExtensionRegistration FDelayedAutoRegisterHelper Extend the top toolbar SAssetView.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
FAssetContextMenu friend   SAssetView.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AllowThumbnailHintLabel bool Whether to ever show the hint label on thumbnails SAssetView.h  
AmortizeStartTime double When delegate amortization began SAssetView.h  
AssetClassPermissionList TSharedPtr< FPathPermissionList >   SAssetView.h  
AssetShowWarningText TAttribute< FText > The text to show when there are no assets to show SAssetView.h  
AssetThumbnailPool TSharedPtr< FAssetThumbnailPool > Pool for maintaining and rendering thumbnails SAssetView.h  
AssetViewOptionsProfile TOptional< FName > An optional profile name for the asset view options menu. SAssetView.h  
AwaitingRename TWeakPtr< FAssetViewItem > Weak ptr to the asset that is waiting to be renamed now that it has scrolled into view, if window is active SAssetView.h  
AwaitingScrollIntoViewForRename TWeakPtr< FAssetViewItem > Weak ptr to the asset that is waiting to be renamed when scrolled into view, and the window is active SAssetView.h  
BackendCustomPathFilters TArray< TSharedRef< const FPathPermissionList > > Paths which should be filtered out based on current filters the user has selected SAssetView.h  
BackendFilter FARFilter   SAssetView.h  
bAllowDragging bool Whether to allow dragging of items SAssetView.h  
bAllowFocusOnSync bool Whether this asset view should allow focus on sync or not SAssetView.h  
bAllowThumbnailEditMode bool When true, the user may edit thumbnails SAssetView.h  
bBulkSelecting bool When true, selection change notifications will not be sent SAssetView.h  
bCanShowClasses bool Indicates if this view is allowed to show classes SAssetView.h  
bCanShowDevelopersFolder bool Indicates if the 'Show Developers' option should be enabled or disabled SAssetView.h  
bCanShowFavorites bool Indicates if the 'Show Favorites' option should be enabled or disabled SAssetView.h  
bCanShowFolders bool Indicates if the 'Show Folders' option should be enabled or disabled SAssetView.h  
bCanShowReadOnlyFolders bool Indicates if this view is allowed to show folders that cannot be written to SAssetView.h  
bCanShowRealTimeThumbnails bool Indicates if the 'Real-Time Thumbnails' option should be enabled or disabled SAssetView.h  
bColumnViewColumnsManuallyChangedOnce bool Set to true as soon as the user change the ColumnView visibility of a column, after that point the Loaded Hidden Columns will be used instead of any default given SAssetView.h  
bFillEmptySpaceInTileView bool Flag indicating if we will be filling the empty space in the tile view. SAssetView.h  
bFilterRecursivelyWithBackendFilter bool If true, recursive filtering will be caused by applying a backend filter SAssetView.h  
bForceHideScrollbar bool If true, scrollbar is never shown, removes scroll border entirely SAssetView.h  
bForceShowEngineContent bool If true, engine content is always shown SAssetView.h  
bForceShowPluginContent bool If true, plugin content is always shown SAssetView.h  
bLastShowRedirectors bool   SAssetView.h  
bListViewColumnsManuallyChangedOnce bool Set to true as soon as the user change the ListView visibility of a column, after that point the Loaded Hidden Columns will be used instead of any default given SAssetView.h  
bLoadingSettings bool True when loading settings, this is needed for the HiddenColumns for example to not double update them SAssetView.h  
bPendingFocusOnSync bool Should we take focus when the PendingSyncAssets are processed? SAssetView.h  
bPendingSortFilteredItems bool When true, filtered list items will be sorted next tick. SAssetView.h  
bPendingUpdateThumbnails bool Flag to defer thumbnail updates until the next frame SAssetView.h  
bQuickFrontendListRefreshRequested bool If true, the frontend items will be refreshed next frame. Much faster. SAssetView.h  
bShouldNotifyNextAssetSync bool Whether or not to notify about newly selected items on on the next asset sync SAssetView.h  
bShowDisallowedAssetClassAsUnsupportedItems bool   SAssetView.h  
bShowPathInColumnView bool If true, it will show path column in the asset view SAssetView.h  
bShowPathViewFilters bool Show path view filters submenu in view options menu SAssetView.h  
bShowRedirectors TAttribute< bool >   SAssetView.h  
bShowTypeInColumnView bool If true, it will show type in the asset view SAssetView.h  
bShowTypeInTileView bool If true, it will show type in the tile view SAssetView.h  
bSlowFullListRefreshRequested bool If true, the source items will be refreshed next frame. Very slow. SAssetView.h  
bSortByPathInColumnView bool If true, it sorts by path and then name SAssetView.h  
bThumbnailEditMode bool True when the asset view is currently allowing the user to edit thumbnails SAssetView.h  
bUserSearching bool Flag set if the user is currently searching SAssetView.h  
bWereItemsRecursivelyFiltered bool Was recursive filtering enabled the last time a full slow refresh performed? SAssetView.h  
ColumnView TSharedPtr< SListView< TSharedPtr< FAssetViewItem > > >   SAssetView.h  
ColumnViewSpecifier const FString   SAssetView.h  
Commands TSharedPtr< FUICommandList > Commands handled by this widget SAssetView.h  
ContentSources FAssetViewContentSources The current base source filter for the view SAssetView.h  
CurrentFrontendFilterTelemetry UE::Telemetry::ContentBrowser::FFrontendFilterTelemetry In progress filter session telemetry - will be sent when filtering ends or user cancels or interacts with a partial filter set. SAssetView.h  
CurrentThumbnailSize int32 The current size of relevant thumbnails SAssetView.h  
CurrentTime double   SAssetView.h  
CurrentViewType EAssetViewType::Type The list view that is displaying the assets SAssetView.h  
CustomColumns TArray< FAssetViewCustomColumn >   SAssetView.h  
CustomView TSharedPtr< SWidget > The actual widget for the custom view SAssetView.h  
CustomViewSpecifier const FString   SAssetView.h  
DefaultHiddenColumnNames TArray< FString > Column filtering state SAssetView.h  
DefaultListHiddenColumnNames TArray< FString >   SAssetView.h  
DeferredItemToCreate TUniquePtr< FCreateDeferredItemData > File or folder item pending deferred creation SAssetView.h  
DeferredPendingSyncItems FSelectionData The list of items used to ensure all the pending sync items are selected due to async nature of filtering SAssetView.h  
DeferredSyncTimeoutFrames int32 A Timeout counter to safeguard against infinite deferement of pending sync items SAssetView.h  
FillScale float The amount to scale each thumbnail so that the empty space is filled. SAssetView.h  
FilterBar TWeakPtr< SFilterList > The Filter Bar attached to this asset view if any SAssetView.h  
FilterCacheID FContentBrowserDataFilterCacheIDOwner An Id for the cache of the data sources for the filters compilation SAssetView.h  
FilteredAssetItems TArray< TSharedPtr< FAssetViewItem > > The items that are being shown in the filtered view list SAssetView.h  
FilteredAssetItemTypeCounts TMap< FName, int32 > Map of an item name to the current count of FilteredAssetItems that are of that type SAssetView.h  
FilterSessionCorrelationGuid FGuid Guid to correlate different telemetry events for a 'session' of search/filtering, reset when new backend items are gathered for filtering. SAssetView.h  
FolderPermissionList TSharedPtr< FPathPermissionList >   SAssetView.h  
FrontendFilters TSharedPtr< FAssetFilterCollectionType >   SAssetView.h  
GridViewSpecifier const FString Specifiers used for Config. SAssetView.h  
HiddenColumnNames TArray< FString >   SAssetView.h  
HighlightedText TAttribute< FText > The text to highlight on the assets SAssetView.h  
InitialCategoryFilter EContentBrowserItemCategoryFilter Initial set of item categories that this view should show - may be adjusted further by things like CanShowClasses or legacy delegate bindings SAssetView.h  
InitialNumAmortizedTasks int32 The initial number of tasks when we started performing amortized work (used to display a progress cue to the user) SAssetView.h  
Items TPimplPtr< FAssetViewItemCollection > Private type managing data retrieved from the backend and async filtering thereof SAssetView.h  
LastSortTime double   SAssetView.h  
ListHiddenColumnNames TArray< FString >   SAssetView.h  
ListView TSharedPtr< SAssetListView >   SAssetView.h  
ListViewItemHeight float   SAssetView.h  
ListViewSpecifier const FString   SAssetView.h  
ListViewThumbnailPadding int32   SAssetView.h  
ListViewThumbnailResolution int32 The size of thumbnails SAssetView.h  
ListViewThumbnailSize int32   SAssetView.h  
MajorityAssetType FName When in columns view, this is the name of the asset type which is most commonly found in the recent results SAssetView.h  
MaxSecondsPerFrame float The max number of results to process per tick SAssetView.h  
MaxThumbnailScale float   SAssetView.h  
MaxThumbnailSize float   SAssetView.h  
MinThumbnailScale float The max and min thumbnail scales as a fraction of the rendered size SAssetView.h  
MinThumbnailSize float The max and min thumbnail sizes SAssetView.h  
NumOffscreenThumbnails int32 The number of thumbnails to keep for asset items that are not currently visible. SAssetView.h  
OnAssetTagWantsToBeDisplayed FOnShouldDisplayAssetTag Called to check if an asset tag should be display in details view. SAssetView.h  
OnAssetToolTipClosing FOnAssetToolTipClosing Called when a custom asset item's tooltip is closing SAssetView.h  
OnExtendAssetViewOptionsMenuContext FOnExtendAssetViewOptionsMenuContext Called when opening view options menu SAssetView.h  
OnGetCustomAssetToolTip FOnGetCustomAssetToolTip Called to get a custom asset item tooltip (If necessary) SAssetView.h  
OnGetCustomSourceAssets FOnGetCustomSourceAssets Called to add extra asset data to the asset view, to display virtual assets. SAssetView.h  
OnGetItemContextMenu FOnGetContentBrowserItemContextMenu Delegate to invoke when generating the context menu for an item SAssetView.h  
OnIsAssetValidForCustomToolTip FOnIsAssetValidForCustomToolTip Called to see if it is valid to get a custom asset tool tip SAssetView.h  
OnItemRenameCommitted FOnContentBrowserItemRenameCommitted Called when the user has committed a rename of one or more items SAssetView.h  
OnItemsActivated FOnContentBrowserItemsActivated Called when the user double clicks, presses enter, or presses space on a Content Browser item SAssetView.h  
OnItemSelectionChanged FOnContentBrowserItemSelectionChanged Called when an item was selected in the list. Provides more context than OnAssetSelected. SAssetView.h  
OnNewItemRequested FOnAssetViewNewItemRequested Called when the asset view is asked to start to create a temporary item SAssetView.h  
OnSearchOptionsChanged FOnSearchOptionChanged Called when a search option changes to notify that results should be rebuilt SAssetView.h  
OnShouldFilterAsset FOnShouldFilterAsset Called to check if an asset should be filtered out by external code SAssetView.h  
OnShouldFilterItem FOnShouldFilterItem Called to check if an item should be filtered out by external code SAssetView.h  
OnVisualizeAssetToolTip FOnVisualizeAssetToolTip Called when a custom asset item is about to show a tooltip SAssetView.h  
OwningContentBrowser TWeakPtr< SContentBrowser > The content browser that created this asset view if any SAssetView.h  
PendingSyncItems FSelectionData The list of items to sync next frame SAssetView.h  
QuickJumpData FQuickJumpData Data for the asset quick-jump SAssetView.h  
RelevantThumbnails TMap< TSharedPtr< FAssetViewItem >, TSharedPtr< FAssetThumbnail > > A map of FAssetViewAsset to the thumbnail that represents it. SAssetView.h  
RenamingAsset TWeakPtr< FAssetViewItem > Set when the user is in the process of naming an asset SAssetView.h  
SelectionMode ESelectionMode::Type The current selection mode used by the asset view SAssetView.h  
SortDelaySeconds double   SAssetView.h  
SortManager TSharedPtr< FAssetViewSortManager > The manager responsible for sorting assets in the view SAssetView.h  
TextFilter TSharedPtr< FAssetTextFilter >   SAssetView.h  
ThumbnailHintColorAndOpacity FLinearColor The current thumbnail hint color and opacity SAssetView.h  
ThumbnailHintFadeInSequence FCurveSequence The sequence used to generate the opacity of the thumbnail hint SAssetView.h  
ThumbnailLabel EThumbnailLabel::Type What the label on the thumbnails should be SAssetView.h  
ThumbnailScaleRangeScalar float Scalar applied to thumbnail sizes so that users thumbnails are scaled based on users display area size SAssetView.h  
ThumbnailSizes TMap< EAssetViewType::Type, EThumbnailSize > Current thumbnail sizes SAssetView.h  
TileView TSharedPtr< SAssetTileView >   SAssetView.h  
TileViewNameHeight int32   SAssetView.h  
TileViewThumbnailPadding int32   SAssetView.h  
TileViewThumbnailResolution int32   SAssetView.h  
TileViewThumbnailSize int32   SAssetView.h  
TotalAmortizeTime double The total time spent amortizing the delegate filter SAssetView.h  
ViewContainer TSharedPtr< SBox >   SAssetView.h  
ViewCorrelationGuid FGuid Guid to correlate different telemetry events for this instance of an asset view over time. SAssetView.h  
ViewExtender TSharedPtr< IContentBrowserViewExtender > An extender to create the custom view SAssetView.h  
VisibleItems TArray< TSharedPtr< FAssetViewItem > > The set of FAssetItems that currently have widgets displaying them. SAssetView.h  
WritableFolderPermissionList TSharedPtr< FPathPermissionList >   SAssetView.h  
ZoomScale float Scale when using CTRL+Wheel, will go from 0.f to 1.f and reset accordingly when ThumbnailSize chosen changes SAssetView.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AdjustActiveSelection ( int32 SelectionDelta
)

 Adjusts the selected asset by the selection delta, which should be +1 or -1) SAssetView.h  

void ApplyHistoryData ( const FHistoryData& History
)

 Sets the state of the asset view to the one described by the history data SAssetView.h  

void ClearSelection ( bool bForceSilent
)

 Clears the selection of all the lists in the view SAssetView.h  

void Construct ( const FArguments& InArgs
)

 Constructs this widget with InArgs SAssetView.h  

void CreateNewAsset ( const FString& DefaultAssetName,
const FString& PackagePath,
UClass* AssetClass,
UFactory* Factory
)

 Creates a new asset item designed to allocate a new object once it is named. SAssetView.h  

void ForceShowPluginFolder ( bool bEnginePlugin
)

 Forces the plugin content folder to be shown. SAssetView.h  

FText GetAssetCountText()

 Gets the text for the asset count label SAssetView.h  

const FARFilter & GetBackendFilter()

 Get the current backend filter SAssetView.h  

const FAssetViewContentSources & GetContentSources()

 Returns the sources filter applied to this asset view SAssetView.h  

TArray< FAssetData > GetSelectedAssets()

 Returns all the asset data objects in items currently selected in the view SAssetView.h  

TArray< FContentBrowserItem > GetSelectedFileItems()

 Returns all the file items currently selected in the view SAssetView.h  

TArray< FContentBrowserItem > GetSelectedFolderItems()

 Returns all the folder items currently selected in the view SAssetView.h  

TArray< FString > GetSelectedFolders()

 Returns all the folders currently selected in the view SAssetView.h  

TArray< FContentBrowserItem > GetSelectedItems()

 Returns all the items currently selected in the view SAssetView.h  

TArray< TSharedPtr< FAssetViewItem > > GetSelectedViewItems()

 Returns all the items currently selected in the view SAssetView.h  

TWeakPtr< FAssetViewSortManager > GetSortManager()

 Get the underlying sort manager SAssetView.h  

FSourcesData GetSourcesData()

   SAssetView.h  

TSharedRef< SWidget > GetViewButtonContent()

 Handler for when the view combo button is clicked SAssetView.h  

void HandleSettingChanged ( FName PropertyName
)

 Delegate called when an editor setting is changed SAssetView.h  

bool HasDeferredItemToCreate()

 True if we have deferred item to create SAssetView.h  

bool HasItemsPendingFilter()

 True if we have items pending that ProcessItemsPendingFilter still needs to process SAssetView.h  

bool HasThumbnailsPendingUpdate()

 True if we have thumbnails that are pending update SAssetView.h  

void InitDeferredPendingSyncItems()

 Setup Deferred Pending Sync for recently added PendingSyncItems. SAssetView.h  

bool IsAssetPathSelected()

 Returns true if a real asset path is selected (i.e \Engine* or \Game*) SAssetView.h  

bool IsIncludingAssetPaths()

   SAssetView.h  

bool IsIncludingClassNames()

   SAssetView.h  

bool IsIncludingCollectionNames()

   SAssetView.h  

bool IsRenamingAsset()

 Returns true if an asset is currently in the process of being renamed SAssetView.h  

bool IsThumbnailEditMode()

 Returns true if the asset view is in thumbnail editing mode SAssetView.h  

void LoadSettings ( const FString& IniFilename,
const FString& IniSection,
const FString& SettingsString
)

 Loads any settings to config that should be persistent between editor sessions SAssetView.h  

void NewFileItemRequested ( const FContentBrowserItemDataTemporaryContext& NewItemContext
)

 Handler for when a data source requests file item creation SAssetView.h  

void NewFolderItemRequested ( const FContentBrowserItemTemporaryContext& NewItemContext
)

 Handler for when a data source requests folder item creation SAssetView.h  

virtual void OnDragLeave ( const FDragDropEvent& DragDropEvent
)

   SAssetView.h  

virtual FReply OnDragOver ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

   SAssetView.h  

virtual FReply OnDrop ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

   SAssetView.h  

virtual void OnFocusChanging ( const FWeakWidgetPath& PreviousFocusPath,
const FWidgetPath& NewWidgetPath,
const FFocusEvent& InFocusEvent
)

   SAssetView.h  

virtual FReply OnKeyChar ( const FGeometry& MyGeometry,
const FCharacterEvent& InCharacterEvent
)

   SAssetView.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   SAssetView.h  

virtual FReply OnMouseWheel ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   SAssetView.h  

void OnOpenAssetsOrFolders()

 Opens the selected assets or folders, depending on the selection SAssetView.h  

void OnPreviewAssets()

 Loads the selected assets and previews them if possible SAssetView.h  
Enables the Show Developer Content setting for the active Content Browser. SAssetView.h  
Enables the Show Engine Content setting for the active Content Browser. SAssetView.h  
Enables the Show Localized Content setting for the active Content Browser. SAssetView.h  
Enables the Show Plugin Content setting for the active Content Browser. SAssetView.h  

void RenameItem ( const FContentBrowserItem& ItemToRename
)

 Sets up an inline rename for the specified item SAssetView.h  
Requests that the asset view refreshes only items that are filtered through frontend sources. SAssetView.h  
Requests that the asset view refreshes all it's source items. SAssetView.h  

void SaveSettings ( const FString& IniFilename,
const FString& IniSection,
const FString& SettingsString
) const

 Saves any settings to config that should be persistent between editor sessions SAssetView.h  

void SetBackendFilter ( const FARFilter& InBackendFilter,
TArray< TSharedRef< const FPathPermissionList > >* InCustomPermissionLists
)

 Provide a backend filter for the asset view and invalidate current source items. SAssetView.h  

void SetContentSources ( const FAssetViewContentSources& InContentSources
)

 Changes the base sources for this view SAssetView.h  

void SetCurrentThumbnailSize ( EThumbnailSize NewThumbnailSize
)

 Sets the thumbnail size and updates lists accordingly SAssetView.h  

void SetCurrentViewType ( EAssetViewType::Type NewType
)

 Sets the view type and updates lists accordingly SAssetView.h  

void SetFilterBar ( TSharedPtr< SFilterList > InFilterBar
)

 Set the filter list attached to this asset view - allows toggling of the the filter bar layout from the view options SAssetView.h  

void SetShouldFilterItem ( FOnShouldFilterItem InCallback
)

 Change the delegate bound via the widget argument OnShouldFilterAsset after construction. SAssetView.h  

void SetSortParameters ( const TOptional< const EColumnSortPriority::Type >& InSortPriority,
const TOptional< const FName >& InColumnId,
const TOptional< const EColumnSortMode::Type >& InNewSortMode
)

 Set's sorting based on the given parameters, using the current value if not specified SAssetView.h  

void SetSourcesData ( const FSourcesData& InSourcesData
)

   SAssetView.h  

void SetUserSearching ( bool bInSearching
)

 Set whether the user is currently searching or not SAssetView.h  

bool ShouldColumnGenerateWidget ( const FString ColumnName
) const

   SAssetView.h  

void SyncToItems ( TArrayView< const FContentBrowserItem > ItemsToSync,
const bool bFocusOnSync
)

 Selects the specified items. SAssetView.h  

void SyncToLegacy ( TArrayView< const FAssetData > AssetDataList,
TArrayView< const FString > FolderList,
const bool bFocusOnSync
)

 Selects the specified assets and paths. SAssetView.h  

void SyncToVirtualPaths ( TArrayView< const FName > VirtualPathsToSync,
const bool bFocusOnSync
)

 Selects the specified virtual paths. SAssetView.h  

virtual void Tick ( const FGeometry& AllottedGeometry,
const double InCurrentTime,
const float InDeltaTime
)

 SWidget inherited. SAssetView.h  

Static

Name Remarks Include Path Unreal Specifiers

static FText ThumbnailSizeToDisplayName ( EThumbnailSize InSize
)

 Gets text name for given thumbnail SAssetView.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page