SCR_MapRulerUI Class Reference

Inheritance diagram for SCR_MapRulerUI:

Protected Member Functions
void	ToggleVisible ()
	Visibility toggle.
void	SetVisible (bool visible, bool saveState=false)
void	SetSize (float x, float y, bool nextSize=false)
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)
override void	OnMapOpen (MapConfiguration config)
override void	OnMapClose (MapConfiguration config)
override void	Init ()
override void	Update (float timeSlice)
void	SCR_MapRulerUI ()

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

Detailed Description

Definition at line 1 of file SCR_MapRulerUI.c.

Constructor & Destructor Documentation

SCR_MapRulerUI()

void SCR_MapRulerUI::SCR_MapRulerUI ( )

inlineprotected

Definition at line 288 of file SCR_MapRulerUI.c.

Member Function Documentation

Init()

override void SCR_MapRulerUI::Init ( )

inlineprotected

Definition at line 253 of file SCR_MapRulerUI.c.

OnActivateTool()

void SCR_MapRulerUI::OnActivateTool ( Widget widget )

inlineprotected

SCR_MapToolInteractionUI event.

Definition at line 201 of file SCR_MapRulerUI.c.

OnDragWidget()

void SCR_MapRulerUI::OnDragWidget ( Widget widget )

inlineprotected

SCR_MapToolInteractionUI event.

Definition at line 191 of file SCR_MapRulerUI.c.

OnInputQuickBind()

void SCR_MapRulerUI::OnInputQuickBind ( float value, EActionTrigger reason )

inlineprotected

Definition at line 210 of file SCR_MapRulerUI.c.

OnMapClose()

override void SCR_MapRulerUI::OnMapClose ( MapConfiguration config )

inlineprotected

Definition at line 244 of file SCR_MapRulerUI.c.

OnMapOpen()

override void SCR_MapRulerUI::OnMapOpen ( MapConfiguration config )

inlineprotected

Definition at line 218 of file SCR_MapRulerUI.c.

OnMapPan()

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

inlineprotected

SCR_MapEntity event.

Definition at line 167 of file SCR_MapRulerUI.c.

OnMapZoom()

void SCR_MapRulerUI::OnMapZoom ( float zoomVal )

inlineprotected

SCR_MapEntity event.

Definition at line 158 of file SCR_MapRulerUI.c.

SetSize()

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

inlineprotected

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

Definition at line 142 of file SCR_MapRulerUI.c.

SetVisible()

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

inlineprotected

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

Definition at line 51 of file SCR_MapRulerUI.c.

ToggleVisible()

void SCR_MapRulerUI::ToggleVisible ( )

inlineprotected

Visibility toggle.

Definition at line 39 of file SCR_MapRulerUI.c.

Update()

override void SCR_MapRulerUI::Update ( float timeSlice )

inlineprotected

Definition at line 271 of file SCR_MapRulerUI.c.

Member Data Documentation

m_aSizesArray

ref array<int> SCR_MapRulerUI::m_aSizesArray

protected

Definition at line 16 of file SCR_MapRulerUI.c.

m_bIsDragged

bool SCR_MapRulerUI::m_bIsDragged

protected

Definition at line 20 of file SCR_MapRulerUI.c.

m_bIsVisible

bool SCR_MapRulerUI::m_bIsVisible

protected

Definition at line 18 of file SCR_MapRulerUI.c.

m_bIsZooming

bool SCR_MapRulerUI::m_bIsZooming

protected

Definition at line 21 of file SCR_MapRulerUI.c.

m_bWantedVisible

bool SCR_MapRulerUI::m_bWantedVisible

protected

Definition at line 19 of file SCR_MapRulerUI.c.

m_fAngle

float SCR_MapRulerUI::m_fAngle

protected

Definition at line 26 of file SCR_MapRulerUI.c.

m_fBaseImageSize

float SCR_MapRulerUI::m_fBaseImageSize[2]

protected

Definition at line 27 of file SCR_MapRulerUI.c.

m_fPosX

float SCR_MapRulerUI::m_fPosX

protected

Definition at line 24 of file SCR_MapRulerUI.c.

m_fPosY

float SCR_MapRulerUI::m_fPosY

protected

Definition at line 24 of file SCR_MapRulerUI.c.

m_fSizeCoef

float SCR_MapRulerUI::m_fSizeCoef

protected

Definition at line 28 of file SCR_MapRulerUI.c.

m_fWorldX

float SCR_MapRulerUI::m_fWorldX

protected

Definition at line 25 of file SCR_MapRulerUI.c.

m_fWorldY

float SCR_MapRulerUI::m_fWorldY

protected

Definition at line 25 of file SCR_MapRulerUI.c.

m_iCurrentSizeIndex

int SCR_MapRulerUI::m_iCurrentSizeIndex

protected

Definition at line 22 of file SCR_MapRulerUI.c.

m_iSizesCount

int SCR_MapRulerUI::m_iSizesCount

protected

Definition at line 23 of file SCR_MapRulerUI.c.

m_ToolMenuEntry

SCR_MapToolEntry SCR_MapRulerUI::m_ToolMenuEntry

protected

Definition at line 30 of file SCR_MapRulerUI.c.

m_vMapPan

vector SCR_MapRulerUI::m_vMapPan

protected

Definition at line 29 of file SCR_MapRulerUI.c.

m_wFrame

Widget SCR_MapRulerUI::m_wFrame

protected

Definition at line 33 of file SCR_MapRulerUI.c.

m_wImage

ImageWidget SCR_MapRulerUI::m_wImage

protected

Definition at line 34 of file SCR_MapRulerUI.c.

m_wWorkspace

WorkspaceWidget SCR_MapRulerUI::m_wWorkspace

protected

Definition at line 35 of file SCR_MapRulerUI.c.

---

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

• scripts/Game/Map/ComponentsUI/SCR_MapRulerUI.c