Table of Contents

Class Wave

Namespace
TMPEffects.Parameters

Allows you to easily create periodic animations. The class is explained in detail here. TODO Update link once docs updated

[Serializable]
[TMPParameterBundle("Wave")]
public class Wave : ISerializationCallbackReceiver
Inheritance
Wave

Constructors

Wave() 

public Wave()

Wave(AnimationCurve, AnimationCurve, float, float, float) 

public Wave(AnimationCurve upwardCurve, AnimationCurve downwardCurve, float upPeriod, float downPeriod, float amplitude)

Parameters

upwardCurve AnimationCurve
downwardCurve AnimationCurve
upPeriod float
downPeriod float
amplitude float

Wave(AnimationCurve, AnimationCurve, float, float, float, float, float) 

public Wave(AnimationCurve upwardCurve, AnimationCurve downwardCurve, float upPeriod, float downPeriod, float amplitude, float crestWait, float troughWait)

Parameters

upwardCurve AnimationCurve
downwardCurve AnimationCurve
upPeriod float
downPeriod float
amplitude float
crestWait float
troughWait float

Wave(Wave) 

public Wave(Wave original)

Parameters

original Wave

Properties

Amplitude

The amplitude of the wave.

public float Amplitude { get; set; }

Property Value

float

CrestWait

How long to stay at the crest of the wave.

public float CrestWait { get; set; }

Property Value

float

DownPeriod

The down period of the wave; how long it takes to travel down the wave.
DownPeriod does NOT contain either wait periods.
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

DownwardCurve

The downward curve of the wave.

public AnimationCurve DownwardCurve { get; set; }

Property Value

AnimationCurve

EffectiveDownPeriod

The amount of time it takes to travel down the wave.
EffectiveDownPeriod does NOT contain either wait periods.

public float EffectiveDownPeriod { get; }

Property Value

float

EffectivePeriod

The amount of time it takes to travel the wave.
Sum of EffectiveUpPeriod and EffectiveDownPeriod.
EffectivePeriod does NOT contain either wait periods.

public float EffectivePeriod { get; }

Property Value

float

EffectiveUpPeriod

The amount of time it takes to travel up the wave.
EffectiveUpPeriod does NOT contain either wait periods.

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.
Period does NOT contain either wait periods.
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

TroughWait

How long to stay at the trough of the wave.

public float TroughWait { get; set; }

Property Value

float

UpPeriod

The up period of the wave; how long it takes to travel up the wave.
UpPeriod does NOT contain either wait periods.
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

UpwardCurve

The upward curve of the wave.

public AnimationCurve UpwardCurve { get; set; }

Property Value

AnimationCurve

Velocity

The velocity at which the wave travels.

public float Velocity { get; }

Property Value

float

WaveLength

The wavelength of the wave.

public float WaveLength { get; }

Property Value

float

Methods

Evaluate(float, float) 

public (float Value, int Direction) Evaluate(float time, float offset)

Parameters

time float
offset float

Returns

(float Value, int Direction)

Evaluate(float, float, bool)

Evaluate the wave.
This will automatically choose the correct way to interpret the wave.

public (float Value, int Direction) Evaluate(float time, float offset, bool realtimeWait = true)

Parameters

time float

The time value.

offset float

The offset.

realtimeWait bool

Whether to use real time (i.e. whether to use TMPAnimationUtility.WaveBase.Period or TMPAnimationUtility.WaveBase.EffectivePeriod).

Returns

(float Value, int Direction)

Value: The value of the wave at the given time and offset.
Direction: Whether youre currently travelling up the wave (=1) or down the wave (=-1).

EvaluateAsInvertedPulse(float, float, bool)

Evaluate the wave as an inverted pulse explicitly, ignoring the TroughWait.

public (float Value, int Direction) EvaluateAsInvertedPulse(float time, float offset, bool realTimeWait = true)

Parameters

time float

The time value.

offset float

The offset.

realTimeWait bool

Whether to use real time (i.e. whether to use TMPAnimationUtility.WaveBase.Period or TMPAnimationUtility.WaveBase.EffectivePeriod).

Returns

(float Value, int Direction)

Item1: The value of the wave at the given time and offset.
Item2: Whether youre currently travelling up the wave (=1) or down the wave (=-1).

Exceptions

Exception

EvaluateAsOneDirectionalPulse(float, float, bool)

Evaluate the wave as a one-directional pulse explicitly.

public (float Value, int Direction) EvaluateAsOneDirectionalPulse(float time, float offset, bool realTimeWait = true)

Parameters

time float

The time value.

offset float

The offset.

realTimeWait bool

Whether to use real time (i.e. whether to use TMPAnimationUtility.WaveBase.Period or TMPAnimationUtility.WaveBase.EffectivePeriod).

Returns

(float Value, int Direction)

Item1: The value of the wave at the given time and offset.
Item2: Whether youre currently travelling up the wave (=1) or down the wave (=-1).

Exceptions

Exception

EvaluateAsPulse(float, float, bool)

Evaluate the wave as a pulse explicitly, ignoring the CrestWait.

public (float Value, int Direction) EvaluateAsPulse(float time, float offset, bool realTimeWait = true)

Parameters

time float

The time value.

offset float

The offset.

realTimeWait bool

Whether to use real time (i.e. whether to use TMPAnimationUtility.WaveBase.Period or TMPAnimationUtility.WaveBase.EffectivePeriod).

Returns

(float Value, int Direction)

Item1: The value of the wave at the given time and offset.
Item2: Whether youre currently travelling up the wave (=1) or down the wave (=-1).

Exceptions

Exception

EvaluateAsWave(float, float)

Evaluate the wave as a normal wave explicitly, ignoring both TroughWait and CrestWait.

public (float Value, int Direction) EvaluateAsWave(float time, float offset)

Parameters

time float

The time value.

offset float

The offset.

Returns

(float Value, int Direction)

Item1: The value of the wave at the given time and offset.
Item2: Whether youre currently travelling up the wave (=1) or down the wave (=-1).

Exceptions

Exception

OnAfterDeserialize() 

public void OnAfterDeserialize()

OnBeforeSerialize() 

public void OnBeforeSerialize()

PassedExtrema(float, float, float, bool, PulseExtrema)

Check whether an extrema was passed between (time - deltaTime) and time.
This will automatically choose the correct way to interpret the wave.

public int PassedExtrema(float time, float deltaTime, float offset, bool realtimeWait = true, Wave.PulseExtrema extrema = PulseExtrema.Early)

Parameters

time float

The time value.

deltaTime float

The delta time value.

offset float

The offset..

realtimeWait bool

Whether to use real time (i.e. whether to use TMPAnimationUtility.WaveBase.Period or TMPAnimationUtility.WaveBase.EffectivePeriod).

extrema Wave.PulseExtrema

If the wave has a CrestWait or TroughWait, this parameter defines whether an extremum is passed once the wait time begins, or once it ends.

Returns

int

1 if a maximum was passed, -1 if a minimum was passed, 0 if no extremum was passed.

Exceptions

Exception

PassedInvertedPulseExtrema(float, float, float, bool, PulseExtrema)

Check whether an extrema was passed between (time - deltaTime) and time.
Explicitly interpret the wave as an inverted pulse, ignoring the TroughWait.

public int PassedInvertedPulseExtrema(float time, float deltaTime, float offset, bool realtimeWait = true, Wave.PulseExtrema extrema = PulseExtrema.Early)

Parameters

time float

The time value.

deltaTime float

The delta time value.

offset float

The offset.

realtimeWait bool

Whether to use real time (i.e. whether to use TMPAnimationUtility.WaveBase.Period or TMPAnimationUtility.WaveBase.EffectivePeriod).

extrema Wave.PulseExtrema

If the wave has a CrestWait or TroughWait, this parameter defines whether an extremum is passed once the wait time begins, or once it ends.

Returns

int

1 if a maximum was passed, -1 if a minimum was passed, 0 if no extremum was passed.

Exceptions

Exception

PassedOneDirectionalPulseExtrema(float, float, float, bool, PulseExtrema)

Check whether an extrema was passed between (time - deltaTime) and time. Explicitly interpret the wave as a one-directional pulse.

public int PassedOneDirectionalPulseExtrema(float time, float deltaTime, float offset, bool realtimeWait = true, Wave.PulseExtrema extrema = PulseExtrema.Early)

Parameters

time float

The time value.

deltaTime float

The delta time value.

offset float

The offset.

realtimeWait bool

Whether to use real time (i.e. whether to use TMPAnimationUtility.WaveBase.Period or TMPAnimationUtility.WaveBase.EffectivePeriod).

extrema Wave.PulseExtrema

If the wave has a CrestWait or TroughWait, this parameter defines whether an extremum is passed once the wait time begins, or once it ends.

Returns

int

1 if a maximum was passed, -1 if a minimum was passed, 0 if no extremum was passed.

Exceptions

Exception

PassedPulseExtrema(float, float, float, bool, PulseExtrema)

Check whether an extrema was passed between (time - deltaTime) and time.
Explicitly interpret the wave as a pulse, ignoring the CrestWait.

public int PassedPulseExtrema(float time, float deltaTime, float offset, bool realtimeWait = true, Wave.PulseExtrema extrema = PulseExtrema.Early)

Parameters

time float

The time value.

deltaTime float

The delta time value.

offset float

The offset.

realtimeWait bool

Whether to use real time (i.e. whether to use TMPAnimationUtility.WaveBase.Period or TMPAnimationUtility.WaveBase.EffectivePeriod).

extrema Wave.PulseExtrema

If the wave has a CrestWait or TroughWait, this parameter defines whether an extremum is passed once the wait time begins, or once it ends.

Returns

int

1 if a maximum was passed, -1 if a minimum was passed, 0 if no extremum was passed.

Exceptions

Exception

PassedWaveExtrema(float, float, float)

Check whether an extrema was passed between (time - deltaTime) and time.
Explicitly interpret the wave as a normal wave, ignoring both CrestWait and TroughWait.

public int PassedWaveExtrema(float time, float deltaTime, float offset)

Parameters

time float

The time value.

deltaTime float

The delta time value.

offset float

The offset.

Returns

int

1 if a maximum was passed, -1 if a minimum was passed, 0 if no extremum was passed.

Exceptions

Exception

ToString() 

public override string ToString()

Returns

string
Edit this page