kotter/com.varabyte.kotter.foundation.anim/TextAnim

TextAnim

An Anim that renders some text, which gets updated on each new frame.

To reference a text animation, just convert it to a string inside a Section.

Using one looks like this:

session {
  val waitingAnim = textAnimOf(listOf("", ".", "..", "..."), frameDuration = 250.milliseconds)
  section {
    text("Thinking$waitingAnim")
  }.runUntilSignal { ... }
}

Types

Template

class Template(val frames: List<String>, val frameDuration: Duration, val looping: Boolean = true)

A template for a text animation, useful if you want to define an animation once but instantiate several copies of it throughout your program.

Properties

currFrame

var currFrame: Int

Manually set the current frame (0-indexed) that this animation should display.

isRunning

val isRunning: Boolean

Returns whether this animation is currently active or not.

lastFrame

val lastFrame: Int

The last frame (0 -indexed) in this animation.

numFrames

val numFrames: Int

How many frames this animation has.

paused

var paused: Boolean

Whether this animation is paused or not.

totalDuration

val totalDuration: Duration

The total duration of this animation if all frames are played once.

Functions

toString

open override fun toString(): String

Returns the current frame of text.