Infinite Runner Engine v1.9
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker Class Reference

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

Inheritance diagram for MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker:
MoreMountains.Feedbacks.MMShaker

Public Member Functions

virtual void OnMMColorGradingShakeEvent (AnimationCurve shakePostExposure, float remapPostExposureZero, float remapPostExposureOne, AnimationCurve shakeHueShift, float remapHueShiftZero, float remapHueShiftOne, AnimationCurve shakeSaturation, float remapSaturationZero, float remapSaturationOne, AnimationCurve shakeContrast, float remapContrastZero, float remapContrastOne, float duration, 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 ShakePostExposure = 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 RemapPostExposureZero = 0f
 the value to remap the curve's 0 to More...
 
float RemapPostExposureOne = 1f
 the value to remap the curve's 1 to More...
 
AnimationCurve ShakeHueShift = 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 RemapHueShiftZero = 0f
 the value to remap the curve's 0 to More...
 
float RemapHueShiftOne = 180f
 the value to remap the curve's 1 to More...
 
AnimationCurve ShakeSaturation = 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 RemapSaturationZero = 0f
 the value to remap the curve's 0 to More...
 
float RemapSaturationOne = 100f
 the value to remap the curve's 1 to More...
 
AnimationCurve ShakeContrast = 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 RemapContrastZero = 0f
 the value to remap the curve's 0 to More...
 
float RemapContrastOne = 100f
 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...
 
virtual void Reset ()
 When that shaker gets added, we initialize its shake duration More...
 
override void Shake ()
 Shakes values over time 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
 
ColorGrading _colorGrading
 
float _initialPostExposure
 
float _initialHueShift
 
float _initialSaturation
 
float _initialContrast
 
float _originalShakeDuration
 
bool _originalRelativeValues
 
AnimationCurve _originalShakePostExposure
 
float _originalRemapPostExposureZero
 
float _originalRemapPostExposureOne
 
AnimationCurve _originalShakeHueShift
 
float _originalRemapHueShiftZero
 
float _originalRemapHueShiftOne
 
AnimationCurve _originalShakeSaturation
 
float _originalRemapSaturationZero
 
float _originalRemapSaturationOne
 
AnimationCurve _originalShakeContrast
 
float _originalRemapContrastZero
 
float _originalRemapContrastOne
 
- 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 color grading post processing and it'll be able to "shake" its values by getting events

Member Function Documentation

◆ GrabInitialValues()

override void MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.GrabInitialValues ( )
protectedvirtual

Collects initial values on the target

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ Initialization()

override void MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.Initialization ( )
protectedvirtual

On init we initialize our values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ OnMMColorGradingShakeEvent()

virtual void MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.OnMMColorGradingShakeEvent ( AnimationCurve  shakePostExposure,
float  remapPostExposureZero,
float  remapPostExposureOne,
AnimationCurve  shakeHueShift,
float  remapHueShiftZero,
float  remapHueShiftOne,
AnimationCurve  shakeSaturation,
float  remapSaturationZero,
float  remapSaturationOne,
AnimationCurve  shakeContrast,
float  remapContrastZero,
float  remapContrastOne,
float  duration,
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.MMColorGradingShaker.Reset ( )
protectedvirtual

When that shaker gets added, we initialize its shake duration

◆ ResetShakerValues()

override void MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.ResetShakerValues ( )
protectedvirtual

Resets the shaker's values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ ResetTargetValues()

override void MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.ResetTargetValues ( )
protectedvirtual

Resets the target's values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ Shake()

override void MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.Shake ( )
protectedvirtual

Shakes values over time

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ StartListening()

override void MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.StartListening ( )
virtual

Starts listening for events

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ StopListening()

override void MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.StopListening ( )
virtual

Stops listening for events

Reimplemented from MoreMountains.Feedbacks.MMShaker.

Member Data Documentation

◆ _colorGrading

ColorGrading MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._colorGrading
protected

◆ _initialContrast

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._initialContrast
protected

◆ _initialHueShift

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._initialHueShift
protected

◆ _initialPostExposure

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._initialPostExposure
protected

◆ _initialSaturation

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._initialSaturation
protected

◆ _originalRelativeValues

bool MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._originalRelativeValues
protected

◆ _originalRemapContrastOne

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._originalRemapContrastOne
protected

◆ _originalRemapContrastZero

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._originalRemapContrastZero
protected

◆ _originalRemapHueShiftOne

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._originalRemapHueShiftOne
protected

◆ _originalRemapHueShiftZero

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._originalRemapHueShiftZero
protected

◆ _originalRemapPostExposureOne

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._originalRemapPostExposureOne
protected

◆ _originalRemapPostExposureZero

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._originalRemapPostExposureZero
protected

◆ _originalRemapSaturationOne

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._originalRemapSaturationOne
protected

◆ _originalRemapSaturationZero

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._originalRemapSaturationZero
protected

◆ _originalShakeContrast

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._originalShakeContrast
protected

◆ _originalShakeDuration

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._originalShakeDuration
protected

◆ _originalShakeHueShift

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._originalShakeHueShift
protected

◆ _originalShakePostExposure

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._originalShakePostExposure
protected

◆ _originalShakeSaturation

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._originalShakeSaturation
protected

◆ _volume

PostProcessVolume MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker._volume
protected

◆ RelativeValues

bool MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.RelativeValues = true

whether or not to add to the initial value

◆ RemapContrastOne

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.RemapContrastOne = 100f

the value to remap the curve's 1 to

◆ RemapContrastZero

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.RemapContrastZero = 0f

the value to remap the curve's 0 to

◆ RemapHueShiftOne

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.RemapHueShiftOne = 180f

the value to remap the curve's 1 to

◆ RemapHueShiftZero

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.RemapHueShiftZero = 0f

the value to remap the curve's 0 to

◆ RemapPostExposureOne

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.RemapPostExposureOne = 1f

the value to remap the curve's 1 to

◆ RemapPostExposureZero

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.RemapPostExposureZero = 0f

the value to remap the curve's 0 to

◆ RemapSaturationOne

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.RemapSaturationOne = 100f

the value to remap the curve's 1 to

◆ RemapSaturationZero

float MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.RemapSaturationZero = 0f

the value to remap the curve's 0 to

◆ ShakeContrast

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.ShakeContrast = 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

◆ ShakeHueShift

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.ShakeHueShift = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve used to animate the aperture value on

◆ ShakePostExposure

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.ShakePostExposure = 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

◆ ShakeSaturation

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMColorGradingShaker.ShakeSaturation = 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


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