MoreMountains.Feedbacks.MMSpringSquashAndStretch Class Reference

Inheritance diagram for MoreMountains.Feedbacks.MMSpringSquashAndStretch:

Public Types
enum	PossibleAxis {   XtoYZ , XtoY , XtoZ , YtoXZ ,   YtoX , YtoZ , ZtoXZ , ZtoX ,   ZtoY }
Public Types inherited from MoreMountains.Feedbacks.MMSpringComponentBase
enum	TimeScaleModes { Unscaled , Scaled }
	the different possible timescale modes for the spring More...

Public Attributes
PossibleAxis	Axis = PossibleAxis.XtoYZ
Public Attributes inherited from MoreMountains.Feedbacks.MMSpringFloatComponent< T >
T	Target
TimeScaleModes	TimeScaleMode = TimeScaleModes.Scaled
	whether this spring should run on scaled time (and be impacted by time scale changes) or unscaled time (and not be impacted by time scale changes)
MMChannelModes	ChannelMode = MMChannelModes.Int
int	Channel = 0
	the channel to listen to - has to match the one on the feedback
MMChannel	MMChannelDefinition = null
MMSpringFloat	FloatSpring = new MMSpringFloat()
Vector2	MoveToRandomValue = new Vector2(-2f, 2f)
	the min (x) and max (y) values between which a random target value will be picked when calling MoveToRandom
Vector2	BumpAmountRandomValue = new Vector2(20f, 100f)
	the min (x) and max (y) values between which a random bump value will be picked when calling BumpRandom
float	TestMoveToValue = 2f
	the value to move this spring to when interacting with any of the MoveTo debug buttons in its inspector
bool	MoveToToolbar
float	TestBumpAmount = 75f
	the amount by which to bump this spring when interacting with the Bump debug button in its inspector
bool	BumpToToolbar
bool	OtherControlsToToolbar
Public Attributes inherited from MoreMountains.Feedbacks.MMSpringComponentBase
UnityEvent	OnEquilibriumReached

Protected Member Functions
override void	Initialization ()
	Performs initialization for this spring.
override void	ApplyValue (float newValue)
override void	GrabCurrentValue ()
	Grabs the current value on the spring's target.
Protected Member Functions inherited from MoreMountains.Feedbacks.MMSpringFloatComponent< T >
override void	UpdateSpringValue ()
	Updates the spring's target value.
override void	Awake ()
	On awake we self disable.
void	OnDestroy ()
override void	TestMoveTo ()
override void	TestMoveToAdditive ()
override void	TestMoveToSubtractive ()
override void	TestMoveToRandom ()
override void	TestMoveToInstant ()
override void	TestBump ()
override void	TestBumpRandom ()
Protected Member Functions inherited from MoreMountains.Feedbacks.MMSpringComponentBase
virtual void	Update ()
	On update we update our spring value and self disable if needed.
virtual void	Activate ()
	Activates this component.
virtual void	SelfDisable ()
	Disables this component.

Protected Attributes
Vector3	_newScale
Vector3	_initialScale
Protected Attributes inherited from MoreMountains.Feedbacks.MMSpringComponentBase
float	_velocityLowThreshold = 0.001f

Additional Inherited Members
Public Member Functions inherited from MoreMountains.Feedbacks.MMSpringFloatComponent< T >
virtual void	MoveTo (float newValue)
virtual void	MoveToAdditive (float newValue)
virtual void	MoveToSubtractive (float newValue)
virtual void	MoveToRandom ()
virtual void	MoveToInstant (float newValue)
virtual void	MoveToRandom (float min, float max)
virtual void	Bump (float bumpAmount)
virtual void	BumpRandom ()
virtual void	BumpRandom (float min, float max)
override void	Stop ()
	Stops all value movement on this spring.
override void	RestoreInitialValue ()
	Restores this spring's initial value.
override void	ResetInitialValue ()
	Sets the current value of this spring as its new initial value, overriding the previous one.
override void	Finish ()
	Moves this spring to its destination and disables it.
void	OnMMEvent (MMSpringFloatEvent springEvent)
Public Member Functions inherited from MoreMountains.Feedbacks.MMSpringComponentBase
virtual void	SetVelocityLowThreshold (float threshold)
	Sets the threshold under which the spring will consider its velocity as too low and will self disable.
Public Member Functions inherited from MoreMountains.Tools.MMEventListener< T >
void	OnMMEvent (T eventType)
Properties inherited from MoreMountains.Feedbacks.MMSpringFloatComponent< T >
override bool	LowVelocity [get]
float	DeltaTime [get]
virtual float	TargetFloat [get, set]
Properties inherited from MoreMountains.Feedbacks.MMSpringComponentBase
virtual bool	LowVelocity [get]
	whether or not this spring has reached a low enough velocity to self disable

Member Enumeration Documentation

PossibleAxis

enum MoreMountains.Feedbacks.MMSpringSquashAndStretch.PossibleAxis

Enumerator
XtoYZ
XtoY
XtoZ
YtoXZ
YtoX
YtoZ
ZtoXZ
ZtoX
ZtoY

Member Function Documentation

ApplyValue()

override void MoreMountains.Feedbacks.MMSpringSquashAndStretch.ApplyValue ( float newValue )

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringFloatComponent< T >.

GrabCurrentValue()

override void MoreMountains.Feedbacks.MMSpringSquashAndStretch.GrabCurrentValue ( )

protectedvirtual

Grabs the current value on the spring's target.

Reimplemented from MoreMountains.Feedbacks.MMSpringFloatComponent< T >.

Initialization()

override void MoreMountains.Feedbacks.MMSpringSquashAndStretch.Initialization ( )

protectedvirtual

Performs initialization for this spring.

Reimplemented from MoreMountains.Feedbacks.MMSpringFloatComponent< T >.

Member Data Documentation

_initialScale

Vector3 MoreMountains.Feedbacks.MMSpringSquashAndStretch._initialScale

protected

_newScale

Vector3 MoreMountains.Feedbacks.MMSpringSquashAndStretch._newScale

protected

Axis

PossibleAxis MoreMountains.Feedbacks.MMSpringSquashAndStretch.Axis = PossibleAxis.XtoYZ

---

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

• H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacks/Springs/Springs/MMSpringSquashAndStretch.cs