animatedledstrip-core/animatedledstrip.leds.sectionmanagement/SectionManager

SectionManager

interface SectionManager

Manages sections and subsections of this section.

A section can run full animations while subsections are used to run subanimations.

Inheritors

LEDStripSectionManager

Section

Properties

name

abstract val name: String

The string used to identify this section

numLEDs

abstract val numLEDs: Int

The number of pixels in this section

pixelActualColorList

val SectionManager.pixelActualColorList: List<Int>

A list of the actual colors for the section

pixelFadeColorList

val SectionManager.pixelFadeColorList: List<Int>

A list of the fade colors for the section

pixelIndices

abstract val pixelIndices: List<Int>

A list of the indices of the pixels in this section (range from 0 to numLEDs - 1)

pixelProlongedColorList

val SectionManager.pixelProlongedColorList: List<Int>

A list of the prolonged colors for the section

pixels

abstract val pixels: List<Int>

A list of all pixels included in this section

pixelTemporaryColorList

val SectionManager.pixelTemporaryColorList: List<Int>

A list of the temporary colors for the section

sections

abstract val sections: MutableMap<String, Section>

The sections managed by this section manager

stripManager

abstract val stripManager: LEDStrip

The strip manager this section manager is managing sections for

subSections

abstract val subSections: MutableMap<Int, Section>

The subsections managed by this section manager

Functions

clear

fun SectionManager.clear()

Clear the section (set all pixels to 0)

createSection

open fun createSection(section: Section): Section

open fun createSection(name: String, pixels: List<Int>, parentSectionName: String = ""): Section

open fun createSection(name: String, startPixel: Int, endPixel: Int, parentSectionName: String = ""): Section

getPhysicalIndex

abstract fun getPhysicalIndex(pixel: Int): Int

Get the appropriate index on the full strip for the specified pixel

getPixelActualColor

fun SectionManager.getPixelActualColor(pixel: Int): Int

getPixelActualColorOrNull

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

getPixelFadeColor

fun SectionManager.getPixelFadeColor(pixel: Int): Int

getPixelFadeColorOrNull

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

getPixelProlongedColor

fun SectionManager.getPixelProlongedColor(pixel: Int): Int

getPixelProlongedColorOrNull

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

getPixelTemporaryColor

fun SectionManager.getPixelTemporaryColor(pixel: Int): Int

getPixelTemporaryColorOrNull

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

getSection

abstract fun getSection(sectionName: String): Section

Get the section specified by sectionName. If it doesn't exist, return this section.

getSectionOrNull

open fun getSectionOrNull(sectionName: String): Section?

getSubSection

open fun getSubSection(pixels: List<Int>): Section

open fun getSubSection(startPixel: Int, endPixel: Int): Section

revertPixel

fun SectionManager.revertPixel(pixel: Int)

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

revertPixels

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

fun SectionManager.revertPixels(pixels: IntRange)

Revert multiple pixels' color (reset their temporary colors)

setPixelFadeColor

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

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

Set a pixel's fade color

setPixelFadeColors

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

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

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

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

Set multiple pixels' fade color

setPixelProlongedColor

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

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

Set a pixel's prolonged color

setPixelProlongedColors

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

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

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

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

Set multiple pixels' prolonged color

setPixelTemporaryColor

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

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

Set a pixel's temporary color

setPixelTemporaryColors

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

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

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

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

Set multiple pixels' temporary color

setStripFadeColor

fun SectionManager.setStripFadeColor(color: PreparedColorContainer)

fun SectionManager.setStripFadeColor(color: Int)

Set the section's fade color

setStripProlongedColor

fun SectionManager.setStripProlongedColor(color: PreparedColorContainer)

fun SectionManager.setStripProlongedColor(color: Int)

Set the section's prolonged color

setStripTemporaryColor

fun SectionManager.setStripTemporaryColor(color: PreparedColorContainer)

fun SectionManager.setStripTemporaryColor(color: Int)

Set the section's temporary color