SCR_ImagePickerComponent Interface Reference

Allows image to be set and removed directly on widget. More...

Inheritance diagram for SCR_ImagePickerComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
void	CaptureImage ()
void	SetImage (string image)
void	RemoveImage ()
ResourceName	GetResourcePath ()
ScriptInvokerImagePickerComponent	GetOnPickerButtonClick ()
ScriptInvokerBase< ScriptInvokerStringMethod >	GetOnResourcePicked ()
Public Member Functions inherited from SCR_ChangeableComponentBase
override void	HandlerAttached (Widget w)
override bool	OnFocus (Widget w, int x, int y)
override bool	OnFocusLost (Widget w, int x, int y)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
TextWidget	GetLabel ()
void	SetLabel (string label)
void	UseLabel (bool use)
bool	IsUsingLabel ()
Widget	GetLabelWidget ()
	If label is not used, label widget might not exist at all!
void	SetSizeWithLabel (float size)
void	SetSizeWithoutLabel (float size)
Public Member Functions inherited from SCR_WLibComponentBase
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnFocus (Widget w, int x, int y)
void	SetHoverSound (string soundHover)
void	SetClickedSound (string soundClicked)
string	GetHoverSound ()
string	GetClickedSound ()
void	SetEnabled (bool enabled, bool animate=true)
void	SetVisible (bool visible, bool animate=true)
bool	IsEnabled ()
void	SetMouseOverToFocus (bool mouseOverToFocus)
void	SetDisabledOpacity (float newDisabledOpacity)
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	OnPickerButtonClicked (SCR_ModularButtonComponent button)
	Solve interaction: Open image capture or delete current
Protected Member Functions inherited from SCR_ChangeableComponentBase
void	SetupLabel ()
void	ClearLabel ()
Protected Member Functions inherited from SCR_WLibComponentBase
void	OnEnabled (bool animate)
void	OnDisabled (bool animate)
bool	IsChildWidget (Widget parent, Widget child)
void	SetAnimationRate ()
void	PlaySound (string sound)

Protected Attributes
string	m_sImageName
ResourceName	m_sResourcePath
TextWidget	m_wImageSourceText
SCR_ModularButtonComponent	m_PickerButton
ref ScriptInvokerImagePickerComponent	m_OnPickerButtonClicked
ref ScriptInvokerBase< ScriptInvokerStringMethod >	m_OnResourcePicked
Protected Attributes inherited from SCR_ChangeableComponentBase
bool	m_bUseLabel
string	m_sLabel
bool	m_bForceSize
float	m_fSizeWithLabel
float	m_fSizeWithoutLabel
ResourceName	m_sLabelLayout
string	m_sSizeLayout
Widget	m_wBorder
Widget	m_wBackground
Widget	m_wLabelRoot
Protected Attributes inherited from SCR_WLibComponentBase
string	m_sSoundHovered
string	m_sSoundClicked
float	m_fAnimationTime
bool	m_bMouseOverToFocus
float	m_fDisabledOpacity
float	m_fAnimationRate
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Static Protected Attributes
const string	TESTING_IMAGE = "{A6D83FD56C68EB77}UI/Textures/MissionLoadingScreens/campaignMP_UI.edds"

Additional Inherited Members
Static Public Member Functions inherited from SCR_WLibComponentBase
static bool	SetTexture (ImageWidget widget, ResourceName texture, string image="")
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_ChangeableComponentBase
ref ScriptInvoker	m_OnChanged = new ScriptInvoker()
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker
Static Public Attributes inherited from SCR_WLibComponentBase
static const float	START_ANIMATION_RATE = 10001
static const float	START_ANIMATION_PERIOD = 250

Detailed Description

Allows image to be set and removed directly on widget.

Member Function Documentation

CaptureImage()

void SCR_ImagePickerComponent.CaptureImage

(

)

GetOnPickerButtonClick()

ScriptInvokerImagePickerComponent SCR_ImagePickerComponent.GetOnPickerButtonClick

(

)

GetOnResourcePicked()

ScriptInvokerBase< ScriptInvokerStringMethod > SCR_ImagePickerComponent.GetOnResourcePicked

(

)

GetResourcePath()

ResourceName SCR_ImagePickerComponent.GetResourcePath

(

)

HandlerAttached()

override void SCR_ImagePickerComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ChangeableComponentBase.

OnPickerButtonClicked()

void SCR_ImagePickerComponent.OnPickerButtonClicked ( SCR_ModularButtonComponent  button )

protected

Solve interaction: Open image capture or delete current

RemoveImage()

void SCR_ImagePickerComponent.RemoveImage

(

)

SetImage()

void SCR_ImagePickerComponent.SetImage

(

string

image

)

Member Data Documentation

m_OnPickerButtonClicked

ref ScriptInvokerImagePickerComponent SCR_ImagePickerComponent.m_OnPickerButtonClicked

protected

m_OnResourcePicked

ref ScriptInvokerBase<ScriptInvokerStringMethod> SCR_ImagePickerComponent.m_OnResourcePicked

protected

m_PickerButton

SCR_ModularButtonComponent SCR_ImagePickerComponent.m_PickerButton

protected

m_sImageName

string SCR_ImagePickerComponent.m_sImageName

protected

m_sResourcePath

ResourceName SCR_ImagePickerComponent.m_sResourcePath

protected

m_wImageSourceText

TextWidget SCR_ImagePickerComponent.m_wImageSourceText

protected

TESTING_IMAGE

const string SCR_ImagePickerComponent.TESTING_IMAGE = "{A6D83FD56C68EB77}UI/Textures/MissionLoadingScreens/campaignMP_UI.edds"

staticprotected

---

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

• Game/UI/Menu/ConfigurableWidgetEntries/SCR_ImagePickerComponent.c