animatedledstrip-core/animatedledstrip.leds.animationmanagement/AnimationToRunParams

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

Constructors

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

Properties

animation

var animation: String

Name of the animation

colors

var colors: MutableList<ColorContainerInterface>

The list of ColorContainers to use

distanceParams

var distanceParams: MutableMap<String, Distance>

A map of Distance parameters for the animation

doubleParams

var doubleParams: MutableMap<String, Double>

A map of double parameters for the animation

equationParams

var equationParams: MutableMap<String, Equation>

A map of Equation parameters for the animation

var id: String

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

intParams

var intParams: MutableMap<String, Int>

A map of integer parameters for the animation

locationParams

var locationParams: MutableMap<String, Location>

A map of Location parameters for the animation

rotationParams

var rotationParams: MutableMap<String, Rotation>

A map of Rotation parameters for the animation

runCount

var runCount: Int

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

section

var 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). This is the section that ColorContainer blend preparation will be based upon. An empty string means the whole strip.

stringParams

var stringParams: MutableMap<String, String>

A map of string parameters for the animation