SCR_DepthOfFieldEffect Interface Reference

Inheritance diagram for SCR_DepthOfFieldEffect:

Public Member Functions
override void	DisplayStartDraw (IEntity owner)
override void	SettingsChanged ()
	Called when any settings are changed in the settings menu, upon DisplayStartDraw() Called from SCR_ScreenEffectsManager.
override void	DisplayControlledEntityChanged (IEntity from, IEntity to)
override void	UpdateEffect (float timeSlice)
	Called every frame from SCR_ScreenEffectsManager.
bool	IsNearDOFAllowed (out bool forceSimpleDOF)
DepthOfFieldTypes	GetDOFType (out bool isNearDOFAllowed, bool settingsChanged=false)
void	ToggleForcedSimpleDOF (bool forceSimpleDOF)
void	AddDOFBokehEffect (bool nearDofAllowed)
void	AddDOFEffect (float timeslice, bool nearDofAllowed)
Public Member Functions inherited from SCR_BaseScreenEffect
override void	DisplayStartDraw (IEntity owner)
void	SettingsChanged ()
	Called when any settings are changed in the settings menu, upon DisplayStartDraw() Called from SCR_ScreenEffectsManager.
override void	DisplayControlledEntityChanged (IEntity from, IEntity to)
override void	DisplayUpdate (IEntity owner, float timeSlice)
void	UpdateEffect (float timeSlice)
	Called every frame from SCR_ScreenEffectsManager.
void	ClearEffects ()
	Automatically called upon DisplayStartDraw() and DisplayStopDraw() from SCR_ScreenEffectsManager Due to many screeneffects listening to invokers, ClearEffects() is often called manually OnControlledEntityChanged()
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)

Static Public Attributes
static const int	DEPTH_OF_FIELD_PRIORITY = 8

Protected Member Functions
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.
override void	DisplayOnResumed ()
override void	ClearEffects ()
	Automatically called upon DisplayStartDraw() and DisplayStopDraw() from SCR_ScreenEffectsManager Due to many screeneffects listening to invokers, ClearEffects() is often called manually OnControlledEntityChanged()
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
int	m_iFocalLengthNearIntensity
int	m_iCustomFocusDistanceScale
bool	m_bForceSimpleToggle
ChimeraCharacter	m_pCharacterEntity
SightsComponent	m_SightsComponent
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 int	FOCUSDISTANCE_MULTIPIER = 30
const int	FOCALLENGTH_MAX = 5000
const float	FOCALDISTANCE_INTENSITY = 0.3
const float	STANDARD_FOCALCHANGE_NEAR = 0.25
const int	SIMPLEDOF_FOCALCHANGE_MAX = 10000
const int	SIMPLEDOF_EFFECT_MAX = 1500
const float	DOF_START_OPACITY = 0.7
const float	DOF_FADEIN_OPACITY_TARGET = 1
const float	DOFOUT_OPACITY_FADEOUT_DURATION = 2
const float	DOFOUT_PROGRESSION_FADEOUT_DURATION = 1
static bool	s_bSkipFar
const string	DOF_NORMAL_EMAT = "{403795B9349EA61C}UI/Materials/ScreenEffects_DepthOfFieldPP.emat"
const string	DOF_BOKEH_EMAT = "{5CFBB3297D669D9C}UI/Materials/ScreenEffects_DepthOfFieldBokehPP.emat"

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

Member Function Documentation

AddDOFBokehEffect()

void SCR_DepthOfFieldEffect.AddDOFBokehEffect

(

bool

nearDofAllowed

)

AddDOFEffect()

void SCR_DepthOfFieldEffect.AddDOFEffect	(	float	timeslice,
		bool	nearDofAllowed
	)

ClearEffects()

override void SCR_DepthOfFieldEffect.ClearEffects ( )

protected

Automatically called upon DisplayStartDraw() and DisplayStopDraw() from SCR_ScreenEffectsManager Due to many screeneffects listening to invokers, ClearEffects() is often called manually OnControlledEntityChanged()

Implements SCR_BaseScreenEffect.

DisplayControlledEntityChanged()

override void SCR_DepthOfFieldEffect.DisplayControlledEntityChanged	(	IEntity	from,
		IEntity	to
	)

Implements SCR_BaseScreenEffect.

DisplayOnResumed()

override void SCR_DepthOfFieldEffect.DisplayOnResumed ( )

protected

Implements SCR_InfoDisplayExtended.

DisplayOnSuspended()

override void SCR_DepthOfFieldEffect.DisplayOnSuspended ( )

protected

Called when GUI is temporarily suspended due to visibility flags; e.g. GM entered and GUI marked as not to show in GM.

Implements SCR_InfoDisplayExtended.

DisplayStartDraw()

override void SCR_DepthOfFieldEffect.DisplayStartDraw

(

IEntity

owner

)

Implements SCR_BaseScreenEffect.

GetDOFType()

DepthOfFieldTypes SCR_DepthOfFieldEffect.GetDOFType	(	out bool	isNearDOFAllowed,
		bool	settingsChanged = false
	)

Parameters

[out]	IsNearDOFAllowed	Returns whether this weapon forces simple DOF
[in]	settingsChanged	Check sights even if they are the same in case settings change

IsNearDOFAllowed()

bool SCR_DepthOfFieldEffect.IsNearDOFAllowed

(

out bool

forceSimpleDOF

)

Parameters

[out]

forceSimpleDOF

Returns whether this weapon forces simple DOF return Whether nearby DOF is allowed by the PIP settings

SettingsChanged()

override void SCR_DepthOfFieldEffect.SettingsChanged

(

)

Called when any settings are changed in the settings menu, upon DisplayStartDraw() Called from SCR_ScreenEffectsManager.

So not every effect has to listen for this individually Relevant when your effect needs to adapt when particular settings are changed, such as switching from normal DoF to Bokeh

Implements SCR_BaseScreenEffect.

ToggleForcedSimpleDOF()

void SCR_DepthOfFieldEffect.ToggleForcedSimpleDOF

(

bool

forceSimpleDOF

)

UpdateEffect()

override void SCR_DepthOfFieldEffect.UpdateEffect

(

float

timeSlice

)

Called every frame from SCR_ScreenEffectsManager.

Implements SCR_BaseScreenEffect.

Member Data Documentation

DEPTH_OF_FIELD_PRIORITY

const int SCR_DepthOfFieldEffect.DEPTH_OF_FIELD_PRIORITY = 8

static

DOF_BOKEH_EMAT

const string SCR_DepthOfFieldEffect.DOF_BOKEH_EMAT = "{5CFBB3297D669D9C}UI/Materials/ScreenEffects_DepthOfFieldBokehPP.emat"

staticprotected

DOF_FADEIN_OPACITY_TARGET

const float SCR_DepthOfFieldEffect.DOF_FADEIN_OPACITY_TARGET = 1

staticprotected

DOF_NORMAL_EMAT

const string SCR_DepthOfFieldEffect.DOF_NORMAL_EMAT = "{403795B9349EA61C}UI/Materials/ScreenEffects_DepthOfFieldPP.emat"

staticprotected

DOF_START_OPACITY

const float SCR_DepthOfFieldEffect.DOF_START_OPACITY = 0.7

staticprotected

DOFOUT_OPACITY_FADEOUT_DURATION

const float SCR_DepthOfFieldEffect.DOFOUT_OPACITY_FADEOUT_DURATION = 2

staticprotected

DOFOUT_PROGRESSION_FADEOUT_DURATION

const float SCR_DepthOfFieldEffect.DOFOUT_PROGRESSION_FADEOUT_DURATION = 1

staticprotected

FOCALDISTANCE_INTENSITY

const float SCR_DepthOfFieldEffect.FOCALDISTANCE_INTENSITY = 0.3

staticprotected

FOCALLENGTH_MAX

const int SCR_DepthOfFieldEffect.FOCALLENGTH_MAX = 5000

staticprotected

FOCUSDISTANCE_MULTIPIER

const int SCR_DepthOfFieldEffect.FOCUSDISTANCE_MULTIPIER = 30

staticprotected

m_bForceSimpleToggle

bool SCR_DepthOfFieldEffect.m_bForceSimpleToggle

protected

m_iCustomFocusDistanceScale

int SCR_DepthOfFieldEffect.m_iCustomFocusDistanceScale

protected

m_iFocalLengthNearIntensity

int SCR_DepthOfFieldEffect.m_iFocalLengthNearIntensity

protected

m_pCharacterEntity

ChimeraCharacter SCR_DepthOfFieldEffect.m_pCharacterEntity

protected

m_SightsComponent

SightsComponent SCR_DepthOfFieldEffect.m_SightsComponent

protected

s_bSkipFar

bool SCR_DepthOfFieldEffect.s_bSkipFar

staticprotected

SIMPLEDOF_EFFECT_MAX

const int SCR_DepthOfFieldEffect.SIMPLEDOF_EFFECT_MAX = 1500

staticprotected

SIMPLEDOF_FOCALCHANGE_MAX

const int SCR_DepthOfFieldEffect.SIMPLEDOF_FOCALCHANGE_MAX = 10000

staticprotected

STANDARD_FOCALCHANGE_NEAR

const float SCR_DepthOfFieldEffect.STANDARD_FOCALCHANGE_NEAR = 0.25

staticprotected

---

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

• Game/UI/ScreenEffects/SCR_DepthOfFieldEffect.c