TopDown Engine  v4.2
Public Types | Static Public Member Functions | Static Protected Member Functions | List of all members
MoreMountains.Tools.MMSignal Class Reference

This class lets you output the value corresponding to one of the basic signal types it contains. Useful to draw basic signal curves. More...

Public Types

enum  SignalType {
  SignalType.Sine, SignalType.Pulse, SignalType.Sawtooth, SignalType.Square,
  SignalType.Triangle, SignalType.DigitalNoise, SignalType.WhiteNoise, SignalType.PerlinNoise,
  SignalType.ValueNoise, SignalType.AnimationCurve, SignalType.MMTween
}
 

Static Public Member Functions

static float GetValue (float time, SignalType signalType, float phase, float amplitude, float frequency, float offset, bool Invert=false, AnimationCurve curve=null, MMTween.MMTweenCurve tweenCurve=MMTween.MMTweenCurve.LinearTween)
 Returns the corresponding value based on the selected SignalType for a given time value More...
 
static float GetValueNormalized (float time, SignalType signalType, float phase, float amplitude, float frequency, float offset, bool Invert=false, AnimationCurve curve=null, MMTween.MMTweenCurve tweenCurve=MMTween.MMTweenCurve.LinearTween, bool clamp=true, float clampMin=0f, float clampMax=1f, bool backAndForth=false, float backAndForthTippingPoint=0.5f)
 

Static Protected Member Functions

static float ValueNoise (float time, float frequency)
 

Detailed Description

This class lets you output the value corresponding to one of the basic signal types it contains. Useful to draw basic signal curves.

Member Enumeration Documentation

◆ SignalType

enum MoreMountains.Tools.MMSignal.SignalType
strong
Enumerator
Sine 
Pulse 
Sawtooth 
Square 
Triangle 
DigitalNoise 
WhiteNoise 
PerlinNoise 
ValueNoise 
AnimationCurve 
MMTween 

Member Function Documentation

◆ GetValue()

static float MoreMountains.Tools.MMSignal.GetValue ( float  time,
SignalType  signalType,
float  phase,
float  amplitude,
float  frequency,
float  offset,
bool  Invert = false,
AnimationCurve  curve = null,
MMTween.MMTweenCurve  tweenCurve = MMTween.MMTweenCurve.LinearTween 
)
static

Returns the corresponding value based on the selected SignalType for a given time value

Parameters
time
signalType
phase
amplitude
frequency
offset
Invert
Returns

◆ GetValueNormalized()

static float MoreMountains.Tools.MMSignal.GetValueNormalized ( float  time,
SignalType  signalType,
float  phase,
float  amplitude,
float  frequency,
float  offset,
bool  Invert = false,
AnimationCurve  curve = null,
MMTween.MMTweenCurve  tweenCurve = MMTween.MMTweenCurve.LinearTween,
bool  clamp = true,
float  clampMin = 0f,
float  clampMax = 1f,
bool  backAndForth = false,
float  backAndForthTippingPoint = 0.5f 
)
static

◆ ValueNoise()

static float MoreMountains.Tools.MMSignal.ValueNoise ( float  time,
float  frequency 
)
staticprotected
The documentation for this class was generated from the following file: