Navigation
API > API/Plugins > API/Plugins/CommonUI
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UVisual
- UWidget
- UImage
- UCommonLazyImage
References
| Module | CommonUI |
| Header | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonLazyImage.h |
| Include | #include "CommonLazyImage.h" |
Syntax
UCLASS&40;&41;
class UCommonLazyImage : public UImage
Remarks
A special Image widget that can show unloaded images and takes care of the loading for you!
UCommonLazyImage is another wrapper for SLoadGuard, but it only handles image loading and a throbber during loading.
If this class changes to show any text, by default it will have CoreStyle styling
Constructors
| Type | Name | Description | |
|---|---|---|---|
UCommonLazyImage
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | IsLoading () |
||
| FOnLoadGuardStateChangedEvent & | |||
| TSharedRef< SWidget > | |||
| void | SetBrushFromLazyDisplayAsset
(
const TSoftObjectPtr< UObject >& LazyObject, |
Set the brush from a string asset ref only - expects the referenced asset to be a texture or material. | |
| void | SetBrushFromLazyMaterial
(
const TSoftObjectPtr< UMaterialInterface >& LazyMaterial |
Set the brush from a lazy material asset pointer - will load the material as needed. | |
| void | SetBrushFromLazyTexture
(
const TSoftObjectPtr< UTexture2D >& LazyTexture, |
Set the brush from a lazy texture asset pointer - will load the texture as needed. | |
| void | SetIsLoading
(
bool bIsLoading |
||
| void | SetMaterialTextureParamName
(
FName TextureParamName |
Establishes the name of the texture parameter on the currently applied brush material to which textures should be applied. |
Overridden from UImage
| Type | Name | Description | |
|---|---|---|---|
| void | Called when we need to abort the texture being streamed in. | ||
| void | OnImageStreamingComplete
(
TSoftObjectPtr< UObject > LoadedSoftObject |
Called when the image streaming completes. | |
| void | OnImageStreamingStarted
(
TSoftObjectPtr< UObject > SoftObject |
Called when the image streaming starts, after the other one was cancelled. | |
| void | SetBrush
(
const FSlateBrush& InBrush |
||
| void | SetBrushFromAsset
(
USlateBrushAsset* Asset |
||
| void | SetBrushFromMaterial
(
UMaterialInterface* Material |
||
| void | SetBrushFromTexture
(
UTexture2D* Texture, |
Sets the Brush to the specified Texture. | |
| void | SetBrushFromTextureDynamic
(
UTexture2DDynamic* Texture, |
Sets the Brush to the specified Dynamic Texture. |
Overridden from UWidget
| Type | Name | Description | |
|---|---|---|---|
| const FText | Gets the palette category of the widget | ||
| void | Function called after the underlying SWidget is constructed. | ||
| TSharedRef< SWidget > | Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. | ||
| void | Applies all properties to the native widget if possible. |
Overridden from UVisual
| Type | Name | Description | |
|---|---|---|---|
| void | ReleaseSlateResources
(
bool bReleaseChildren |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| bool | CanEditChange
(
const FProperty* InProperty |
Called by the editor to query whether a property of this object is allowed to be modified. |