SCR_CameraShakeManagerComponent Interface Reference

This manager allows adding camera shake that is updated automatically and can be applied to any transform via provided API. More...

Inheritance diagram for SCR_CameraShakeManagerComponent:

Public Member Functions
void	DoAddCameraShake (float linearMagnitude=1.0, float angularMagnitude=1.0, float inTime=0.01, float sustainTime=0.1, float outTime=0.24)
	Adds camera shake.
void	DoAddCameraShake (SCR_BaseCameraShakeProgress instance)
	Adds custom scripted camera shake that will be progressed, applied and then withdrawn from the manager.
void	DoApplyCameraShake (inout vector matrix[4], inout float fov)
	Applies currently calculated shake to desired camera.
void	DoClearCameraShake ()
	Clears all existing camera shake progress(es).
override void	OnPostInit (IEntity owner)
override void	EOnFrame (IEntity owner, float timeSlice)

Static Public Member Functions
static void	AddCameraShake (float linearMagnitude=1.0, float angularMagnitude=1.0, float inTime=0.01, float sustainTime=0.1, float outTime=0.24)
	Adds camera shake.
static void	AddCameraShake (SCR_BaseCameraShakeProgress instance)
	Adds custom scripted camera shake that will be progressed, applied and then withdrawn from the manager.
static void	ApplyCameraShake (inout vector matrix[4], inout float fov)
	Applies currently calculated shake to desired camera.
static void	ClearCameraShake ()
	Clears all existing camera shake progress(es).

Public Attributes
ref SCR_NoisyCameraShakeProgress	m_aShakeInstances [CAMERA_SHAKE_INSTANCES]
ref array< ref SCR_BaseCameraShakeProgress >	m_aAdditionalInstances = {}
	Array of custom shakes.

Static Public Attributes
const int	CAMERA_SHAKE_INSTANCES = 16
	Array of pre-cached generic shakes.

Protected Attributes
vector	m_mShakeMatrix [4]
	Immediate shake transformation matrix.
float	m_fFovScale

Detailed Description

This manager allows adding camera shake that is updated automatically and can be applied to any transform via provided API.

Member Function Documentation

AddCameraShake() [1/2]

static void SCR_CameraShakeManagerComponent.AddCameraShake ( float linearMagnitude = 1::0, float angularMagnitude = 1::0, float inTime = 0::01, float sustainTime = 0::1, float outTime = 0::24 )

static

Adds camera shake.

Parameters

[in]	linearMagnitude	Magnitude of linear (positional change) shake
[in]	angularMagnitude	Magnitude of angular (rotational change) shake
[in]	inTime	Blend in time duration before shake reached peak value (in seconds)
[in]	sustainTime	Time duration for which the shake stays at peak value (in seconds)
[in]	outTime	Blend out time duration before shake clears out from peak value (in seconds)

AddCameraShake() [2/2]

static void SCR_CameraShakeManagerComponent.AddCameraShake ( SCR_BaseCameraShakeProgress instance )

static

Adds custom scripted camera shake that will be progressed, applied and then withdrawn from the manager.

Parameters

[in]

instance

The shake to add

ApplyCameraShake()

static void SCR_CameraShakeManagerComponent.ApplyCameraShake ( inout vector matrix[4], inout float fov )

static

Applies currently calculated shake to desired camera.

ClearCameraShake()

static void SCR_CameraShakeManagerComponent.ClearCameraShake ( )

static

Clears all existing camera shake progress(es).

DoAddCameraShake() [1/2]

void SCR_CameraShakeManagerComponent.DoAddCameraShake	(	float	linearMagnitude = 1::0,
		float	angularMagnitude = 1::0,
		float	inTime = 0::01,
		float	sustainTime = 0::1,
		float	outTime = 0::24 )

Adds camera shake.

Parameters

[in]	linearMagnitude	Magnitude of linear (positional change) shake
[in]	angularMagnitude	Magnitude of angular (rotational change) shake
[in]	inTime	Blend in time duration before shake reached peak value (in seconds)
[in]	sustainTime	Time duration for which the shake stays at peak value (in seconds)
[in]	outTime	Blend out time duration before shake clears out from peak value (in seconds)

DoAddCameraShake() [2/2]

void SCR_CameraShakeManagerComponent.DoAddCameraShake

(

SCR_BaseCameraShakeProgress

instance

)

Adds custom scripted camera shake that will be progressed, applied and then withdrawn from the manager.

Parameters

[in]

instance

The shake to add

DoApplyCameraShake()

void SCR_CameraShakeManagerComponent.DoApplyCameraShake	(	inout vector	matrix[4],
		inout float	fov )

Applies currently calculated shake to desired camera.

Parameters

[in,out]	matrix
[in,out]	fov

DoClearCameraShake()

void SCR_CameraShakeManagerComponent.DoClearCameraShake

(

)

Clears all existing camera shake progress(es).

EOnFrame()

override void SCR_CameraShakeManagerComponent.EOnFrame	(	IEntity	owner,
		float	timeSlice )

OnPostInit()

override void SCR_CameraShakeManagerComponent.OnPostInit

(

IEntity

owner

)

Member Data Documentation

CAMERA_SHAKE_INSTANCES

const int SCR_CameraShakeManagerComponent.CAMERA_SHAKE_INSTANCES = 16

static

Array of pre-cached generic shakes.

m_aAdditionalInstances

ref array<ref SCR_BaseCameraShakeProgress> SCR_CameraShakeManagerComponent.m_aAdditionalInstances = {}

Array of custom shakes.

m_aShakeInstances

ref SCR_NoisyCameraShakeProgress SCR_CameraShakeManagerComponent.m_aShakeInstances[CAMERA_SHAKE_INSTANCES]

m_fFovScale

float SCR_CameraShakeManagerComponent.m_fFovScale

protected

m_mShakeMatrix

vector SCR_CameraShakeManagerComponent.m_mShakeMatrix[4]

protected

Immediate shake transformation matrix.

---

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

• Game/Components/SCR_CameraShakeManagerComponent.c