animatedledstrip-core/animatedledstrip.leds.stripmanagement/LEDStrip

LEDStrip

class LEDStrip(val stripInfo: StripInfo, val nativeLEDStrip: NativeLEDStrip)

Manages the managers that manage all aspects of the strip, from animations to sending colors to the strip to sections of the strip, etc.

Constructors

LEDStrip

constructor(stripInfo: StripInfo, nativeLEDStrip: NativeLEDStrip)

Properties

animationManager

val animationManager: LEDStripAnimationManager

Manages animations running on the strip

colorManager

val colorManager: LEDStripColorManager

Manages colors on the strip

endAnimationCallback

var endAnimationCallback: (RunningAnimationParams) -> Any??

Callback run after the last iteration of the animation (but before the animation is removed from animationManager.runningAnimations)

nativeLEDStrip

val nativeLEDStrip: NativeLEDStrip

The actual LED strip this instance is managing

newSectionCallback

var newSectionCallback: (Section) -> Any??

Callback to run when a new section is created

numLEDs

val numLEDs: Int

The number of pixels in this strip

pauseAnimationCallback

var pauseAnimationCallback: (RunningAnimationParams) -> Any??

Callback run when an animation is paused

pixelActualColorList

val LEDStrip.pixelActualColorList: List<Int>

A list of the actual colors for the strip

pixelFadeColorList

val LEDStrip.pixelFadeColorList: List<Int>

A list of the fade colors for the strip

pixelIndices

val pixelIndices: List<Int>

A list of the valid pixel indices in this strip

pixelLocationManager

val pixelLocationManager: PixelLocationManager

pixelProlongedColorList

val LEDStrip.pixelProlongedColorList: List<Int>

A list of the prolonged colors for the strip

pixelTemporaryColorList

val LEDStrip.pixelTemporaryColorList: List<Int>

A list of the temporary colors for the strip

renderer

val renderer: LEDStripRenderer

Manages rendering the colors on the strip

resumeAnimationCallback

var resumeAnimationCallback: (RunningAnimationParams) -> Any??

Callback run when an animation is resumed

sectionManager

val sectionManager: LEDStripSectionManager

Manages strip sections

startAnimationCallback

var startAnimationCallback: (RunningAnimationParams) -> Any??

Callback run before the first iteration of the animation

stripInfo

val stripInfo: StripInfo

Information about this strip

Functions

addNewAnimation

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

Add a new animation to the list of supported animations

addNewGroup

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

Add a new animation group to the list of supported animations

clear

fun LEDStrip.clear()

Clear the strip (set all pixels to 0)

fun close()

currentStripColor

fun LEDStrip.currentStripColor(): CurrentStripColor

getPixelActualColor

fun LEDStrip.getPixelActualColor(pixel: Int): Int

getPixelActualColorOrNull

fun LEDStrip.getPixelActualColorOrNull(pixel: Int): Int?

getPixelFadeColor

fun LEDStrip.getPixelFadeColor(pixel: Int): Int

getPixelFadeColorOrNull

fun LEDStrip.getPixelFadeColorOrNull(pixel: Int): Int?

getPixelProlongedColor

fun LEDStrip.getPixelProlongedColor(pixel: Int): Int

getPixelProlongedColorOrNull

fun LEDStrip.getPixelProlongedColorOrNull(pixel: Int): Int?

getPixelTemporaryColor

fun LEDStrip.getPixelTemporaryColor(pixel: Int): Int

getPixelTemporaryColorOrNull

fun LEDStrip.getPixelTemporaryColorOrNull(pixel: Int): Int?

revertPixel

fun LEDStrip.revertPixel(pixel: Int)

Revert a pixel's color (reset its temporary color)

revertPixels

fun LEDStrip.revertPixels(pixels: List<Int>)

fun LEDStrip.revertPixels(pixels: IntRange)

Revert multiple pixels' color (reset their temporary colors)

setPixelFadeColor

fun LEDStrip.setPixelFadeColor(pixel: Int, color: PreparedColorContainer)

fun LEDStrip.setPixelFadeColor(pixel: Int, color: Int)

Set a pixel's fade color

setPixelFadeColors

fun LEDStrip.setPixelFadeColors(pixels: List<Int>, color: PreparedColorContainer)

Set multiple pixel's fade color

fun LEDStrip.setPixelFadeColors(pixels: List<Int>, color: Int)

fun LEDStrip.setPixelFadeColors(pixels: IntRange, color: PreparedColorContainer)

fun LEDStrip.setPixelFadeColors(pixels: IntRange, color: Int)

Set multiple pixels' fade color

setPixelProlongedColor

fun LEDStrip.setPixelProlongedColor(pixel: Int, color: PreparedColorContainer)

fun LEDStrip.setPixelProlongedColor(pixel: Int, color: Int)

Set a pixel's prolonged color

setPixelProlongedColors

fun LEDStrip.setPixelProlongedColors(pixels: List<Int>, color: PreparedColorContainer)

fun LEDStrip.setPixelProlongedColors(pixels: List<Int>, color: Int)

fun LEDStrip.setPixelProlongedColors(pixels: IntRange, color: PreparedColorContainer)

fun LEDStrip.setPixelProlongedColors(pixels: IntRange, color: Int)

Set multiple pixels' prolonged color

setPixelTemporaryColor

fun LEDStrip.setPixelTemporaryColor(pixel: Int, color: PreparedColorContainer)

fun LEDStrip.setPixelTemporaryColor(pixel: Int, color: Int)

Set a pixel's temporary color

setPixelTemporaryColors

fun LEDStrip.setPixelTemporaryColors(pixels: List<Int>, color: PreparedColorContainer)

fun LEDStrip.setPixelTemporaryColors(pixels: List<Int>, color: Int)

fun LEDStrip.setPixelTemporaryColors(pixels: IntRange, color: PreparedColorContainer)

fun LEDStrip.setPixelTemporaryColors(pixels: IntRange, color: Int)

Set multiple pixels' temporary color

setStripFadeColor

fun LEDStrip.setStripFadeColor(color: PreparedColorContainer)

fun LEDStrip.setStripFadeColor(color: Int)

Set the strip's fade color

setStripProlongedColor

fun LEDStrip.setStripProlongedColor(color: PreparedColorContainer)

fun LEDStrip.setStripProlongedColor(color: Int)

Set the strip's prolonged color

setStripTemporaryColor

fun LEDStrip.setStripTemporaryColor(color: PreparedColorContainer)

fun LEDStrip.setStripTemporaryColor(color: Int)

Set the strip's temporary color