1. Epic GamesDeveloper
  3. UContentBrowserAssetDataSource

UContentBrowserAssetDataSource

API > API/Plugins > API/Plugins/ContentBrowserAssetDataSource

Inheritance Hierarchy

References

   
Module ContentBrowserAssetDataSource
Header /Engine/Plugins/Editor/ContentBrowser/ContentBrowserAssetDataSource/Source/ContentBrowserAssetDataSource/Public/ContentBrowserAssetDataSource.h
Include #include "ContentBrowserAssetDataSource.h"

Syntax

UCLASS&40;&41;  
class UContentBrowserAssetDataSource : public UContentBrowserDataSource

Variables

  Type Name Description
Public variable *param OutCompiledFilter The output filer supplied to this will be used to filter objects when a... assets  
Public variable *param Filter The compiled filter to test with supplied by const FContentBrowserItemData const F... Filter  
Public variable *param OutCompiledFilter The output filer supplied to optionally recursive **return fals... folders  
Public variable *param Filter The compiled filter to test with supplied by const FContentBrowserItemData & InItem  
Public variable *param OutCompiledFilter The output filer supplied to this will be used to filter objects when a... requested  
Public variable *param OutCompiledFilter The output filer supplied to this will be used to filter objects when a... set  

Functions

  Type Name Description
Public function *param OutCompiledFilter The output filer supplied to Call in CompileFilter() after CreatePathFilter() to fill OutCompiledFilter with an FContentBrowserCompiledAssetDataFilter capable of filtering assets
Public function *param OutCompiledFilter The output filer supplied to Call in CompileFilter() to populate an FAssetFilterInputParams for use in CreatePathFilter and CreateAssetFilter.
Public function *param OutCompiledFilter The output filer supplied to Call in CompileFilter() after PopulateAssetFilterInputParams() to fill OutCompiledFilter with an FContentBrowserCompiledAssetDataFilter capable of filtering folders
Public function Static *param OutCompiledFilter The output filer supplied to otherwise true *staticbool

CreateAssetFilter ( FAssetFilterInputParams& Params,
FName InPath,
const FContentBrowserDataFilter& InFilter,
FContentBrowserDataCompiledFilter& OutCompiledFilter,
FSubPathEnumerationFunc* GetSubPackagePathsFunc
)

  
Public function Static *param OutCompiledFilter The output filer supplied to optionally recursive **return fals...

CreatePathFilter ( FAssetFilterInputParams& Params,
FName InPath,
const FContentBrowserDataFilter& InFilter,
FContentBrowserDataCompiledFilter& OutCompiledFilter,
FSubPathEnumerationFunc SubPathEnumeration
)

  
Public function *param Filter The compiled filter to test with supplied by Call in DoesItemPassFilter() to check if a folder passes the compiled asset data filter.
Public function Static void Call in EnumerateItemsMatchingFilter() to generate a list of folders that match the compiled filter.
Public function void

Initialize ( const bool InAutoRegister
)

  
Public function Static bool  
Public function Static *param OutCompiledFilter The output filer supplied to this will be used to filter objects when a...  

Overridden from UContentBrowserDataSource

  Type Name Description
Public function Virtual bool

AppendItemReference ( const FContentBrowserItemData& InItem,
FString& InOutStr
)

 Attempt to append any path references for the given item to the given string.
Protected function Virtual void Rebuilds the tree of virtual paths that ends with internal roots
Public function Virtual bool

BulkCopyItems ( TArrayView< const FContentBrowserItemData > InItems,
const FName InDestPath
)

 Attempt to copy the given items to the given virtual path.
Public function Virtual bool Attempt to delete the given items.
Public function Virtual bool Attempt to synchronously duplicate the given items.
Public function Virtual bool Attempt to open the given item for editing.
Public function Virtual bool

BulkMoveItems ( TArrayView< const FContentBrowserItemData > InItems,
const FName InDestPath
)

 Attempt to move the given items to the given virtual path.
Public function Virtual bool Attempt to preview the given items.
Public function Virtual bool Attempt to mark the given items as private (NotExternallyReferenceable)
Public function Virtual bool

BulkSaveItems ( TArrayView< const FContentBrowserItemData > InItems,
const EContentBrowserItemSaveFlags InSaveFlags
)

 Attempt to save the given items.
Public function Virtual bool Attempt to open the given items for read-only viewing.
Public function Virtual bool

CanCopyItem ( const FContentBrowserItemData& InItem,
const FName InDestPath,
FText* OutErrorMsg
)

 Query whether the given item is can be copied, optionally providing error information if it cannot.
Public function Virtual bool

CanCreateFolder ( const FName InPath,
FText* OutErrorMsg
)

 Query whether a folder can be created at the given virtual path, optionally providing error information if it cannot.
Public function Virtual bool

CanDeleteItem ( const FContentBrowserItemData& InItem,
FText* OutErrorMsg
)

 Query whether the given item is can be deleted, optionally providing error information if it cannot.
Public function Virtual bool

CanDuplicateItem ( const FContentBrowserItemData& InItem,
FText* OutErrorMsg
)

 Query whether the given item is can be duplicated, optionally providing error information if it cannot.
Public function Virtual bool

CanEditItem ( const FContentBrowserItemData& InItem,
FText* OutErrorMsg
)

 Query whether the given item is can be edited, optionally providing error information if it cannot.
Public function Virtual bool

CanMoveItem ( const FContentBrowserItemData& InItem,
const FName InDestPath,
FText* OutErrorMsg
)

 Query whether the given item is can be moved, optionally providing error information if it cannot.
Public function Virtual bool

CanPreviewItem ( const FContentBrowserItemData& InItem,
FText* OutErrorMsg
)

 Query whether the given item is can be previewed, optionally providing error information if it cannot.
Public function Virtual bool

CanPrivatizeItem ( const FContentBrowserItemData& InItem,
FText* OutErrorMsg
)

 Query whether the given item can be privatized, optionally providing error information if it cannot.
Public function Virtual bool

CanRenameItem ( const FContentBrowserItemData& InItem,
const FString* InNewName,
FText* OutErrorMsg
)

 Query whether the given item is can be renamed, optionally providing error information if it cannot.
Public function Virtual bool

CanSaveItem ( const FContentBrowserItemData& InItem,
const EContentBrowserItemSaveFlags InSaveFlags,
FText* OutErrorMsg
)

 Query whether the given item is can be saved, optionally providing error information if it cannot.
Public function Virtual bool

CanViewItem ( const FContentBrowserItemData& InItem,
FText* OutErrorMsg
)

 Query whether the given item is can be viewed (a read-only asset editor), optionally providing error information if it cannot.
Public function Virtual void Tell the data source to remove the cached data for the filter compilation for this specific owner.
Public function Virtual void

CompileFilter ( const FName InPath,
const FContentBrowserDataFilter& InFilter,
FContentBrowserDataCompiledFilter& OutCompiledFilter
)

 Given a path and a data filter, produce an optimized filter that can be used to efficiently enumerate items that match it, and also query whether an item would pass it.
Public function Virtual bool Let the compiled filter decide the payload and the type of the item Some Compiled filter might change the type/payload of the item.
Public function Virtual bool

CopyItem ( const FContentBrowserItemData& InItem,
const FName InDestPath
)

 Attempt to copy the given item to the given virtual path.
Public function Virtual bool

CreateFolder ( const FName InPath,
FContentBrowserItemDataTemporaryContext& OutPendingItem
)

 Attempt to begin the process of asynchronously creating a folder at the given virtual path, populating a temporary item that can be finalized or canceled by the user.
Public function Virtual bool Attempt to delete the given item.
Public function Virtual bool Query whether the given item passes the given compiled filter.
Public function Virtual bool Attempt to begin the process of asynchronously duplicating the given item, populating a temporary item that can be finalized or canceled by the user.
Public function Virtual bool

EditItem ( const FContentBrowserItemData& InItem
)

 Attempt to open the given item for editing.
Public function Virtual void

EnumerateItemsAtPath ( const FName InPath,
const EContentBrowserItemTypeFilter InItemTypeFilter,
TFunctionRef< bool(FContentBrowserItemData&&)> InCallback
)

 Enumerate items that have the given virtual path, optionally filtering by type, and invoking the callback for each matching item.
Public function Virtual bool

EnumerateItemsAtPaths ( const TArrayView< FContentBrowserItemPath > InPaths,
const EContentBrowserItemTypeFilter InItemTypeFilter,
TFunctionRef< bool(FContentBrowserItemData&&)> InCallback
)

 Enumerate the items (folders and/or files) that exist at the given content browser paths.
Public function Virtual void Enumerate items that match the given compiled filter, invoking the callback for each matching item.
Public function Virtual bool

GetItemAttribute ( const FContentBrowserItemData& InItem,
const bool InIncludeMetaData,
const FName InAttributeKey,
FContentBrowserItemDataAttributeValue& OutAttributeValue
)

 Query the value of the given attribute on the given item.
Public function Virtual bool

GetItemAttributes ( const FContentBrowserItemData& InItem,
const bool InIncludeMetaData,
FContentBrowserItemDataAttributeValues& OutAttributeValues
)

 Query the values of all attributes on the given item.
Public function Virtual bool

GetItemPhysicalPath ( const FContentBrowserItemData& InItem,
FString& OutDiskPath
)

 Query the physical (on-disk) path of the given item.
Public function Virtual bool

HandleDragDropOnItem ( const FContentBrowserItemData& InItem,
const FDragDropEvent& InDragDropEvent
)

 Called to provide custom drag and drop handling when a drag event is dropped on an item.
Public function Virtual bool

HandleDragEnterItem ( const FContentBrowserItemData& InItem,
const FDragDropEvent& InDragDropEvent
)

 Called to provide custom drag and drop handling when a drag event enters an item, such as performing validation and reporting error information.
Public function Virtual bool

HandleDragLeaveItem ( const FContentBrowserItemData& InItem,
const FDragDropEvent& InDragDropEvent
)

 Called to provide custom drag and drop handling when a drag event leaves an item, such as clearing any error information set during earlier validation.
Public function Virtual bool

HandleDragOverItem ( const FContentBrowserItemData& InItem,
const FDragDropEvent& InDragDropEvent
)

 Called to provide custom drag and drop handling while a drag event is over an item, such as performing validation and reporting error information.
Public function Virtual bool

IsDiscoveringItems ( FText* OutStatus
)

 Query whether this data source instance is currently discovering content, and retrieve an optional status message that can be shown in the UI.
Public function Virtual bool

IsFolderVisible ( const FName InPath,
const EContentBrowserIsFolderVisibleFlags InFlags
)

 Query whether the given virtual folder should be visible in the UI.
Public function Virtual bool Query whether the given item is considered dirty (ie, has unsaved changes).
Public function Virtual bool

Legacy_TryConvertAssetDataToVirtualPath ( const FAssetData& InAssetData,
const bool InUseFolderPaths,
FName& OutPath
)

 Attempt to convert the given asset data to a virtual path associated with this data source.
Public function Virtual bool

Legacy_TryConvertPackagePathToVirtualPath ( const FName InPackagePath,
FName& OutPath
)

 Attempt to convert the given package path to a virtual path associated with this data source.
Public function Virtual bool

Legacy_TryGetAssetData ( const FContentBrowserItemData& InItem,
FAssetData& OutAssetData
)

 Attempt to retrieve the asset data associated with the given item.
Public function Virtual bool

Legacy_TryGetPackagePath ( const FContentBrowserItemData& InItem,
FName& OutPackagePath
)

 Attempt to retrieve the package path associated with the given item.
Public function Virtual bool

MoveItem ( const FContentBrowserItemData& InItem,
const FName InDestPath
)

 Attempt to move the given item to the given virtual path.
Public function Virtual bool Attempt to preview the given item.
Public function Virtual bool

PrioritizeSearchPath ( const FName InPath
)

 If possible, attempt to prioritize content discovery for the given virtual path.
Public function Virtual bool Attempt to mark the given item as private (NotExternallyReferenceable).
Public function Virtual void

RemoveUnusedCachedFilterData ( const FContentBrowserDataFilterCacheIDOwner& IDOwner,
TArrayView< const FName > InVirtualPathsInUse,
const FContentBrowserDataFilter& DataFilter
)

 Tell the data source to remove any cached data for the filter compilation that might not be needed any more.
Public function Virtual bool

RenameItem ( const FContentBrowserItemData& InItem,
const FString& InNewName,
FContentBrowserItemData& OutNewItem
)

 Attempt to rename the given item.
Public function Virtual bool

SaveItem ( const FContentBrowserItemData& InItem,
const EContentBrowserItemSaveFlags InSaveFlags
)

 Attempt to save the given item.
Public function Virtual void Shutdown this data source instance.
Public function Virtual bool

TryGetCollectionId ( const FContentBrowserItemData& InItem,
FSoftObjectPath& OutCollectionId
)

 Attempt to retrieve the identifier that should be used when storing a reference to the given item within a collection.
Public function Virtual bool

UpdateThumbnail ( const FContentBrowserItemData& InItem,
FAssetThumbnail& InThumbnail
)

 Attempt to update the thumbnail associated with the given item.
Public function Virtual bool

ViewItem ( const FContentBrowserItemData& InItem
)

 Attempt to open the given item for read-only viewing.

Classes

  Type Name Description
Public struct FAssetDataSourceFilterCache A struct used to cache some data to accelerate the compilation of the filters for the asset data source  
Public struct FAssetFilterInputParams All of the data necessary to generate a compiled filter for folders and assets  

Typedefs

Name Description
FCompileARFilterFunc  
FCreateFolderItemFunc  
FSubPathEnumerationFunc  

Constants

Name Description
OnAssetPathAddedDelegate  
OnAssetPathRemovedDelegate  

Deprecated Functions

  Type Name Description
Public function Static bool

CreateAssetFilter ( FAssetFilterInputParams& Params,
FName InPath,
const FContentBrowserDataFilter& InFilter,
FContentBrowserDataCompiledFilter& OutCompiledFilter,
FCompileARFilterFunc CreateCompiledFilter
)

 Use the override without the function to customize the compilation the ARFilter or duplicate this function logic. This function will no longer be supported and will be removed to allow future performence improvements

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page