SCR_EditableEntitySceneSlotUIComponent Interface Reference

Inheritance diagram for SCR_EditableEntitySceneSlotUIComponent:

Public Member Functions
void	UpdateShowOffScreen ()
	Set if the icon should be shown on screen borders when its position is off-screen.
bool	IsShownOffScreen ()
	Check if the icon is supposed to be shown on screen borders when its position is off-screen.
void	SetOffScreenPadding (float padding)
	Set padding from screen border when the icon is rendered off-screen.
float	GetOffScreenPadding ()
	Get padding from screen border when the icon is rendered off-screen.
Widget	GetOffScreenWidget ()
override bool	IsPreview ()
vector	GetIntersectionPoint (vector A1, vector A2, vector B1, vector B2)
vector	ShowOffScreen (vector pos, int screenW, int screenH, vector posCenter)
override vector	UpdateSlot (int screenW, int screenH, vector posCenter, vector posCam)
override Widget	CreateWidgetForEntity (SCR_EditableEntityComponent entity, SCR_EntitiesEditorUIRule rule, ResourceName layout)
override void	DeleteWidget (SCR_EntitiesEditorUIRule rule)
override void	InitSlot (SCR_EditableEntityComponent entity)
Public Member Functions inherited from SCR_EditableEntityBaseSlotUIComponent
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	DeleteSlot ()
Widget	GetWidget ()
override void	HandlerAttached (Widget w)

Protected Attributes
float	m_fOffScreenPadding
ResourceName	m_OffScreenPrefab
WorkspaceWidget	m_Workspace
BaseWorld	m_World
bool	m_bShowOffScreen = false
bool	m_bIsOffScreen
vector	m_vCornersPadding [4]
ImageWidget	m_OffScreenWidget
bool	m_bIsPreview
Protected Attributes inherited from SCR_EditableEntityBaseSlotUIComponent
Widget	m_Widget
SCR_EditableEntityComponent	m_Entity
ref map< SCR_EntitiesEditorUIRule, SCR_BaseEditableEntityUIComponent >	m_EntityWidgets = new map<SCR_EntitiesEditorUIRule, SCR_BaseEditableEntityUIComponent>()

Additional Inherited Members
Protected Member Functions inherited from SCR_EditableEntityBaseSlotUIComponent
SCR_BaseEditableEntityUIComponent	CreateWidgetFromLayout (ResourceName layout)
void	SetFactionColor ()
void	RefreshSlot ()
void	ResetSlot ()

Member Function Documentation

CreateWidgetForEntity()

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

Implements SCR_EditableEntityBaseSlotUIComponent.

DeleteWidget()

override void SCR_EditableEntitySceneSlotUIComponent.DeleteWidget

(

SCR_EntitiesEditorUIRule

rule

)

Parameters

[in]

rule

Implements SCR_EditableEntityBaseSlotUIComponent.

GetIntersectionPoint()

vector SCR_EditableEntitySceneSlotUIComponent.GetIntersectionPoint	(	vector	A1,
		vector	A2,
		vector	B1,
		vector	B2 )

Parameters

[in]	A1
[in]	A2
[in]	B1
[in]	B2

Returns

GetOffScreenPadding()

float SCR_EditableEntitySceneSlotUIComponent.GetOffScreenPadding

(

)

Get padding from screen border when the icon is rendered off-screen.

Returns

Padding

GetOffScreenWidget()

Widget SCR_EditableEntitySceneSlotUIComponent.GetOffScreenWidget

(

)

Returns

InitSlot()

override void SCR_EditableEntitySceneSlotUIComponent.InitSlot

(

SCR_EditableEntityComponent

entity

)

Parameters

[in]

entity

Implements SCR_EditableEntityBaseSlotUIComponent.

Implemented in SCR_EditableEntityCustomSlotUIComponent.

IsPreview()

override bool SCR_EditableEntitySceneSlotUIComponent.IsPreview

(

)

Returns

Implements SCR_EditableEntityBaseSlotUIComponent.

IsShownOffScreen()

bool SCR_EditableEntitySceneSlotUIComponent.IsShownOffScreen

(

)

Check if the icon is supposed to be shown on screen borders when its position is off-screen.

Returns

True when marked to shown off-screen

SetOffScreenPadding()

void SCR_EditableEntitySceneSlotUIComponent.SetOffScreenPadding

(

float

padding

)

Set padding from screen border when the icon is rendered off-screen.

Parameters

[in]

padding

ShowOffScreen()

vector SCR_EditableEntitySceneSlotUIComponent.ShowOffScreen	(	vector	pos,
		int	screenW,
		int	screenH,
		vector	posCenter )

Parameters

[in]	pos
[in]	screenW
[in]	screenH
[in]	posCenter

Returns

UpdateShowOffScreen()

void SCR_EditableEntitySceneSlotUIComponent.UpdateShowOffScreen

(

)

Set if the icon should be shown on screen borders when its position is off-screen.

UpdateSlot()

override vector SCR_EditableEntitySceneSlotUIComponent.UpdateSlot	(	int	screenW,
		int	screenH,
		vector	posCenter,
		vector	posCam )

Parameters

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

Returns

Implements SCR_EditableEntityBaseSlotUIComponent.

Implemented in SCR_EditableEntityCustomSlotUIComponent.

Member Data Documentation

m_bIsOffScreen

bool SCR_EditableEntitySceneSlotUIComponent.m_bIsOffScreen

protected

m_bIsPreview

bool SCR_EditableEntitySceneSlotUIComponent.m_bIsPreview

protected

m_bShowOffScreen

bool SCR_EditableEntitySceneSlotUIComponent.m_bShowOffScreen = false

protected

m_fOffScreenPadding

float SCR_EditableEntitySceneSlotUIComponent.m_fOffScreenPadding

protected

m_OffScreenPrefab

ResourceName SCR_EditableEntitySceneSlotUIComponent.m_OffScreenPrefab

protected

m_OffScreenWidget

ImageWidget SCR_EditableEntitySceneSlotUIComponent.m_OffScreenWidget

protected

m_vCornersPadding

vector SCR_EditableEntitySceneSlotUIComponent.m_vCornersPadding[4]

protected

m_Workspace

WorkspaceWidget SCR_EditableEntitySceneSlotUIComponent.m_Workspace

protected

m_World

BaseWorld SCR_EditableEntitySceneSlotUIComponent.m_World

protected

---

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

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