animatedledstrip-core/animatedledstrip.leds.animationmanagement/RunningAnimationParams

RunningAnimationParams

data class RunningAnimationParams : SendableData

Describes the properties of a currently running animation

Constructors

RunningAnimationParams

constructor(animation: Animation, animationName: String, colors: List<PreparedColorContainer>, id: String, section: String, runCount: Int, intParams: Map<String, Int>, doubleParams: Map<String, Double>, stringParams: Map<String, String>, locationParams: Map<String, Location>, distanceParams: Map<String, AbsoluteDistance>, rotationParams: Map<String, RadiansRotation>, equationParams: Map<String, Equation>, sourceParams: AnimationToRunParams)

Constructor so we can have the animation parameter but not include it in serialization

Properties

lateinit var animation: Animation

The animation being run

val animationName: String

The name of the animation being run

val colors: List<PreparedColorContainer>

The list of PreparedColorContainers used

val distanceParams: Map<String, AbsoluteDistance>

A map of Distance parameters for the animation

val doubleParams: Map<String, Double>

A map of double parameters for the animation

val equationParams: Map<String, Equation>

A map of Equation parameters for the animation

val extraData: <Error class: unknown class>

A map used internally by animations to communicate between runs of the animation (see Alternate or Cat Toy)

ID for the animation. Used by server and clients to identify a specific animation.

val intParams: Map<String, Int>

A map of integer parameters for the animation

val locationParams: Map<String, Location>

A map of Location parameters for the animation

val rotationParams: Map<String, RadiansRotation>

A map of Rotation parameters for the animation

val runCount: Int

The number of times the animation should be run. -1 means until stopped.

val section: String

The id of the section of the strip that will be running the whole animation (not necessarily the section running this animation, such as if this is a subanimation). An empty string means the whole strip.

val sourceParams: AnimationToRunParams

The AnimationToRunParams instance that created this RunningAnimationParams

val stringParams: Map<String, String>

A map of string parameters for the animation

Functions

fun RunningAnimationParams.endAnimation(): EndAnimation

open fun json(): ByteArray

open fun jsonString(): String

jsonStringWithDelimiter

open fun jsonStringWithDelimiter(): String

jsonWithDelimiter

open fun jsonWithDelimiter(): ByteArray

fun RunningAnimationParams.randomColor(): PreparedColorContainer

withModifications

fun withModifications(animation: String = this.animationName, colors: List<ColorContainerInterface> = this.colors, id: String = this.id, section: String = this.section, runCount: Int = this.runCount, intParamMods: Map<String, Int> = mapOf(), doubleParamMods: Map<String, Double> = mapOf(), stringParamMods: Map<String, String> = mapOf(), locationParamMods: Map<String, Location> = mapOf(), distanceParamMods: Map<String, Distance> = mapOf(), rotationParamMods: Map<String, Rotation> = mapOf(), equationParamMods: Map<String, Equation> = mapOf()): AnimationToRunParams

Create a new AnimationToRunParams instance with the values in this RunningAnimationParams, unless if specified otherwise