API ReferenceSandbox.Utility

Easingclass

Easing functions used for transitions. See https://easings.net/ for examples.

objectEasing
Namespace
Sandbox.Utility
Assembly
Sandbox.System
Declaration
public static abstract sealed class Sandbox.Utility.Easing

Methods22

Showing 22 methods

public static float BounceIn(float f)PUBLICSTATIC

Bouncy ease in.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static float BounceInOut(float f)PUBLICSTATIC

Bouncy ease in and out.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static float BounceOut(float f)PUBLICSTATIC

Bouncy ease out.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static Sandbox.Utility.Easing.Function CubicBezier(float x1, float y1, float x2, float y2)PUBLICSTATIC

Cubic bezier easing with control points (x1,y1) and (x2,y2). The curve runs from (0,0) to (1,1). Matches the CSS `cubic-bezier(x1, y1, x2, y2)` timing function.

ParameterTypeDescription
x1float
y1float
x2float
y2float
Returns:Function

public static float EaseIn(float f)PUBLICSTATIC

ParameterTypeDescription
ffloat
Returns:float

public static float EaseInOut(float f)PUBLICSTATIC

ParameterTypeDescription
ffloat
Returns:float

public static float EaseOut(float f)PUBLICSTATIC

ParameterTypeDescription
ffloat
Returns:float

public static float ExpoIn(float f)PUBLICSTATIC

Exponential ease in.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static float ExpoInOut(float f)PUBLICSTATIC

Exponential ease in and out.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static float ExpoOut(float f)PUBLICSTATIC

Exponential ease out.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static Sandbox.Utility.Easing.Function GetFunction(string name)PUBLICSTATIC

Get an easing function by name (ie, "ease-in", "cubic-bezier(0.1, 0.7, 1, 0.1)" or "steps(4, end)"). If the function doesn't exist we return QuadraticInOut

ParameterTypeDescription
namestring
Returns:Function

public static float Linear(float f)PUBLICSTATIC

Linear easing function, x=y.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static float QuadraticIn(float f)PUBLICSTATIC

Quadratic ease in.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static float QuadraticInOut(float f)PUBLICSTATIC

Quadratic ease in and out.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static float QuadraticOut(float f)PUBLICSTATIC

Quadratic ease out.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static float SineEaseIn(float f)PUBLICSTATIC

Sine ease in.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static float SineEaseInOut(float f)PUBLICSTATIC

Sine ease in and out.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static float SineEaseOut(float f)PUBLICSTATIC

Sine ease out.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static float StepEnd(float f)PUBLICSTATIC

Stays at 0 until the animation ends, then jumps to 1.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static Sandbox.Utility.Easing.Function Steps(int count, bool atStart = False)PUBLICSTATIC

Stepped easing with `count` equal-sized jumps. When `atStart` is true the jump happens at the start of each step, otherwise it happens at the end. Matches the CSS `steps(n, start|end)` timing function.

ParameterTypeDescription
countint
atStart = Falsebool
Returns:Function

public static float StepStart(float f)PUBLICSTATIC

Jumps straight to 1 the moment the animation starts.

ParameterTypeDescription
ffloatInput in range of 0 to 1.
Returns:floatOutput in range 0 to 1.

public static bool TryGetFunction(string name, Sandbox.Utility.Easing.Function function)PUBLICSTATIC

Get an easing function by name (ie, "ease-in", "cubic-bezier(0.1, 0.7, 1, 0.1)" or "steps(4, end)"). If the function exists we return true, otherwise return false.

ParameterTypeDescription
namestring
functionFunction
Returns:bool

On this page