1. Epic GamesDeveloper
  3. UCommonLazyImage

UCommonLazyImage

A special Image widget that can show unloaded images and takes care of the loading for you!

API > API/Plugins > API/Plugins/CommonUI

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

   
Name UCommonLazyImage
Type class
Header File /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonLazyImage.h
Include Path #include "CommonLazyImage.h"

Syntax

UCLASS (MinimalAPI)  
class UCommonLazyImage : public UImage

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UCommonLazyImage ( const FObjectInitializer& ObjectInitializer
)

   CommonLazyImage.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BP_OnLoadingStateChanged FOnLoadGuardStateChangedDynamic   CommonLazyImage.h
  • BlueprintAssignable
  • Category=LazyImage
  • Meta=(DisplayName="On Loading State Changed", ScriptName="OnLoadingStateChanged")
bShowLoading bool   CommonLazyImage.h
  • EditAnywhere
  • Category=LoadPreview
LoadingBackgroundBrush FSlateBrush   CommonLazyImage.h
  • EditAnywhere
  • Category=Appearance
LoadingThrobberBrush FSlateBrush   CommonLazyImage.h
  • EditAnywhere
  • Category=Appearance
MaterialTextureParamName FName If this image uses a material that a texture should be applied to, this is the name of the material param to use. CommonLazyImage.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=Appearance
MyLoadGuard TSharedPtr< SLoadGuard >   CommonLazyImage.h  
OnLoadingStateChangedEvent FOnLoadGuardStateChangedEvent   CommonLazyImage.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool IsLoading()

   CommonLazyImage.h
  • BlueprintCallable
  • Category=LazyImage

FOnLoadGuardStateChangedEvent & OnLoadingStateChanged()

   CommonLazyImage.h  

void SetBrushFromLazyDisplayAsset ( const TSoftObjectPtr< UObject >& LazyObject,
bool bMatchTextureSize
)

 Set the brush from a string asset ref only - expects the referenced asset to be a texture or material. CommonLazyImage.h
  • BlueprintCallable
  • Category=LazyImage

void SetBrushFromLazyMaterial ( const TSoftObjectPtr< UMaterialInterface >& LazyMaterial
)

 Set the brush from a lazy material asset pointer - will load the material as needed. CommonLazyImage.h
  • BlueprintCallable
  • Category=LazyImage

void SetBrushFromLazyTexture ( const TSoftObjectPtr< UTexture2D >& LazyTexture,
bool bMatchSize
)

 Set the brush from a lazy texture asset pointer - will load the texture as needed. CommonLazyImage.h
  • BlueprintCallable
  • Category=LazyImage

void SetMaterialTextureParamName ( FName TextureParamName
)

 Establishes the name of the texture parameter on the currently applied brush material to which textures should be applied. CommonLazyImage.h
  • BlueprintCallable
  • Category=LazyImage

Overridden from UImage

Name Remarks Include Path Unreal Specifiers

virtual void SetBrush ( const FSlateBrush& InBrush
)

   CommonLazyImage.h  

virtual void SetBrushFromAsset ( USlateBrushAsset* Asset
)

   CommonLazyImage.h  

virtual void SetBrushFromMaterial ( UMaterialInterface* Material
)

   CommonLazyImage.h  

virtual void SetBrushFromTexture ( UTexture2D* Texture,
bool bMatchSize
)

   CommonLazyImage.h  

virtual void SetBrushFromTextureDynamic ( UTexture2DDynamic* Texture,
bool bMatchSize
)

   CommonLazyImage.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > RebuildImageWidget()

   CommonLazyImage.h  

void SetIsLoading ( bool bIsLoading
)

   CommonLazyImage.h  

Overridden from UImage

Name Remarks Include Path Unreal Specifiers

virtual void CancelImageStreaming()

   CommonLazyImage.h  

virtual void OnImageStreamingComplete ( TSoftObjectPtr< UObject > LoadedSoftObject
)

   CommonLazyImage.h  

virtual void OnImageStreamingStarted ( TSoftObjectPtr< UObject > SoftObject
)

   CommonLazyImage.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

   CommonLazyImage.h  

virtual void OnWidgetRebuilt()

   CommonLazyImage.h  

virtual TSharedRef< SWidget > RebuildWidget()

   CommonLazyImage.h  

virtual void SynchronizeProperties()

   CommonLazyImage.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   CommonLazyImage.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   CommonLazyImage.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page