SCR_EditableEntityBaseSlotUIComponent Interface Reference

Slot for icons representing editable entity. More...

Inheritance diagram for SCR_EditableEntityBaseSlotUIComponent:

Public Member Functions
bool	IsEmpty ()
	Check if the slot is empty, i.e., doesn't contain icons for any rule.
SCR_EditableEntityComponent	GetEntity ()
	Get entity this slot represents.
Widget	CreateWidget (SCR_EditableEntityUIInfo info, SCR_EntitiesEditorUIRule rule)
	Create icon from UI info and a rule.
Widget	CreateWidget (SCR_EditableEntityComponent entity, SCR_EntitiesEditorUIRule rule)
	Create icon from editable entity and a rule.
Widget	CreateWidget (SCR_EditableEntityComponent entity, ResourceName layout)
	Create icon from editable entity and layout path.
void	DeleteWidget (SCR_EntitiesEditorUIRule rule)
vector	UpdateSlot (int screenW, int screenH, vector posCenter, vector posCam)
void	InitSlot (SCR_EditableEntityComponent entity)
void	DeleteSlot ()
bool	IsPreview ()
Widget	GetWidget ()
override void	HandlerAttached (Widget w)

Protected Member Functions
Widget	CreateWidgetForEntity (SCR_EditableEntityComponent entity, SCR_EntitiesEditorUIRule rule, ResourceName layout)
SCR_BaseEditableEntityUIComponent	CreateWidgetFromLayout (ResourceName layout)
void	SetFactionColor ()
void	RefreshSlot ()
void	ResetSlot ()

Protected Attributes
Widget	m_Widget
SCR_EditableEntityComponent	m_Entity
ref map< SCR_EntitiesEditorUIRule, SCR_BaseEditableEntityUIComponent >	m_EntityWidgets = new map<SCR_EntitiesEditorUIRule, SCR_BaseEditableEntityUIComponent>()

Detailed Description

Slot for icons representing editable entity.

One exists for every visible editable entity. Attached to Frame widget inside of which icon widgets are created (one for each active SCR_EntitiesEditorUIRule).

Member Function Documentation

CreateWidget() [1/3]

Widget SCR_EditableEntityBaseSlotUIComponent.CreateWidget	(	SCR_EditableEntityComponent	entity,
		ResourceName	layout
	)

Create icon from editable entity and layout path.

Parameters

[in]

entity

Editable entity \rule layout Path to the layout

Returns

Created widget

CreateWidget() [2/3]

Widget SCR_EditableEntityBaseSlotUIComponent.CreateWidget	(	SCR_EditableEntityComponent	entity,
		SCR_EntitiesEditorUIRule	rule
	)

Create icon from editable entity and a rule.

Parameters

[in]

entity

Editable entity \rule Visualisation rule

Returns

Created widget

CreateWidget() [3/3]

Widget SCR_EditableEntityBaseSlotUIComponent.CreateWidget	(	SCR_EditableEntityUIInfo	info,
		SCR_EntitiesEditorUIRule	rule
	)

Create icon from UI info and a rule.

Parameters

[in]

info

UI info representing the entity \rule Visualisation rule

Returns

Created widget

CreateWidgetForEntity()

Widget SCR_EditableEntityBaseSlotUIComponent.CreateWidgetForEntity ( SCR_EditableEntityComponent  entity, SCR_EntitiesEditorUIRule  rule, ResourceName  layout  )

protected

Implemented in SCR_EditableEntitySceneSlotUIComponent.

CreateWidgetFromLayout()

SCR_BaseEditableEntityUIComponent SCR_EditableEntityBaseSlotUIComponent.CreateWidgetFromLayout ( ResourceName  layout )

protected

DeleteSlot()

void SCR_EditableEntityBaseSlotUIComponent.DeleteSlot

(

)

DeleteWidget()

void SCR_EditableEntityBaseSlotUIComponent.DeleteWidget

(

SCR_EntitiesEditorUIRule

rule

)

Parameters

[in]

rule

Implemented in SCR_EditableEntitySceneSlotUIComponent.

GetEntity()

SCR_EditableEntityComponent SCR_EditableEntityBaseSlotUIComponent.GetEntity

(

)

Get entity this slot represents.

Returns

Editable entity

GetWidget()

Widget SCR_EditableEntityBaseSlotUIComponent.GetWidget

(

)

Returns

HandlerAttached()

override void SCR_EditableEntityBaseSlotUIComponent.HandlerAttached

(

Widget

w

)

InitSlot()

void SCR_EditableEntityBaseSlotUIComponent.InitSlot

(

SCR_EditableEntityComponent

entity

)

Parameters

[in]

entity

Implemented in SCR_EditableEntityCustomSlotUIComponent, and SCR_EditableEntitySceneSlotUIComponent.

IsEmpty()

bool SCR_EditableEntityBaseSlotUIComponent.IsEmpty

(

)

Check if the slot is empty, i.e., doesn't contain icons for any rule.

Returns

True when empty

IsPreview()

bool SCR_EditableEntityBaseSlotUIComponent.IsPreview

(

)

Returns

Implemented in SCR_EditableEntitySceneSlotUIComponent.

RefreshSlot()

void SCR_EditableEntityBaseSlotUIComponent.RefreshSlot ( )

protected

ResetSlot()

void SCR_EditableEntityBaseSlotUIComponent.ResetSlot ( )

protected

SetFactionColor()

void SCR_EditableEntityBaseSlotUIComponent.SetFactionColor ( )

protected

UpdateSlot()

vector SCR_EditableEntityBaseSlotUIComponent.UpdateSlot	(	int	screenW,
		int	screenH,
		vector	posCenter,
		vector	posCam
	)

Parameters

[in]	screenW
[in]	screenH
[in]	posCenter
[in]	posCam

Returns

Implemented in SCR_EditableEntityCustomSlotUIComponent, and SCR_EditableEntitySceneSlotUIComponent.

Member Data Documentation

m_Entity

SCR_EditableEntityComponent SCR_EditableEntityBaseSlotUIComponent.m_Entity

protected

m_EntityWidgets

ref map<SCR_EntitiesEditorUIRule, SCR_BaseEditableEntityUIComponent> SCR_EditableEntityBaseSlotUIComponent.m_EntityWidgets = new map<SCR_EntitiesEditorUIRule, SCR_BaseEditableEntityUIComponent>()

protected

m_Widget

Widget SCR_EditableEntityBaseSlotUIComponent.m_Widget

protected

---

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

• Game/Editor/UI/Components/EditableEntityFilters/SCR_EditableEntityBaseSlotUIComponent.c