ktvn/com.github.benpollarduk.ktvn.text.sequencing/GridTextSequencer

GridTextSequencer

class GridTextSequencer(var msBetweenCharacters: Long, listener: (characters: List<CharacterPosition>) -> Unit) : TextSequencer

Provides a TextSequencer that is time based and dispatches lists of CharacterPosition for a grid based arrangement. At each step of the sequence a list of CharacterPosition will be dispatched to the listener. The delay between characters must be specified, in milliseconds, with msBetweenCharacters. A listener must be provided.

Constructors

Link copied to clipboard
constructor(msBetweenCharacters: Long, listener: (characters: List<CharacterPosition>) -> Unit)

Properties

Link copied to clipboard
open override var msBetweenCharacters: Long

Get or set the delay between characters, in milliseconds.

Link copied to clipboard
open override val sequencing: Boolean

Get if sequencing is currently running.

Functions

Link copied to clipboard
open override fun cancel()

Cancel all sequencing.

Link copied to clipboard
open override fun requestAll()

Request all characters now.

Link copied to clipboard
open override fun sequence(frame: TextFrame)

Start sequencing characters for a specified frame.