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

Inheritance diagram for SCR_MapRTWBaseUI:

Public Member Functions
IEntity	FindRelatedGadget ()
	Find related gadget in inventory.

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

override void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.

override void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

void	SCR_MapRTWBaseUI ()

Public Member Functions inherited from SCR_MapUIBaseComponent
bool	IsConfigDisabled ()

void	SetActive (bool active, bool isCleanup=false)
	Enable open/close events, called every time component is activated, usually on map open.

void	Init ()
	Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.

void	Update (float timeSlice)
	Update method for frame operations.

bool	IsToolMenuFocused ()

void	SCR_MapUIBaseComponent ()

Protected Member Functions
void	SetWidgetNames ()
	Set widget names.

void	InitPositionVectors ()
	Initialise RT camera and prefab positon.

string	GetPrefabResource ()
	Get prefab resource for display.

void	ToggleVisible ()
	Visibility toggle.

void	SetVisible (bool visible)
	Set visibility.

bool	SetupRTWorld ()
	Setup preview world.

bool	SpawnPrefab ()
	Spawn prefab in the preview world.

void	SetSize (bool nextSize=false)
	Set size of RTW widget, cyclying through an array of prepared sizes.

void	OnDragWidget (Widget widget)
	Drag event.

void	OnActivateTool (Widget widget)
	SCR_MapToolInteractionUI event.

void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.

void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

Protected Attributes
ref array< ref ToolSize >	m_aSizesArray

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

Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent

bool	m_bHookToRoot = false

Widget	m_RootWidget

SCR_MapEntity	m_MapEntity

Static Protected Attributes
static const string	BASE_WORLD_TYPE = "ChimeraWorld"

static const float	CAMERA_VERTICAL_FOV = 43

Detailed Description

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

Constructor & Destructor Documentation

◆ SCR_MapRTWBaseUI()

void SCR_MapRTWBaseUI.SCR_MapRTWBaseUI ( )

Member Function Documentation

◆ FindRelatedGadget()

IEntity SCR_MapRTWBaseUI.FindRelatedGadget ( )

Find related gadget in inventory.

Returns: gadget or null if not found in inventory

Implemented in SCR_MapCompassUIDeploy, and SCR_MapWatchUIDeploy.

◆ GetPrefabResource()

string SCR_MapRTWBaseUI.GetPrefabResource ( )

protected

Get prefab resource for display.

Returns: prefab resource

Implemented in SCR_MapCompassUI, SCR_MapCompassUIDeploy, SCR_MapWatchUI, and SCR_MapWatchUIDeploy.

◆ InitPositionVectors()

void SCR_MapRTWBaseUI.InitPositionVectors ( )

protected

Initialise RT camera and prefab positon.

Implemented in SCR_MapCompassUI, and SCR_MapWatchUI.

◆ OnActivateTool()

void SCR_MapRTWBaseUI.OnActivateTool ( Widget widget )

protected

SCR_MapToolInteractionUI event.

◆ OnDragWidget()

void SCR_MapRTWBaseUI.OnDragWidget ( Widget widget )

protected

Drag event.

Parameters

[in] widget

◆ OnMapClose()

override void SCR_MapRTWBaseUI.OnMapClose ( MapConfiguration config )

SCR_MapEntity event.

Parameters

[in] config

Implements SCR_MapUIBaseComponent.

◆ OnMapOpen()

override void SCR_MapRTWBaseUI.OnMapOpen ( MapConfiguration config )

SCR_MapEntity event.

Parameters

[in] config

Implements SCR_MapUIBaseComponent.

◆ SetFrameVisible()

void SCR_MapRTWBaseUI.SetFrameVisible ( )

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

◆ SetSize()

void SCR_MapRTWBaseUI.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

◆ SetupRTWorld()

bool SCR_MapRTWBaseUI.SetupRTWorld ( )

protected

Setup preview world.

Returns: Returns true if successful

◆ SetVisible()

void SCR_MapRTWBaseUI.SetVisible ( bool visible )

protected

Set visibility.

Parameters

[in] visible is true/false switch

Implemented in SCR_MapCompassUI, and SCR_MapWatchUI.

◆ SetWidgetNames()

void SCR_MapRTWBaseUI.SetWidgetNames ( )

protected

Set widget names.

Implemented in SCR_MapCompassUI, and SCR_MapWatchUI.

◆ SpawnPrefab()

bool SCR_MapRTWBaseUI.SpawnPrefab ( )

protected

Spawn prefab in the preview world.

Returns: true if successful

◆ ToggleVisible()

void SCR_MapRTWBaseUI.ToggleVisible ( )

protected

Visibility toggle.

Member Data Documentation

◆ BASE_WORLD_TYPE

const string SCR_MapRTWBaseUI.BASE_WORLD_TYPE = "ChimeraWorld"

staticprotected

◆ CAMERA_VERTICAL_FOV

const float SCR_MapRTWBaseUI.CAMERA_VERTICAL_FOV = 43

staticprotected

◆ m_aSizesArray

ref array<ref ToolSize> SCR_MapRTWBaseUI.m_aSizesArray

protected

◆ m_bIsDragged

bool SCR_MapRTWBaseUI.m_bIsDragged = false

protected

◆ m_bIsVisible

bool SCR_MapRTWBaseUI.m_bIsVisible

protected

◆ m_bWantedVisible

bool SCR_MapRTWBaseUI.m_bWantedVisible

protected

◆ m_eGadgetType

EGadgetType SCR_MapRTWBaseUI.m_eGadgetType

protected

◆ m_fPosX

float SCR_MapRTWBaseUI.m_fPosX

protected

◆ m_fPosY

float SCR_MapRTWBaseUI.m_fPosY

protected

◆ m_iCurrentSizeIndex

int SCR_MapRTWBaseUI.m_iCurrentSizeIndex

protected

◆ m_iSizesCount

int SCR_MapRTWBaseUI.m_iSizesCount

protected

◆ m_RTEntity

GenericEntity SCR_MapRTWBaseUI.m_RTEntity

protected

◆ m_RTWorld

ref SharedItemRef SCR_MapRTWBaseUI.m_RTWorld

protected

◆ m_ToolMenuEntry

SCR_MapToolEntry SCR_MapRTWBaseUI.m_ToolMenuEntry

protected

◆ m_vCameraAngle

vector SCR_MapRTWBaseUI.m_vCameraAngle

protected

◆ m_vCameraPos

vector SCR_MapRTWBaseUI.m_vCameraPos

protected

◆ m_vPrefabPos

vector SCR_MapRTWBaseUI.m_vPrefabPos

protected

◆ m_wFrame

Widget SCR_MapRTWBaseUI.m_wFrame

protected

◆ m_wRenderTarget

RenderTargetWidget SCR_MapRTWBaseUI.m_wRenderTarget

protected

◆ RT_WIDGET_NAME

string SCR_MapRTWBaseUI.RT_WIDGET_NAME

protected

◆ WIDGET_NAME

string SCR_MapRTWBaseUI.WIDGET_NAME

protected

◆ WORLD_NAME

string SCR_MapRTWBaseUI.WORLD_NAME

protected

◆ WORLD_RESOURCE

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

protected

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

Game/Map/ComponentsUI/SCR_MapRTWBaseUI.c

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCR_MapRTWBaseUI()

Member Function Documentation

◆ FindRelatedGadget()

◆ GetPrefabResource()

◆ InitPositionVectors()

◆ OnActivateTool()

◆ OnDragWidget()

◆ OnMapClose()

◆ OnMapOpen()

◆ SetFrameVisible()

◆ SetSize()

◆ SetupRTWorld()

◆ SetVisible()

◆ SetWidgetNames()

◆ SpawnPrefab()

◆ ToggleVisible()

Member Data Documentation

◆ BASE_WORLD_TYPE

◆ CAMERA_VERTICAL_FOV

◆ m_aSizesArray

◆ m_bIsDragged

◆ m_bIsVisible

◆ m_bWantedVisible

◆ m_eGadgetType

◆ m_fPosX

◆ m_fPosY

◆ m_iCurrentSizeIndex

◆ m_iSizesCount

◆ m_RTEntity

◆ m_RTWorld

◆ m_ToolMenuEntry

◆ m_vCameraAngle

◆ m_vCameraPos

◆ m_vPrefabPos

◆ m_wFrame

◆ m_wRenderTarget

◆ RT_WIDGET_NAME

◆ WIDGET_NAME

◆ WORLD_NAME

◆ WORLD_RESOURCE