SCR_RadialMenuDisplay Interface Reference

Radial menu class for handling HUD part of menu. More...

Inheritance diagram for SCR_RadialMenuDisplay:

Public Member Functions
override void	DisplayStartDraw (IEntity owner)
	Setup menu.
override void	DisplayStopDraw (IEntity owner)
override void	DisplayUpdate (IEntity owner, float timeSlice)
override void	SetupMenu (SCR_SelectionMenu menu)
	Set menu and register callback reactions for menu Clear callbacks if there was any other menu used.
void	VisualizeEnableEntry (notnull SCR_SelectionMenuEntryComponent entry, int id, bool enable)
void	ShowInnerBackground (bool show)
void	ShowCrosshair (bool show)
Public Member Functions inherited from SCR_SelectionMenuDisplay
override void	DisplayOnSuspended ()
	Called when GUI is temporarily suspended due to visibility flags; e.g. GM entered and GUI marked as not to show in GM.
SCR_SelectionMenu	GetMenu ()
Public Member Functions inherited from SCR_InfoDisplayExtended
void	SetEnabled (bool isEnabled)
override void	Show (bool show, float speed=UIConstants.FADE_RATE_INSTANT, EAnimationCurve curve=EAnimationCurve.LINEAR)
	Show/hide InfoDisplay properly, not breaking other systems like AdaptiveOpacity or ConditionalVisibility.
Public Member Functions inherited from SCR_InfoDisplay
SCR_InfoDisplayHandler	GetHandler (TypeName handlerType)
SCR_InfoDisplayInvoker	GetOnStart ()
SCR_InfoDisplayInvoker	GetOnStop ()
IEntity	GetOwnerEntity ()
Widget	GetContentWidget ()
string	GetContentWidgetName ()
void	SetRootWidget (notnull Widget root)
void	SetContentWidget (notnull Widget content)
bool	IsShown ()
Widget	GetRootWidget ()
bool	GetDimensions (out float width, out float height, bool addSafezones=true)
	Get width and height of the InfoDisplay element, optionally with safezones adjustments.
bool	GetAnchorPosition (out float x, out float y, EWidgetAnchor anchor=EWidgetAnchor.TOPLEFT, bool addSafezones=true)
	Get width and height of the InfoDisplay element, optionally with safezones adjustments.
void	RegisterToHudManager ()
Public Member Functions inherited from GroupInfoDisplay
proto external int	GetInfoDisplays (out notnull array< BaseInfoDisplay > outInfoDisplays)
Public Member Functions inherited from BaseInfoDisplay
proto external GenericComponent	FindComponentInParentContainer (TypeName typeName)

Protected Member Functions
override void	OnMenuOpen ()
override void	OnShownFinished (Widget w, float targetOpacity, WidgetAnimationOpacity anim=null)
void	SetupMenuCenter ()
override void	OnMenuClose ()
override void	OnMenuEntriesUpdate (SCR_SelectionMenu menu, array< ref SCR_SelectionMenuEntry > entries)
override void	SetupEntryWidget (notnull SCR_SelectionMenuEntry entry, notnull Widget widget, int id)
	Setup entry widget properties specific for each menu Method can e.g.
void	CreateNumberHint (int id)
	Create number hint to the enter to state quick number action to use.
override void	OnMenuEntrySelected (SCR_SelectionMenu menu, SCR_SelectionMenuEntry entry, int id)
	React on selected entry change.
override void	OnMenuEntryPerform (SCR_SelectionMenu menu, SCR_SelectionMenuEntry entry)
	React on selected entry change.
void	OnEntrySizeAnimCycleCompleted (WidgetAnimationBase anim)
override void	ClearEntryWidgets ()
	Clear segments and lines.
vector	GetPointOnCircle (float radius, float degrees)
	Vector X Y positions from radisu (distance) and degrees (angle)
void	VisualizeSelection (float selectionAngle)
float	SetupFrameSlotPosition (out notnull Widget widget, int id, float distance, float angle, float angleOffset=0)
	Setup widget position and angle in frame slot.
void	CreateEntrySegment (notnull SCR_SelectionMenuEntry entry, notnull Widget widget, int id)
	Add to circle segments filling entry area.
void	CreateDivider (int id)
	Add divider after entry segments.
void	SetupEntryHint (string text, int id)
void	DisplayEntryHint ()
void	OnDisplaySizeChange (SCR_RadialMenu menu, float size)
	Callback reacting to changing size from SCR_RadialMenu.
void	OnSetActionHint (SCR_RadialMenu menu, string action)
	Callback to display action hint icon.
void	OnMenuOpenCategory (SCR_SelectionMenu menu, SCR_SelectionMenuCategoryEntry category, int level)
void	LateMenuEntriesUpdate ()
void	ChangeCategoryOpen (SCR_SelectionMenu menu, SCR_SelectionMenuCategoryEntry category, int level)
void	SetupSelectionVisuals ()
Protected Member Functions inherited from SCR_SelectionMenuDisplay
void	FindMenu ()
	Method ready for override to find menu at custom place.
void	CreateEntryWidgets ()
	Will create entries in HUD layout.
void	CreateNewEntry (int i)
void	RemoveEntry (Widget entry, int id)
bool	EntriesChanged (array< ref SCR_SelectionMenuEntry > entries)
	Check if used data are still same.
void	DebugPrint (string method, string msg)
Protected Member Functions inherited from SCR_InfoDisplayExtended
bool	DisplayStartDrawInit (IEntity owner)
void	DisplayInit (IEntity owner)
void	DisplayControlledEntityChanged (IEntity from, IEntity to)
void	DisplayConsciousnessChanged (bool conscious, bool init=false)
void	DisplayOnResumed ()
void	InitializeInterfaceSettings ()
void	OnSettingsChanged ()
Protected Member Functions inherited from SCR_InfoDisplay
void	AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false)

Protected Attributes
int	m_iEntriesRadius
float	m_fSelectedIndicatorOffset
string	m_sBaseWidget
bool	m_bForceSize
bool	m_bFastFadeOnPerform
string	m_sDividersParent
ResourceName	m_sDividerTexture
int	m_iDividersRadius
int	m_iDividerSize
float	m_fDividersOpacity
string	m_sSegmentsParent
ResourceName	m_sSegmentLayout
string	m_sSelectorLine
string	m_sSelectorArrow
string	m_sInnerSelector
string	m_sSelectedIndicator
string	m_sSelectedIndicatorFeedback
string	m_sSelectedName
string	m_sActionHint
string	m_sDescription
string	m_sBreadCrumbs
string	m_sInnerBackround
string	m_sCrosshairWrap
string	m_sBlur
string	m_sHintWrapper
float	m_fHintRadius
int	m_iHintDisplayDelay
int	m_iCategoryIconRadius
ResourceName	m_sNumberHintLayout
string	m_sNumberHintParent
float	m_fNumberHintRadius
Widget	m_wBase
Widget	m_wDividersParent
ref array< Widget >	m_aDividers = {}
Widget	m_wSegmentsParent
ref array< SCR_RadialMenuSegmentComponent >	m_aSegments = {}
Widget	m_wNumberHints
ref array< SCR_RadialMenuNumberHintComponent >	m_aNumberHints = {}
ImageWidget	m_wSelectorArrow
ImageWidget	m_wInnerSelector
ImageWidget	m_wSelectorLine
ImageWidget	m_wSelectedIndicator
ImageWidget	m_wSelectedIndicatorFeedback
TextWidget	m_wSelectedName
TextWidget	m_wActionHint
TextWidget	m_wDescription
ImageWidget	m_wInnerBackround
Widget	m_wCrosshairWrap
BlurWidget	m_wBlur
Widget	m_wHintWrapper
SCR_RadialMenu	m_RadialMenu
SCR_BreadCrumbsComponent	m_BreadCrumbs
float	m_fSelectorArrowRadius
float	m_fDynamicEntriesRadius
float	m_fDynamicDividerSize
float	m_fDynamicDividersRadius
float	m_SizeRatio
int	m_iPrevCategoryLevel = 0
Protected Attributes inherited from SCR_SelectionMenuDisplay
ResourceName	m_sEntryLayout
string	m_sEntriesParent
ref SCR_SelectionMenu	m_Menu
ref array< SCR_SelectionMenuEntry >	m_aEntries = {}
ref array< ref Widget >	m_aEntryWidgets = {}
SCR_SelectionMenuEntry	m_LastSelectedEntry
int	m_iLastSelectedId = -1
Widget	m_wEntriesParent
Protected Attributes inherited from SCR_InfoDisplayExtended
bool	m_bIsEnabled
string	m_sInterfaceSettingName
SCR_PlayerController	m_PlayerController
SCR_CharacterControllerComponent	m_CharacterController
SCR_CharacterCameraHandlerComponent	m_CameraHandler
MenuManager	m_MenuManager
EventHandlerManagerComponent	m_EventHandlerManager
SCR_EditorManagerEntity	m_EditorManager
bool	m_bAttachedToPlayerController
bool	m_bInThirdPerson
bool	m_bInADS
bool	m_bIsUnconscious
bool	m_bInPauseMenu
bool	m_bInEditor
bool	m_bCanShow
bool	m_bIsEnabledInSettings = true
bool	m_bShowInAllCameras = true
Protected Attributes inherited from SCR_InfoDisplay
string	m_sParentSlot
string	m_sContentWidget
int	m_iContentWidthAdjustment
int	m_iContentHeightAdjustment
string	m_sAdaptiveOpacityWidgetName
ref array< ref SCR_InfoDisplayHandler >	m_aHandlers
bool	m_bShown
Widget	m_wRoot
Widget	m_wContent
Widget	m_wSlot
SCR_HUDManagerComponent	m_HUDManager
int	m_iChildDisplays = 0
ref array< BaseInfoDisplay >	m_aChildDisplays = new array<BaseInfoDisplay>
SCR_InfoDisplay	m_pParentDisplay
bool	m_bRegistered = false
IEntity	m_OwnerEntity
ref array< ref SCR_InfoDisplayHandler >	m_aUpdatableHandlers = {}
ref SCR_InfoDisplayInvoker	m_OnStart = new SCR_InfoDisplayInvoker()
ref SCR_InfoDisplayInvoker	m_OnStop = new SCR_InfoDisplayInvoker()

Static Protected Attributes
const string	HINT_BASE = "<action name='%1' hideEmpty='1'/>"
const float	CHANGE_CONTENT_OPACITY = 0.4
const float	ENTRY_ANIMATION_SCALE = 1.25
const float	ENTRY_ANIMATION_SPEED = 7.5
Static Protected Attributes inherited from SCR_SelectionMenuDisplay
const float	FADE_IN_SPEED = UIConstants.FADE_RATE_SUPER_FAST

Additional Inherited Members
Public Attributes inherited from SCR_InfoDisplay
ResourceName	m_LayoutPath
EHudLayers	m_eLayer
int	m_iOverrideZOrder

Detailed Description

Radial menu class for handling HUD part of menu.

Displays menu circle and distributes entries into the circle

Member Function Documentation

ChangeCategoryOpen()

void SCR_RadialMenuDisplay.ChangeCategoryOpen ( SCR_SelectionMenu menu, SCR_SelectionMenuCategoryEntry category, int level )

protected

ClearEntryWidgets()

override void SCR_RadialMenuDisplay.ClearEntryWidgets ( )

protected

Clear segments and lines.

Implements SCR_SelectionMenuDisplay.

CreateDivider()

void SCR_RadialMenuDisplay.CreateDivider ( int id )

protected

Add divider after entry segments.

CreateEntrySegment()

void SCR_RadialMenuDisplay.CreateEntrySegment ( notnull SCR_SelectionMenuEntry entry, notnull Widget widget, int id )

protected

Add to circle segments filling entry area.

CreateNumberHint()

void SCR_RadialMenuDisplay.CreateNumberHint ( int id )

protected

Create number hint to the enter to state quick number action to use.

DisplayEntryHint()

void SCR_RadialMenuDisplay.DisplayEntryHint ( )

protected

DisplayStartDraw()

override void SCR_RadialMenuDisplay.DisplayStartDraw

(

IEntity

owner

)

Setup menu.

Implements SCR_SelectionMenuDisplay.

Implemented in SCR_VONRadialDisplay.

DisplayStopDraw()

override void SCR_RadialMenuDisplay.DisplayStopDraw

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

DisplayUpdate()

override void SCR_RadialMenuDisplay.DisplayUpdate	(	IEntity	owner,
		float	timeSlice )

Implements SCR_InfoDisplayExtended.

GetPointOnCircle()

vector SCR_RadialMenuDisplay.GetPointOnCircle ( float radius, float degrees )

protected

Vector X Y positions from radisu (distance) and degrees (angle)

LateMenuEntriesUpdate()

void SCR_RadialMenuDisplay.LateMenuEntriesUpdate ( )

protected

OnDisplaySizeChange()

void SCR_RadialMenuDisplay.OnDisplaySizeChange ( SCR_RadialMenu menu, float size )

protected

Callback reacting to changing size from SCR_RadialMenu.

OnEntrySizeAnimCycleCompleted()

void SCR_RadialMenuDisplay.OnEntrySizeAnimCycleCompleted ( WidgetAnimationBase anim )

protected

OnMenuClose()

override void SCR_RadialMenuDisplay.OnMenuClose ( )

protected

Implements SCR_SelectionMenuDisplay.

OnMenuEntriesUpdate()

override void SCR_RadialMenuDisplay.OnMenuEntriesUpdate ( SCR_SelectionMenu menu, array< ref SCR_SelectionMenuEntry > entries )

protected

Implements SCR_SelectionMenuDisplay.

OnMenuEntryPerform()

override void SCR_RadialMenuDisplay.OnMenuEntryPerform ( SCR_SelectionMenu menu, SCR_SelectionMenuEntry entry )

protected

React on selected entry change.

Implements SCR_SelectionMenuDisplay.

Implemented in SCR_VONRadialDisplay.

OnMenuEntrySelected()

override void SCR_RadialMenuDisplay.OnMenuEntrySelected ( SCR_SelectionMenu menu, SCR_SelectionMenuEntry entry, int id )

protected

React on selected entry change.

Implements SCR_SelectionMenuDisplay.

OnMenuOpen()

override void SCR_RadialMenuDisplay.OnMenuOpen ( )

protected

Implements SCR_SelectionMenuDisplay.

OnMenuOpenCategory()

void SCR_RadialMenuDisplay.OnMenuOpenCategory ( SCR_SelectionMenu menu, SCR_SelectionMenuCategoryEntry category, int level )

protected

OnSetActionHint()

void SCR_RadialMenuDisplay.OnSetActionHint ( SCR_RadialMenu menu, string action )

protected

Callback to display action hint icon.

OnShownFinished()

override void SCR_RadialMenuDisplay.OnShownFinished ( Widget w, float targetOpacity, WidgetAnimationOpacity anim = null )

protected

Implements SCR_InfoDisplay.

SetupEntryHint()

void SCR_RadialMenuDisplay.SetupEntryHint ( string text, int id )

protected

SetupEntryWidget()

override void SCR_RadialMenuDisplay.SetupEntryWidget ( notnull SCR_SelectionMenuEntry entry, notnull Widget widget, int id )

protected

Setup entry widget properties specific for each menu Method can e.g.

entries position - that can be different for horizontal and radial menus Ready for override

Implements SCR_SelectionMenuDisplay.

SetupFrameSlotPosition()

float SCR_RadialMenuDisplay.SetupFrameSlotPosition ( out notnull Widget widget, int id, float distance, float angle, float angleOffset = 0 )

protected

Setup widget position and angle in frame slot.

SetupMenu()

override void SCR_RadialMenuDisplay.SetupMenu

(

SCR_SelectionMenu

menu

)

Set menu and register callback reactions for menu Clear callbacks if there was any other menu used.

Implements SCR_SelectionMenuDisplay.

SetupMenuCenter()

void SCR_RadialMenuDisplay.SetupMenuCenter ( )

protected

SetupSelectionVisuals()

void SCR_RadialMenuDisplay.SetupSelectionVisuals ( )

protected

ShowCrosshair()

void SCR_RadialMenuDisplay.ShowCrosshair

(

bool

show

)

ShowInnerBackground()

void SCR_RadialMenuDisplay.ShowInnerBackground

(

bool

show

)

VisualizeEnableEntry()

void SCR_RadialMenuDisplay.VisualizeEnableEntry	(	notnull SCR_SelectionMenuEntryComponent	entry,
		int	id,
		bool	enable )

VisualizeSelection()

void SCR_RadialMenuDisplay.VisualizeSelection ( float selectionAngle )

protected

Member Data Documentation

CHANGE_CONTENT_OPACITY

const float SCR_RadialMenuDisplay.CHANGE_CONTENT_OPACITY = 0.4

staticprotected

ENTRY_ANIMATION_SCALE

const float SCR_RadialMenuDisplay.ENTRY_ANIMATION_SCALE = 1.25

staticprotected

ENTRY_ANIMATION_SPEED

const float SCR_RadialMenuDisplay.ENTRY_ANIMATION_SPEED = 7.5

staticprotected

HINT_BASE

const string SCR_RadialMenuDisplay.HINT_BASE = "<action name='%1' hideEmpty='1'/>"

staticprotected

m_aDividers

ref array<Widget> SCR_RadialMenuDisplay.m_aDividers = {}

protected

m_aNumberHints

ref array<SCR_RadialMenuNumberHintComponent> SCR_RadialMenuDisplay.m_aNumberHints = {}

protected

m_aSegments

ref array<SCR_RadialMenuSegmentComponent> SCR_RadialMenuDisplay.m_aSegments = {}

protected

m_bFastFadeOnPerform

bool SCR_RadialMenuDisplay.m_bFastFadeOnPerform

protected

m_bForceSize

bool SCR_RadialMenuDisplay.m_bForceSize

protected

m_BreadCrumbs

SCR_BreadCrumbsComponent SCR_RadialMenuDisplay.m_BreadCrumbs

protected

m_fDividersOpacity

float SCR_RadialMenuDisplay.m_fDividersOpacity

protected

m_fDynamicDividerSize

float SCR_RadialMenuDisplay.m_fDynamicDividerSize

protected

m_fDynamicDividersRadius

float SCR_RadialMenuDisplay.m_fDynamicDividersRadius

protected

m_fDynamicEntriesRadius

float SCR_RadialMenuDisplay.m_fDynamicEntriesRadius

protected

m_fHintRadius

float SCR_RadialMenuDisplay.m_fHintRadius

protected

m_fNumberHintRadius

float SCR_RadialMenuDisplay.m_fNumberHintRadius

protected

m_fSelectedIndicatorOffset

float SCR_RadialMenuDisplay.m_fSelectedIndicatorOffset

protected

m_fSelectorArrowRadius

float SCR_RadialMenuDisplay.m_fSelectorArrowRadius

protected

m_iCategoryIconRadius

int SCR_RadialMenuDisplay.m_iCategoryIconRadius

protected

m_iDividerSize

int SCR_RadialMenuDisplay.m_iDividerSize

protected

m_iDividersRadius

int SCR_RadialMenuDisplay.m_iDividersRadius

protected

m_iEntriesRadius

int SCR_RadialMenuDisplay.m_iEntriesRadius

protected

m_iHintDisplayDelay

int SCR_RadialMenuDisplay.m_iHintDisplayDelay

protected

m_iPrevCategoryLevel

int SCR_RadialMenuDisplay.m_iPrevCategoryLevel = 0

protected

m_RadialMenu

SCR_RadialMenu SCR_RadialMenuDisplay.m_RadialMenu

protected

m_sActionHint

string SCR_RadialMenuDisplay.m_sActionHint

protected

m_sBaseWidget

string SCR_RadialMenuDisplay.m_sBaseWidget

protected

m_sBlur

string SCR_RadialMenuDisplay.m_sBlur

protected

m_sBreadCrumbs

string SCR_RadialMenuDisplay.m_sBreadCrumbs

protected

m_sCrosshairWrap

string SCR_RadialMenuDisplay.m_sCrosshairWrap

protected

m_sDescription

string SCR_RadialMenuDisplay.m_sDescription

protected

m_sDividersParent

string SCR_RadialMenuDisplay.m_sDividersParent

protected

m_sDividerTexture

ResourceName SCR_RadialMenuDisplay.m_sDividerTexture

protected

m_sHintWrapper

string SCR_RadialMenuDisplay.m_sHintWrapper

protected

m_sInnerBackround

string SCR_RadialMenuDisplay.m_sInnerBackround

protected

m_sInnerSelector

string SCR_RadialMenuDisplay.m_sInnerSelector

protected

m_SizeRatio

float SCR_RadialMenuDisplay.m_SizeRatio

protected

m_sNumberHintLayout

ResourceName SCR_RadialMenuDisplay.m_sNumberHintLayout

protected

m_sNumberHintParent

string SCR_RadialMenuDisplay.m_sNumberHintParent

protected

m_sSegmentLayout

ResourceName SCR_RadialMenuDisplay.m_sSegmentLayout

protected

m_sSegmentsParent

string SCR_RadialMenuDisplay.m_sSegmentsParent

protected

m_sSelectedIndicator

string SCR_RadialMenuDisplay.m_sSelectedIndicator

protected

m_sSelectedIndicatorFeedback

string SCR_RadialMenuDisplay.m_sSelectedIndicatorFeedback

protected

m_sSelectedName

string SCR_RadialMenuDisplay.m_sSelectedName

protected

m_sSelectorArrow

string SCR_RadialMenuDisplay.m_sSelectorArrow

protected

m_sSelectorLine

string SCR_RadialMenuDisplay.m_sSelectorLine

protected

m_wActionHint

TextWidget SCR_RadialMenuDisplay.m_wActionHint

protected

m_wBase

Widget SCR_RadialMenuDisplay.m_wBase

protected

m_wBlur

BlurWidget SCR_RadialMenuDisplay.m_wBlur

protected

m_wCrosshairWrap

Widget SCR_RadialMenuDisplay.m_wCrosshairWrap

protected

m_wDescription

TextWidget SCR_RadialMenuDisplay.m_wDescription

protected

m_wDividersParent

Widget SCR_RadialMenuDisplay.m_wDividersParent

protected

m_wHintWrapper

Widget SCR_RadialMenuDisplay.m_wHintWrapper

protected

m_wInnerBackround

ImageWidget SCR_RadialMenuDisplay.m_wInnerBackround

protected

m_wInnerSelector

ImageWidget SCR_RadialMenuDisplay.m_wInnerSelector

protected

m_wNumberHints

Widget SCR_RadialMenuDisplay.m_wNumberHints

protected

m_wSegmentsParent

Widget SCR_RadialMenuDisplay.m_wSegmentsParent

protected

m_wSelectedIndicator

ImageWidget SCR_RadialMenuDisplay.m_wSelectedIndicator

protected

m_wSelectedIndicatorFeedback

ImageWidget SCR_RadialMenuDisplay.m_wSelectedIndicatorFeedback

protected

m_wSelectedName

TextWidget SCR_RadialMenuDisplay.m_wSelectedName

protected

m_wSelectorArrow

ImageWidget SCR_RadialMenuDisplay.m_wSelectorArrow

protected

m_wSelectorLine

ImageWidget SCR_RadialMenuDisplay.m_wSelectorLine

protected

---

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

• Game/UI/HUD/SelectionMenu/RadialMenu/SCR_RadialMenuDisplay.c