SCR_MapDrawingUI Interface Reference

Temporary drawing substitute so the protractor can be utilized properly. More...

Inheritance diagram for SCR_MapDrawingUI:

Public Member Functions
bool	IsUsingGamepad ()
void	UpdateLineCount ()
override void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
override void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.
override void	Update (float timeSlice)
	Update method for frame operations.
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.
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
bool	m_bActivationThrottle
bool	m_bIsLineBeingDrawn
int	m_iLinesDrawn

Protected Member Functions
void	ToggleDrawMode ()
	Toggle draw mode.
void	SetDrawMode (bool state, bool cacheDrawn=false)
	Start/stop draw mode.
void	OnMapClick (float value, EActionTrigger reason)
void	OnMapModifierClick (float value, EActionTrigger reason)
	Callback method that is used to cancel line drawing and remove line that wasnt finished.
void	OnMapPan (float x, float y, bool adjustedPan)
	SCR_MapEntity event.
void	OnMapPanEnd (float x, float y)
	SCR_MapEntity event.
void	OnEntryToggled (SCR_MapToolEntry entry)
	SCR_MapToolEntry event.
void	OnInputQuickBind (float value, EActionTrigger reason)

Protected Attributes
string	m_sToolMenuIconName
int	m_iLineCount
bool	m_bIsDrawModeActive
int	m_iLineID
Widget	m_wDrawingContainer
SCR_MapCursorModule	m_CursorModule
SCR_MapToolEntry	m_ToolMenuEntry
ref array< ref MapLine >	m_aLines = new array <ref MapLine>()
Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent
bool	m_bIsExclusive
bool	m_bHookToRoot = false
Widget	m_RootWidget
SCR_MapEntity	m_MapEntity

Detailed Description

Temporary drawing substitute so the protractor can be utilized properly.

Member Function Documentation

Init()

override void SCR_MapDrawingUI.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.

IsUsingGamepad()

bool SCR_MapDrawingUI.IsUsingGamepad

(

)

OnEntryToggled()

void SCR_MapDrawingUI.OnEntryToggled ( SCR_MapToolEntry entry )

protected

SCR_MapToolEntry event.

Parameters

[in]

entry

OnInputQuickBind()

void SCR_MapDrawingUI.OnInputQuickBind ( float value, EActionTrigger reason )

protected

OnMapClick()

void SCR_MapDrawingUI.OnMapClick ( float value, EActionTrigger reason )

protected

OnMapClose()

override void SCR_MapDrawingUI.OnMapClose

(

MapConfiguration

config

)

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

OnMapModifierClick()

void SCR_MapDrawingUI.OnMapModifierClick ( float value, EActionTrigger reason )

protected

Callback method that is used to cancel line drawing and remove line that wasnt finished.

Parameters

[in]	value
[in]	reason

OnMapOpen()

override void SCR_MapDrawingUI.OnMapOpen

(

MapConfiguration

config

)

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

OnMapPan()

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

protected

SCR_MapEntity event.

Parameters

[in]	x
[in]	y
[in]	adjustedPan

OnMapPanEnd()

void SCR_MapDrawingUI.OnMapPanEnd ( float x, float y )

protected

SCR_MapEntity event.

Parameters

[in]	x
[in]	y

SetDrawMode()

void SCR_MapDrawingUI.SetDrawMode ( bool state, bool cacheDrawn = false )

protected

Start/stop draw mode.

Parameters

[in]	state
[in]	cacheDrawn

ToggleDrawMode()

void SCR_MapDrawingUI.ToggleDrawMode ( )

protected

Toggle draw mode.

Update()

override void SCR_MapDrawingUI.Update

(

float

timeSlice

)

Update method for frame operations.

Implements SCR_MapUIBaseComponent.

UpdateLineCount()

void SCR_MapDrawingUI.UpdateLineCount

(

)

Member Data Documentation

m_aLines

ref array<ref MapLine> SCR_MapDrawingUI.m_aLines = new array <ref MapLine>()

protected

m_bActivationThrottle

bool SCR_MapDrawingUI.m_bActivationThrottle

m_bIsDrawModeActive

bool SCR_MapDrawingUI.m_bIsDrawModeActive

protected

m_bIsLineBeingDrawn

bool SCR_MapDrawingUI.m_bIsLineBeingDrawn

m_CursorModule

SCR_MapCursorModule SCR_MapDrawingUI.m_CursorModule

protected

m_iLineCount

int SCR_MapDrawingUI.m_iLineCount

protected

m_iLineID

int SCR_MapDrawingUI.m_iLineID

protected

m_iLinesDrawn

int SCR_MapDrawingUI.m_iLinesDrawn

m_sToolMenuIconName

string SCR_MapDrawingUI.m_sToolMenuIconName

protected

m_ToolMenuEntry

SCR_MapToolEntry SCR_MapDrawingUI.m_ToolMenuEntry

protected

m_wDrawingContainer

Widget SCR_MapDrawingUI.m_wDrawingContainer

protected

---

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

• Game/Map/ComponentsUI/SCR_MapDrawingUI.c