Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: Interpolators

[18:14] static extends: object

Helper for FXGL's Interpolators enum, which catalogs the easing curves used by AnimationBuilder.interpolator. Each constant (LINEAR, EASE_IN, EASE_OUT, EASE_IN_OUT, EXPONENTIAL, BOUNCE, BACK, ELASTIC, CIRCULAR, etc.) carries the EASE_IN / EASE_OUT / EASE_IN_OUT direction modifiers. Use Interpolators.get(Name) for the raw enum value and Interpolators.easeIn / easeOut / easeInOut to pull the concrete Interpolator instance the builder accepts.

Methods

  • get (string Name)

    Resolves an Interpolators enum value by name.

    • @p Name is the constant name (e.g. "LINEAR", "EASE_OUT", "BOUNCE").
    • @r An AussomJavaObject wrapping the Interpolators value.
  • easeIn (string Name)

    Returns the EASE_IN interpolator for the named family.

    • @p Name is the family name (LINEAR, EASE, EXPONENTIAL, etc.).
    • @r An AussomJavaObject wrapping a javafx.animation.Interpolator.
  • easeOut (string Name)

    Returns the EASE_OUT interpolator for the named family.

    • @p Name is the family name.
    • @r An AussomJavaObject wrapping a javafx.animation.Interpolator.
  • easeInOut (string Name)

    Returns the EASE_IN_OUT interpolator for the named family.

    • @p Name is the family name.
    • @r An AussomJavaObject wrapping a javafx.animation.Interpolator.
  • values ()

    Returns every Interpolators enum constant as a Java array AJO. Iterate with .invoke("get", i) to discover available families.

    • @r An AussomJavaObject around Interpolators[].
  • valueOf (string Name)

    Standard Enum.valueOf — strict variant of get. Throws when Name does not match a constant.

    • @p Name is the constant name.
    • @r An AussomJavaObject wrapping the Interpolators value.