SCR_BackendImageComponent Interface Reference

This component implements basic image and loading overlay handling m_sImageWidgetName must be an Image Widget m_sLoadingOverlayName must have an SCR_LoadingOverlay component attached. More...

Inheritance diagram for SCR_BackendImageComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
void	SetImage (BackendImage image)
	image can be null
void	SetImageSaturation (float saturation)
ScriptInvokerVoid	GetOnImageSelected ()
Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
Widget	GetRootWidget ()
bool	IsVisible ()

Protected Member Functions
void	CheckWidgetInitialized ()
void	TryDownloadImage ()
void	Callback_DownloadImage_OnTimeoutError (SCR_WorkshopItemCallback_DownloadImage callback)
void	Callback_DownloadImage_OnSuccess (SCR_WorkshopItemCallback_DownloadImage callback)
void	TryLocalImage ()
bool	TryShowImage (ResourceName imagePath)
void	ShowLoadingImage (ResourceName loadingImage=string.Empty)
void	ShowFallbackImage ()
	If no fallback is set, the image widget will be hidden instead.
bool	TryLoadImageTexture (ResourceName imagePath)
void	ShowDebugText (string txt)
string	FormatAvailableScales ()

Protected Attributes
ResourceName	m_sFallbackImage
string	m_sImageWidgetName
string	m_sImageSizeWidgetName
bool	m_bShowLoadingImage
string	m_sLoadingOverlayName
string	m_sDebugTextName
ImageWidget	m_wImage
Widget	m_wImageSize
SCR_LoadingOverlay	m_LoadingOverlay
TextWidget	m_wDebugText
ref BackendImage	m_BackendImage
ref SCR_WorkshopItemCallback_DownloadImage	m_DownloadImageCallback
bool	m_bIsWaitingForWidgetInit
int	m_iPreferredWidth
int	m_iScreenWidth
ref ScriptInvokerVoid	m_OnImageSelected
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Detailed Description

This component implements basic image and loading overlay handling m_sImageWidgetName must be an Image Widget m_sLoadingOverlayName must have an SCR_LoadingOverlay component attached.

Member Function Documentation

Callback_DownloadImage_OnSuccess()

void SCR_BackendImageComponent.Callback_DownloadImage_OnSuccess ( SCR_WorkshopItemCallback_DownloadImage  callback )

protected

Callback_DownloadImage_OnTimeoutError()

void SCR_BackendImageComponent.Callback_DownloadImage_OnTimeoutError ( SCR_WorkshopItemCallback_DownloadImage  callback )

protected

CheckWidgetInitialized()

void SCR_BackendImageComponent.CheckWidgetInitialized ( )

protected

FormatAvailableScales()

string SCR_BackendImageComponent.FormatAvailableScales ( )

protected

GetOnImageSelected()

ScriptInvokerVoid SCR_BackendImageComponent.GetOnImageSelected

(

)

HandlerAttached()

override void SCR_BackendImageComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ScriptedWidgetComponent.

SetImage()

void SCR_BackendImageComponent.SetImage

(

BackendImage

image

)

image can be null

SetImageSaturation()

void SCR_BackendImageComponent.SetImageSaturation

(

float

saturation

)

ShowDebugText()

void SCR_BackendImageComponent.ShowDebugText ( string  txt )

protected

ShowFallbackImage()

void SCR_BackendImageComponent.ShowFallbackImage ( )

protected

If no fallback is set, the image widget will be hidden instead.

ShowLoadingImage()

void SCR_BackendImageComponent.ShowLoadingImage ( ResourceName  loadingImage = string::Empty )

protected

Implemented in SCR_WorkshopItemBackendImageComponent, and SCR_ScenarioBackendImageComponent.

TryDownloadImage()

void SCR_BackendImageComponent.TryDownloadImage ( )

protected

TryLoadImageTexture()

bool SCR_BackendImageComponent.TryLoadImageTexture ( ResourceName  imagePath )

protected

TryLocalImage()

void SCR_BackendImageComponent.TryLocalImage ( )

protected

TryShowImage()

bool SCR_BackendImageComponent.TryShowImage ( ResourceName  imagePath )

protected

Member Data Documentation

m_BackendImage

ref BackendImage SCR_BackendImageComponent.m_BackendImage

protected

m_bIsWaitingForWidgetInit

bool SCR_BackendImageComponent.m_bIsWaitingForWidgetInit

protected

m_bShowLoadingImage

bool SCR_BackendImageComponent.m_bShowLoadingImage

protected

m_DownloadImageCallback

ref SCR_WorkshopItemCallback_DownloadImage SCR_BackendImageComponent.m_DownloadImageCallback

protected

m_iPreferredWidth

int SCR_BackendImageComponent.m_iPreferredWidth

protected

m_iScreenWidth

int SCR_BackendImageComponent.m_iScreenWidth

protected

m_LoadingOverlay

SCR_LoadingOverlay SCR_BackendImageComponent.m_LoadingOverlay

protected

m_OnImageSelected

ref ScriptInvokerVoid SCR_BackendImageComponent.m_OnImageSelected

protected

m_sDebugTextName

string SCR_BackendImageComponent.m_sDebugTextName

protected

m_sFallbackImage

ResourceName SCR_BackendImageComponent.m_sFallbackImage

protected

m_sImageSizeWidgetName

string SCR_BackendImageComponent.m_sImageSizeWidgetName

protected

m_sImageWidgetName

string SCR_BackendImageComponent.m_sImageWidgetName

protected

m_sLoadingOverlayName

string SCR_BackendImageComponent.m_sLoadingOverlayName

protected

m_wDebugText

TextWidget SCR_BackendImageComponent.m_wDebugText

protected

m_wImage

ImageWidget SCR_BackendImageComponent.m_wImage

protected

m_wImageSize

Widget SCR_BackendImageComponent.m_wImageSize

protected

---

The documentation for this interface was generated from the following file:

• Game/UI/Components/SCR_BackendImageComponent.c