xiiEasingFunction Struct Reference

Available Procedural Curve Generators. More...

#include <Easing.h>

Inheritance diagram for xiiEasingFunction:

Public Types
enum	Enum : StorageType {   ConstantZero , ConstantQuarter , ConstantHalf , ConstantThreeFourths ,   ConstantOne , InLinear , OutLinear , InOutLinear ,   InSine , OutSine , InOutSine , InQuad ,   OutQuad , InOutQuad , InCubic , OutCubic ,   InOutCubic , InQuartic , OutQuartic , InOutQuartic ,   InQuintic , OutQuintic , InOutQuintic , InExpo ,   OutExpo , InOutExpo , InCirc , OutCirc ,   InOutCirc , InBack , OutBack , InOutBack ,   InElastic , OutElastic , InOutElastic , InBounce ,   OutBounce , InOutBounce , Conical , FadeInHoldFadeOut ,   FadeInFadeOut , Bell , ENUM_COUNT , Default = InLinear }
using	StorageType = xiiUInt8

Static Public Member Functions
static double	GetValue (xiiEasingFunction::Enum function, double fInput)
	Helper function that returns the function value at the given input.
static double	GetValue (xiiEasingFunction::Enum function, double fInput, bool bInverse)
	Helper function that returns the function value at the given input.

Detailed Description

Available Procedural Curve Generators.

Supported easing function types adapted from https://easings.net. To view some of these in action, please visit the above mentioned source link.

Types:

• EaseIn: Indicates a transition from the zero strength to full strength.
• EaseOut: Indicates a transition from full strength to zero strength.
• EaseInOut: Indicates a transition from zero strength to full strength halfway, then a transition back to zero strength.
• EaseOutIn: Indicates a transition from full strength to zero strength halfway, then a transition back to full strength.

Member Enumeration Documentation

Enum

enum xiiEasingFunction::Enum : StorageType

Enumerator
InBack	Values exceed the 0-1 range briefly.
OutBack	Values exceed the 0-1 range briefly.
InOutBack	Values exceed the 0-1 range briefly.
InElastic	Values exceed the 0-1 range briefly.
OutElastic	Values exceed the 0-1 range briefly.
InOutElastic	Values exceed the 0-1 range briefly.

Member Function Documentation

GetValue()

double xiiEasingFunction::GetValue ( xiiEasingFunction::Enum function, double fInput, bool bInverse )

inlinestatic

Helper function that returns the function value at the given input.

if inverse is true, the value (1 - result) is returned.

---

The documentation for this struct was generated from the following files:

• /home/runner/work/XII/XII/Source/Engine/Foundation/Math/Easing.h
• /home/runner/work/XII/XII/Source/Engine/Foundation/Math/Implementation/Easing_inl.h