animatedledstrip.leds.ColorContainer.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of animatedledstrip-kotlin-pi Show documentation
Library for using the AnimatedLEDStrip library on Raspberry Pis.
There is a newer version: 0.3
Show newest version
package animatedledstrip.leds

/*
 *  Copyright (c) 2019 AnimatedLEDStrip
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in
 *  all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 *  THE SOFTWARE.
 */


import javafx.scene.paint.Color


/**
 * A class used to hold a color value.
 *
 * @param r The red intensity
 * @param g The green intensity
 * @param b The blue intensity
 */
open class ColorContainer(var r: Int, var g: Int, var b: Int) {

    /**
     * Constructor for ColorContainer that extracts r, g and b from a Long.
     *
     * @param hexIn The integer representation of the color's RGB
     */
    constructor(hexIn: Long) : this(
        (hexIn and 0xFF0000 shr 16).toInt(),
        (hexIn and 0x00FF00 shr 8).toInt(),
        (hexIn and 0x0000FF).toInt()
    )


    /**
     * Returns a Long containing the RGB data held by this ColorContainer.
     * Color can also be set using a Long via this property.
     */
    var hex: Long
        get() {
            return (r shl 16).toLong() or (g shl 8).toLong() or b.toLong()
        }
        set(hexIn) {
            setRGB(
                (hexIn and 0xFF0000 shr 16).toInt(),
                (hexIn and 0x00FF00 shr 8).toInt(),
                (hexIn and 0x0000FF).toInt()
            )
        }

    /**
     * Returns a hexadecimal string representation (without a 0x) of the color held
     * by this ColorContainer.
     */
    var hexString = hex.toString(16)

    /**
     * Set the color held by this ColorContainer using individual r, g, b values.
     * @param rIn Red intensity
     * @param gIn Green intensity
     * @param bIn Blue intensity
     */
    fun setRGB(rIn: Int, gIn: Int, bIn: Int) {
        r = rIn
        g = gIn
        b = bIn
    }

    @Deprecated("Use hex property instead", ReplaceWith("hex"))
    fun setRGBFromHex(hexIn: Long) {
        setRGB((hexIn and 0xFF0000 shr 16).toInt(), (hexIn and 0x00FF00 shr 8).toInt(), (hexIn and 0x0000FF).toInt())
    }

    @Deprecated("Use hex property instead", ReplaceWith("hex"))
    fun getColorHex() = hex

    /**
     * Returns the color held by this ColorContainer as a JavaFX Color
     */
    fun toColor(): Color = Color.color((hex shr 16 and 0xFF) / 255.0, (hex shr 8 and 0xFF) / 255.0, (hex and 0xFF) / 255.0)

    /**
     * Returns a ColorContainer with the inverse of the color held by this ColorContainer
     */
    fun invert() = ColorContainer(255 - this.r, 255 - this.g, 255 - this.b)

    /**
     * Returns the average of r, g, b
     */
    fun grayscale() = ((r + g + b) / 3).toLong()

}