SCR_TooltipManagerEditorUIComponent Interface Reference

Inheritance diagram for SCR_TooltipManagerEditorUIComponent:

Public Member Functions
void	SetInfo (SCR_UIInfo info, EEditorTooltip type=0, Managed instance=null)
	Show tooltip with given params.
void	ResetInfo (SCR_UIInfo info=null)
	Hide currently shown tooltip.
void	RefreshInfo (SCR_UIInfo info, EEditorTooltip type=0, Managed instance=null)
	Refresh currently shown tooltip, in case it's UI info changed (e.g., action state was toggled).
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,.
void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Protected Member Functions
void	PlayAnimation ()
void	ResetAnimation ()
void	ShowEntityTooltip (SCR_EditableEntityComponent entity)
void	OnHover (EEditableEntityState state, set< SCR_EditableEntityComponent > entitiesInsert, set< SCR_EditableEntityComponent > entitiesRemove)
void	OnInputDeviceIsGamepad (bool isGamepad)
void	OnRadialMenuToggle (IEntity owner, bool isOpened)
void	OnContextMenuToggle (bool isOpened)
void	OnMenuUpdate (float tDelta)
void	OnMenuFocusLost ()
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
ref array< ref SCR_TooltipEditorEntry >	m_Tooltips
float	m_fDelay
float	m_fFadeInSpeed
bool	m_bTrackHoverState
InputManager	m_InputManager
SCR_LayersEditorComponent	m_LayersManager
SCR_TooltipAreaEditorUIComponent	m_TooltipArea
SCR_CursorEditorUIComponent	m_Cursor
SCR_BaseTooltipEditorUIComponent	m_Tooltip
SCR_BaseContextMenuEditorUIComponent	m_ContextMenu
SCR_UIInfo	m_Info
Managed	m_InfoInstance
bool	m_bTooltipShown
Protected Attributes inherited from SCR_BaseEditorUIComponent
vector	m_vClickPosCancel

Static Protected Attributes
static const float	INERTIA_THRESHOLD = 0.001

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

HandlerAttachedScripted()

override void SCR_TooltipManagerEditorUIComponent.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_TooltipManagerEditorUIComponent.HandlerDeattached

(

Widget

w

)

Implements MenuRootSubComponent.

OnContextMenuToggle()

void SCR_TooltipManagerEditorUIComponent.OnContextMenuToggle ( bool  isOpened )

protected

OnHover()

void SCR_TooltipManagerEditorUIComponent.OnHover ( EEditableEntityState  state, set< SCR_EditableEntityComponent >  entitiesInsert, set< SCR_EditableEntityComponent >  entitiesRemove  )

protected

OnInputDeviceIsGamepad()

void SCR_TooltipManagerEditorUIComponent.OnInputDeviceIsGamepad ( bool  isGamepad )

protected

OnMenuFocusLost()

void SCR_TooltipManagerEditorUIComponent.OnMenuFocusLost ( )

protected

OnMenuUpdate()

void SCR_TooltipManagerEditorUIComponent.OnMenuUpdate ( float  tDelta )

protected

OnRadialMenuToggle()

void SCR_TooltipManagerEditorUIComponent.OnRadialMenuToggle ( IEntity  owner, bool  isOpened  )

protected

PlayAnimation()

void SCR_TooltipManagerEditorUIComponent.PlayAnimation ( )

protected

RefreshInfo()

void SCR_TooltipManagerEditorUIComponent.RefreshInfo	(	SCR_UIInfo	info,
		EEditorTooltip	type = 0,
		Managed	instance = null
	)

Refresh currently shown tooltip, in case it's UI info changed (e.g., action state was toggled).

Parameters

[in]	info
[in]	type
[in]	instance

ResetAnimation()

void SCR_TooltipManagerEditorUIComponent.ResetAnimation ( )

protected

ResetInfo()

void SCR_TooltipManagerEditorUIComponent.ResetInfo

(

SCR_UIInfo

info = null

)

Hide currently shown tooltip.

Parameters

[in]

info

When not null, it will reset tooltip if this one is the current one

SetInfo()

void SCR_TooltipManagerEditorUIComponent.SetInfo	(	SCR_UIInfo	info,
		EEditorTooltip	type = 0,
		Managed	instance = null
	)

Show tooltip with given params.

Parameters

[in]	info	UI info with all visual information
[in]	type	Tooltip type, influences which layout will be selected
[in]	instance	Instance, e.g., entity, which can be accessed for more information

ShowEntityTooltip()

void SCR_TooltipManagerEditorUIComponent.ShowEntityTooltip ( SCR_EditableEntityComponent  entity )

protected

Member Data Documentation

INERTIA_THRESHOLD

const float SCR_TooltipManagerEditorUIComponent.INERTIA_THRESHOLD = 0.001

staticprotected

m_bTooltipShown

bool SCR_TooltipManagerEditorUIComponent.m_bTooltipShown

protected

m_bTrackHoverState

bool SCR_TooltipManagerEditorUIComponent.m_bTrackHoverState

protected

m_ContextMenu

SCR_BaseContextMenuEditorUIComponent SCR_TooltipManagerEditorUIComponent.m_ContextMenu

protected

m_Cursor

SCR_CursorEditorUIComponent SCR_TooltipManagerEditorUIComponent.m_Cursor

protected

m_fDelay

float SCR_TooltipManagerEditorUIComponent.m_fDelay

protected

m_fFadeInSpeed

float SCR_TooltipManagerEditorUIComponent.m_fFadeInSpeed

protected

m_Info

SCR_UIInfo SCR_TooltipManagerEditorUIComponent.m_Info

protected

m_InfoInstance

Managed SCR_TooltipManagerEditorUIComponent.m_InfoInstance

protected

m_InputManager

InputManager SCR_TooltipManagerEditorUIComponent.m_InputManager

protected

m_LayersManager

SCR_LayersEditorComponent SCR_TooltipManagerEditorUIComponent.m_LayersManager

protected

m_Tooltip

SCR_BaseTooltipEditorUIComponent SCR_TooltipManagerEditorUIComponent.m_Tooltip

protected

m_TooltipArea

SCR_TooltipAreaEditorUIComponent SCR_TooltipManagerEditorUIComponent.m_TooltipArea

protected

m_Tooltips

ref array<ref SCR_TooltipEditorEntry> SCR_TooltipManagerEditorUIComponent.m_Tooltips

protected

---

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

• Game/Editor/UI/Components/Tooltips/SCR_TooltipManagerEditorUIComponent.c