SCR_BaseAnalogGauge Interface Reference

Inheritance diagram for SCR_BaseAnalogGauge:

Public Member Functions
override void	DisplayUpdate (IEntity owner, float timeSlice)
override bool	DisplayStartDrawInit (IEntity owner)
override void	DisplayStartDraw (IEntity owner)
override void	DisplayStopDraw (IEntity owner)
override void	DisplayInit (IEntity owner)
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)
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.
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
float	GetValue ()
float	GetValuePerc (float value)
ref SCR_BaseAnalogGaugeData	GetGaugeData ()
void	InitGauge (IEntity owner, out bool bSuccess)
void	CreateGauge (IEntity owner, out bool bSuccess)
bool	CreateGaugeRing (IEntity owner)
bool	CreateGaugeNeedle (IEntity owner, ImageWidget wNeedle, ImageWidget wNeedleShadow, string sCustomNeedle="", bool bVisible=true)
bool	CreateGaugeOverlay (IEntity owner, ImageWidget wOverlay, string sOverlayTexture, bool bVisible=true)
bool	CreateGaugeInfoText (IEntity owner, TextWidget wInfo, string sText, Widget wAnchor, float fPosX, float fPosY, bool bVisible=true)
void	UpdateGauge (IEntity owner, float timeSlice, float value)
void	UpdateGaugeNeedle (IEntity owner, float timeSlice, ImageWidget wNeedle, ImageWidget wNeedleShadow, float fValuePerc, float fScaleValue=1.00, bool bClamp=true)
void	DestroyGauge ()
void	CreateRingLabel (WorkspaceWidget workspace, float angle, float value, bool absValues=true, float labelValueMultiplier=1, int labelValuePrecision=0)
void	CreateRingMark (WorkspaceWidget workspace, float angle, string texture)
Protected Member Functions inherited from SCR_InfoDisplayExtended
bool	DisplayStartDrawInit (IEntity owner)
void	DisplayStartDraw (IEntity owner)
void	DisplayStopDraw (IEntity owner)
void	DisplayInit (IEntity owner)
void	DisplayUpdate (IEntity owner, float timeSlice)
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)
override void	OnStartDraw (IEntity owner)
void	AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false)
override void	OnStopDraw (IEntity owner)
override void	UpdateValues (IEntity owner, float timeSlice)
override void	OnInit (IEntity owner)
void	OnInit (IEntity owner)
void	UpdateValues (IEntity owner, float timeSlice)
void	OnStartDraw (IEntity owner)
void	OnStopDraw (IEntity owner)

Protected Attributes
float	m_fWidgetRange
float	m_fWidgetRotation
float	m_fWidgetScale
string	m_sInfoText
float	m_fInfoPosX
float	m_fInfoPosY
string	m_sInfo2Text
float	m_fInfo2PosX
float	m_fInfo2PosY
float	m_fLabelValueMultiplier
int	m_iLabelValuePrecision
bool	m_bAbsLabelValues
bool	m_bShowLabel0
bool	m_bShowLabelMax
bool	m_bShowLabelMin
ref SCR_BaseAnalogGaugeData	m_pGaugeData
TextWidget	m_wInfo
TextWidget	m_wInfo2
Widget	m_wInfoAnchor
Widget	m_wInfo2Anchor
ImageWidget	m_wRing
ImageWidget	m_wBackground
ImageWidget	m_wNeedle
ImageWidget	m_wNeedleShadow
ImageWidget	m_wOverlay
float	m_fGaugeSizeX
float	m_fGaugeSizeY
Widget	m_wRingMarks
Widget	m_wRingLabels
float	m_fZeroValueRotation
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

CreateGauge()

void SCR_BaseAnalogGauge.CreateGauge ( IEntity  owner, out bool  bSuccess  )

protected

Implemented in SCR_AnalogGauge360, and SCR_AnalogGaugeUni.

CreateGaugeInfoText()

bool SCR_BaseAnalogGauge.CreateGaugeInfoText ( IEntity  owner, TextWidget  wInfo, string  sText, Widget  wAnchor, float  fPosX, float  fPosY, bool  bVisible = true  )

protected

CreateGaugeNeedle()

bool SCR_BaseAnalogGauge.CreateGaugeNeedle ( IEntity  owner, ImageWidget  wNeedle, ImageWidget  wNeedleShadow, string  sCustomNeedle = "", bool  bVisible = true  )

protected

CreateGaugeOverlay()

bool SCR_BaseAnalogGauge.CreateGaugeOverlay ( IEntity  owner, ImageWidget  wOverlay, string  sOverlayTexture, bool  bVisible = true  )

protected

CreateGaugeRing()

bool SCR_BaseAnalogGauge.CreateGaugeRing ( IEntity  owner )

protected

Implemented in SCR_AnalogGauge, and SCR_AnalogGaugeNonLinear.

CreateRingLabel()

void SCR_BaseAnalogGauge.CreateRingLabel ( WorkspaceWidget  workspace, float  angle, float  value, bool  absValues = true, float  labelValueMultiplier = 1, int  labelValuePrecision = 0  )

protected

CreateRingMark()

void SCR_BaseAnalogGauge.CreateRingMark ( WorkspaceWidget  workspace, float  angle, string  texture  )

protected

DestroyGauge()

void SCR_BaseAnalogGauge.DestroyGauge ( )

protected

Implemented in SCR_AnalogGaugeNonLinear.

DisplayInit()

override void SCR_BaseAnalogGauge.DisplayInit

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

Implemented in SCR_AnalogGauge, and SCR_AnalogGaugeNonLinear.

DisplayStartDraw()

override void SCR_BaseAnalogGauge.DisplayStartDraw

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

Implemented in SCR_AnalogGauge, SCR_AnalogGaugeMultiSignal, and SCR_AnalogGaugeNonLinear.

DisplayStartDrawInit()

override bool SCR_BaseAnalogGauge.DisplayStartDrawInit

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

DisplayStopDraw()

override void SCR_BaseAnalogGauge.DisplayStopDraw

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

DisplayUpdate()

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

Implements SCR_InfoDisplayExtended.

GetGaugeData()

ref SCR_BaseAnalogGaugeData SCR_BaseAnalogGauge.GetGaugeData ( )

protected

Implemented in SCR_AnalogGauge, SCR_AnalogGauge360Small, SCR_AnalogGaugeNonLinear, and SCR_AnalogGaugeSmall.

GetValue()

float SCR_BaseAnalogGauge.GetValue ( )

protected

Implemented in SCR_AnalogGauge, SCR_AnalogGaugeMultiSignal, and SCR_AnalogGaugeNonLinear.

GetValuePerc()

float SCR_BaseAnalogGauge.GetValuePerc ( float  value )

protected

Implemented in SCR_AnalogGauge, and SCR_AnalogGaugeNonLinear.

InitGauge()

void SCR_BaseAnalogGauge.InitGauge ( IEntity  owner, out bool  bSuccess  )

protected

Implemented in SCR_AnalogGauge, and SCR_AnalogGaugeNonLinear.

UpdateGauge()

void SCR_BaseAnalogGauge.UpdateGauge ( IEntity  owner, float  timeSlice, float  value  )

protected

Implemented in SCR_AnalogGauge360, and SCR_AnalogGaugeUni.

UpdateGaugeNeedle()

void SCR_BaseAnalogGauge.UpdateGaugeNeedle ( IEntity  owner, float  timeSlice, ImageWidget  wNeedle, ImageWidget  wNeedleShadow, float  fValuePerc, float  fScaleValue = 1::00, bool  bClamp = true  )

protected

Member Data Documentation

m_bAbsLabelValues

bool SCR_BaseAnalogGauge.m_bAbsLabelValues

protected

m_bShowLabel0

bool SCR_BaseAnalogGauge.m_bShowLabel0

protected

m_bShowLabelMax

bool SCR_BaseAnalogGauge.m_bShowLabelMax

protected

m_bShowLabelMin

bool SCR_BaseAnalogGauge.m_bShowLabelMin

protected

m_fGaugeSizeX

float SCR_BaseAnalogGauge.m_fGaugeSizeX

protected

m_fGaugeSizeY

float SCR_BaseAnalogGauge.m_fGaugeSizeY

protected

m_fInfo2PosX

float SCR_BaseAnalogGauge.m_fInfo2PosX

protected

m_fInfo2PosY

float SCR_BaseAnalogGauge.m_fInfo2PosY

protected

m_fInfoPosX

float SCR_BaseAnalogGauge.m_fInfoPosX

protected

m_fInfoPosY

float SCR_BaseAnalogGauge.m_fInfoPosY

protected

m_fLabelValueMultiplier

float SCR_BaseAnalogGauge.m_fLabelValueMultiplier

protected

m_fWidgetRange

float SCR_BaseAnalogGauge.m_fWidgetRange

protected

m_fWidgetRotation

float SCR_BaseAnalogGauge.m_fWidgetRotation

protected

m_fWidgetScale

float SCR_BaseAnalogGauge.m_fWidgetScale

protected

m_fZeroValueRotation

float SCR_BaseAnalogGauge.m_fZeroValueRotation

protected

m_iLabelValuePrecision

int SCR_BaseAnalogGauge.m_iLabelValuePrecision

protected

m_pGaugeData

ref SCR_BaseAnalogGaugeData SCR_BaseAnalogGauge.m_pGaugeData

protected

m_sInfo2Text

string SCR_BaseAnalogGauge.m_sInfo2Text

protected

m_sInfoText

string SCR_BaseAnalogGauge.m_sInfoText

protected

m_wBackground

ImageWidget SCR_BaseAnalogGauge.m_wBackground

protected

m_wInfo

TextWidget SCR_BaseAnalogGauge.m_wInfo

protected

m_wInfo2

TextWidget SCR_BaseAnalogGauge.m_wInfo2

protected

m_wInfo2Anchor

Widget SCR_BaseAnalogGauge.m_wInfo2Anchor

protected

m_wInfoAnchor

Widget SCR_BaseAnalogGauge.m_wInfoAnchor

protected

m_wNeedle

ImageWidget SCR_BaseAnalogGauge.m_wNeedle

protected

m_wNeedleShadow

ImageWidget SCR_BaseAnalogGauge.m_wNeedleShadow

protected

m_wOverlay

ImageWidget SCR_BaseAnalogGauge.m_wOverlay

protected

m_wRing

ImageWidget SCR_BaseAnalogGauge.m_wRing

protected

m_wRingLabels

Widget SCR_BaseAnalogGauge.m_wRingLabels

protected

m_wRingMarks

Widget SCR_BaseAnalogGauge.m_wRingMarks

protected

---

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

• Game/UI/HUD/VehicleInfo/SCR_BaseAnalogGauge.c