CameraHandlerComponent Class Reference

Inheritance diagram for CameraHandlerComponent:

Protected Member Functions
float	CalculateFovScalar (notnull CameraBase mainCamera, CameraBase overlayCamera)
event void	Init ()
	initialization
event void	OnCameraActivate ()
	activation
event void	OnCameraDeactivate ()
	deactivation
event int	CameraSelector ()
	selects next camera
event void	OnBeforeCameraUpdate (float pDt, bool pIsKeyframe)
	before camera update
event void	OnAfterCameraUpdate (float pDt, bool pIsKeyframe, inout vector transformMS[4], inout vector transformWS[4])
	after camera update
event void	CollisionSolver (float pDt, inout ScriptedCameraItemResult pOutResult, inout vector resCamTM[4], bool isKeyframe)
	collision solver
event void	OnThirdPersonSwitch (bool isInThirdPerson)
	when we switch between FPP and TPP
event float	GetCameraTransitionTime (int pFrom, int pTo)
	get how long should transition between given cameras be
event float	GetOverlayCameraFOVScalarWeight ()
float	CalculateFovScalar (notnull CameraBase mainCamera, CameraBase overlayCamera)
event void	Init ()
	initialization
event void	OnCameraActivate ()
	activation
event void	OnCameraDeactivate ()
	deactivation
event int	CameraSelector ()
	selects next camera
event void	OnBeforeCameraUpdate (float pDt, bool pIsKeyframe)
	before camera update
event void	OnAfterCameraUpdate (float pDt, bool pIsKeyframe, inout vector transformMS[4], inout vector transformWS[4])
	after camera update
event void	CollisionSolver (float pDt, inout ScriptedCameraItemResult pOutResult, inout vector resCamTM[4], bool isKeyframe)
	collision solver
event void	OnThirdPersonSwitch (bool isInThirdPerson)
	when we switch between FPP and TPP
event float	GetCameraTransitionTime (int pFrom, int pTo)
	get how long should transition between given cameras be
event float	GetOverlayCameraFOVScalarWeight ()

Detailed Description

Definition at line 12 of file CameraHandlerComponent.c.

Member Function Documentation

CalculateFovScalar() [1/2]

float CameraHandlerComponent::CalculateFovScalar ( notnull CameraBase mainCamera, CameraBase overlayCamera )

inlineprotected

Calculate and return desired fov scalar. 1.0 = normal

Parameters

mainCamera	Main camera used, usually player camera
overlayCamera	Overlay camera, usually PiP camera or null

Definition at line 42 of file CameraHandlerComponent.c.

CalculateFovScalar() [2/2]

float CameraHandlerComponent::CalculateFovScalar ( notnull CameraBase mainCamera, CameraBase overlayCamera )

inlineprotected

Calculate and return desired fov scalar. 1.0 = normal

Parameters

mainCamera	Main camera used, usually player camera
overlayCamera	Overlay camera, usually PiP camera or null

Definition at line 42 of file CameraHandlerComponent.c.

CameraSelector() [1/2]

event int CameraHandlerComponent::CameraSelector ( )

protected

selects next camera

CameraSelector() [2/2]

event int CameraHandlerComponent::CameraSelector ( )

protected

selects next camera

CollisionSolver() [1/2]

event void CameraHandlerComponent::CollisionSolver ( float pDt, inout ScriptedCameraItemResult pOutResult, inout vector resCamTM[4], bool isKeyframe )

protected

collision solver

CollisionSolver() [2/2]

event void CameraHandlerComponent::CollisionSolver ( float pDt, inout ScriptedCameraItemResult pOutResult, inout vector resCamTM[4], bool isKeyframe )

protected

collision solver

GetCameraTransitionTime() [1/2]

event float CameraHandlerComponent::GetCameraTransitionTime ( int pFrom, int pTo )

protected

get how long should transition between given cameras be

GetCameraTransitionTime() [2/2]

event float CameraHandlerComponent::GetCameraTransitionTime ( int pFrom, int pTo )

protected

get how long should transition between given cameras be

GetOverlayCameraFOVScalarWeight() [1/2]

event float CameraHandlerComponent::GetOverlayCameraFOVScalarWeight ( )

protected

Weight in the <0, 1> range of how much input sensitivity should be modulated if an overlay camera is active. (0 = main camera, 1 = overlay camera).

GetOverlayCameraFOVScalarWeight() [2/2]

event float CameraHandlerComponent::GetOverlayCameraFOVScalarWeight ( )

protected

Weight in the <0, 1> range of how much input sensitivity should be modulated if an overlay camera is active. (0 = main camera, 1 = overlay camera).

Init() [1/2]

event void CameraHandlerComponent::Init ( )

protected

initialization

Init() [2/2]

event void CameraHandlerComponent::Init ( )

protected

initialization

OnAfterCameraUpdate() [1/2]

event void CameraHandlerComponent::OnAfterCameraUpdate ( float pDt, bool pIsKeyframe, inout vector transformMS[4], inout vector transformWS[4] )

protected

after camera update

OnAfterCameraUpdate() [2/2]

event void CameraHandlerComponent::OnAfterCameraUpdate ( float pDt, bool pIsKeyframe, inout vector transformMS[4], inout vector transformWS[4] )

protected

after camera update

OnBeforeCameraUpdate() [1/2]

event void CameraHandlerComponent::OnBeforeCameraUpdate ( float pDt, bool pIsKeyframe )

protected

before camera update

OnBeforeCameraUpdate() [2/2]

event void CameraHandlerComponent::OnBeforeCameraUpdate ( float pDt, bool pIsKeyframe )

protected

before camera update

OnCameraActivate() [1/2]

event void CameraHandlerComponent::OnCameraActivate ( )

protected

activation

OnCameraActivate() [2/2]

event void CameraHandlerComponent::OnCameraActivate ( )

protected

activation

OnCameraDeactivate() [1/2]

event void CameraHandlerComponent::OnCameraDeactivate ( )

protected

deactivation

OnCameraDeactivate() [2/2]

event void CameraHandlerComponent::OnCameraDeactivate ( )

protected

deactivation

OnThirdPersonSwitch() [1/2]

event void CameraHandlerComponent::OnThirdPersonSwitch ( bool isInThirdPerson )

protected

when we switch between FPP and TPP

OnThirdPersonSwitch() [2/2]

event void CameraHandlerComponent::OnThirdPersonSwitch ( bool isInThirdPerson )

protected

when we switch between FPP and TPP

---

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

• scripts/Game/generated/Camera/CameraHandlerComponent.c