CameraHandlerComponent Interface Reference

Inheritance diagram for CameraHandlerComponent:

Public Member Functions
proto external ScriptedCameraSet	GetCameraSet ()
proto external bool	IsInThirdPerson ()
	Returns true if the camera is in third person mode.
proto external void	SetThirdPerson (bool val)
	Set the current third person camera state.
proto external float	GetFocusMode ()
	Returns the current value of the focus mode.
proto external void	SetFocusMode (float focusMode)
	Set the current value of the focus mode.
proto external float	GetBlendAlpha (ScriptedCameraItem forCameraItem)
proto external ScriptedCameraItem	GetCurrentCamera ()
	returns current active camera
proto external bool	IsCameraBlending ()
	returns true if there's more than one processing camera
proto external void	SetLensFlareSet (CameraLensFlareSetType type, string lensFlareSetUserName)
	Sets camera lens flare set.
void	Init ()
	initialization
void	OnCameraActivate ()
	activation
void	OnCameraDeactivate ()
	deactivation
int	CameraSelector ()
	selects next camera
void	OnBeforeCameraUpdate (float pDt, bool pIsKeyframe)
	before camera update
void	OnAfterCameraUpdate (float pDt, bool pIsKeyframe, inout vector transformMS[4], inout vector transformWS[4])
	after camera update
void	CollisionSolver (float pDt, inout ScriptedCameraItemResult pOutResult, inout vector resCamTM[4], bool isKeyframe)
	collision solver
void	OnThirdPersonSwitch (bool isInThirdPerson)
	when we switch between FPP and TPP
float	GetCameraTransitionTime (int pFrom, int pTo)
	get how long should transition between given cameras be
float	GetOverlayCameraFOVScalarWeight ()
	Weight in the <0, 1> range of how much input sensitivity should be modulated if an overlay camera is active.

Protected Member Functions
float	CalculateFovScalar (notnull CameraBase mainCamera, CameraBase overlayCamera)
	Calculate and return desired fov scalar.

Member Function Documentation

CalculateFovScalar()

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

protected

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

Implemented in SCR_CharacterCameraHandlerComponent.

CameraSelector()

int CameraHandlerComponent.CameraSelector

(

)

selects next camera

Implemented in SCR_CharacterCameraHandlerComponent.

CollisionSolver()

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

collision solver

Implemented in SCR_CharacterCameraHandlerComponent.

GetBlendAlpha()

proto external float CameraHandlerComponent.GetBlendAlpha

(

ScriptedCameraItem

forCameraItem

)

GetCameraSet()

proto external ScriptedCameraSet CameraHandlerComponent.GetCameraSet

(

)

GetCameraTransitionTime()

float CameraHandlerComponent.GetCameraTransitionTime	(	int	pFrom,
		int	pTo
	)

get how long should transition between given cameras be

Implemented in SCR_CharacterCameraHandlerComponent.

GetCurrentCamera()

proto external ScriptedCameraItem CameraHandlerComponent.GetCurrentCamera

(

)

returns current active camera

GetFocusMode()

proto external float CameraHandlerComponent.GetFocusMode

(

)

Returns the current value of the focus mode.

GetOverlayCameraFOVScalarWeight()

float CameraHandlerComponent.GetOverlayCameraFOVScalarWeight

(

)

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).

Implemented in SCR_CharacterCameraHandlerComponent.

Init()

void CameraHandlerComponent.Init

(

)

initialization

Implemented in SCR_CharacterCameraHandlerComponent.

IsCameraBlending()

proto external bool CameraHandlerComponent.IsCameraBlending

(

)

returns true if there's more than one processing camera

IsInThirdPerson()

proto external bool CameraHandlerComponent.IsInThirdPerson

(

)

Returns true if the camera is in third person mode.

OnAfterCameraUpdate()

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

after camera update

Implemented in SCR_CharacterCameraHandlerComponent.

OnBeforeCameraUpdate()

void CameraHandlerComponent.OnBeforeCameraUpdate	(	float	pDt,
		bool	pIsKeyframe
	)

before camera update

Implemented in SCR_CharacterCameraHandlerComponent.

OnCameraActivate()

void CameraHandlerComponent.OnCameraActivate

(

)

activation

Implemented in SCR_CharacterCameraHandlerComponent.

OnCameraDeactivate()

void CameraHandlerComponent.OnCameraDeactivate

(

)

deactivation

Implemented in SCR_CharacterCameraHandlerComponent.

OnThirdPersonSwitch()

void CameraHandlerComponent.OnThirdPersonSwitch

(

bool

isInThirdPerson

)

when we switch between FPP and TPP

Implemented in SCR_CharacterCameraHandlerComponent.

SetFocusMode()

proto external void CameraHandlerComponent.SetFocusMode

(

float

focusMode

)

Set the current value of the focus mode.

SetLensFlareSet()

proto external void CameraHandlerComponent.SetLensFlareSet	(	CameraLensFlareSetType	type,
		string	lensFlareSetUserName
	)

Sets camera lens flare set.

Parameters

type	type of the lens flare set
userSetName	user name of the lens flare set (used only when type is set to User)

SetThirdPerson()

proto external void CameraHandlerComponent.SetThirdPerson

(

bool

val

)

Set the current third person camera state.

---

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

• Game/generated/Camera/CameraHandlerComponent.c