TopDown Engine v4.5
Loading...
Searching...
No Matches
MoreMountains.Feedbacks.MMF_ScaleSpring Class Reference

This feedback will let you animate the scale of the target object over time, with a spring effect. More...

Inheritance diagram for MoreMountains.Feedbacks.MMF_ScaleSpring:
MoreMountains.Feedbacks.MMF_Feedback

Public Types

enum  Modes { MoveTo , MoveToAdditive , Bump }

Public Attributes

Transform AnimateScaleTarget
 the object to animate
float DeclaredDuration = 0f
 spring duration is determined by the spring (and could be impacted real time), so it's up to you to determine how long this feedback should last, from the point of view of its parent MMF Player
float DampingX = 0.4f
 the dumping ratio determines how fast the spring will evolve after a disturbance. At a low value, it'll oscillate for a long time, while closer to 1 it'll stop oscillating quickly
float FrequencyX = 6f
 the frequency determines how fast the spring will oscillate when disturbed, low frequency means less oscillations per second, high frequency means more oscillations per second
float DampingY = 0.4f
 the dumping ratio determines how fast the spring will evolve after a disturbance. At a low value, it'll oscillate for a long time, while closer to 1 it'll stop oscillating quickly
float FrequencyY = 6f
 the frequency determines how fast the spring will oscillate when disturbed, low frequency means less oscillations per second, high frequency means more oscillations per second
float DampingZ = 0.4f
 the dumping ratio determines how fast the spring will evolve after a disturbance. At a low value, it'll oscillate for a long time, while closer to 1 it'll stop oscillating quickly
float FrequencyZ = 6f
 the frequency determines how fast the spring will oscillate when disturbed, low frequency means less oscillations per second, high frequency means more oscillations per second
Modes Mode = Modes.Bump
 the chosen mode for this spring. MoveTo will move the target the specified scale (randomized between min and max). MoveToAdditive will add the specified scale (randomized between min and max) to the target's current scale. Bump will bump the target's scale by the specified power (randomized between min and max)
Vector3 MoveToScaleMin = new Vector3(1f, 1f, 1f)
 the min value from which to pick a random target value when in MoveTo or MoveToAdditive modes
Vector3 MoveToScaleMax = new Vector3(2f, 2f, 2f)
 the max value from which to pick a random target value when in MoveTo or MoveToAdditive modes
Vector3 BumpScaleMin = new Vector3(20f, 20f, 20f)
 the min value from which to pick a random bump amount when in Bump mode
Vector3 BumpScaleMax = new Vector3(30f, 30f, 30f)
 the max value from which to pick a random bump amount when in Bump mode

Static Public Attributes

static bool FeedbackTypeAuthorized = true
 a static bool used to disable all feedbacks of this type at once

Protected Member Functions

override void AutomateTargetAcquisition ()
 A method meant to be implemented per feedback letting you specify what happens (usually setting a target)
override void CustomInitialization (MMF_Player owner)
 On init we store our initial scale.
virtual void GetInitialValues ()
 Stores initial scale for future use.
override void CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On Play, triggers the scale animation.
virtual IEnumerator Spring ()
 a coroutine running on the Owner used to move the spring
virtual void UpdateSpring ()
 Updates the spring's values.
virtual void ApplyValue ()
 Applies the current spring value to the target.
override void CustomStopFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On stop, we interrupt movement if it was active.
override void CustomSkipToTheEnd (Vector3 position, float feedbacksIntensity=1.0f)
 Skips to the end, matching the target value.
override void CustomRestoreInitialValues ()
 On restore, we restore our initial state.

Protected Attributes

Vector3 _currentValue = Vector3.zero
Vector3 _targetValue = Vector3.zero
Vector3 _velocity = Vector3.zero
Vector3 _initialScale
Coroutine _coroutine
float _velocityLowThreshold = 0.001f
Vector3 _newScale

Properties

override bool HasAutomatedTargetAcquisition [get]
 sets the inspector color for this feedback
override bool CanForceInitialValue [get]
override float FeedbackDuration [get, set]
 the duration of this feedback is the duration of the scale animation
override bool HasRandomness [get]
virtual bool LowVelocity [get]

Additional Inherited Members

Detailed Description

This feedback will let you animate the scale of the target object over time, with a spring effect.

Member Enumeration Documentation

◆ Modes

Enumerator
MoveTo 
MoveToAdditive 
Bump 

Member Function Documentation

◆ ApplyValue()

virtual void MoreMountains.Feedbacks.MMF_ScaleSpring.ApplyValue ( )
protectedvirtual

Applies the current spring value to the target.

◆ AutomateTargetAcquisition()

override void MoreMountains.Feedbacks.MMF_ScaleSpring.AutomateTargetAcquisition ( )
protectedvirtual

A method meant to be implemented per feedback letting you specify what happens (usually setting a target)

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomInitialization()

override void MoreMountains.Feedbacks.MMF_ScaleSpring.CustomInitialization ( MMF_Player owner)
protectedvirtual

On init we store our initial scale.

Parameters
owner

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomPlayFeedback()

override void MoreMountains.Feedbacks.MMF_ScaleSpring.CustomPlayFeedback ( Vector3 position,
float feedbacksIntensity = 1::0f )
protected

On Play, triggers the scale animation.

Parameters
position
feedbacksIntensity

◆ CustomRestoreInitialValues()

override void MoreMountains.Feedbacks.MMF_ScaleSpring.CustomRestoreInitialValues ( )
protectedvirtual

On restore, we restore our initial state.

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomSkipToTheEnd()

override void MoreMountains.Feedbacks.MMF_ScaleSpring.CustomSkipToTheEnd ( Vector3 position,
float feedbacksIntensity = 1::0f )
protectedvirtual

Skips to the end, matching the target value.

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

override void MoreMountains.Feedbacks.MMF_ScaleSpring.CustomStopFeedback ( Vector3 position,
float feedbacksIntensity = 1::0f )
protectedvirtual

On stop, we interrupt movement if it was active.

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ GetInitialValues()

virtual void MoreMountains.Feedbacks.MMF_ScaleSpring.GetInitialValues ( )
protectedvirtual

Stores initial scale for future use.

◆ Spring()

virtual IEnumerator MoreMountains.Feedbacks.MMF_ScaleSpring.Spring ( )
protectedvirtual

a coroutine running on the Owner used to move the spring

Returns

◆ UpdateSpring()

virtual void MoreMountains.Feedbacks.MMF_ScaleSpring.UpdateSpring ( )
protectedvirtual

Updates the spring's values.

Member Data Documentation

◆ _coroutine

Coroutine MoreMountains.Feedbacks.MMF_ScaleSpring._coroutine
protected

◆ _currentValue

Vector3 MoreMountains.Feedbacks.MMF_ScaleSpring._currentValue = Vector3.zero
protected

◆ _initialScale

Vector3 MoreMountains.Feedbacks.MMF_ScaleSpring._initialScale
protected

◆ _newScale

Vector3 MoreMountains.Feedbacks.MMF_ScaleSpring._newScale
protected

◆ _targetValue

Vector3 MoreMountains.Feedbacks.MMF_ScaleSpring._targetValue = Vector3.zero
protected

◆ _velocity

Vector3 MoreMountains.Feedbacks.MMF_ScaleSpring._velocity = Vector3.zero
protected

◆ _velocityLowThreshold

float MoreMountains.Feedbacks.MMF_ScaleSpring._velocityLowThreshold = 0.001f
protected

◆ AnimateScaleTarget

Transform MoreMountains.Feedbacks.MMF_ScaleSpring.AnimateScaleTarget

the object to animate

◆ BumpScaleMax

Vector3 MoreMountains.Feedbacks.MMF_ScaleSpring.BumpScaleMax = new Vector3(30f, 30f, 30f)

the max value from which to pick a random bump amount when in Bump mode

◆ BumpScaleMin

Vector3 MoreMountains.Feedbacks.MMF_ScaleSpring.BumpScaleMin = new Vector3(20f, 20f, 20f)

the min value from which to pick a random bump amount when in Bump mode

◆ DampingX

float MoreMountains.Feedbacks.MMF_ScaleSpring.DampingX = 0.4f

the dumping ratio determines how fast the spring will evolve after a disturbance. At a low value, it'll oscillate for a long time, while closer to 1 it'll stop oscillating quickly

◆ DampingY

float MoreMountains.Feedbacks.MMF_ScaleSpring.DampingY = 0.4f

the dumping ratio determines how fast the spring will evolve after a disturbance. At a low value, it'll oscillate for a long time, while closer to 1 it'll stop oscillating quickly

◆ DampingZ

float MoreMountains.Feedbacks.MMF_ScaleSpring.DampingZ = 0.4f

the dumping ratio determines how fast the spring will evolve after a disturbance. At a low value, it'll oscillate for a long time, while closer to 1 it'll stop oscillating quickly

◆ DeclaredDuration

float MoreMountains.Feedbacks.MMF_ScaleSpring.DeclaredDuration = 0f

spring duration is determined by the spring (and could be impacted real time), so it's up to you to determine how long this feedback should last, from the point of view of its parent MMF Player

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_ScaleSpring.FeedbackTypeAuthorized = true
static

a static bool used to disable all feedbacks of this type at once

◆ FrequencyX

float MoreMountains.Feedbacks.MMF_ScaleSpring.FrequencyX = 6f

the frequency determines how fast the spring will oscillate when disturbed, low frequency means less oscillations per second, high frequency means more oscillations per second

◆ FrequencyY

float MoreMountains.Feedbacks.MMF_ScaleSpring.FrequencyY = 6f

the frequency determines how fast the spring will oscillate when disturbed, low frequency means less oscillations per second, high frequency means more oscillations per second

◆ FrequencyZ

float MoreMountains.Feedbacks.MMF_ScaleSpring.FrequencyZ = 6f

the frequency determines how fast the spring will oscillate when disturbed, low frequency means less oscillations per second, high frequency means more oscillations per second

◆ Mode

Modes MoreMountains.Feedbacks.MMF_ScaleSpring.Mode = Modes.Bump

the chosen mode for this spring. MoveTo will move the target the specified scale (randomized between min and max). MoveToAdditive will add the specified scale (randomized between min and max) to the target's current scale. Bump will bump the target's scale by the specified power (randomized between min and max)

◆ MoveToScaleMax

Vector3 MoreMountains.Feedbacks.MMF_ScaleSpring.MoveToScaleMax = new Vector3(2f, 2f, 2f)

the max value from which to pick a random target value when in MoveTo or MoveToAdditive modes

◆ MoveToScaleMin

Vector3 MoreMountains.Feedbacks.MMF_ScaleSpring.MoveToScaleMin = new Vector3(1f, 1f, 1f)

the min value from which to pick a random target value when in MoveTo or MoveToAdditive modes

Property Documentation

◆ CanForceInitialValue

override bool MoreMountains.Feedbacks.MMF_ScaleSpring.CanForceInitialValue
get

◆ FeedbackDuration

override float MoreMountains.Feedbacks.MMF_ScaleSpring.FeedbackDuration
getset

the duration of this feedback is the duration of the scale animation

◆ HasAutomatedTargetAcquisition

override bool MoreMountains.Feedbacks.MMF_ScaleSpring.HasAutomatedTargetAcquisition
get

sets the inspector color for this feedback

◆ HasRandomness

override bool MoreMountains.Feedbacks.MMF_ScaleSpring.HasRandomness
get

◆ LowVelocity

virtual bool MoreMountains.Feedbacks.MMF_ScaleSpring.LowVelocity
getprotected

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