API ReferenceSandbox.Utility

Easingclass

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

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

Methods25

Showing 25 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 CubicIn(float f)PUBLICSTATIC

Cubic ease in.

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

public static float CubicInOut(float f)PUBLICSTATIC

Cubic ease in and out.

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

public static float CubicOut(float f)PUBLICSTATIC

Cubic ease out.

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

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

Methodspublic static System.Single BounceIn(System.Single f)public static System.Single BounceInOut(System.Single f)public static System.Single BounceOut(System.Single f)public static Sandbox.Utility.Easing.Function CubicBezier(System.Single x1, System.Single y1, System.Single x2, System.Single y2)public static System.Single CubicIn(System.Single f)public static System.Single CubicInOut(System.Single f)public static System.Single CubicOut(System.Single f)public static System.Single EaseIn(System.Single f)public static System.Single EaseInOut(System.Single f)public static System.Single EaseOut(System.Single f)public static System.Single ExpoIn(System.Single f)public static System.Single ExpoInOut(System.Single f)public static System.Single ExpoOut(System.Single f)public static Sandbox.Utility.Easing.Function GetFunction(System.String name)public static System.Single Linear(System.Single f)public static System.Single QuadraticIn(System.Single f)public static System.Single QuadraticInOut(System.Single f)public static System.Single QuadraticOut(System.Single f)public static System.Single SineEaseIn(System.Single f)public static System.Single SineEaseInOut(System.Single f)public static System.Single SineEaseOut(System.Single f)public static System.Single StepEnd(System.Single f)public static Sandbox.Utility.Easing.Function Steps(System.Int32 count, System.Boolean atStart = False)public static System.Single StepStart(System.Single f)public static System.Boolean TryGetFunction(System.String name, Sandbox.Utility.Easing.Function function)Metadata