animatedledstrip-core/animatedledstrip.animations.groups/AnimationGroup

AnimationGroup

class AnimationGroup(val info: Animation.AnimationInfo, val groupType: GroupType, val animationList: List<String>) : Animation, SendableData

Represents a group of animations that can be run

Constructors

constructor(info: Animation.AnimationInfo, groupType: GroupType, animationList: List<String>)

Types

NewAnimationGroupInfo

data class NewAnimationGroupInfo(val groupType: GroupType, val groupInfo: Animation.AnimationInfo, val animationList: List<String>) : SendableData

Stores information about a new animation group to create

Properties

val animationList: List<String>

The list of animations to run

val groupType: GroupType

Identifies how the animations will be run

open override val info: Animation.AnimationInfo

Information about the group

Functions

open fun json(): ByteArray

open fun jsonString(): String

jsonStringWithDelimiter

open fun jsonStringWithDelimiter(): String

jsonWithDelimiter

open fun jsonWithDelimiter(): ByteArray

open suspend override fun runAnimation(leds: AnimationManager, params: RunningAnimationParams, scope: <Error class: unknown class>)

Run the animation, passing it the AnimationManager running it, parameters specifying how to run the animation, and the CoroutineScope the animation is running in