animatedledstrip.leds.Direction.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.
 */

/**
 * Helper enum that determines if an animation should appear to move 'Forward'
 * or 'Backward'.
 *
 * The start of the LED strip is the end where the signal is connected (small
 * arrows on strip pointing away from it).
 * The end of the LED strip is the opposite end from the start (small arrows on
 * strip point towards it).
 */
enum class Direction {
    /**
     * Animation appears to move from the start to the end of the strip.
     */
    FORWARD,
    /**
     * Animation appears to move from the end to the start of the strip.
     */
    BACKWARD
}