SCR_MapToolInteractionUI Interface Reference

Component for interacting with map tools. More...

Inheritance diagram for SCR_MapToolInteractionUI:

Public Member Functions
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.
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 ()

Static Public Member Functions
static ScriptInvoker	GetOnDragWidgetInvoker ()
static ScriptInvokerBase< ScriptInvokerWidgetBool >	GetOnDragEndInvoker ()
static ScriptInvoker	GetOnActivateToolInvoker ()
static void	ActivateAction ()
	Tool action.
static bool	StartDrag ()
	Begin drag.
static bool	StartRotate ()
	Begin rotation.
static bool	CanBeManipulated (array< Widget > tracedWidgets)
	Check whether the tool isnt currently clicked from top of/under of a button.
static void	EndDrag ()
	End drag.
static void	EndRotate ()
	End rotation.
static void	DragWidget (notnull Widget widget)
	Drag widget.
static void	RotateWidget (notnull Widget widget)
	Rotate widget based on mouse movement.

Static Public Attributes
static bool	s_bIsDragging = false
static bool	s_bIsRotating = false
static bool	s_bCanDragOffScreen = false
static float	s_fDragTime

Static Protected Attributes
const float	HOLD_DRAG_EVENT_TIME = 0.2
const float	ROTATION_DEADZONE = 0.02
static ref ScriptInvoker< Widget >	s_OnDragWidget = new ScriptInvoker()
static ref ScriptInvokerBase< ScriptInvokerWidgetBool >	s_OnDragEnd = new ScriptInvokerBase<ScriptInvokerWidgetBool>()
static ref ScriptInvoker< Widget >	s_OnActivateTool = new ScriptInvoker()
static Widget	s_DraggedWidget
static Widget	s_RotatedWidget
static SCR_MapCursorModule	s_CursorModule
static SCR_MapCursorInfo	s_CursorInfo

Additional Inherited Members
void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.
Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent
bool	m_bHookToRoot = false
Widget	m_RootWidget
SCR_MapEntity	m_MapEntity

Detailed Description

Component for interacting with map tools.

Member Function Documentation

ActivateAction()

static void SCR_MapToolInteractionUI.ActivateAction ( )

static

Tool action.

CanBeManipulated()

static bool SCR_MapToolInteractionUI.CanBeManipulated ( array< Widget >  tracedWidgets )

static

Check whether the tool isnt currently clicked from top of/under of a button.

Parameters

[in]

tracedWidgets

Returns

DragWidget()

static void SCR_MapToolInteractionUI.DragWidget ( notnull Widget  widget )

static

Drag widget.

Parameters

[in]

widget

get widget size

get max screen size

EndDrag()

static void SCR_MapToolInteractionUI.EndDrag ( )

static

End drag.

EndRotate()

static void SCR_MapToolInteractionUI.EndRotate ( )

static

End rotation.

GetOnActivateToolInvoker()

static ScriptInvoker SCR_MapToolInteractionUI.GetOnActivateToolInvoker ( )

static

Returns

GetOnDragEndInvoker()

static ScriptInvokerBase< ScriptInvokerWidgetBool > SCR_MapToolInteractionUI.GetOnDragEndInvoker ( )

static

Returns

GetOnDragWidgetInvoker()

static ScriptInvoker SCR_MapToolInteractionUI.GetOnDragWidgetInvoker ( )

static

Returns

OnMapClose()

override void SCR_MapToolInteractionUI.OnMapClose

(

MapConfiguration

config

)

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

OnMapOpen()

override void SCR_MapToolInteractionUI.OnMapOpen

(

MapConfiguration

config

)

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

RotateWidget()

static void SCR_MapToolInteractionUI.RotateWidget ( notnull Widget  widget )

static

Rotate widget based on mouse movement.

Parameters

[in]

widget

get widget size

StartDrag()

static bool SCR_MapToolInteractionUI.StartDrag ( )

static

Begin drag.

Returns

Returns true if there is a draggable widget under the cursor

StartRotate()

static bool SCR_MapToolInteractionUI.StartRotate ( )

static

Begin rotation.

Returns

Returns true if there is a rotatable widget under the cursor

Update()

override void SCR_MapToolInteractionUI.Update

(

float

timeSlice

)

Update method for frame operations.

Implements SCR_MapUIBaseComponent.

Member Data Documentation

HOLD_DRAG_EVENT_TIME

const float SCR_MapToolInteractionUI.HOLD_DRAG_EVENT_TIME = 0.2

staticprotected

ROTATION_DEADZONE

const float SCR_MapToolInteractionUI.ROTATION_DEADZONE = 0.02

staticprotected

s_bCanDragOffScreen

bool SCR_MapToolInteractionUI.s_bCanDragOffScreen = false

static

s_bIsDragging

bool SCR_MapToolInteractionUI.s_bIsDragging = false

static

s_bIsRotating

bool SCR_MapToolInteractionUI.s_bIsRotating = false

static

s_CursorInfo

SCR_MapCursorInfo SCR_MapToolInteractionUI.s_CursorInfo

staticprotected

s_CursorModule

SCR_MapCursorModule SCR_MapToolInteractionUI.s_CursorModule

staticprotected

s_DraggedWidget

Widget SCR_MapToolInteractionUI.s_DraggedWidget

staticprotected

s_fDragTime

float SCR_MapToolInteractionUI.s_fDragTime

static

s_OnActivateTool

ref ScriptInvoker<Widget> SCR_MapToolInteractionUI.s_OnActivateTool = new ScriptInvoker()

staticprotected

s_OnDragEnd

ref ScriptInvokerBase<ScriptInvokerWidgetBool> SCR_MapToolInteractionUI.s_OnDragEnd = new ScriptInvokerBase<ScriptInvokerWidgetBool>()

staticprotected

s_OnDragWidget

ref ScriptInvoker<Widget> SCR_MapToolInteractionUI.s_OnDragWidget = new ScriptInvoker()

staticprotected

s_RotatedWidget

Widget SCR_MapToolInteractionUI.s_RotatedWidget

staticprotected

---

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

• Game/Map/ComponentsUI/SCR_MapToolInteractionUI.c