animatedledstrip-core/animatedledstrip.animations/Animation/AnimationInfo

AnimationInfo

data class AnimationInfo(val name: String, val abbr: String, val description: String, val runCountDefault: Int, val minimumColors: Int, val unlimitedColors: Boolean, val dimensionality: Set<Dimensionality>, val intParams: List<AnimationParameter<Int>> = listOf(), val doubleParams: List<AnimationParameter<Double>> = listOf(), val stringParams: List<AnimationParameter<String>> = listOf(), val locationParams: List<AnimationParameter<Location>> = listOf(), val distanceParams: List<AnimationParameter<Distance>> = listOf(), val rotationParams: List<AnimationParameter<Rotation>> = listOf(), val equationParams: List<AnimationParameter<Equation>> = listOf()) : SendableData

Stores information about an animation.

Constructors

AnimationInfo

constructor(name: String, abbr: String, description: String, runCountDefault: Int, minimumColors: Int, unlimitedColors: Boolean, dimensionality: Set<Dimensionality>, intParams: List<AnimationParameter<Int>> = listOf(), doubleParams: List<AnimationParameter<Double>> = listOf(), stringParams: List<AnimationParameter<String>> = listOf(), locationParams: List<AnimationParameter<Location>> = listOf(), distanceParams: List<AnimationParameter<Distance>> = listOf(), rotationParams: List<AnimationParameter<Rotation>> = listOf(), equationParams: List<AnimationParameter<Equation>> = listOf())

Properties

abbr

val abbr: String

The abbreviation that can be used to identify the animation

description

val description: String

A description of the animation

dimensionality

val dimensionality: Set<Dimensionality>

distanceParams

val distanceParams: List<AnimationParameter<Distance>>

A list of Distance parameters the animation uses (note that default values are percentages of the strip span in that dimension, not the full distance)

doubleParams

val doubleParams: List<AnimationParameter<Double>>

A list of double parameters the animation uses

equationParams

val equationParams: List<AnimationParameter<Equation>>

A list of Equation parameters the animation uses

intParams

val intParams: List<AnimationParameter<Int>>

A list of integer parameters the animation uses

locationParams

val locationParams: List<AnimationParameter<Location>>

A list of Location parameters the animation uses

minimumColors

val minimumColors: Int

The number of required colors for this animation

name

val name: String

The name used to identify this animation

rotationParams

val rotationParams: List<AnimationParameter<Rotation>>

runCountDefault

val runCountDefault: Int

Default value for the runCount parameter

stringParams

val stringParams: List<AnimationParameter<String>>

unlimitedColors

val unlimitedColors: Boolean

Can this animation take an unlimited number of colors

Functions

json

open fun json(): ByteArray

jsonString

open fun jsonString(): String

jsonStringWithDelimiter

open fun jsonStringWithDelimiter(): String

jsonWithDelimiter

open fun jsonWithDelimiter(): ByteArray