SCR_GenericCameraShakeProgress Interface Reference

This object implements generic way of applying camera shake, but does not implement any shaking by itself. More...

Inheritance diagram for SCR_GenericCameraShakeProgress:

Public Member Functions
override bool	IsRunning ()
	Is this shake.
override void	Apply (inout vector transformMatrix[4], inout float fieldOfView)
	Apply the shake to camera matrix.
override void	Clear ()
	Clear progress of this shake.
Public Member Functions inherited from SCR_BaseCameraShakeProgress
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.

Protected Attributes
vector	m_vTranslation
vector	m_vRotation
float	m_fFovScale = 1.0
bool	m_bIsRunning

Detailed Description

This object implements generic way of applying camera shake, but does not implement any shaking by itself.

Member Function Documentation

Apply()

override void SCR_GenericCameraShakeProgress.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

Implements SCR_BaseCameraShakeProgress.

Clear()

override void SCR_GenericCameraShakeProgress.Clear

(

)

Clear progress of this shake.

Implements SCR_BaseCameraShakeProgress.

Implemented in SCR_NoisyCameraShakeProgress.

IsRunning()

override bool SCR_GenericCameraShakeProgress.IsRunning

(

)

Is this shake.

Implements SCR_BaseCameraShakeProgress.

Implemented in SCR_RecoilCameraShakeProgress.

Member Data Documentation

m_bIsRunning

bool SCR_GenericCameraShakeProgress.m_bIsRunning

protected

m_fFovScale

float SCR_GenericCameraShakeProgress.m_fFovScale = 1.0

protected

m_vRotation

vector SCR_GenericCameraShakeProgress.m_vRotation

protected

m_vTranslation

vector SCR_GenericCameraShakeProgress.m_vTranslation

protected

---

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

• Game/Camera/Shake/SCR_GenericCameraShakeProgress.c