SCR_MapRTWBaseUI.c File Reference

Go to the source code of this file.

Classes
class	ToolSize

Functions
class ToolSize	Attribute ("", UIWidgets.Object, desc:"Array of x*y sizes in unscaled pix")] protected ref array< ref ToolSize > m_aSizesArray
	Base map UI component for map tools which are using RenderTargetWidget to display.
void	SetWidgetNames ()
	Set widget names.
void	InitPositionVectors ()
	Initialise RT camera and prefab positon.
string	GetPrefabResource ()
IEntity	FindRelatedGadget ()
void	ToggleVisible ()
	Visibility toggle.
void	SetVisible (bool visible)
void	SetFrameVisible ()
	TODO Frame is now set through script here instead of directly in callqueue to avoid leak.
bool	SetupRTWorld ()
bool	SpawnPrefab ()
void	SetSize (bool nextSize=false)
void	OnDragWidget (Widget widget)
void	OnActivateTool (Widget widget)
	SCR_MapToolInteractionUI event.
override void	OnMapOpen (MapConfiguration config)
override void	OnMapClose (MapConfiguration config)
void	SCR_MapRTWBaseUI ()

Variables
int	m_iSizeX
int	m_iSizeY
string	WIDGET_NAME
string	RT_WIDGET_NAME
string	WORLD_RESOURCE = "{88ABCDC0EEC969DF}Prefabs/World/PreviewWorld/MapCompassWorld.et"
string	WORLD_NAME
vector	m_vPrefabPos
vector	m_vCameraPos
vector	m_vCameraAngle
bool	m_bIsVisible
bool	m_bWantedVisible
bool	m_bIsDragged = false
int	m_iCurrentSizeIndex
int	m_iSizesCount
float	m_fPosX
float	m_fPosY
EGadgetType	m_eGadgetType
GenericEntity	m_RTEntity
ref SharedItemRef	m_RTWorld
SCR_MapToolEntry	m_ToolMenuEntry
Widget	m_wFrame
RenderTargetWidget	m_wRenderTarget

Function Documentation

Attribute()

class ToolSize Attribute	(	""	,
		UIWidgets.	Object,
		desc:"Array of x*y sizes in unscaled pix"	)

Base map UI component for map tools which are using RenderTargetWidget to display.

FindRelatedGadget()

IEntity FindRelatedGadget ( )

protected

Find related gadget in inventory

Returns

gadget or null if not found in inventory

Definition at line 74 of file SCR_MapRTWBaseUI.c.

GetPrefabResource()

string GetPrefabResource ( )

protected

Get prefab resource for display

Returns

prefab resource

Definition at line 66 of file SCR_MapRTWBaseUI.c.

InitPositionVectors()

void InitPositionVectors ( )

protected

Initialise RT camera and prefab positon.

Definition at line 56 of file SCR_MapRTWBaseUI.c.

OnActivateTool()

void OnActivateTool ( Widget widget )

protected

SCR_MapToolInteractionUI event.

Definition at line 246 of file SCR_MapRTWBaseUI.c.

OnDragWidget()

void OnDragWidget ( Widget widget )

protected

Drag event

Parameters

[in]

widget

Definition at line 236 of file SCR_MapRTWBaseUI.c.

OnMapClose()

override void OnMapClose ( MapConfiguration config )

protected

Definition at line 288 of file SCR_MapRTWBaseUI.c.

OnMapOpen()

override void OnMapOpen ( MapConfiguration config )

protected

Definition at line 259 of file SCR_MapRTWBaseUI.c.

SCR_MapRTWBaseUI()

void SCR_MapRTWBaseUI ( )

protected

Definition at line 300 of file SCR_MapRTWBaseUI.c.

SetFrameVisible()

void SetFrameVisible ( )

protected

TODO Frame is now set through script here instead of directly in callqueue to avoid leak.

Definition at line 137 of file SCR_MapRTWBaseUI.c.

SetSize()

void SetSize ( bool nextSize = false )

protected

Set size of RTW widget, cyclying through an array of prepared sizes

Parameters

[in]

nextSize

determines whether current size is kept or swapped to the next one in size array

Definition at line 220 of file SCR_MapRTWBaseUI.c.

SetupRTWorld()

bool SetupRTWorld ( )

protected

Setup preview world

Returns

Returns true if successful

Definition at line 145 of file SCR_MapRTWBaseUI.c.

SetVisible()

void SetVisible ( bool visible )

protected

Set visibility

Parameters

[in]

visible

is true/false switch

Definition at line 100 of file SCR_MapRTWBaseUI.c.

SetWidgetNames()

void SetWidgetNames ( )

protected

Set widget names.

Definition at line 47 of file SCR_MapRTWBaseUI.c.

SpawnPrefab()

bool SpawnPrefab ( )

protected

Spawn prefab in the preview world

Returns

true if successful

Definition at line 180 of file SCR_MapRTWBaseUI.c.

ToggleVisible()

void ToggleVisible ( )

protected

Visibility toggle.

Definition at line 87 of file SCR_MapRTWBaseUI.c.

Variable Documentation

m_bIsDragged

bool m_bIsDragged = false

protected

Definition at line 31 of file SCR_MapRTWBaseUI.c.

m_bIsVisible

bool m_bIsVisible

protected

Definition at line 29 of file SCR_MapRTWBaseUI.c.

m_bWantedVisible

bool m_bWantedVisible

protected

Definition at line 30 of file SCR_MapRTWBaseUI.c.

m_eGadgetType

EGadgetType m_eGadgetType

protected

Definition at line 36 of file SCR_MapRTWBaseUI.c.

m_fPosX

float m_fPosX

protected

Definition at line 34 of file SCR_MapRTWBaseUI.c.

m_fPosY

float m_fPosY

protected

Definition at line 34 of file SCR_MapRTWBaseUI.c.

m_iCurrentSizeIndex

int m_iCurrentSizeIndex

protected

Definition at line 32 of file SCR_MapRTWBaseUI.c.

m_iSizesCount

int m_iSizesCount

protected

Definition at line 33 of file SCR_MapRTWBaseUI.c.

m_iSizeX

int m_iSizeX

Definition at line 1 of file SCR_MapRTWBaseUI.c.

m_iSizeY

int m_iSizeY

Definition at line 4 of file SCR_MapRTWBaseUI.c.

m_RTEntity

GenericEntity m_RTEntity

protected

Definition at line 37 of file SCR_MapRTWBaseUI.c.

m_RTWorld

ref SharedItemRef m_RTWorld

protected

Definition at line 38 of file SCR_MapRTWBaseUI.c.

m_ToolMenuEntry

SCR_MapToolEntry m_ToolMenuEntry

protected

Definition at line 39 of file SCR_MapRTWBaseUI.c.

m_vCameraAngle

vector m_vCameraAngle

protected

Definition at line 27 of file SCR_MapRTWBaseUI.c.

m_vCameraPos

vector m_vCameraPos

protected

Examples

F:/Games/AReforger/scripts/Game/Editor/Containers/EditableEntityFilters/SCR_RenderedEditableEntityFilter.c.

Definition at line 26 of file SCR_MapRTWBaseUI.c.

m_vPrefabPos

vector m_vPrefabPos

protected

Definition at line 25 of file SCR_MapRTWBaseUI.c.

m_wFrame

Widget m_wFrame

protected

Definition at line 42 of file SCR_MapRTWBaseUI.c.

m_wRenderTarget

RenderTargetWidget m_wRenderTarget

protected

Definition at line 43 of file SCR_MapRTWBaseUI.c.

RT_WIDGET_NAME

string RT_WIDGET_NAME

protected

Definition at line 22 of file SCR_MapRTWBaseUI.c.

WIDGET_NAME

string WIDGET_NAME

protected

Definition at line 21 of file SCR_MapRTWBaseUI.c.

WORLD_NAME

string WORLD_NAME

protected

Definition at line 24 of file SCR_MapRTWBaseUI.c.

WORLD_RESOURCE

string WORLD_RESOURCE = "{88ABCDC0EEC969DF}Prefabs/World/PreviewWorld/MapCompassWorld.et"

protected

Definition at line 23 of file SCR_MapRTWBaseUI.c.