Package arc.flabel

Class FEffect

java.lang.Object
arc.flabel.FEffect
Direct Known Subclasses:
BlinkEffect, EaseEffect, FadeEffect, GradientEffect, JumpEffect, RainbowEffect, ShakeEffect, SickEffect, WaveEffect, WindEffect
public abstract class FEffect extends Object
Abstract text effect.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    float
    duration
     
    String
    endToken
     
    int
    indexEnd
     
    int
    indexStart
     
    protected float
    totalTime
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    FEffect()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    apply(FLabel label, FGlyph glyph, int glyphIndex, float delta)
    Applies the effect to the given glyph.
    protected float
    calculateFadeout()
    Calculates the fadeout of this effect, if any.
    protected float
    calculateProgress(float modifier)
    Calculates a linear progress dividing the total time by the given modifier.
    protected float
    calculateProgress(float modifier, float offset)
    Calculates a linear progress dividing the total time by the given modifier.
    protected float
    calculateProgress(float modifier, float offset, boolean pingpong)
    Calculates a linear progress dividing the total time by the given modifier.
    protected float
    getLineHeight(FLabel label)
    Returns the line height of the label controlling this effect.
    boolean
    isFinished()
    Returns whether or not this effect is finished and should be removed.
    protected abstract void
    onApply(FLabel label, FGlyph glyph, int localIndex, float delta)
    Called when this effect should be applied to the given glyph.
    void
    update(float delta)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • indexStart

      public int indexStart

    • indexEnd

      public int indexEnd

    • duration

      public float duration

    • endToken

      public String endToken

    • totalTime

      protected float totalTime

  • Constructor Details

    • FEffect

      public FEffect()

  • Method Details

    • update

      public void update(float delta)

    • apply

      public final void apply(FLabel label, FGlyph glyph, int glyphIndex, float delta)
      Applies the effect to the given glyph.

    • onApply

      protected abstract void onApply(FLabel label, FGlyph glyph, int localIndex, float delta)
      Called when this effect should be applied to the given glyph.

    • isFinished

      public boolean isFinished()
      Returns whether or not this effect is finished and should be removed. Note that effects are infinite by default.

    • calculateFadeout

      protected float calculateFadeout()
      Calculates the fadeout of this effect, if any. Only considers the second half of the duration.

    • calculateProgress

      protected float calculateProgress(float modifier)
      Calculates a linear progress dividing the total time by the given modifier. Returns a value between 0 and 1 that loops in a ping-pong mode.

    • calculateProgress

      protected float calculateProgress(float modifier, float offset)
      Calculates a linear progress dividing the total time by the given modifier. Returns a value between 0 and 1 that loops in a ping-pong mode.

    • calculateProgress

      protected float calculateProgress(float modifier, float offset, boolean pingpong)
      Calculates a linear progress dividing the total time by the given modifier. Returns a value between 0 and 1.

    • getLineHeight

      protected float getLineHeight(FLabel label)
      Returns the line height of the label controlling this effect.