Class AnimationUtility.WaveBase

Namespace

TMPEffects.TMPAnimations

Assembly

TMPEffects.dll

Base class for AnimationUtility.Wave.
Allows you to easily create periodic animations. You should take a look at the online documentation for this one: https://tmpeffects.luca3317.dev/docs/tmpanimator_animationutility_wave.html

[Serializable]
public abstract class AnimationUtility.WaveBase : ISerializationCallbackReceiver

Inheritance

object

AnimationUtility.WaveBase

Implements

ISerializationCallbackReceiver

Derived

AnimationUtility.Wave

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WaveBase()

public WaveBase()

WaveBase(float, float, float, float)

public WaveBase(float upPeriod, float downPeriod, float velocity, float amplitude)

Parameters

upPeriod float

downPeriod float

velocity float

amplitude float

Fields

wavelength

[NonSerialized]
public float wavelength

Field Value

float

Properties

Amplitude

The amplitude of the wave.

public float Amplitude { get; set; }

Property Value

float

DownPeriod

The down period of the wave; how long it takes to travel down the wave.
Ignores the Velocity of the wave, if you want to know it'll actually take to travel down the wave, use EffectiveDownPeriod.

public float DownPeriod { get; set; }

Property Value

float

EffectiveDownPeriod

The amount of time it takes to travel down the wave.

public float EffectiveDownPeriod { get; }

Property Value

float

EffectivePeriod

The amount of time it takes to travel the wave.
Sum of EffectiveUpPeriod and EffectiveDownPeriod.

public float EffectivePeriod { get; }

Property Value

float

EffectiveUpPeriod

The amount of time it takes to travel up the wave.

public float EffectiveUpPeriod { get; }

Property Value

float

Frequency

The frequency of the wave.

public float Frequency { get; }

Property Value

float

Period

The period of the wave; how long it takes to travel up and down the wave.
Sum of UpPeriod and DownPeriod.
Ignores the Velocity of the wave, if you want to know it'll actually take to travel the wave, use EffectivePeriod.

public float Period { get; }

Property Value

float

UpPeriod

The up period of the wave; how long it takes to travel up the wave.
Ignores the Velocity of the wave, if you want to know it'll actually take to travel up the wave, use EffectiveUpPeriod.

public float UpPeriod { get; set; }

Property Value

float

Velocity

The velocity at which the wave travels.

public float Velocity { get; set; }

Property Value

float

WaveLength

The wavelength of the wave.

public float WaveLength { get; }

Property Value

float

Methods

OnAfterDeserialize()

Implement this method to receive a callback after Unity deserializes your object.

public virtual void OnAfterDeserialize()

OnBeforeSerialize()

Implement this method to receive a callback before Unity serializes your object.

public virtual void OnBeforeSerialize()