TopDown Engine v5.0
Loading...
Searching...
No Matches
MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP Class Reference

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

Inheritance diagram for MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP:
MoreMountains.Feedbacks.MMShaker MoreMountains.Tools.MMMonoBehaviour

Public Attributes

bool AnimateFocusDistance = true
 whether or not to animate the focus distance
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
float RemapFocusDistanceZero = 0f
 the value to remap the curve's 0 to
float RemapFocusDistanceOne = 3f
 the value to remap the curve's 1 to
bool AnimateNearRangeStart = false
 whether or not to animate the near range start
AnimationCurve ShakeNearRangeStart = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
 the curve used to animate the near range start on
float RemapNearRangeStartZero = 0f
 the value to remap the curve's 0 to
float RemapNearRangeStartOne = 3f
 the value to remap the curve's 1 to
bool AnimateNearRangeEnd = false
 whether or not to animate the near range end
AnimationCurve ShakeNearRangeEnd = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
 the curve used to animate the near range end on
float RemapNearRangeEndZero = 0f
 the value to remap the curve's 0 to
float RemapNearRangeEndOne = 3f
 the value to remap the curve's 1 to
bool AnimateFarRangeStart = false
 whether or not to animate the far range start
AnimationCurve ShakeFarRangeStart = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
 the curve used to animate the far range start on
float RemapFarRangeStartZero = 0f
 the value to remap the curve's 0 to
float RemapFarRangeStartOne = 3f
 the value to remap the curve's 1 to
bool AnimateFarRangeEnd = false
 whether or not to animate the far range end
AnimationCurve ShakeFarRangeEnd = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
 the curve used to animate the far range end on
float RemapFarRangeEndZero = 0f
 the value to remap the curve's 0 to
float RemapFarRangeEndOne = 3f
 the value to remap the curve's 1 to
Public Attributes inherited from MoreMountains.Feedbacks.MMShaker
MMChannelModes ChannelMode = MMChannelModes.Int
int Channel = 0
 the channel to listen to - has to match the one on the feedback
MMChannel MMChannelDefinition = null
float ShakeDuration = 0.2f
 the duration of the shake, in seconds
bool PlayOnAwake = false
 if this is true this shaker will play on awake
bool PermanentShake = false
 if this is true, the shaker will shake permanently as long as its game object is active
bool Interruptible = true
 if this is true, a new shake can happen while shaking
bool AlwaysResetTargetValuesAfterShake = false
 if this is true, this shaker will always reset target values, regardless of how it was called
bool OnlyUseShakerValues = false
 if this is true, this shaker will ignore any value passed in an event that triggered it, and will instead use the values set on its inspector
float CooldownBetweenShakes = 0f
 a cooldown, in seconds, after a shake, during which no other shake can start
bool Shaking = false
 whether or not this shaker is shaking right now
bool ForwardDirection = true
TimescaleModes TimescaleMode = TimescaleModes.Scaled

Additional Inherited Members

Public Member Functions inherited from MoreMountains.Feedbacks.MMShaker
virtual float GetTime ()
virtual float GetDeltaTime ()
virtual void ForceInitialization ()
 Call this externally if you need to force a new initialization.
virtual void StartShaking ()
 Starts shaking the values.
virtual void Play ()
 Starts this shaker.
virtual void Stop ()
 Stops this shaker.
virtual void StartListening ()
 Starts listening for events.
virtual void StopListening ()
 Stops listening for events.
virtual float ComputeRangeIntensity (bool useRange, float rangeDistance, bool useRangeFalloff, AnimationCurve rangeFalloff, Vector2 remapRangeFalloff, Vector3 rangePosition)
Static Public Attributes inherited from MoreMountains.Feedbacks.MMShaker
const float MaxEditorPreviewDeltaTime = 0.05f
 the maximum delta time allowed in editor preview mode
Protected Member Functions inherited from MoreMountains.Feedbacks.MMShaker
virtual void Awake ()
 On Awake we grab our volume and profile.
virtual void Initialization ()
 Override this method to initialize your shaker.
virtual void SetShakeStartedTimestamp ()
 Logs the start timestamp for this shaker.
virtual void ShakeStarts ()
 Describes what happens when a shake starts.
virtual void GrabInitialValues ()
 A method designed to collect initial values.
virtual void Update ()
 On Update, we shake our values if needed, or reset if our shake has ended.
virtual void Shake ()
 Override this method to implement shake over time.
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.
virtual Color ShakeGradient (Gradient gradient)
virtual void ResetTargetValues ()
 Resets the values on the target.
virtual void ResetShakerValues ()
 Resets the values on the shaker.
virtual void ShakeComplete ()
 Describes what happens when the shake is complete.
virtual void OnEnable ()
 On enable we start shaking if needed.
virtual void OnDestroy ()
 On destroy we stop listening for events.
virtual void OnDisable ()
 On disable we complete our shake if it was in progress.
virtual bool CheckEventAllowed (MMChannelData channelData, bool useRange=false, float range=0f, Vector3 eventOriginPosition=default(Vector3))
 Returns true if this shaker should listen to events, false otherwise.
Protected Attributes inherited from MoreMountains.Feedbacks.MMShaker
float _shakeStartedTimestamp = -Single.MaxValue
float _shakeStartedTimestampUnscaled = -Single.MaxValue
float _remappedTimeSinceStart
bool _resetShakerValuesAfterShake
bool _resetTargetValuesAfterShake
float _journey
Properties inherited from MoreMountains.Feedbacks.MMShaker
virtual MMChannelData ChannelData [get]
virtual bool ListeningToEvents [get]
virtual bool InCooldown [get]
 Returns true if this shaker is currently in cooldown, false otherwise.

Detailed Description

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

Member Data Documentation

◆ AnimateFarRangeEnd

bool MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.AnimateFarRangeEnd = false

whether or not to animate the far range end

◆ AnimateFarRangeStart

bool MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.AnimateFarRangeStart = false

whether or not to animate the far range start

◆ AnimateFocusDistance

bool MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.AnimateFocusDistance = true

whether or not to animate the focus distance

◆ AnimateNearRangeEnd

bool MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.AnimateNearRangeEnd = false

whether or not to animate the near range end

◆ AnimateNearRangeStart

bool MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.AnimateNearRangeStart = false

whether or not to animate the near range start

◆ RemapFarRangeEndOne

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.RemapFarRangeEndOne = 3f

the value to remap the curve's 1 to

◆ RemapFarRangeEndZero

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.RemapFarRangeEndZero = 0f

the value to remap the curve's 0 to

◆ RemapFarRangeStartOne

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.RemapFarRangeStartOne = 3f

the value to remap the curve's 1 to

◆ RemapFarRangeStartZero

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.RemapFarRangeStartZero = 0f

the value to remap the curve's 0 to

◆ RemapFocusDistanceOne

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.RemapFocusDistanceOne = 3f

the value to remap the curve's 1 to

◆ RemapFocusDistanceZero

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.RemapFocusDistanceZero = 0f

the value to remap the curve's 0 to

◆ RemapNearRangeEndOne

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.RemapNearRangeEndOne = 3f

the value to remap the curve's 1 to

◆ RemapNearRangeEndZero

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.RemapNearRangeEndZero = 0f

the value to remap the curve's 0 to

◆ RemapNearRangeStartOne

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.RemapNearRangeStartOne = 3f

the value to remap the curve's 1 to

◆ RemapNearRangeStartZero

float MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.RemapNearRangeStartZero = 0f

the value to remap the curve's 0 to

◆ ShakeFarRangeEnd

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.ShakeFarRangeEnd = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve used to animate the far range end on

◆ ShakeFarRangeStart

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.ShakeFarRangeStart = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve used to animate the far range start on

◆ ShakeFocusDistance

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.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

◆ ShakeNearRangeEnd

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.ShakeNearRangeEnd = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve used to animate the near range end on

◆ ShakeNearRangeStart

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMDepthOfFieldShaker_HDRP.ShakeNearRangeStart = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve used to animate the near range start on


The documentation for this class was generated from the following file:
  • H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacksForThirdParty/HDRP/Shakers/MMDepthOfFieldShaker_HDRP.cs