Navigation
API > API/Plugins > API/Plugins/UAFEditor
Experimental. May be removed whenever we switch to the future generic content browser IAssetPreviewCustomization API.
Base class for asset preview widgets. Currently previews are restricted to UAF, but may not be in the future.
@TODO: This class currently supports individual async loading, but users may want to async preload a set of assets for responsiveness. @TODO: Once we use the future content browser API, consider removing the "UAF" aspect of this class. Maybe move to engine as IAsyncAssetPreview? Need editor buy in first.
| Name | IUAFAssetPreview |
| Type | class |
| Header File | /Engine/Plugins/Experimental/UAF/UAF/Source/UAFEditor/Public/Common/AssetPreview/IUAFAssetPreview.h |
| Include Path | #include "Common/AssetPreview/IUAFAssetPreview.h" |
Syntax
class IUAFAssetPreview : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → IUAFAssetPreview
- FSlateControlledConstruction → SWidget → SCompoundWidget → IUAFAssetPreview
Derived Classes
Structs
| Name | Remarks |
|---|---|
| FArguments |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const UStruct * GetAssetPreviewType() |
Utility method to get the current preview type this widget is associated with. | Common/AssetPreview/IUAFAssetPreview.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CancelAsyncLoad() |
Utility method to cancel async load of asset to preview | Common/AssetPreview/IUAFAssetPreview.h | |
virtual void Construct
(
const FArguments& InArgs, |
Common/AssetPreview/IUAFAssetPreview.h | ||
virtual void OnSameTypeAssetSelectedAsync
(
const FAssetData& InAssetData |
Callback for when another asset of the same type is selected. | Common/AssetPreview/IUAFAssetPreview.h | |
virtual void RequestAsyncLoad
(
const FSoftObjectPath& SoftObject, |
Utility method to load an asset async with function callback | Common/AssetPreview/IUAFAssetPreview.h | |
virtual void RequestAsyncLoad
(
const FSoftObjectPath& SoftObject, |
Utility method to load an asset async with a delegate callback | Common/AssetPreview/IUAFAssetPreview.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool OnSameTypeAssetSelected
(
const FAssetData& InAssetData |
Callback for when another asset of the same type is selected & loaded. | Common/AssetPreview/IUAFAssetPreview.h |
Protected Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedRef< SWidget > OnConstructAssetPreviewWidget () |
Callback used to construct preview widget whenever async loading is done or an asset is already loaded. | Common/AssetPreview/IUAFAssetPreview.h | |
virtual void OnConstructAsyncPreviewWidget
(
const FAssetData& InAssetData |
Called to show a loading widget when the asset is loading, and a preview widget when the asset is done loading. | Common/AssetPreview/IUAFAssetPreview.h | |
virtual TSharedRef< SWidget > OnConstructLoadingAssetPreviewWidget () |
Callback used to construct preview widget when async loading is occuring. | Common/AssetPreview/IUAFAssetPreview.h |