SCR_HighlightedEditorUIComponent Interface Reference

Is an highlighted icon which, if animated pulsates. More...

Inheritance diagram for SCR_HighlightedEditorUIComponent:

Public Member Functions
override void	OnInit (SCR_EditableEntityComponent entity, SCR_UIInfo info, SCR_EditableEntityBaseSlotUIComponent slot)
	Method called when the widget is initialised.
override bool	OnClick (Widget w, int x, int y, int button)
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from SCR_BaseEditableEntityUIComponent
void	OnRefresh (SCR_EditableEntityBaseSlotUIComponent slot)
	Method called when the widget is updsted from the entity.
void	OnInit (SCR_EditableEntityComponent entity, SCR_UIInfo info, SCR_EditableEntityBaseSlotUIComponent slot)
	Method called when the widget is initialised.
void	OnShownOffScreen (bool offScreen)
	Method called the icon moves from on-screen to off-screen and vice versa.
void	Init (SCR_EditableEntityComponent entity, SCR_EditableEntityBaseSlotUIComponent slot)
	Initialise entity widget using editable entity.
sealed void	Init (SCR_UIInfo info, SCR_EditableEntityBaseSlotUIComponent slot)
	Initialise entity widget using UI info.
void	Exit (SCR_EditableEntityBaseSlotUIComponent slot)
	Terminate entity widget.
SCR_EditableEntityComponent	GetEntity ()
Widget	GetWidget ()
bool	IsVisible ()
void	SetVisible (bool visible)
	Set visibility of the widget.
bool	IsShownOffScreen ()
	Check if the icon is supposed to be shown on screen borders when its position is off-screen.
override void	HandlerAttached (Widget w)

Protected Member Functions
void	OnUpdateHighlight (SCR_EditableEntityComponent entity, EEditableEntityHighlight highlight, int highlightCount)
void	OnSelectedChange (EEditableEntityState state, set< SCR_EditableEntityComponent > entitiesInsert, set< SCR_EditableEntityComponent > entitiesRemove)
void	StopAnimations (Widget w)

Protected Attributes
string	m_ImageWidgetName
string	m_TextWidgetName
string	m_AnimWidgetName
ResourceName	m_DefaultIcon
ResourceName	m_MultiHighlightIcon
ref array< ref SCR_HighlightVisual >	m_aHighlightVisuals
bool	m_bAnimate
SCR_HighlightedEditorComponent	m_HighlightedEditorComponent
ImageWidget	m_ImageWidget
TextWidget	m_TextWidget
Protected Attributes inherited from SCR_BaseEditableEntityUIComponent
SCR_EditableEntityComponent	m_Entity

Detailed Description

Is an highlighted icon which, if animated pulsates.

Member Function Documentation

HandlerDeattached()

override void SCR_HighlightedEditorUIComponent.HandlerDeattached

(

Widget

w

)

OnClick()

override bool SCR_HighlightedEditorUIComponent.OnClick	(	Widget	w,
		int	x,
		int	y,
		int	button
	)

OnInit()

override void SCR_HighlightedEditorUIComponent.OnInit	(	SCR_EditableEntityComponent	entity,
		SCR_UIInfo	info,
		SCR_EditableEntityBaseSlotUIComponent	slot
	)

Method called when the widget is initialised.

Parameters

[in]	entity	Editable entity
[in]	slot	Slot to which this widget is attached to

Implements SCR_BaseEditableEntityUIComponent.

OnSelectedChange()

void SCR_HighlightedEditorUIComponent.OnSelectedChange ( EEditableEntityState  state, set< SCR_EditableEntityComponent >  entitiesInsert, set< SCR_EditableEntityComponent >  entitiesRemove  )

protected

OnUpdateHighlight()

void SCR_HighlightedEditorUIComponent.OnUpdateHighlight ( SCR_EditableEntityComponent  entity, EEditableEntityHighlight  highlight, int  highlightCount  )

protected

StopAnimations()

void SCR_HighlightedEditorUIComponent.StopAnimations ( Widget  w )

protected

Member Data Documentation

m_aHighlightVisuals

ref array<ref SCR_HighlightVisual> SCR_HighlightedEditorUIComponent.m_aHighlightVisuals

protected

m_AnimWidgetName

string SCR_HighlightedEditorUIComponent.m_AnimWidgetName

protected

m_bAnimate

bool SCR_HighlightedEditorUIComponent.m_bAnimate

protected

m_DefaultIcon

ResourceName SCR_HighlightedEditorUIComponent.m_DefaultIcon

protected

m_HighlightedEditorComponent

SCR_HighlightedEditorComponent SCR_HighlightedEditorUIComponent.m_HighlightedEditorComponent

protected

m_ImageWidget

ImageWidget SCR_HighlightedEditorUIComponent.m_ImageWidget

protected

m_ImageWidgetName

string SCR_HighlightedEditorUIComponent.m_ImageWidgetName

protected

m_MultiHighlightIcon

ResourceName SCR_HighlightedEditorUIComponent.m_MultiHighlightIcon

protected

m_TextWidget

TextWidget SCR_HighlightedEditorUIComponent.m_TextWidget

protected

m_TextWidgetName

string SCR_HighlightedEditorUIComponent.m_TextWidgetName

protected

---

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

• Game/Editor/UI/Components/Common/SCR_HighlightedEditorUIComponent.c