animatedledstrip-core/animatedledstrip.leds.animationmanagement

Package-level declarations

Types

AnimationManager

interface AnimationManager

Represents an instance that can run animations on a specific section of a strip

AnimationToRunParams

data class AnimationToRunParams(var animation: String = "", var colors: MutableList<ColorContainerInterface> = mutableListOf(), var id: String = "", var section: String = "", var runCount: Int = 0, var intParams: MutableMap<String, Int> = mutableMapOf(), var doubleParams: MutableMap<String, Double> = mutableMapOf(), var stringParams: MutableMap<String, String> = mutableMapOf(), var locationParams: MutableMap<String, Location> = mutableMapOf(), var distanceParams: MutableMap<String, Distance> = mutableMapOf(), var rotationParams: MutableMap<String, Rotation> = mutableMapOf(), var equationParams: MutableMap<String, Equation> = mutableMapOf()) : SendableData

Describes the properties of an animation to run

data class EndAnimation(val id: String = "") : SendableData

Communicates that an animation should end or is ending

LEDStripAnimationManager

class LEDStripAnimationManager(val sectionManager: SectionManager) : AnimationManager

Manages animations running on the entire strip and is the parent manager to all animations

PixelModificationLists

data class PixelModificationLists(setLists: List<List<Int>>, revertLists: List<List<Int>>)

A list of PixelsToModify for an animation. A separate class was created so it can be saved in a map without worrying about type erasure and so the PixelsToModify instances can be created easily.

data class PixelsToModify(val allSetPixels: List<Int>, val allRevertPixels: List<Int>)

Contains lists of pixels so the animation knows what pixels to set and revert during this iteration.

RunningAnimation

data class RunningAnimation(val params: RunningAnimationParams, val animationScope: <Error class: unknown class>, val sectionManager: SectionManager, val parentManager: AnimationManager, val topLevelAnimation: Boolean = false, var paused: Boolean = false) : AnimationManager

Tracks a currently running animation

RunningAnimationParams

data class RunningAnimationParams : SendableData

Describes the properties of a currently running animation

SubAnimationToRunParams

data class SubAnimationToRunParams(val animationParams: AnimationToRunParams, val scope: <Error class: unknown class>, val section: SectionManager, val runCount: Int = 1)

Properties

val AnimationManager.numLEDs: Int

The number of LEDs in the section that corresponds with this animation manager

val AnimationManager.pixelIndices: List<Int>

A list of all valid indices for the section that corresponds with this animation manager

Functions

fun AnimationToRunParams.addColor(color: ColorContainerInterface): AnimationToRunParams

fun AnimationToRunParams.addColor(color: Int): AnimationToRunParams

fun AnimationToRunParams.addColor(color: Long): AnimationToRunParams

fun AnimationToRunParams.addColor(color: String): AnimationToRunParams

Append a color to the end of colors

fun AnimationToRunParams.addColors(vararg colors: ColorContainerInterface): AnimationToRunParams

fun AnimationToRunParams.addColors(vararg colors: String): AnimationToRunParams

fun AnimationToRunParams.addColors(vararg colors: Int): AnimationToRunParams

fun AnimationToRunParams.addColors(vararg colors: Long): AnimationToRunParams

fun AnimationToRunParams.addColors(colors: List<*>): AnimationToRunParams

Append multiple colors to the end of colors

addNewAnimation

fun LEDStrip.addNewAnimation(anim: Animation): Animation?

Add a new animation to the list of supported animations

fun LEDStrip.addNewGroup(anim: AnimationGroup.NewAnimationGroupInfo): AnimationGroup?

Add a new animation group to the list of supported animations

fun AnimationToRunParams.animation(animation: String): AnimationToRunParams

Sets the animation parameter.

fun AnimationToRunParams.color(color: Any, index: Int = 0): AnimationToRunParams

Set a color using a ColorContainer, hex String, or Int or Long in range(0..0xFFFFFF), along with the index of the color

fun AnimationToRunParams.color0(color: Any): AnimationToRunParams

Set colors[0]

fun AnimationToRunParams.color1(color: Any): AnimationToRunParams

Set colors[1]

fun AnimationToRunParams.color2(color: Any): AnimationToRunParams

Set colors[2]

fun AnimationToRunParams.color3(color: Any): AnimationToRunParams

Set colors[3]

fun AnimationToRunParams.color4(color: Any): AnimationToRunParams

Set colors[4]

fun AnimationToRunParams.distanceParam(key: String, value: Distance): AnimationToRunParams

fun AnimationToRunParams.doubleParam(key: String, value: Double): AnimationToRunParams

fun AnimationToRunParams.endAnimation(): EndAnimation

fun RunningAnimationParams.endAnimation(): EndAnimation

fun AnimationManager.endAnimation(endAnimation: EndAnimation)

fun AnimationManager.endAnimation(id: String)

End a currently running animation

fun AnimationToRunParams.equationParam(key: String, value: Equation): AnimationToRunParams

fun Section.findAnimation(animId: String): Animation

findAnimationOrNull

fun Section.findAnimationOrNull(animId: String): Animation?

fun AnimationToRunParams.id(id: String): AnimationToRunParams

Set the id parameter.

fun AnimationToRunParams.intParam(key: String, value: Int): AnimationToRunParams

inline fun iterateOver(indices: List<Int>, operation: (Int) -> Unit)

Iterate over indices given in a list

inline fun iterateOver(indices: IntProgression, operation: (Int) -> Unit)

Iterate over a range of indices

iterateOverPixels

inline fun AnimationManager.iterateOverPixels(operation: (Int) -> Unit)

Iterate over each pixel, performing operation on each index

iterateOverPixelsReverse

inline fun AnimationManager.iterateOverPixelsReverse(operation: (Int) -> Unit)

Iterate over each pixel in reverse, performing operation on each index

fun AnimationToRunParams.locationParam(key: String, value: Location): AnimationToRunParams

fun randomDouble(): Double

fun AnimationManager.randomIndex(): Int

fun randomInt(): Int

removeWhitespace

fun String.removeWhitespace(): String

Remove whitespace from a String

fun AnimationToRunParams.rotationParam(key: String, value: Rotation): AnimationToRunParams

fun AnimationToRunParams.runCount(runs: Int): AnimationToRunParams

fun AnimationManager.runParallel(params: SubAnimationToRunParams): RunningAnimation

Run a new subanimation in a child coroutine

runParallelAndJoin

suspend fun AnimationManager.runParallelAndJoin(vararg animations: SubAnimationToRunParams)

Run many new subanimations in child coroutines and wait for all to complete before returning

suspend fun AnimationManager.runSequential(params: SubAnimationToRunParams)

Run a new animation in a child coroutine and wait for it to complete before returning

fun AnimationToRunParams.section(sectionId: String): AnimationToRunParams

Set the section parameter.

shuffledIndices

fun AnimationManager.shuffledIndices(): List<Int>

fun AnimationManager.startAnimation(params: AnimationToRunParams, animId: String? = null): RunningAnimation

Start running a new animation

fun AnimationToRunParams.stringParam(key: String, value: String): AnimationToRunParams