SCR_BaseHeadingDisplay Interface Reference

Inheritance diagram for SCR_BaseHeadingDisplay:

Public Member Functions
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.
void	CalculateScreenSize (Widget degreeWidget)
	Calculate the current screensize in DPI unscaled format.
override void	DisplayUpdate (IEntity owner, float timeSlice)
override void	DisplayStartDraw (IEntity owner)
override void	DisplayStopDraw (IEntity owner)
Public Member Functions inherited from SCR_InfoDisplayExtended
void	SetEnabled (bool isEnabled)
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
void	ShowDelay (bool show, float speed=UIConstants.FADE_RATE_INSTANT)
	Calls the SCR_InfoDisplayExtended.Show method after some delay.
void	UpdateFOV (float fov)
	Update padding and size based on current FOV.
vector	GetMuzzleDirection ()
	Get muzzle rotation global vector.
void	CalculateWidgetScreenSizeUnscaled (Widget widget)
	Calculate the size in screenspace 1 widget takes.
void	SetupHeadingWidgets (ResourceName headingHolderLayout=string.Empty, ResourceName headingNotchLayout=string.Empty)
	Create all needed Widgets that display the current and next / previous heading.
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	DisplayOnSuspended ()
	Called when GUI is temporarily suspended due to visibility flags; e.g. GM entered and GUI marked as not to show in GM.
void	DisplayOnResumed ()
void	InitializeInterfaceSettings ()
void	OnSettingsChanged ()
Protected Member Functions inherited from SCR_InfoDisplay
void	OnShownFinished (Widget w, float targetOpacity, WidgetAnimationOpacity anim=null)
void	AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false)

Protected Attributes
int	m_iMaxShownDegrees
float	m_fMils
float	m_fFadeInDelay
bool	m_bShowMils
bool	m_bShowDegrees
string	m_sHeadingTableHolderWidgetName
string	m_sTxtHeadingDegreeNotchWidgetName
string	m_sMilsTextWidgetName
string	m_sDegreeTextWidgetName
ref array< string >	m_aPaddingWidgetNames
ref array< string >	m_aHalfPaddingWidgetNames
float	m_fDegreeWidgetDefaultSize
float	m_fDegreeWidgetDefaultSizeWidth
float	m_fDegreeWidgetDefaultSizeHeight
float	m_fSliderPosX
float	m_fSliderPosY
float	m_fCurrentFOV
float	m_fDegreeWidgetSize
int	m_iLastStoredHeading
int	m_iCurrentHeading
CameraManager	m_CameraManager
CameraBase	m_Camera
Widget	m_wSavedHeadingWidget
TextWidget	m_wMilsTextWidget
TextWidget	m_wDegreesTextWidget
ScrollLayoutWidget	m_wHeadingTableHolderWidget
TurretControllerComponent	m_TurretController
ref array< TextWidget >	m_aHeadingTextWidgets = {}
ref array< SizeLayoutWidget >	m_aHeadingPaddingWidgets = {}
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()

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

Member Function Documentation

CalculateScreenSize()

void SCR_BaseHeadingDisplay.CalculateScreenSize

(

Widget

degreeWidget

)

Calculate the current screensize in DPI unscaled format.

Parameters

[in]

Widget

which will be used to get the size from

Implemented in SCR_BaseWeaponAzimuthDisplay, and SCR_BaseWeaponElevationDisplay.

CalculateWidgetScreenSizeUnscaled()

void SCR_BaseHeadingDisplay.CalculateWidgetScreenSizeUnscaled ( Widget widget )

protected

Calculate the size in screenspace 1 widget takes.

Parameters

[in]

widget

that will be used to get the size from

Implemented in SCR_BaseWeaponAzimuthDisplay, and SCR_BaseWeaponElevationDisplay.

DisplayStartDraw()

override void SCR_BaseHeadingDisplay.DisplayStartDraw

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

Implemented in SCR_BaseWeaponAzimuthDisplay, SCR_BaseWeaponElevationDisplay, SCR_MortarAzimuthDisplay, and SCR_MortarElevationDisplay.

DisplayStopDraw()

override void SCR_BaseHeadingDisplay.DisplayStopDraw

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

DisplayUpdate()

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

Implements SCR_InfoDisplayExtended.

Implemented in SCR_BaseWeaponAzimuthDisplay, and SCR_BaseWeaponElevationDisplay.

GetMuzzleDirection()

vector SCR_BaseHeadingDisplay.GetMuzzleDirection ( )

protected

Get muzzle rotation global vector.

Returns

azimuth & elevation of turret

Implemented in SCR_VehicleTurretAzimuthDisplay, and SCR_VehicleTurretElevationDisplay.

SetupHeadingWidgets()

void SCR_BaseHeadingDisplay.SetupHeadingWidgets ( ResourceName headingHolderLayout = string::Empty, ResourceName headingNotchLayout = string::Empty )

protected

Create all needed Widgets that display the current and next / previous heading.

Parameters

[in]	headingHolderLayout	resource name of the layout that will be used for holding the notches
[in]	headingNotchLayout	resource name of the layout which will be used to create notches

Implemented in SCR_BaseWeaponAzimuthDisplay, and SCR_BaseWeaponElevationDisplay.

Show()

override void SCR_BaseHeadingDisplay.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.

Use this method instead of SetVisible/SetOpacity.

Parameters

show	true to show, false to hide
speed	fade rate, default 0
curve	hiding interpolation, default linear

Implements SCR_InfoDisplayExtended.

ShowDelay()

void SCR_BaseHeadingDisplay.ShowDelay ( bool show, float speed = UIConstants::FADE_RATE_INSTANT )

protected

Calls the SCR_InfoDisplayExtended.Show method after some delay.

Parameters

[in]	True	if it can be shown, false otherwise
[in]	Fade	speed

UpdateFOV()

void SCR_BaseHeadingDisplay.UpdateFOV ( float fov )

protected

Update padding and size based on current FOV.

Parameters

[in]

FOV

of current camera

Member Data Documentation

m_aHalfPaddingWidgetNames

ref array<string> SCR_BaseHeadingDisplay.m_aHalfPaddingWidgetNames

protected

m_aHeadingPaddingWidgets

ref array<SizeLayoutWidget> SCR_BaseHeadingDisplay.m_aHeadingPaddingWidgets = {}

protected

m_aHeadingTextWidgets

ref array<TextWidget> SCR_BaseHeadingDisplay.m_aHeadingTextWidgets = {}

protected

m_aPaddingWidgetNames

ref array<string> SCR_BaseHeadingDisplay.m_aPaddingWidgetNames

protected

m_bShowDegrees

bool SCR_BaseHeadingDisplay.m_bShowDegrees

protected

m_bShowMils

bool SCR_BaseHeadingDisplay.m_bShowMils

protected

m_Camera

CameraBase SCR_BaseHeadingDisplay.m_Camera

protected

m_CameraManager

CameraManager SCR_BaseHeadingDisplay.m_CameraManager

protected

m_fCurrentFOV

float SCR_BaseHeadingDisplay.m_fCurrentFOV

protected

m_fDegreeWidgetDefaultSize

float SCR_BaseHeadingDisplay.m_fDegreeWidgetDefaultSize

protected

m_fDegreeWidgetDefaultSizeHeight

float SCR_BaseHeadingDisplay.m_fDegreeWidgetDefaultSizeHeight

protected

m_fDegreeWidgetDefaultSizeWidth

float SCR_BaseHeadingDisplay.m_fDegreeWidgetDefaultSizeWidth

protected

m_fDegreeWidgetSize

float SCR_BaseHeadingDisplay.m_fDegreeWidgetSize

protected

m_fFadeInDelay

float SCR_BaseHeadingDisplay.m_fFadeInDelay

protected

m_fMils

float SCR_BaseHeadingDisplay.m_fMils

protected

m_fSliderPosX

float SCR_BaseHeadingDisplay.m_fSliderPosX

protected

m_fSliderPosY

float SCR_BaseHeadingDisplay.m_fSliderPosY

protected

m_iCurrentHeading

int SCR_BaseHeadingDisplay.m_iCurrentHeading

protected

m_iLastStoredHeading

int SCR_BaseHeadingDisplay.m_iLastStoredHeading

protected

m_iMaxShownDegrees

int SCR_BaseHeadingDisplay.m_iMaxShownDegrees

protected

m_sDegreeTextWidgetName

string SCR_BaseHeadingDisplay.m_sDegreeTextWidgetName

protected

m_sHeadingTableHolderWidgetName

string SCR_BaseHeadingDisplay.m_sHeadingTableHolderWidgetName

protected

m_sMilsTextWidgetName

string SCR_BaseHeadingDisplay.m_sMilsTextWidgetName

protected

m_sTxtHeadingDegreeNotchWidgetName

string SCR_BaseHeadingDisplay.m_sTxtHeadingDegreeNotchWidgetName

protected

m_TurretController

TurretControllerComponent SCR_BaseHeadingDisplay.m_TurretController

protected

m_wDegreesTextWidget

TextWidget SCR_BaseHeadingDisplay.m_wDegreesTextWidget

protected

m_wHeadingTableHolderWidget

ScrollLayoutWidget SCR_BaseHeadingDisplay.m_wHeadingTableHolderWidget

protected

m_wMilsTextWidget

TextWidget SCR_BaseHeadingDisplay.m_wMilsTextWidget

protected

m_wSavedHeadingWidget

Widget SCR_BaseHeadingDisplay.m_wSavedHeadingWidget

protected

---

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

• Game/UI/HUD/MortarInfo/SCR_BaseHeadingDisplay.c