SCR_NoisyCameraShakeProgress Interface Reference

This object implements a pseudorandom camera shake. More...

Inheritance diagram for SCR_NoisyCameraShakeProgress:

Public Member Functions
override void	Update (IEntity owner, float timeSlice)
	Update the shake progress by a single step.
void	SetParams (float linearMagnitude, float angularMagnitude, float inTime, float sustainTime, float outTime)
override void	Start ()
	First tick of the shake update.
override void	Clear ()
	Clear progress of this shake.
Public Member Functions inherited from SCR_GenericCameraShakeProgress
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	IsRunning ()
	Is this shake.
sealed 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.

Protected Attributes
float	m_fCurrent
float	m_fVelocity
float	m_fMaxVelocity
float	m_fLinearMagnitude
float	m_fAngularMagnitude
float	m_fInTime
float	m_fSustainTime
float	m_fOutTime
float	m_fElapsedTime
float	m_fDuration
Protected Attributes inherited from SCR_GenericCameraShakeProgress
vector	m_vTranslation
vector	m_vRotation
float	m_fFovScale = 1.0
bool	m_bIsRunning

Detailed Description

This object implements a pseudorandom camera shake.

Member Function Documentation

Clear()

override void SCR_NoisyCameraShakeProgress.Clear

(

)

Clear progress of this shake.

Implements SCR_GenericCameraShakeProgress.

SetParams()

void SCR_NoisyCameraShakeProgress.SetParams	(	float	linearMagnitude,
		float	angularMagnitude,
		float	inTime,
		float	sustainTime,
		float	outTime
	)

Start()

override void SCR_NoisyCameraShakeProgress.Start

(

)

First tick of the shake update.

Implements SCR_BaseCameraShakeProgress.

Update()

override void SCR_NoisyCameraShakeProgress.Update	(	IEntity	owner,
		float	timeSlice
	)

Update the shake progress by a single step.

Implements SCR_BaseCameraShakeProgress.

Implemented in SCR_BuildingDestructionCameraShakeProgress.

Member Data Documentation

m_fAngularMagnitude

float SCR_NoisyCameraShakeProgress.m_fAngularMagnitude

protected

m_fCurrent

float SCR_NoisyCameraShakeProgress.m_fCurrent

protected

m_fDuration

float SCR_NoisyCameraShakeProgress.m_fDuration

protected

m_fElapsedTime

float SCR_NoisyCameraShakeProgress.m_fElapsedTime

protected

m_fInTime

float SCR_NoisyCameraShakeProgress.m_fInTime

protected

m_fLinearMagnitude

float SCR_NoisyCameraShakeProgress.m_fLinearMagnitude

protected

m_fMaxVelocity

float SCR_NoisyCameraShakeProgress.m_fMaxVelocity

protected

m_fOutTime

float SCR_NoisyCameraShakeProgress.m_fOutTime

protected

m_fSustainTime

float SCR_NoisyCameraShakeProgress.m_fSustainTime

protected

m_fVelocity

float SCR_NoisyCameraShakeProgress.m_fVelocity

protected

---

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

• Game/Camera/Shake/SCR_NoisyCameraShakeProgress.c