Class BaseEase

Namespace

UILib.Animations

Assembly

UILib.dll

The base class of all "ease" behaviours.

Eases between two values, supports reversing, and different curves for easing in/out.

public abstract class BaseEase : BaseTimer

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

BaseTimer

BaseEase

Derived

Ease

Fade

Inherited Members

BaseTimer.running

BaseTimer.time

BaseTimer.duration

BaseTimer.timeScale

BaseTimer.increasing

BaseTimer.ForceRun()

BaseTimer.StartTimer()

BaseTimer.RestartTimer()

BaseTimer.StopTimer()

BaseTimer.SetIncreasing(bool)

BaseTimer.Reverse()

BaseTimer.SetDuration(float)

BaseTimer.SetTimeScale(float)

BaseTimer.SetTime(float)

BaseTimer.SetToStart()

BaseTimer.SetToEnd()

BaseTimer.OnStart()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.Internal_CancelInvokeAll(MonoBehaviour)

MonoBehaviour.Internal_IsInvokingAll(MonoBehaviour)

MonoBehaviour.InvokeDelayed(MonoBehaviour, string, float, float)

MonoBehaviour.CancelInvoke(MonoBehaviour, string)

MonoBehaviour.IsInvoking(MonoBehaviour, string)

MonoBehaviour.IsObjectMonoBehaviour(Object)

MonoBehaviour.StartCoroutineManaged(string, object)

MonoBehaviour.StartCoroutineManaged2(IEnumerator)

MonoBehaviour.StopCoroutineManaged(Coroutine)

MonoBehaviour.StopCoroutineFromEnumeratorManaged(IEnumerator)

MonoBehaviour.GetScriptClassName()

MonoBehaviour.useGUILayout

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponentFastPath(Type, IntPtr)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponentsForListInternal(Type, object)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.m_CachedPtr

Object.OffsetOfInstanceIDInCPlusPlusObject

Object.objectIsNullMessage

Object.cloneDestroyedMessage

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.CompareBaseObjects(Object, Object)

Object.EnsureRunningOnMainThread()

Object.IsNativeObjectAlive(Object)

Object.GetCachedPtr()

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.CheckNullArgument(object, string)

Object.FindObjectOfType(Type)

Object.ToString()

Object.GetOffsetOfInstanceIDInCPlusPlusObject()

Object.CurrentThreadIsMainThread()

Object.Internal_CloneSingle(Object)

Object.Internal_CloneSingleWithParent(Object, Transform, bool)

Object.Internal_InstantiateSingle(Object, Vector3, Quaternion)

Object.Internal_InstantiateSingleWithParent(Object, Transform, Vector3, Quaternion)

Object.ToString(Object)

Object.GetName(Object)

Object.IsPersistent(Object)

Object.SetName(Object, string)

Object.DoesObjectWithInstanceIDExist(int)

Object.FindObjectFromInstanceID(int)

Object.ForceLoadFromInstanceID(int)

Object.Internal_InstantiateSingle_Injected(Object, ref Vector3, ref Quaternion)

Object.Internal_InstantiateSingleWithParent_Injected(Object, Transform, ref Vector3, ref Quaternion)

Object.name

Object.hideFlags

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Properties

easeFunction

The easing function this ease will use. This is unset by default and will be treated as a linear function.

public Func<float, float> easeFunction { get; }

Property Value

Func<float, float>

easingIn

Whether this behaviour is currently easing in.

public bool easingIn { get; }

Property Value

bool

easingOut

Whether this behaviour is currently easing out.

public bool easingOut { get; }

Property Value

bool

maxValue

The maximum value.

public float maxValue { get; }

Property Value

float

minValue

The minimum value.

public float minValue { get; }

Property Value

float

value

The current value.

public float value { get; }

Property Value

float

Methods

EaseIn(bool)

Eases in, heading towards the maxValue.

public void EaseIn(bool force = false)

Parameters

force bool

Whether to force easing in

EaseOut(bool)

Eases out, heading towards the minValue.

public void EaseOut(bool force = false)

Parameters

force bool

Whether to force easing in

OnEaseIn()

Runs when easing in has finished.

protected virtual void OnEaseIn()

OnEaseOut()

Runs when easing out has finished.

protected virtual void OnEaseOut()

OnEnd()

Runs when this behaviour finishes easing in/out.

protected override void OnEnd()

OnIter(float)

Runs on each iteration of easing.

protected override void OnIter(float time)

Parameters

time float

The current value of the internal timer

SetEaseFunction(Func<float, float>)

Sets the easing function this behaviour will use.

The easing function must accept a float between 0 and 1 (inclusive).

The function must also return a float between 0 and 1 (inclusive).

Providing an easeFunction of null is equivalent to using a linear easing function.

public void SetEaseFunction(Func<float, float> easeFunction)

Parameters

easeFunction Func<float, float>

The ease function to use

_SetValue(float)

Sets the current value.

This is clamped between minValue and maxValue.

This is called in OnIter(float) to update the current easing value.

protected virtual void _SetValue(float value)

Parameters

value float

The value to set

_SetValues(float, float)

Sets the minimum and maximum values to ease between.

protected void _SetValues(float minValue, float maxValue)

Parameters

minValue float

The minimum value to use

maxValue float

The maximum value to use