SCR_MapRulerUI Interface Reference

Inheritance diagram for SCR_MapRulerUI:

Public Member Functions
override void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
override void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.
override void	Init ()
	Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.
override void	Update (float timeSlice)
	Update method for frame operations.
void	SCR_MapRulerUI ()
Public Member Functions inherited from SCR_MapUIBaseComponent
bool	IsConfigDisabled ()
bool	IsExclusive ()
void	SetActive (bool active, bool isCleanup=false)
	Enable open/close events, called every time component is activated, usually on map open.
bool	IsToolMenuFocused ()
void	SCR_MapUIBaseComponent ()

Public Attributes
float	m_fRulerLength
string	m_sRootWidgetName
string	m_sImageWidgetName
string	m_sToolMenuIconName

Protected Member Functions
void	ToggleVisible ()
	Visibility toggle.
void	SetVisible (bool visible, bool saveState=false)
	Set visibility.
void	SetSize (float x, float y, bool nextSize=false)
	Set size of image, multiply by current size mode.
void	OnMapZoom (float zoomVal)
	SCR_MapEntity event.
void	OnMapPan (float x, float y, bool adjustedPan)
	SCR_MapEntity event.
void	OnDragWidget (Widget widget)
	SCR_MapToolInteractionUI event.
void	OnActivateTool (Widget widget)
	SCR_MapToolInteractionUI event.
void	OnInputQuickBind (float value, EActionTrigger reason)

Protected Attributes
ref array< int >	m_aSizesArray
bool	m_bIsVisible
bool	m_bWantedVisible
bool	m_bIsDragged
bool	m_bIsZooming
int	m_iCurrentSizeIndex
int	m_iSizesCount
float	m_fPosX
float	m_fPosY
float	m_fWorldX
float	m_fWorldY
float	m_fAngle
float	m_fBaseImageSize [2]
float	m_fSizeCoef
vector	m_vMapPan
SCR_MapToolEntry	m_ToolMenuEntry
Widget	m_wFrame
ImageWidget	m_wImage
WorkspaceWidget	m_wWorkspace
Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent
bool	m_bIsExclusive
bool	m_bHookToRoot = false
Widget	m_RootWidget
SCR_MapEntity	m_MapEntity

Constructor & Destructor Documentation

SCR_MapRulerUI()

void SCR_MapRulerUI.SCR_MapRulerUI

(

)

Member Function Documentation

Init()

override void SCR_MapRulerUI.Init

(

)

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

Implements SCR_MapUIBaseComponent.

OnActivateTool()

void SCR_MapRulerUI.OnActivateTool ( Widget widget )

protected

SCR_MapToolInteractionUI event.

OnDragWidget()

void SCR_MapRulerUI.OnDragWidget ( Widget widget )

protected

SCR_MapToolInteractionUI event.

OnInputQuickBind()

void SCR_MapRulerUI.OnInputQuickBind ( float value, EActionTrigger reason )

protected

OnMapClose()

override void SCR_MapRulerUI.OnMapClose

(

MapConfiguration

config

)

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

OnMapOpen()

override void SCR_MapRulerUI.OnMapOpen

(

MapConfiguration

config

)

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

OnMapPan()

void SCR_MapRulerUI.OnMapPan ( float x, float y, bool adjustedPan )

protected

SCR_MapEntity event.

OnMapZoom()

void SCR_MapRulerUI.OnMapZoom ( float zoomVal )

protected

SCR_MapEntity event.

SetSize()

void SCR_MapRulerUI.SetSize ( float x, float y, bool nextSize = false )

protected

Set size of image, multiply by current size mode.

Parameters

[in]	x	is unscaled size in px
[in]	y	is unscaled size in px
[in]	nextSize	determines whether current size is kept or swapped to the next one in size array

SetVisible()

void SCR_MapRulerUI.SetVisible ( bool visible, bool saveState = false )

protected

Set visibility.

Parameters

[in]	visible	is true/false switch
[in]	saveState	determines whether this is visibility set during closing of the map, so the pos and rotation should be saved

ToggleVisible()

void SCR_MapRulerUI.ToggleVisible ( )

protected

Visibility toggle.

Update()

override void SCR_MapRulerUI.Update

(

float

timeSlice

)

Update method for frame operations.

Implements SCR_MapUIBaseComponent.

Member Data Documentation

m_aSizesArray

ref array<int> SCR_MapRulerUI.m_aSizesArray

protected

m_bIsDragged

bool SCR_MapRulerUI.m_bIsDragged

protected

m_bIsVisible

bool SCR_MapRulerUI.m_bIsVisible

protected

m_bIsZooming

bool SCR_MapRulerUI.m_bIsZooming

protected

m_bWantedVisible

bool SCR_MapRulerUI.m_bWantedVisible

protected

m_fAngle

float SCR_MapRulerUI.m_fAngle

protected

m_fBaseImageSize

float SCR_MapRulerUI.m_fBaseImageSize[2]

protected

m_fPosX

float SCR_MapRulerUI.m_fPosX

protected

m_fPosY

float SCR_MapRulerUI.m_fPosY

protected

m_fRulerLength

float SCR_MapRulerUI.m_fRulerLength

m_fSizeCoef

float SCR_MapRulerUI.m_fSizeCoef

protected

m_fWorldX

float SCR_MapRulerUI.m_fWorldX

protected

m_fWorldY

float SCR_MapRulerUI.m_fWorldY

protected

m_iCurrentSizeIndex

int SCR_MapRulerUI.m_iCurrentSizeIndex

protected

m_iSizesCount

int SCR_MapRulerUI.m_iSizesCount

protected

m_sImageWidgetName

string SCR_MapRulerUI.m_sImageWidgetName

m_sRootWidgetName

string SCR_MapRulerUI.m_sRootWidgetName

m_sToolMenuIconName

string SCR_MapRulerUI.m_sToolMenuIconName

m_ToolMenuEntry

SCR_MapToolEntry SCR_MapRulerUI.m_ToolMenuEntry

protected

m_vMapPan

vector SCR_MapRulerUI.m_vMapPan

protected

m_wFrame

Widget SCR_MapRulerUI.m_wFrame

protected

m_wImage

ImageWidget SCR_MapRulerUI.m_wImage

protected

m_wWorkspace

WorkspaceWidget SCR_MapRulerUI.m_wWorkspace

protected

---

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

• Game/Map/ComponentsUI/SCR_MapRulerUI.c