SCR_RecoilCameraShakeParams Class Reference

Inheritance diagram for SCR_RecoilCameraShakeParams:

Protected Member Functions
float	GetStanceImpulseMagnitude (float dynamicStance)
float	GetStanceMagnitude (float dynamicStance)
float	GetMagnitude (float stance, float crouch, float prone, float erect)
float	RandomFloat (float min, float max)
vector	RandomVector (vector min, vector max)
vector	RandomVectorSphere (vector min, vector max, bool uniform=true)
float	GetFovScale (float progress01)
vector	GetRandomTranslation (bool onSphere=false)
vector	GetRandomAnglesImpulse (bool onSphere=false)
vector	GetRandomYawPitchRollImpulse (bool onSphere=false)

Protected Attributes
vector	m_vTranslationMin
vector	m_vTranslationMax
float	m_fFOVModifier
vector	m_vRotationImpulseMin
vector	m_vRotationImpulseMax
float	m_fMinImpulseThreshold
float	m_fMinImpulseRate
float	m_fImpulseCrouchMagnitudeModifier
float	m_fImpulseProneMagnitudeModifier
float	m_fCrouchMagnitudeModifier
float	m_fProneMagnitudeModifier
ref RandomGenerator	m_pRandomGenerator = new RandomGenerator()

Detailed Description

Definition at line 5 of file SCR_RecoilCameraShakeParams.c.

Member Function Documentation

GetFovScale()

float SCR_RecoilCameraShakeParams::GetFovScale ( float progress01 )

inlineprotected

Returns field of view scale <0, 1> based on input parameters.

Definition at line 173 of file SCR_RecoilCameraShakeParams.c.

GetMagnitude()

float SCR_RecoilCameraShakeParams::GetMagnitude ( float stance, float crouch, float prone, float erect )

inlineprotected

Definition at line 119 of file SCR_RecoilCameraShakeParams.c.

GetRandomAnglesImpulse()

vector SCR_RecoilCameraShakeParams::GetRandomAnglesImpulse ( bool onSphere = false )

inlineprotected

Definition at line 193 of file SCR_RecoilCameraShakeParams.c.

GetRandomTranslation()

vector SCR_RecoilCameraShakeParams::GetRandomTranslation ( bool onSphere = false )

inlineprotected

Returns random translation in the right, up, forward format.

Definition at line 182 of file SCR_RecoilCameraShakeParams.c.

GetRandomYawPitchRollImpulse()

vector SCR_RecoilCameraShakeParams::GetRandomYawPitchRollImpulse ( bool onSphere = false )

inlineprotected

Definition at line 204 of file SCR_RecoilCameraShakeParams.c.

GetStanceImpulseMagnitude()

float SCR_RecoilCameraShakeParams::GetStanceImpulseMagnitude ( float dynamicStance )

inlineprotected

Returns impulse magnitude for dynamic character stance.

Parameters

dynamicStance

Dynamic stance value of character (0=prone, 0.5=crouch, 1=erect)

Definition at line 105 of file SCR_RecoilCameraShakeParams.c.

GetStanceMagnitude()

float SCR_RecoilCameraShakeParams::GetStanceMagnitude ( float dynamicStance )

inlineprotected

Returns continuous magnitude for dynamic character stance.

Parameters

dynamicStance

Dynamic stance value of character (0=prone, 0.5=crouch, 1=erect)

Definition at line 114 of file SCR_RecoilCameraShakeParams.c.

RandomFloat()

float SCR_RecoilCameraShakeParams::RandomFloat ( float min, float max )

inlineprotected

Generates a random float in both the positive and negative interval based on provided parameters.

Definition at line 136 of file SCR_RecoilCameraShakeParams.c.

RandomVector()

vector SCR_RecoilCameraShakeParams::RandomVector ( vector min, vector max )

inlineprotected

Generates random vector.

Definition at line 148 of file SCR_RecoilCameraShakeParams.c.

RandomVectorSphere()

vector SCR_RecoilCameraShakeParams::RandomVectorSphere ( vector min, vector max, bool uniform = true )

inlineprotected

Generates random vector using a random point on a sphere from provided parameters.

Definition at line 160 of file SCR_RecoilCameraShakeParams.c.

Member Data Documentation

m_fCrouchMagnitudeModifier

float SCR_RecoilCameraShakeParams::m_fCrouchMagnitudeModifier

protected

Definition at line 88 of file SCR_RecoilCameraShakeParams.c.

m_fFOVModifier

float SCR_RecoilCameraShakeParams::m_fFOVModifier

protected

The percentage of FOV used when shake is at max value.

Definition at line 42 of file SCR_RecoilCameraShakeParams.c.

m_fImpulseCrouchMagnitudeModifier

float SCR_RecoilCameraShakeParams::m_fImpulseCrouchMagnitudeModifier

protected

Definition at line 76 of file SCR_RecoilCameraShakeParams.c.

m_fImpulseProneMagnitudeModifier

float SCR_RecoilCameraShakeParams::m_fImpulseProneMagnitudeModifier

protected

Definition at line 82 of file SCR_RecoilCameraShakeParams.c.

m_fMinImpulseRate

float SCR_RecoilCameraShakeParams::m_fMinImpulseRate

protected

Definition at line 70 of file SCR_RecoilCameraShakeParams.c.

m_fMinImpulseThreshold

float SCR_RecoilCameraShakeParams::m_fMinImpulseThreshold

protected

Definition at line 64 of file SCR_RecoilCameraShakeParams.c.

m_fProneMagnitudeModifier

float SCR_RecoilCameraShakeParams::m_fProneMagnitudeModifier

protected

Definition at line 94 of file SCR_RecoilCameraShakeParams.c.

m_pRandomGenerator

ref RandomGenerator SCR_RecoilCameraShakeParams::m_pRandomGenerator = new RandomGenerator()

protected

Generator used for generating points and ranges of values fed into the shake function.

Definition at line 99 of file SCR_RecoilCameraShakeParams.c.

m_vRotationImpulseMax

vector SCR_RecoilCameraShakeParams::m_vRotationImpulseMax

protected

Definition at line 58 of file SCR_RecoilCameraShakeParams.c.

m_vRotationImpulseMin

vector SCR_RecoilCameraShakeParams::m_vRotationImpulseMin

protected

Definition at line 50 of file SCR_RecoilCameraShakeParams.c.

m_vTranslationMax

vector SCR_RecoilCameraShakeParams::m_vTranslationMax

protected

Definition at line 36 of file SCR_RecoilCameraShakeParams.c.

m_vTranslationMin

vector SCR_RecoilCameraShakeParams::m_vTranslationMin

protected

Definition at line 29 of file SCR_RecoilCameraShakeParams.c.

---

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

• scripts/Game/Camera/Shake/SCR_RecoilCameraShakeParams.c