SCR_MapRTWBaseUI.c File Reference

Go to the source code of this file.

Data Structures
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. More...
protected void	SetWidgetNames ()
	Set widget names. More...
protected void	InitPositionVectors ()
	Initialise RT camera and prefab positon. More...
protected string	GetPrefabResource ()
IEntity	FindRelatedGadget ()
protected void	ToggleVisible ()
	Visibility toggle. More...
protected void	SetVisible (bool visible)
void	SetFrameVisible ()
	TODO Frame is now set through script here instead of directly in callqueue to avoid leak. More...
protected bool	SetupRTWorld ()
protected bool	SpawnPrefab ()
protected void	SetSize (bool nextSize=false)
protected void	OnDragWidget (Widget widget)
protected void	OnActivateTool (Widget widget)
	SCR_MapToolInteractionUI event. More...
override void	OnMapOpen (MapConfiguration config)
override void	OnMapClose (MapConfiguration config)
void	SCR_MapRTWBaseUI ()

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

(

)

Find related gadget in inventory

Returns

gadget or null if not found in inventory

Definition at line 74 of file SCR_MapRTWBaseUI.c.

GetPrefabResource()

protected string GetPrefabResource

(

)

Get prefab resource for display

Returns

prefab resource

Definition at line 66 of file SCR_MapRTWBaseUI.c.

InitPositionVectors()

protected void InitPositionVectors

(

)

Initialise RT camera and prefab positon.

Definition at line 56 of file SCR_MapRTWBaseUI.c.

OnActivateTool()

protected void OnActivateTool

(

Widget

widget

)

SCR_MapToolInteractionUI event.

Definition at line 246 of file SCR_MapRTWBaseUI.c.

OnDragWidget()

protected void OnDragWidget

(

Widget

widget

)

Drag event

Parameters

[in]

widget

Definition at line 236 of file SCR_MapRTWBaseUI.c.

OnMapClose()

override void OnMapClose

(

MapConfiguration

config

)

Definition at line 288 of file SCR_MapRTWBaseUI.c.

OnMapOpen()

override void OnMapOpen

(

MapConfiguration

config

)

Definition at line 259 of file SCR_MapRTWBaseUI.c.

SCR_MapRTWBaseUI()

void SCR_MapRTWBaseUI

(

)

Definition at line 300 of file SCR_MapRTWBaseUI.c.

SetFrameVisible()

void SetFrameVisible

(

)

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()

protected void SetSize

(

bool

nextSize = false

)

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()

protected bool SetupRTWorld

(

)

Setup preview world

Returns

Returns true if successful

Definition at line 145 of file SCR_MapRTWBaseUI.c.

SetVisible()

protected void SetVisible

(

bool

visible

)

Set visibility

Parameters

[in]

visible

is true/false switch

Definition at line 100 of file SCR_MapRTWBaseUI.c.

SetWidgetNames()

protected void SetWidgetNames

(

)

Set widget names.

Definition at line 47 of file SCR_MapRTWBaseUI.c.

SpawnPrefab()

protected bool SpawnPrefab

(

)

Spawn prefab in the preview world

Returns

true if successful

Definition at line 180 of file SCR_MapRTWBaseUI.c.

ToggleVisible()

protected void ToggleVisible

(

)

Visibility toggle.

Definition at line 87 of file SCR_MapRTWBaseUI.c.

Variable Documentation

m_bIsDragged

protected bool m_bIsDragged = false

Definition at line 31 of file SCR_MapRTWBaseUI.c.

m_bIsVisible

protected bool m_bIsVisible

Definition at line 29 of file SCR_MapRTWBaseUI.c.

m_bWantedVisible

protected bool m_bWantedVisible

Definition at line 30 of file SCR_MapRTWBaseUI.c.

m_eGadgetType

protected EGadgetType m_eGadgetType

Definition at line 36 of file SCR_MapRTWBaseUI.c.

m_fPosX

protected float m_fPosX

Definition at line 34 of file SCR_MapRTWBaseUI.c.

m_fPosY

protected float m_fPosY

Definition at line 34 of file SCR_MapRTWBaseUI.c.

m_iCurrentSizeIndex

protected int m_iCurrentSizeIndex

Definition at line 32 of file SCR_MapRTWBaseUI.c.

m_iSizesCount

protected int m_iSizesCount

Definition at line 33 of file SCR_MapRTWBaseUI.c.

m_iSizeX

int m_iSizeX

Definition at line 3 of file SCR_MapRTWBaseUI.c.

m_iSizeY

int m_iSizeY

Definition at line 6 of file SCR_MapRTWBaseUI.c.

m_RTEntity

protected GenericEntity m_RTEntity

Definition at line 37 of file SCR_MapRTWBaseUI.c.

m_RTWorld

protected ref SharedItemRef m_RTWorld

Definition at line 38 of file SCR_MapRTWBaseUI.c.

m_ToolMenuEntry

protected SCR_MapToolEntry m_ToolMenuEntry

Definition at line 39 of file SCR_MapRTWBaseUI.c.

m_vCameraAngle

protected vector m_vCameraAngle

Definition at line 27 of file SCR_MapRTWBaseUI.c.

m_vCameraPos

protected vector m_vCameraPos

Definition at line 26 of file SCR_MapRTWBaseUI.c.

m_vPrefabPos

protected vector m_vPrefabPos

Definition at line 25 of file SCR_MapRTWBaseUI.c.

m_wFrame

protected Widget m_wFrame

Definition at line 42 of file SCR_MapRTWBaseUI.c.

m_wRenderTarget

protected RenderTargetWidget m_wRenderTarget

Definition at line 43 of file SCR_MapRTWBaseUI.c.

RT_WIDGET_NAME

protected string RT_WIDGET_NAME

Definition at line 22 of file SCR_MapRTWBaseUI.c.

WIDGET_NAME

protected string WIDGET_NAME

Definition at line 21 of file SCR_MapRTWBaseUI.c.

WORLD_NAME

protected string WORLD_NAME

Definition at line 24 of file SCR_MapRTWBaseUI.c.

WORLD_RESOURCE

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

Definition at line 23 of file SCR_MapRTWBaseUI.c.