SCR_CursorEditorUIComponent Interface Reference

Inheritance diagram for SCR_CursorEditorUIComponent:

Public Member Functions
void	SetCursorPos (vector pos, bool DPIScale=false)
	Set cursor position.
vector	GetCursorPos ()
	Get cached cursor position in reference resolution.
void	GetCursorPos (out int posX, out int posY)
	Get cached cursor position as integers in native (current) resolution.
bool	GetCursorWorldPos (out vector worldPos, bool isNormalized=false, TraceFlags flags=-1)
	Get world position below cursor.
IEntity	GetTraceEntity ()
float	GetCursorRadius ()
float	GetCursorRadiusSq ()
void	SetCursorAlpha (float alpha, float strength=1)
void	OnFilterChange (EEditableEntityState state, set< SCR_EditableEntityComponent > entitiesInsert, set< SCR_EditableEntityComponent > entitiesRemove)
void	OnMapToggled (MapConfiguration config)
override void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from MenuRootSubComponent
Widget	GetWidget ()
	Get widget to which the component belongs to.
MenuRootBase	GetMenu ()
	Get menu of which the widget is part of.
MenuRootComponent	GetRootComponent ()
	Get root component of this subcomponent,.
override void	HandlerAttached (Widget w)

Protected Member Functions
void	SetCursorType (EEditorCursor type)
void	ResetCursor ()
void	UpdateCursorDebug ()
void	UpdateCursor ()
bool	TraceFilter (Class target)
SCR_EditableEntityComponent	TraceEntity (vector cursorPos)
void	OnInputDeviceIsGamepad (bool isGamepad)
void	OnMenuUpdate (float tDelta)
Protected Member Functions inherited from SCR_BaseEditorUIComponent
vector	OnCancelDown ()
bool	OnCancelUp ()
void	OnCancelExpired ()
Protected Member Functions inherited from MenuRootSubComponent
bool	IsUnique ()
	Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.

Protected Attributes
TraceFlags	m_DefaultWorldTraceFlags = TraceFlags.WORLD | TraceFlags.OCEAN | TraceFlags.ENTS
Protected Attributes inherited from SCR_BaseEditorUIComponent
vector	m_vClickPosCancel

Static Protected Attributes
const float	TRACE_DIS_SINGLE = 10000
const float	TRACE_DIS_REPEATED = 250

Additional Inherited Members
Static Public Attributes inherited from SCR_BaseEditorUIComponent
const int	CANCEL_CLICK_MAX_DIS = 5
const int	CANCEL_CLICK_MAX_TIME = 500

Member Function Documentation

GetCursorPos() [1/2]

vector SCR_CursorEditorUIComponent.GetCursorPos

(

)

Get cached cursor position in reference resolution.

Returns

Unscaled screen coordinates

GetCursorPos() [2/2]

void SCR_CursorEditorUIComponent.GetCursorPos	(	out int	posX,
		out int	posY )

Get cached cursor position as integers in native (current) resolution.

Parameters

[out]	posX
[out]	posY

GetCursorRadius()

float SCR_CursorEditorUIComponent.GetCursorRadius

(

)

Returns

GetCursorRadiusSq()

float SCR_CursorEditorUIComponent.GetCursorRadiusSq

(

)

Returns

GetCursorWorldPos()

bool SCR_CursorEditorUIComponent.GetCursorWorldPos	(	out vector	worldPos,
		bool	isNormalized = false,
		TraceFlags	flags = -1 )

Get world position below cursor.

Parameters

[out]	worldPos	Vector to be filled with world position
[in]	isNormalized
[in]	flags	Trace flags to be used (send -1 for default flags)

Returns

True if the cursor is above world position (e.g., not pointing at sky)

GetTraceEntity()

IEntity SCR_CursorEditorUIComponent.GetTraceEntity

(

)

Returns

HandlerAttachedScripted()

override void SCR_CursorEditorUIComponent.HandlerAttachedScripted

(

Widget

w

)

Event called when subcomponent is initialized.

Called only after all other subcomponents were registered as well and can be searched for. To be overwritten by inherited classes.

Parameters

Widget

Implements MenuRootSubComponent.

HandlerDeattached()

override void SCR_CursorEditorUIComponent.HandlerDeattached

(

Widget

w

)

Implements MenuRootSubComponent.

OnFilterChange()

void SCR_CursorEditorUIComponent.OnFilterChange	(	EEditableEntityState	state,
		set< SCR_EditableEntityComponent >	entitiesInsert,
		set< SCR_EditableEntityComponent >	entitiesRemove )

Parameters

[in]	state
[in]	entitiesInsert
[in]	entitiesRemove

OnInputDeviceIsGamepad()

void SCR_CursorEditorUIComponent.OnInputDeviceIsGamepad ( bool isGamepad )

protected

OnMapToggled()

void SCR_CursorEditorUIComponent.OnMapToggled

(

MapConfiguration

config

)

Parameters

[in]

config

OnMenuUpdate()

void SCR_CursorEditorUIComponent.OnMenuUpdate ( float tDelta )

protected

ResetCursor()

void SCR_CursorEditorUIComponent.ResetCursor ( )

protected

SetCursorAlpha()

void SCR_CursorEditorUIComponent.SetCursorAlpha	(	float	alpha,
		float	strength = 1 )

Parameters

[in]	alpha
[in]	strength

SetCursorPos()

void SCR_CursorEditorUIComponent.SetCursorPos	(	vector	pos,
		bool	DPIScale = false )

Set cursor position.

Parameters

[in]	pos	Cursor position
[in]	DPIScale	True if the position is in reference resolution, false if in native (current)

SetCursorType()

void SCR_CursorEditorUIComponent.SetCursorType ( EEditorCursor type )

protected

TraceEntity()

SCR_EditableEntityComponent SCR_CursorEditorUIComponent.TraceEntity ( vector cursorPos )

protected

TraceFilter()

bool SCR_CursorEditorUIComponent.TraceFilter ( Class target )

protected

UpdateCursor()

void SCR_CursorEditorUIComponent.UpdateCursor ( )

protected

UpdateCursorDebug()

void SCR_CursorEditorUIComponent.UpdateCursorDebug ( )

protected

Member Data Documentation

m_DefaultWorldTraceFlags

TraceFlags SCR_CursorEditorUIComponent.m_DefaultWorldTraceFlags = TraceFlags.WORLD | TraceFlags.OCEAN | TraceFlags.ENTS

protected

TRACE_DIS_REPEATED

const float SCR_CursorEditorUIComponent.TRACE_DIS_REPEATED = 250

staticprotected

TRACE_DIS_SINGLE

const float SCR_CursorEditorUIComponent.TRACE_DIS_SINGLE = 10000

staticprotected

---

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

• Game/Editor/UI/Components/Common/SCR_CursorEditorUIComponent.c