SCR_BuildingDestructionCameraShakeProgress Interface Reference

Inheritance diagram for SCR_BuildingDestructionCameraShakeProgress:

Public Member Functions
override void	Update (IEntity owner, float timeSlice)
	Update the shake progress by a single step.
void	SetStartOrigin (vector startOrigin)
void	SetCurve (Curve curve)
void	SetSizeMultiplier (float sizeMultiplier)
Public Member Functions inherited from SCR_NoisyCameraShakeProgress
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_fMaxDistance = 50
float	m_fSizeMultiplier = 1
ref Curve	m_CameraShakeCurve
vector	m_vStartOrigin
Protected Attributes inherited from SCR_NoisyCameraShakeProgress
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

Static Protected Attributes
const float	MAX_MULTIPLIER = 1.5

Member Function Documentation

SetCurve()

void SCR_BuildingDestructionCameraShakeProgress.SetCurve

(

Curve

curve

)

Parameters

[in]

curve

SetSizeMultiplier()

void SCR_BuildingDestructionCameraShakeProgress.SetSizeMultiplier

(

float

sizeMultiplier

)

Parameters

[in]

sizeMultiplier

SetStartOrigin()

void SCR_BuildingDestructionCameraShakeProgress.SetStartOrigin

(

vector

startOrigin

)

Parameters

[in]

startOrigin

Update()

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

Update the shake progress by a single step.

Implements SCR_NoisyCameraShakeProgress.

Member Data Documentation

m_CameraShakeCurve

ref Curve SCR_BuildingDestructionCameraShakeProgress.m_CameraShakeCurve

protected

m_fMaxDistance

float SCR_BuildingDestructionCameraShakeProgress.m_fMaxDistance = 50

protected

m_fSizeMultiplier

float SCR_BuildingDestructionCameraShakeProgress.m_fSizeMultiplier = 1

protected

m_vStartOrigin

vector SCR_BuildingDestructionCameraShakeProgress.m_vStartOrigin

protected

MAX_MULTIPLIER

const float SCR_BuildingDestructionCameraShakeProgress.MAX_MULTIPLIER = 1.5

staticprotected

---

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

• Game/Destruction/Building/SCR_DestructibleBuildingComponent.c