TopDown Engine v4.3
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
MoreMountains.Feedbacks.MMSpringComponentBase Class Reference

An abstract class used to build spring components to pilot various properties (float, vector2, vector3, color, etc) More...

Inheritance diagram for MoreMountains.Feedbacks.MMSpringComponentBase:
MoreMountains.Tools.MMMonoBehaviour MoreMountains.Feedbacks.MMSpringColorComponent< T > MoreMountains.Feedbacks.MMSpringFloatComponent< T > MoreMountains.Feedbacks.MMSpringVector2Component< T > MoreMountains.Feedbacks.MMSpringVector3Component< T > MoreMountains.Feedbacks.MMSpringVector4< T >

Public Types

enum  TimeScaleModes { Unscaled , Scaled }
 the different possible timescale modes for the spring More...
 

Public Member Functions

virtual void SetVelocityLowThreshold (float threshold)
 Sets the threshold under which the spring will consider its velocity as too low and will self disable More...
 
virtual void Stop ()
 Stops all value movement on this spring More...
 
virtual void Finish ()
 Moves this spring to its destination and disables it More...
 
virtual void RestoreInitialValue ()
 Restores this spring's initial value More...
 
virtual void ResetInitialValue ()
 Sets the current value of this spring as its new initial value, overriding the previous one More...
 

Public Attributes

UnityEvent OnEquilibriumReached
 

Protected Member Functions

virtual void Awake ()
 On awake we self disable More...
 
virtual void Update ()
 On update we update our spring value and self disable if needed More...
 
virtual void Activate ()
 Activates this component More...
 
virtual void SelfDisable ()
 Disables this component More...
 
virtual void Initialization ()
 Performs initialization for this spring More...
 
virtual void GrabCurrentValue ()
 Grabs the current value on the spring's target More...
 
virtual void UpdateSpringValue ()
 Updates the spring's target value More...
 
virtual void TestMoveTo ()
 
virtual void TestMoveToAdditive ()
 
virtual void TestMoveToSubtractive ()
 
virtual void TestMoveToRandom ()
 
virtual void TestMoveToInstant ()
 
virtual void TestBump ()
 
virtual void TestBumpRandom ()
 

Protected Attributes

float _velocityLowThreshold = 0.001f
 

Properties

virtual bool LowVelocity [get]
 whether or not this spring has reached a low enough velocity to self disable More...
 

Detailed Description

An abstract class used to build spring components to pilot various properties (float, vector2, vector3, color, etc)

Member Enumeration Documentation

◆ TimeScaleModes

enum MoreMountains.Feedbacks.MMSpringComponentBase.TimeScaleModes

the different possible timescale modes for the spring

Enumerator
Unscaled 
Scaled 

Member Function Documentation

◆ Activate()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.Activate ( )
protectedvirtual

Activates this component

◆ Awake()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.Awake ( )
protectedvirtual

On awake we self disable

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

◆ Finish()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.Finish ( )
virtual

Moves this spring to its destination and disables it

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, MoreMountains.Feedbacks.MMSpringVector4< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

◆ GrabCurrentValue()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.GrabCurrentValue ( )
protectedvirtual

Grabs the current value on the spring's target

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

◆ Initialization()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.Initialization ( )
protectedvirtual

Performs initialization for this spring

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

◆ ResetInitialValue()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.ResetInitialValue ( )
virtual

Sets the current value of this spring as its new initial value, overriding the previous one

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

◆ RestoreInitialValue()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.RestoreInitialValue ( )
virtual

Restores this spring's initial value

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, MoreMountains.Feedbacks.MMSpringVector4< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

◆ SelfDisable()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.SelfDisable ( )
protectedvirtual

Disables this component

◆ SetVelocityLowThreshold()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.SetVelocityLowThreshold ( float  threshold)
virtual

Sets the threshold under which the spring will consider its velocity as too low and will self disable

Parameters
threshold

◆ Stop()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.Stop ( )
virtual

Stops all value movement on this spring

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, MoreMountains.Feedbacks.MMSpringVector4< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

◆ TestBump()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.TestBump ( )
protectedvirtual

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

◆ TestBumpRandom()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.TestBumpRandom ( )
protectedvirtual

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

◆ TestMoveTo()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.TestMoveTo ( )
protectedvirtual

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

◆ TestMoveToAdditive()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.TestMoveToAdditive ( )
protectedvirtual

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

◆ TestMoveToInstant()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.TestMoveToInstant ( )
protectedvirtual

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

◆ TestMoveToRandom()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.TestMoveToRandom ( )
protectedvirtual

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

◆ TestMoveToSubtractive()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.TestMoveToSubtractive ( )
protectedvirtual

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

◆ Update()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.Update ( )
protectedvirtual

On update we update our spring value and self disable if needed

◆ UpdateSpringValue()

virtual void MoreMountains.Feedbacks.MMSpringComponentBase.UpdateSpringValue ( )
protectedvirtual

Updates the spring's target value

Reimplemented in MoreMountains.Feedbacks.MMSpringColorComponent< T >, MoreMountains.Feedbacks.MMSpringFloatComponent< T >, MoreMountains.Feedbacks.MMSpringVector2Component< T >, MoreMountains.Feedbacks.MMSpringVector3Component< T >, and MoreMountains.Feedbacks.MMSpringVector4< T >.

Member Data Documentation

◆ _velocityLowThreshold

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

◆ OnEquilibriumReached

UnityEvent MoreMountains.Feedbacks.MMSpringComponentBase.OnEquilibriumReached

Property Documentation

◆ LowVelocity

virtual bool MoreMountains.Feedbacks.MMSpringComponentBase.LowVelocity
get

whether or not this spring has reached a low enough velocity to self disable

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