Inheritance diagram for SCR_RadialMenu:

Protected Member Functions
ScriptInvokerSelectionMenuEntry	GetOnEntryPerformed ()
void	InvokeOnDisplaySizeChange (float size)
ScriptInvoker	GetOnDisplaySizeChange ()
void	InvokeOnSetActionHint (string action)
ScriptInvoker	GetOnSetActionHint ()
void	OnMenuOpened (ChimeraMenuBase menu)
override event void	OnOpen ()
override event void	OnClose ()
void	ReleaseContext ()
override void	Update (float timeSlice)
void	OnUpdate (float timeSlice)
	Empty method called on update ready for override.
override void	SetMenuDisplay (SCR_SelectionMenuDisplay display=null)
	Radial menu set menu display will auto find HUD manager radial menu display if display is null.
void	SelectEntry ()
	For gamepad - based on direction of stick.
void	InvokeOnUpdateEntries (array< ref SCR_SelectionMenuEntry > entries)
override void	SetController (IEntity owner, SCR_SelectionMenuControllerInputs controls)
void	OnPerformInput ()
void	AddActionListeners ()
	Add 1-9 quick actions.
void	RemoveActionListeners ()
	Remove 1-9 quick actions.
void	OnQuickAction1 ()
void	OnQuickAction2 ()
void	OnQuickAction3 ()
void	OnQuickAction4 ()
void	OnQuickAction5 ()
void	OnQuickAction6 ()
void	OnQuickAction7 ()
void	OnQuickAction8 ()
void	OnQuickAction9 ()
void	QuickActionUse (int id)
int	GetSelectedElementIndex (float angle, int elementCount)
float	AdjustDistanceWithResolution (float distance)
SCR_SelectionMenuEntry	HandleSelection (out int id)
void	DeselectEntry ()
void	ReactQuickInput ()
	Check quick 1-10 actions and perform entry on action trigger.
void	ChangeDisplaySize (bool useLarge=true, float customSize=-1)
void	SetActionHint (string action)
	Set current hint to display and send invoke it so radial menu display will show the hint.
void	HideActionHint ()
void	SetMenuCenterPos (vector centerPos)
float	GetEntriesAngleDistance ()
float	GetPointingAngle ()
bool	IsPointingToCenter ()
void	SCR_RadialMenu ()
void	~SCR_RadialMenu ()
void	SetPreventSelectionContext (bool enable)
bool	GetPreventSelectionContext ()
bool	GetUseQuickActions ()

Static Protected Member Functions
static SCR_RadialMenu	GlobalRadialMenu ()
	Find and get reference to global redial menu.
static SCR_RadialMenu	GetOpenedRadialMenu ()
	Find and get reference to global redial menu.

Protected Attributes
const float	SIZE_LARGE = 580
const float	SIZE_SMALL = 400
vector	m_vMenuCenterPos
float	m_fEntriesAngleDistance
float	m_fEntryAngleOffset
float	m_fPointingAngle
bool	m_bIsPointingToCenter
float	m_fDynamicMouseSelectionTreshold
bool	m_bActivateContext
bool	m_bPreventSelectionContext
SCR_RadialMenuInputs	m_RadialInputs
SCR_RadialMenuControllerInputs	m_RadialControllerInputs
string	m_sActionHint
ref ScriptInvoker< SCR_RadialMenu, float >	m_OnDisplaySizeChange
ref ScriptInvoker< SCR_RadialMenu, string >	m_OnSetActionHint
SCR_ERadialMenuType	m_eRadialType = SCR_ERadialMenuType.DEFAULT
ref ScriptInvokerSelectionMenuEntry	m_OnEntryPerformed

Static Protected Attributes
static SCR_RadialMenu	m_GlobalRadialMenu
static SCR_RadialMenu	m_OpenedRadialMenu

Detailed Description

Radial menu class specifing behavior and interaction for circular interface Can distrubute and select entries in set angle in distace Can be interacted with mouse or gamepad thumbsticks

Definition at line 18 of file SCR_RadialMenu.c.

Constructor & Destructor Documentation

◆ SCR_RadialMenu()

void SCR_RadialMenu::SCR_RadialMenu ( )

inlineprotected

Definition at line 716 of file SCR_RadialMenu.c.

◆ ~SCR_RadialMenu()

void SCR_RadialMenu::~SCR_RadialMenu ( )

inlineprotected

Definition at line 724 of file SCR_RadialMenu.c.

Member Function Documentation

◆ AddActionListeners()

void SCR_RadialMenu::AddActionListeners ( )

inlineprotected

Add 1-9 quick actions.

Definition at line 315 of file SCR_RadialMenu.c.

◆ AdjustDistanceWithResolution()

float SCR_RadialMenu::AdjustDistanceWithResolution ( float distance )

inlineprotected

Multiply selection distance from center with ratio of reference resolution to current resoluution Should fix distance being calculated same for various resolutions

Definition at line 439 of file SCR_RadialMenu.c.

◆ ChangeDisplaySize()

void SCR_RadialMenu::ChangeDisplaySize	(	bool	useLarge = true,
		float	customSize = -1 )

inlineprotected

Call to influence size of radial menu display layout useLarge = true will use predefined size for large menu radius (SIZE_LARGE) Custom size will ignore useLarge

Definition at line 564 of file SCR_RadialMenu.c.

◆ DeselectEntry()

void SCR_RadialMenu::DeselectEntry ( )

inlineprotected

Definition at line 528 of file SCR_RadialMenu.c.

◆ GetEntriesAngleDistance()

float SCR_RadialMenu::GetEntriesAngleDistance ( )

inlineprotected

Definition at line 609 of file SCR_RadialMenu.c.

◆ GetOnDisplaySizeChange()

ScriptInvoker SCR_RadialMenu::GetOnDisplaySizeChange ( )

inlineprotected

Definition at line 68 of file SCR_RadialMenu.c.

◆ GetOnEntryPerformed()

ScriptInvokerSelectionMenuEntry SCR_RadialMenu::GetOnEntryPerformed ( )

inlineprotected

Definition at line 52 of file SCR_RadialMenu.c.

◆ GetOnSetActionHint()

ScriptInvoker SCR_RadialMenu::GetOnSetActionHint ( )

inlineprotected

Definition at line 84 of file SCR_RadialMenu.c.

◆ GetOpenedRadialMenu()

SCR_RadialMenu SCR_RadialMenu::GetOpenedRadialMenu ( )

inlinestaticprotected

Find and get reference to global redial menu.

Definition at line 125 of file SCR_RadialMenu.c.

◆ GetPointingAngle()

float SCR_RadialMenu::GetPointingAngle ( )

inlineprotected

Definition at line 615 of file SCR_RadialMenu.c.

◆ GetPreventSelectionContext()

bool SCR_RadialMenu::GetPreventSelectionContext ( )

inlineprotected

Definition at line 738 of file SCR_RadialMenu.c.

◆ GetSelectedElementIndex()

int SCR_RadialMenu::GetSelectedElementIndex	(	float	angle,
		int	elementCount )

inlineprotected

Definition at line 394 of file SCR_RadialMenu.c.

◆ GetUseQuickActions()

bool SCR_RadialMenu::GetUseQuickActions ( )

inlineprotected

Definition at line 744 of file SCR_RadialMenu.c.

◆ GlobalRadialMenu()

SCR_RadialMenu SCR_RadialMenu::GlobalRadialMenu ( )

inlinestaticprotected

Find and get reference to global redial menu.

Definition at line 99 of file SCR_RadialMenu.c.

◆ HandleSelection()

SCR_SelectionMenuEntry SCR_RadialMenu::HandleSelection ( out int id )

inlineprotected

Definition at line 464 of file SCR_RadialMenu.c.

◆ HideActionHint()

void SCR_RadialMenu::HideActionHint ( )

inlineprotected

Definition at line 593 of file SCR_RadialMenu.c.

◆ InvokeOnDisplaySizeChange()

void SCR_RadialMenu::InvokeOnDisplaySizeChange ( float size )

inlineprotected

Definition at line 61 of file SCR_RadialMenu.c.

◆ InvokeOnSetActionHint()

void SCR_RadialMenu::InvokeOnSetActionHint ( string action )

inlineprotected

Definition at line 77 of file SCR_RadialMenu.c.

◆ InvokeOnUpdateEntries()

void SCR_RadialMenu::InvokeOnUpdateEntries ( array< ref SCR_SelectionMenuEntry > entries )

inlineprotected

Definition at line 270 of file SCR_RadialMenu.c.

◆ IsPointingToCenter()

bool SCR_RadialMenu::IsPointingToCenter ( )

inlineprotected

Definition at line 621 of file SCR_RadialMenu.c.

◆ OnClose()

override event void SCR_RadialMenu::OnClose ( )

inlineprotected

Definition at line 162 of file SCR_RadialMenu.c.

◆ OnMenuOpened()

void SCR_RadialMenu::OnMenuOpened ( ChimeraMenuBase menu )

inlineprotected

Definition at line 131 of file SCR_RadialMenu.c.

◆ OnOpen()

override event void SCR_RadialMenu::OnOpen ( )

inlineprotected

Definition at line 142 of file SCR_RadialMenu.c.

◆ OnPerformInput()

void SCR_RadialMenu::OnPerformInput ( )

inlineprotected

Definition at line 299 of file SCR_RadialMenu.c.

◆ OnQuickAction1()

void SCR_RadialMenu::OnQuickAction1 ( )

inlineprotected

Definition at line 360 of file SCR_RadialMenu.c.

◆ OnQuickAction2()

void SCR_RadialMenu::OnQuickAction2 ( )

inlineprotected

Definition at line 361 of file SCR_RadialMenu.c.

◆ OnQuickAction3()

void SCR_RadialMenu::OnQuickAction3 ( )

inlineprotected

Definition at line 362 of file SCR_RadialMenu.c.

◆ OnQuickAction4()

void SCR_RadialMenu::OnQuickAction4 ( )

inlineprotected

Definition at line 363 of file SCR_RadialMenu.c.

◆ OnQuickAction5()

void SCR_RadialMenu::OnQuickAction5 ( )

inlineprotected

Definition at line 364 of file SCR_RadialMenu.c.

◆ OnQuickAction6()

void SCR_RadialMenu::OnQuickAction6 ( )

inlineprotected

Definition at line 365 of file SCR_RadialMenu.c.

◆ OnQuickAction7()

void SCR_RadialMenu::OnQuickAction7 ( )

inlineprotected

Definition at line 366 of file SCR_RadialMenu.c.

◆ OnQuickAction8()

void SCR_RadialMenu::OnQuickAction8 ( )

inlineprotected

Definition at line 367 of file SCR_RadialMenu.c.

◆ OnQuickAction9()

void SCR_RadialMenu::OnQuickAction9 ( )

inlineprotected

Definition at line 368 of file SCR_RadialMenu.c.

◆ OnUpdate()

void SCR_RadialMenu::OnUpdate ( float timeSlice )

inlineprotected

Empty method called on update ready for override.

Definition at line 199 of file SCR_RadialMenu.c.

◆ QuickActionUse()

void SCR_RadialMenu::QuickActionUse ( int id )

inlineprotected

Definition at line 371 of file SCR_RadialMenu.c.

◆ ReactQuickInput()

void SCR_RadialMenu::ReactQuickInput ( )

inlineprotected

Check quick 1-10 actions and perform entry on action trigger.

Definition at line 536 of file SCR_RadialMenu.c.

◆ ReleaseContext()

void SCR_RadialMenu::ReleaseContext ( )

inlineprotected

Definition at line 175 of file SCR_RadialMenu.c.

◆ RemoveActionListeners()

void SCR_RadialMenu::RemoveActionListeners ( )

inlineprotected

Remove 1-9 quick actions.

Definition at line 338 of file SCR_RadialMenu.c.

◆ SelectEntry()

void SCR_RadialMenu::SelectEntry ( )

inlineprotected

For gamepad - based on direction of stick.

Definition at line 232 of file SCR_RadialMenu.c.

◆ SetActionHint()

void SCR_RadialMenu::SetActionHint ( string action )

inlineprotected

Set current hint to display and send invoke it so radial menu display will show the hint.

Definition at line 585 of file SCR_RadialMenu.c.

◆ SetController()

override void SCR_RadialMenu::SetController	(	IEntity	owner,
		SCR_SelectionMenuControllerInputs	controls )

inlineprotected

Definition at line 279 of file SCR_RadialMenu.c.

◆ SetMenuCenterPos()

void SCR_RadialMenu::SetMenuCenterPos ( vector centerPos )

inlineprotected

Definition at line 603 of file SCR_RadialMenu.c.

◆ SetMenuDisplay()

override void SCR_RadialMenu::SetMenuDisplay ( SCR_SelectionMenuDisplay display = null )

inlineprotected

Radial menu set menu display will auto find HUD manager radial menu display if display is null.

Definition at line 210 of file SCR_RadialMenu.c.

◆ SetPreventSelectionContext()

void SCR_RadialMenu::SetPreventSelectionContext ( bool enable )

inlineprotected

Definition at line 732 of file SCR_RadialMenu.c.

◆ Update()

override void SCR_RadialMenu::Update ( float timeSlice )

inlineprotected

Definition at line 181 of file SCR_RadialMenu.c.

Member Data Documentation

◆ m_bActivateContext

bool SCR_RadialMenu::m_bActivateContext

protected

Definition at line 35 of file SCR_RadialMenu.c.

◆ m_bIsPointingToCenter

bool SCR_RadialMenu::m_bIsPointingToCenter

protected

Definition at line 32 of file SCR_RadialMenu.c.

◆ m_bPreventSelectionContext

bool SCR_RadialMenu::m_bPreventSelectionContext

protected

Definition at line 36 of file SCR_RadialMenu.c.

◆ m_eRadialType

SCR_ERadialMenuType SCR_RadialMenu::m_eRadialType = SCR_ERadialMenuType.DEFAULT

protected

Definition at line 47 of file SCR_RadialMenu.c.

◆ m_fDynamicMouseSelectionTreshold

float SCR_RadialMenu::m_fDynamicMouseSelectionTreshold

protected

Definition at line 33 of file SCR_RadialMenu.c.

◆ m_fEntriesAngleDistance

float SCR_RadialMenu::m_fEntriesAngleDistance

protected

Definition at line 28 of file SCR_RadialMenu.c.

◆ m_fEntryAngleOffset

float SCR_RadialMenu::m_fEntryAngleOffset

protected

Definition at line 29 of file SCR_RadialMenu.c.

◆ m_fPointingAngle

float SCR_RadialMenu::m_fPointingAngle

protected

Definition at line 31 of file SCR_RadialMenu.c.

◆ m_GlobalRadialMenu

SCR_RadialMenu SCR_RadialMenu::m_GlobalRadialMenu

staticprotected

Definition at line 20 of file SCR_RadialMenu.c.

◆ m_OnDisplaySizeChange

ref ScriptInvoker<SCR_RadialMenu, float> SCR_RadialMenu::m_OnDisplaySizeChange

protected

Definition at line 44 of file SCR_RadialMenu.c.

◆ m_OnEntryPerformed

ref ScriptInvokerSelectionMenuEntry SCR_RadialMenu::m_OnEntryPerformed

protected

Definition at line 49 of file SCR_RadialMenu.c.

◆ m_OnSetActionHint

ref ScriptInvoker<SCR_RadialMenu, string> SCR_RadialMenu::m_OnSetActionHint

protected

Definition at line 45 of file SCR_RadialMenu.c.

◆ m_OpenedRadialMenu

SCR_RadialMenu SCR_RadialMenu::m_OpenedRadialMenu

staticprotected

Definition at line 21 of file SCR_RadialMenu.c.

◆ m_RadialControllerInputs

SCR_RadialMenuControllerInputs SCR_RadialMenu::m_RadialControllerInputs

protected

Definition at line 39 of file SCR_RadialMenu.c.

◆ m_RadialInputs

SCR_RadialMenuInputs SCR_RadialMenu::m_RadialInputs

protected

Definition at line 38 of file SCR_RadialMenu.c.

◆ m_sActionHint

string SCR_RadialMenu::m_sActionHint

protected

Definition at line 41 of file SCR_RadialMenu.c.

◆ m_vMenuCenterPos

vector SCR_RadialMenu::m_vMenuCenterPos

protected

Definition at line 26 of file SCR_RadialMenu.c.

◆ SIZE_LARGE

const float SCR_RadialMenu::SIZE_LARGE = 580

protected

Definition at line 23 of file SCR_RadialMenu.c.

◆ SIZE_SMALL

const float SCR_RadialMenu::SIZE_SMALL = 400

protected

Definition at line 24 of file SCR_RadialMenu.c.

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

scripts/Game/UI/HUD/SelectionMenu/RadialMenu/SCR_RadialMenu.c

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCR_RadialMenu()

◆ ~SCR_RadialMenu()

Member Function Documentation

◆ AddActionListeners()

◆ AdjustDistanceWithResolution()

◆ ChangeDisplaySize()

◆ DeselectEntry()

◆ GetEntriesAngleDistance()

◆ GetOnDisplaySizeChange()

◆ GetOnEntryPerformed()

◆ GetOnSetActionHint()

◆ GetOpenedRadialMenu()

◆ GetPointingAngle()

◆ GetPreventSelectionContext()

◆ GetSelectedElementIndex()

◆ GetUseQuickActions()

◆ GlobalRadialMenu()

◆ HandleSelection()

◆ HideActionHint()

◆ InvokeOnDisplaySizeChange()

◆ InvokeOnSetActionHint()

◆ InvokeOnUpdateEntries()

◆ IsPointingToCenter()

◆ OnClose()

◆ OnMenuOpened()

◆ OnOpen()

◆ OnPerformInput()

◆ OnQuickAction1()

◆ OnQuickAction2()

◆ OnQuickAction3()

◆ OnQuickAction4()

◆ OnQuickAction5()

◆ OnQuickAction6()

◆ OnQuickAction7()

◆ OnQuickAction8()

◆ OnQuickAction9()

◆ OnUpdate()

◆ QuickActionUse()

◆ ReactQuickInput()

◆ ReleaseContext()

◆ RemoveActionListeners()

◆ SelectEntry()

◆ SetActionHint()

◆ SetController()

◆ SetMenuCenterPos()

◆ SetMenuDisplay()

◆ SetPreventSelectionContext()

◆ Update()

Member Data Documentation

◆ m_bActivateContext

◆ m_bIsPointingToCenter

◆ m_bPreventSelectionContext

◆ m_eRadialType

◆ m_fDynamicMouseSelectionTreshold

◆ m_fEntriesAngleDistance

◆ m_fEntryAngleOffset

◆ m_fPointingAngle

◆ m_GlobalRadialMenu

◆ m_OnDisplaySizeChange

◆ m_OnEntryPerformed

◆ m_OnSetActionHint

◆ m_OpenedRadialMenu

◆ m_RadialControllerInputs

◆ m_RadialInputs

◆ m_sActionHint

◆ m_vMenuCenterPos

◆ SIZE_LARGE

◆ SIZE_SMALL