plCurveFunction Struct Reference

Available procedural curve generators. More...

#include <CurveFunctions.h>

Inheritance diagram for plCurveFunction:

Public Types
enum	Enum {   Linear , ConstantZero , ConstantOne , EaseInSine ,   EaseOutSine , EaseInOutSine , EaseInQuad , EaseOutQuad ,   EaseInOutQuad , EaseInCubic , EaseOutCubic , EaseInOutCubic ,   EaseInQuartic , EaseOutQuartic , EaseInOutQuartic , EaseInQuintic ,   EaseOutQuintic , EaseInOutQuintic , EaseInExpo , EaseOutExpo ,   EaseInOutExpo , EaseInCirc , EaseOutCirc , EaseInOutCirc ,   EaseInBack , EaseOutBack , EaseInOutBack , EaseInElastic ,   EaseOutElastic , EaseInOutElastic , EaseInBounce , EaseOutBounce ,   EaseInOutBounce , Conical , FadeInHoldFadeOut , FadeInFadeOut ,   Bell , ENUM_COUNT , Default = Linear }
using	StorageType = plUInt8

Static Public Member Functions
static double	GetValue (Enum function, double x)
	Helper function that returns the function value at the given x coordinate.
static double	GetValue (Enum function, double x, bool bInverse)
	Helper function that returns the function value at the given x coordinate.

Detailed Description

Available procedural curve generators.

The easing function types are adapted from https://easings.net. Visit that page for a preview.

Types:

• EaseIn: Indicates a slow transition from the zero strength to full strength.
• EaseOut: Indicates a fast transition from the zero strength to full strength.
• EaseInOut: A transition from zero to one that starts out slow, continues fast in the middle and finishes slow again.

Member Enumeration Documentation

Enum

enum plCurveFunction::Enum

Enumerator
EaseInBack	Values exceed the 0-1 range briefly.
EaseOutBack	Values exceed the 0-1 range briefly.
EaseInOutBack	Values exceed the 0-1 range briefly.
EaseInElastic	Values exceed the 0-1 range briefly.
EaseOutElastic	Values exceed the 0-1 range briefly.
EaseInOutElastic	Values exceed the 0-1 range briefly.

Member Function Documentation

GetValue()

double plCurveFunction::GetValue ( Enum function, double x, bool bInverse )

inlinestatic

Helper function that returns the function value at the given x coordinate.

If inverse is true, the value (1-Y) is returned.

---

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

• Code/Engine/Foundation/Math/CurveFunctions.h
• Code/Engine/Foundation/Math/Implementation/CurveFunctions_inl.h