Skip to main content

Class Easing

Base class facilitating the implementation of easing functions.

Assembly: Dalamud.dll​
Declaration
public abstract class Easing

Derived:

Expand

Dalamud.Interface.Animation.EasingFunctions.InCirc, Dalamud.Interface.Animation.EasingFunctions.InCubic, Dalamud.Interface.Animation.EasingFunctions.InElastic, Dalamud.Interface.Animation.EasingFunctions.InOutCirc, Dalamud.Interface.Animation.EasingFunctions.InOutCubic, Dalamud.Interface.Animation.EasingFunctions.InOutElastic, Dalamud.Interface.Animation.EasingFunctions.InOutQuint, Dalamud.Interface.Animation.EasingFunctions.InOutSine, Dalamud.Interface.Animation.EasingFunctions.InQuint, Dalamud.Interface.Animation.EasingFunctions.InSine, Dalamud.Interface.Animation.EasingFunctions.OutCirc, Dalamud.Interface.Animation.EasingFunctions.OutCubic, Dalamud.Interface.Animation.EasingFunctions.OutElastic, Dalamud.Interface.Animation.EasingFunctions.OutQuint, Dalamud.Interface.Animation.EasingFunctions.OutSine

Properties​

Point1​

Gets or sets the origin point of the animation.

Declaration
public Vector2? Point1 { get; set; }

Point2​

Gets or sets the destination point of the animation.

Declaration
public Vector2? Point2 { get; set; }

EasedPoint​

Gets the resulting point at the current timestep.

Declaration
public Vector2 EasedPoint { get; }

IsInverse​

Gets or sets a value indicating whether the result of the easing should be inversed.

Declaration
public bool IsInverse { get; set; }

Value​

Gets the current value of the animation, following unclamped logic.

Declaration
[Obsolete("This field has been deprecated. Use either ValueClamped or ValueUnclamped instead.", true)]
public double Value { get; }

ValueClamped​

Gets the current value of the animation, from 0 to 1.

Declaration
public double ValueClamped { get; }

ValueUnclamped​

Gets or sets the current value of the animation, not limited to a range of 0 to 1. Will return numbers outside of this range if accessed beyond animation time.

Declaration
public double ValueUnclamped { get; protected set; }

Duration​

Gets or sets the duration of the animation.

Declaration
public TimeSpan Duration { get; set; }

IsRunning​

Gets a value indicating whether the animation is running.

Declaration
public bool IsRunning { get; }

IsDone​

Gets a value indicating whether the animation is done.

Declaration
public bool IsDone { get; }

Progress​

Gets the progress of the animation, from 0 to 1.

Declaration
protected double Progress { get; }

Methods​

Start()​

Starts the animation from where it was last stopped, or from the start if it was never started before.

Declaration
public void Start()

Stop()​

Stops the animation at the current point.

Declaration
public void Stop()

Restart()​

Restarts the animation.

Declaration
public void Restart()

Reset()​

Resets the animation.

Declaration
public void Reset()

Update()​

Updates the animation.

Declaration
public abstract void Update()