Add this class to a Camera with a depth of field post processing and it'll be able to "shake" its values by getting events More...

Inheritance diagram for MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker:

Public Member Functions
virtual void	OnDepthOfFieldShakeEvent (AnimationCurve focusDistance, float duration, float remapFocusDistanceMin, float remapFocusDistanceMax, AnimationCurve aperture, float remapApertureMin, float remapApertureMax, AnimationCurve focalLength, float remapFocalLengthMin, float remapFocalLengthMax, bool relativeValues=false, float feedbacksIntensity=1.0f, int channel=0, bool resetShakerValuesAfterShake=true, bool resetTargetValuesAfterShake=true, bool forwardDirection=true, TimescaleModes timescaleMode=TimescaleModes.Scaled, bool stop=false)
	When we get the appropriate event, we trigger a shake More...

override void	StartListening ()
	Starts listening for events More...

override void	StopListening ()
	Stops listening for events More...

Public Member Functions inherited from MoreMountains.Feedbacks.MMShaker
virtual float	GetTime ()

virtual float	GetDeltaTime ()

virtual void	StartShaking ()
	Starts shaking the values More...

virtual void	Play ()
	Starts this shaker More...

virtual void	Stop ()
	Stops this shaker More...

Public Attributes
bool	RelativeValues = true
	whether or not to add to the initial value More...

AnimationCurve	ShakeFocusDistance = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
	the curve used to animate the focus distance value on More...

float	RemapFocusDistanceZero = 0f
	the value to remap the curve's 0 to More...

float	RemapFocusDistanceOne = 3f
	the value to remap the curve's 1 to More...

AnimationCurve	ShakeAperture = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
	the curve used to animate the aperture value on More...

float	RemapApertureZero = 0f
	the value to remap the curve's 0 to More...

float	RemapApertureOne = 0f
	the value to remap the curve's 1 to More...

AnimationCurve	ShakeFocalLength = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
	the curve used to animate the focal length value on More...

float	RemapFocalLengthZero = 0f
	the value to remap the curve's 0 to More...

float	RemapFocalLengthOne = 0f
	the value to remap the curve's 1 to More...

Public Attributes inherited from MoreMountains.Feedbacks.MMShaker
int	Channel = 0
	the channel to listen to - has to match the one on the feedback More...

float	ShakeDuration = 0.2f
	the duration of the shake, in seconds More...

bool	PlayOnAwake = false
	if this is true this shaker will play on awake More...

bool	Interruptible = true
	if this is true, a new shake can happen while shaking More...

bool	AlwaysResetTargetValuesAfterShake = false
	if this is true, this shaker will always reset target values, regardless of how it was called More...

float	CooldownBetweenShakes = 0f
	a cooldown, in seconds, after a shake, during which no other shake can start More...

bool	Shaking = false
	whether or not this shaker is shaking right now More...

bool	ForwardDirection = true

TimescaleModes	TimescaleMode = TimescaleModes.Scaled

Protected Member Functions
override void	Initialization ()
	On init we initialize our values More...

override void	Shake ()
	Shakes values over time More...

virtual void	Reset ()
	When that shaker gets added, we initialize its shake duration More...

override void	GrabInitialValues ()
	Collects initial values on the target More...

override void	ResetTargetValues ()
	Resets the target's values More...

override void	ResetShakerValues ()
	Resets the shaker's values More...

Protected Member Functions inherited from MoreMountains.Feedbacks.MMShaker
virtual void	Awake ()
	On Awake we grab our volume and profile More...

virtual void	ShakeStarts ()
	Describes what happens when a shake starts More...

virtual void	Update ()
	On Update, we shake our values if needed, or reset if our shake has ended More...

virtual float	ShakeFloat (AnimationCurve curve, float remapMin, float remapMax, bool relativeIntensity, float initialValue)
	A method used to "shake" a flot over time along a curve More...

virtual void	ShakeComplete ()
	Describes what happens when the shake is complete More...

virtual void	OnEnable ()
	On enable we start shaking if needed More...

virtual void	OnDestroy ()
	On destroy we stop listening for events More...

virtual void	OnDisable ()
	On disable we complete our shake if it was in progress More...

virtual bool	CheckEventAllowed (int channel, bool useRange=false, float range=0f, Vector3 eventOriginPosition=default(Vector3))
	Returns true if this shaker should listen to events, false otherwise More...

Protected Attributes
PostProcessVolume	_volume

DepthOfField	_depthOfField

float	_initialFocusDistance

float	_initialAperture

float	_initialFocalLength

float	_originalShakeDuration

bool	_originalRelativeValues

AnimationCurve	_originalShakeFocusDistance

float	_originalRemapFocusDistanceZero

float	_originalRemapFocusDistanceOne

AnimationCurve	_originalShakeAperture

float	_originalRemapApertureZero

float	_originalRemapApertureOne

AnimationCurve	_originalShakeFocalLength

float	_originalRemapFocalLengthZero

float	_originalRemapFocalLengthOne

Protected Attributes inherited from MoreMountains.Feedbacks.MMShaker
float	_shakeStartedTimestamp = -Single.MaxValue

float	_remappedTimeSinceStart

bool	_resetShakerValuesAfterShake

bool	_resetTargetValuesAfterShake

float	_journey

Additional Inherited Members
Properties inherited from MoreMountains.Feedbacks.MMShaker
bool	ListeningToEvents `[get]`

Detailed Description

Add this class to a Camera with a depth of field post processing and it'll be able to "shake" its values by getting events

Member Function Documentation

◆ GrabInitialValues()

override void MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.GrabInitialValues ( )

protectedvirtual

Collects initial values on the target

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ Initialization()

override void MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.Initialization ( )

protectedvirtual

On init we initialize our values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ OnDepthOfFieldShakeEvent()

virtual void MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.OnDepthOfFieldShakeEvent	(	AnimationCurve	focusDistance,
		float	duration,
		float	remapFocusDistanceMin,
		float	remapFocusDistanceMax,
		AnimationCurve	aperture,
		float	remapApertureMin,
		float	remapApertureMax,
		AnimationCurve	focalLength,
		float	remapFocalLengthMin,
		float	remapFocalLengthMax,
		bool	relativeValues = `false`,
		float	feedbacksIntensity = `1.0f`,
		int	channel = `0`,
		bool	resetShakerValuesAfterShake = `true`,
		bool	resetTargetValuesAfterShake = `true`,
		bool	forwardDirection = `true`,
		TimescaleModes	timescaleMode = `TimescaleModes.Scaled`,
		bool	stop = `false`
	)

virtual

When we get the appropriate event, we trigger a shake

Parameters

intensity
duration
amplitude
relativeIntensity
feedbacksIntensity
channel

◆ Reset()

virtual void MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.Reset ( )

protectedvirtual

When that shaker gets added, we initialize its shake duration

◆ ResetShakerValues()

override void MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.ResetShakerValues ( )

protectedvirtual

Resets the shaker's values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ ResetTargetValues()

override void MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.ResetTargetValues ( )

protectedvirtual

Resets the target's values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ Shake()

override void MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.Shake ( )

protectedvirtual

Shakes values over time

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ StartListening()

override void MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.StartListening ( )

virtual

Starts listening for events

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ StopListening()

override void MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.StopListening ( )

virtual

Stops listening for events

Reimplemented from MoreMountains.Feedbacks.MMShaker.

Member Data Documentation

◆ _depthOfField

DepthOfField MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._depthOfField

protected

◆ _initialAperture

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._initialAperture

protected

◆ _initialFocalLength

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._initialFocalLength

protected

◆ _initialFocusDistance

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._initialFocusDistance

protected

◆ _originalRelativeValues

bool MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._originalRelativeValues

protected

◆ _originalRemapApertureOne

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._originalRemapApertureOne

protected

◆ _originalRemapApertureZero

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._originalRemapApertureZero

protected

◆ _originalRemapFocalLengthOne

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._originalRemapFocalLengthOne

protected

◆ _originalRemapFocalLengthZero

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._originalRemapFocalLengthZero

protected

◆ _originalRemapFocusDistanceOne

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._originalRemapFocusDistanceOne

protected

◆ _originalRemapFocusDistanceZero

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._originalRemapFocusDistanceZero

protected

◆ _originalShakeAperture

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._originalShakeAperture

protected

◆ _originalShakeDuration

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._originalShakeDuration

protected

◆ _originalShakeFocalLength

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._originalShakeFocalLength

protected

◆ _originalShakeFocusDistance

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._originalShakeFocusDistance

protected

◆ _volume

PostProcessVolume MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker._volume

protected

◆ RelativeValues

bool MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.RelativeValues = true

whether or not to add to the initial value

◆ RemapApertureOne

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.RemapApertureOne = 0f

the value to remap the curve's 1 to

◆ RemapApertureZero

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.RemapApertureZero = 0f

the value to remap the curve's 0 to

◆ RemapFocalLengthOne

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.RemapFocalLengthOne = 0f

the value to remap the curve's 1 to

◆ RemapFocalLengthZero

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.RemapFocalLengthZero = 0f

the value to remap the curve's 0 to

◆ RemapFocusDistanceOne

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.RemapFocusDistanceOne = 3f

the value to remap the curve's 1 to

◆ RemapFocusDistanceZero

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.RemapFocusDistanceZero = 0f

the value to remap the curve's 0 to

◆ ShakeAperture

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.ShakeAperture = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve used to animate the aperture value on

◆ ShakeFocalLength

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.ShakeFocalLength = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve used to animate the focal length value on

◆ ShakeFocusDistance

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker.ShakeFocusDistance = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve used to animate the focus distance value on

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

Assets/InfiniteRunnerEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacksForThirdParty/PostProcessing/Shakers/MMDepthOfFieldShaker.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GrabInitialValues()

◆ Initialization()

◆ OnDepthOfFieldShakeEvent()

◆ Reset()

◆ ResetShakerValues()

◆ ResetTargetValues()

◆ Shake()

◆ StartListening()

◆ StopListening()

Member Data Documentation

◆ _depthOfField

◆ _initialAperture

◆ _initialFocalLength

◆ _initialFocusDistance

◆ _originalRelativeValues

◆ _originalRemapApertureOne

◆ _originalRemapApertureZero

◆ _originalRemapFocalLengthOne

◆ _originalRemapFocalLengthZero

◆ _originalRemapFocusDistanceOne

◆ _originalRemapFocusDistanceZero

◆ _originalShakeAperture

◆ _originalShakeDuration

◆ _originalShakeFocalLength

◆ _originalShakeFocusDistance

◆ _volume

◆ RelativeValues

◆ RemapApertureOne

◆ RemapApertureZero

◆ RemapFocalLengthOne

◆ RemapFocalLengthZero

◆ RemapFocusDistanceOne

◆ RemapFocusDistanceZero

◆ ShakeAperture

◆ ShakeFocalLength

◆ ShakeFocusDistance