SCR_EditableEntityBaseSlotUIComponent Class Reference

Inheritance diagram for SCR_EditableEntityBaseSlotUIComponent:

Protected Member Functions
bool	IsEmpty ()
SCR_EditableEntityComponent	GetEntity ()
Widget	CreateWidget (SCR_EditableEntityUIInfo info, SCR_EntitiesEditorUIRule rule)
Widget	CreateWidget (SCR_EditableEntityComponent entity, SCR_EntitiesEditorUIRule rule)
Widget	CreateWidget (SCR_EditableEntityComponent entity, ResourceName layout)
Widget	CreateWidgetForEntity (SCR_EditableEntityComponent entity, SCR_EntitiesEditorUIRule rule, ResourceName layout)
SCR_BaseEditableEntityUIComponent	CreateWidgetFromLayout (ResourceName layout)
void	DeleteWidget (SCR_EntitiesEditorUIRule rule)
void	SetFactionColor ()
void	RefreshSlot ()
void	ResetSlot ()
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 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).

Definition at line 6 of file SCR_EditableEntityBaseSlotUIComponent.c.

Member Function Documentation

CreateWidget() [1/3]

Widget SCR_EditableEntityBaseSlotUIComponent::CreateWidget ( SCR_EditableEntityComponent entity, ResourceName layout )

inlineprotected

Create icon from editable entity and layout path.

Parameters

[in]

entity

Editable entity \rule layout Path to the layout

Returns

Created widget

Definition at line 60 of file SCR_EditableEntityBaseSlotUIComponent.c.

CreateWidget() [2/3]

Widget SCR_EditableEntityBaseSlotUIComponent::CreateWidget ( SCR_EditableEntityComponent entity, SCR_EntitiesEditorUIRule rule )

inlineprotected

Create icon from editable entity and a rule.

Parameters

[in]

entity

Editable entity \rule Visualisation rule

Returns

Created widget

Definition at line 47 of file SCR_EditableEntityBaseSlotUIComponent.c.

CreateWidget() [3/3]

Widget SCR_EditableEntityBaseSlotUIComponent::CreateWidget ( SCR_EditableEntityUIInfo info, SCR_EntitiesEditorUIRule rule )

inlineprotected

Create icon from UI info and a rule.

Parameters

[in]

info

UI info representing the entity \rule Visualisation rule

Returns

Created widget

Definition at line 33 of file SCR_EditableEntityBaseSlotUIComponent.c.

CreateWidgetForEntity()

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

inlineprotected

Definition at line 66 of file SCR_EditableEntityBaseSlotUIComponent.c.

CreateWidgetFromLayout()

SCR_BaseEditableEntityUIComponent SCR_EditableEntityBaseSlotUIComponent::CreateWidgetFromLayout ( ResourceName layout )

inlineprotected

Definition at line 83 of file SCR_EditableEntityBaseSlotUIComponent.c.

DeleteSlot()

void SCR_EditableEntityBaseSlotUIComponent::DeleteSlot ( )

inlineprotected

Definition at line 194 of file SCR_EditableEntityBaseSlotUIComponent.c.

DeleteWidget()

void SCR_EditableEntityBaseSlotUIComponent::DeleteWidget ( SCR_EntitiesEditorUIRule rule )

inlineprotected

Parameters

[in]

rule

Definition at line 108 of file SCR_EditableEntityBaseSlotUIComponent.c.

GetEntity()

SCR_EditableEntityComponent SCR_EditableEntityBaseSlotUIComponent::GetEntity ( )

inlineprotected

Get entity this slot represents.

Returns

Editable entity

Definition at line 23 of file SCR_EditableEntityBaseSlotUIComponent.c.

GetWidget()

Widget SCR_EditableEntityBaseSlotUIComponent::GetWidget ( )

inlineprotected

Returns

Definition at line 222 of file SCR_EditableEntityBaseSlotUIComponent.c.

HandlerAttached()

override void SCR_EditableEntityBaseSlotUIComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 228 of file SCR_EditableEntityBaseSlotUIComponent.c.

InitSlot()

void SCR_EditableEntityBaseSlotUIComponent::InitSlot ( SCR_EditableEntityComponent entity )

inlineprotected

Parameters

[in]

entity

Definition at line 174 of file SCR_EditableEntityBaseSlotUIComponent.c.

IsEmpty()

bool SCR_EditableEntityBaseSlotUIComponent::IsEmpty ( )

inlineprotected

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

Returns

True when empty

Definition at line 15 of file SCR_EditableEntityBaseSlotUIComponent.c.

IsPreview()

bool SCR_EditableEntityBaseSlotUIComponent::IsPreview ( )

inlineprotected

Returns

Definition at line 215 of file SCR_EditableEntityBaseSlotUIComponent.c.

RefreshSlot()

void SCR_EditableEntityBaseSlotUIComponent::RefreshSlot ( )

inlineprotected

Definition at line 137 of file SCR_EditableEntityBaseSlotUIComponent.c.

ResetSlot()

void SCR_EditableEntityBaseSlotUIComponent::ResetSlot ( )

inlineprotected

Definition at line 148 of file SCR_EditableEntityBaseSlotUIComponent.c.

SetFactionColor()

void SCR_EditableEntityBaseSlotUIComponent::SetFactionColor ( )

inlineprotected

Definition at line 119 of file SCR_EditableEntityBaseSlotUIComponent.c.

UpdateSlot()

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

inlineprotected

Parameters

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

Returns

Definition at line 166 of file SCR_EditableEntityBaseSlotUIComponent.c.

Member Data Documentation

m_Entity

SCR_EditableEntityComponent SCR_EditableEntityBaseSlotUIComponent::m_Entity

protected

Definition at line 9 of file SCR_EditableEntityBaseSlotUIComponent.c.

m_EntityWidgets

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

protected

Definition at line 10 of file SCR_EditableEntityBaseSlotUIComponent.c.

m_Widget

Widget SCR_EditableEntityBaseSlotUIComponent::m_Widget

protected

Definition at line 8 of file SCR_EditableEntityBaseSlotUIComponent.c.

---

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

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