SCR_BaseCameraShakeProgress Interface Reference

Interface for simulating individual camera shake(s). More...

Inheritance diagram for SCR_BaseCameraShakeProgress:

Public Member Functions
bool	IsRunning ()
	Is this shake.
bool	IsFinished ()
	Is this shake finished updating, should it be removed?
void	Start ()
	First tick of the shake update.
void	Update (IEntity owner, float timeSlice)
	Update the shake progress by a single step.
void	Apply (inout vector transformMatrix[4], inout float fieldOfView)
	Apply the shake to camera matrix.
void	Clear ()
	Clear progress of this shake.

Detailed Description

Interface for simulating individual camera shake(s).

Member Function Documentation

Apply()

void SCR_BaseCameraShakeProgress.Apply	(	inout vector	transformMatrix[4],
		inout float	fieldOfView )

Apply the shake to camera matrix.

Parameters

transformMatrix	Input/output camera matrix to apply transform to
fieldOfView	Input/otuput camera field of view in degrees

Implemented in SCR_GenericCameraShakeProgress.

Clear()

void SCR_BaseCameraShakeProgress.Clear

(

)

Clear progress of this shake.

Implemented in SCR_GenericCameraShakeProgress, and SCR_NoisyCameraShakeProgress.

IsFinished()

bool SCR_BaseCameraShakeProgress.IsFinished ( )

sealed

Is this shake finished updating, should it be removed?

IsRunning()

bool SCR_BaseCameraShakeProgress.IsRunning

(

)

Is this shake.

Implemented in SCR_GenericCameraShakeProgress, and SCR_RecoilCameraShakeProgress.

Start()

void SCR_BaseCameraShakeProgress.Start

(

)

First tick of the shake update.

Implemented in SCR_NoisyCameraShakeProgress.

Update()

void SCR_BaseCameraShakeProgress.Update	(	IEntity	owner,
		float	timeSlice )

Update the shake progress by a single step.

Implemented in SCR_BuildingDestructionCameraShakeProgress, SCR_NoisyCameraShakeProgress, and SCR_RecoilCameraShakeProgress.

---

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

• Game/Camera/Shake/SCR_BaseCameraShakeProgress.c