├── .github
    └── workflows
    │   └── build.yml
├── .gitignore
├── README.md
├── build.gradle
├── gradle
    └── wrapper
    │   ├── gradle-wrapper.jar
    │   └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── settings.gradle
└── src
    ├── main
        └── java
        │   └── me
        │       └── surge
        │           └── animation
        │               ├── Animation.kt
        │               ├── BoundedAnimation.kt
        │               ├── ColourAnimation.kt
        │               └── Easing.kt
    └── test
        └── java
            └── me
                └── surge
                    └── test
                        └── Main.kt


/.github/workflows/build.yml:
--------------------------------------------------------------------------------
 1 | name: Build Project
 2 | 
 3 | on: [push, pull_request]
 4 | 
 5 | jobs:
 6 |   build:
 7 |     runs-on: ubuntu-latest
 8 |     steps:
 9 |       - uses: actions/checkout@v2
10 | 
11 |       - name: JDK 1.8 Setup
12 |         uses: actions/setup-java@v1
13 |         with:
14 |           java-version: 1.8
15 | 
16 |       - name: Gradle Setup
17 |         uses: actions/cache@v2
18 |         with:
19 |           path: |
20 |             ~/.gradle/caches
21 |             ~/.gradle/wrapper
22 |           key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*','**/gradle-wrapper.properties') }}
23 |           restore-keys: |
24 |             ${{ runner.os }}-gradle-
25 |       - name: Gradle
26 |         run: chmod +x gradlew
27 | 
28 |       - name: Build client
29 |         run: ./gradlew build
30 | 
31 |       - uses: actions/upload-artifact@v2
32 |         with:
33 |           name: Package
34 |           path: build/libs/*.jar
35 | 
36 |       - name: Cleanup Gradle Cache
37 |         run: |
38 |           rm -rf ~/.gradle/caches/modules-2/modules-2.lock
39 |           rm -rf ~/.gradle/caches/modules-2/gc.properties


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Project exclude paths
2 | /.gradle/
3 | /build/
4 | /.idea/


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # AnimationSystem
 2 | Simple animation system written in Kotlin.
 3 | 
 4 | ## Add to projects
 5 | ### Gradle
 6 | 
 7 | ```gradle
 8 | repositories {
 9 |     maven { url 'https://jitpack.io' }
10 | }
11 | 
12 | dependencies {
13 |     implementation 'com.github.Wolfsurge:AnimationSystem:1.1'
14 | }
15 | ```
16 | 
17 | ### Maven
18 | ```xml
19 | <repositories>
20 |     <repository>
21 |         <id>jitpack.io</id>
22 |         <url>https://jitpack.io</url>
23 |     </repository>
24 | </repositories>
25 |   
26 | <dependencies>
27 |     <dependency>
28 |         <groupId>com.github.Wolfsurge</groupId>
29 |         <artifactId>AnimationSystem</artifactId>
30 |         <version>1.1</version>
31 |     </dependency>
32 | </dependencies>
33 | ```
34 | 
35 | ## Usage
36 | Create an animation object by instantiating the Animation class:
37 | 
38 | ```kotlin
39 | val animation: Animation = Animation( { 200f }, false, { Easing.LINEAR } )
40 | ```
41 | 
42 | The constructor takes in three parameters:<br>
43 | `length` A supplier that provides the length (duration) of the animation.<br>
44 | `initialState` A boolean that determines whether the animation should start expanded or closed.<br>
45 | `easing` A supplier that provides the easing we want to use for the animation.
46 | 
47 | You can set the state of the animation at any time, by simply setting the `state` variable.<br>
48 | ```kotlin
49 | animation.state = true
50 | ```
51 | 
52 | You can get the current value of the animation by calling `getAnimationFactor()`<br>
53 | This method returns a double between 0 and 1, representing the current progress of the animation.
54 | 
55 | When applying this, it should be used in a similar way to this:
56 | ```kotlin
57 | val y = 100.0 * animation.getAnimationFactor()
58 | ```
59 | 
60 | The `resetToDefault` method instantly resets the animation to its original state.
61 | 
62 | Need more help? Check out the src/test directory!
63 | 
64 | 
65 | 


--------------------------------------------------------------------------------
/build.gradle:
--------------------------------------------------------------------------------
 1 | plugins {
 2 |     id 'java'
 3 |     id 'maven-publish'
 4 |     id 'org.jetbrains.kotlin.jvm' version '1.7.10'
 5 | }
 6 | 
 7 | group 'me.surge'
 8 | version '1.11'
 9 | 
10 | sourceCompatibility = 1.8
11 | targetCompatibility = 1.8
12 | 
13 | repositories {
14 |     mavenCentral()
15 | }
16 | 
17 | dependencies {
18 |     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8"
19 | }
20 | 
21 | publishing {
22 |     publications {
23 |         maven(MavenPublication) {
24 |             from components.java
25 |         }
26 |     }
27 | }
28 | 
29 | compileKotlin {
30 |     kotlinOptions {
31 |         jvmTarget = "1.8"
32 |     }
33 | }
34 | 
35 | compileTestKotlin {
36 |     kotlinOptions {
37 |         jvmTarget = "1.8"
38 |     }
39 | }


--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/surge541/AnimationSystem/a13aaf7ef97cdfac9adfa56a7890a659a1193216/gradle/wrapper/gradle-wrapper.jar


--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionBase=GRADLE_USER_HOME
2 | distributionPath=wrapper/dists
3 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip
4 | zipStoreBase=GRADLE_USER_HOME
5 | zipStorePath=wrapper/dists
6 | 


--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
  1 | #!/bin/sh
  2 | 
  3 | #
  4 | # Copyright © 2015-2021 the original authors.
  5 | #
  6 | # Licensed under the Apache License, Version 2.0 (the "License");
  7 | # you may not use this file except in compliance with the License.
  8 | # You may obtain a copy of the License at
  9 | #
 10 | #      https://www.apache.org/licenses/LICENSE-2.0
 11 | #
 12 | # Unless required by applicable law or agreed to in writing, software
 13 | # distributed under the License is distributed on an "AS IS" BASIS,
 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 15 | # See the License for the specific language governing permissions and
 16 | # limitations under the License.
 17 | #
 18 | 
 19 | ##############################################################################
 20 | #
 21 | #   Gradle start up script for POSIX generated by Gradle.
 22 | #
 23 | #   Important for running:
 24 | #
 25 | #   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
 26 | #       noncompliant, but you have some other compliant shell such as ksh or
 27 | #       bash, then to run this script, type that shell name before the whole
 28 | #       command line, like:
 29 | #
 30 | #           ksh Gradle
 31 | #
 32 | #       Busybox and similar reduced shells will NOT work, because this script
 33 | #       requires all of these POSIX shell features:
 34 | #         * functions;
 35 | #         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
 36 | #           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
 37 | #         * compound commands having a testable exit status, especially «case»;
 38 | #         * various built-in commands including «command», «set», and «ulimit».
 39 | #
 40 | #   Important for patching:
 41 | #
 42 | #   (2) This script targets any POSIX shell, so it avoids extensions provided
 43 | #       by Bash, Ksh, etc; in particular arrays are avoided.
 44 | #
 45 | #       The "traditional" practice of packing multiple parameters into a
 46 | #       space-separated string is a well documented source of bugs and security
 47 | #       problems, so this is (mostly) avoided, by progressively accumulating
 48 | #       options in "$@", and eventually passing that to Java.
 49 | #
 50 | #       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
 51 | #       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
 52 | #       see the in-line comments for details.
 53 | #
 54 | #       There are tweaks for specific operating systems such as AIX, CygWin,
 55 | #       Darwin, MinGW, and NonStop.
 56 | #
 57 | #   (3) This script is generated from the Groovy template
 58 | #       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 59 | #       within the Gradle project.
 60 | #
 61 | #       You can find Gradle at https://github.com/gradle/gradle/.
 62 | #
 63 | ##############################################################################
 64 | 
 65 | # Attempt to set APP_HOME
 66 | 
 67 | # Resolve links: $0 may be a link
 68 | app_path=$0
 69 | 
 70 | # Need this for daisy-chained symlinks.
 71 | while
 72 |     APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
 73 |     [ -h "$app_path" ]
 74 | do
 75 |     ls=$( ls -ld "$app_path" )
 76 |     link=${ls#*' -> '}
 77 |     case $link in             #(
 78 |       /*)   app_path=$link ;; #(
 79 |       *)    app_path=$APP_HOME$link ;;
 80 |     esac
 81 | done
 82 | 
 83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 84 | 
 85 | APP_NAME="Gradle"
 86 | APP_BASE_NAME=${0##*/}
 87 | 
 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 90 | 
 91 | # Use the maximum available, or set MAX_FD != -1 to use that value.
 92 | MAX_FD=maximum
 93 | 
 94 | warn () {
 95 |     echo "$*"
 96 | } >&2
 97 | 
 98 | die () {
 99 |     echo
100 |     echo "$*"
101 |     echo
102 |     exit 1
103 | } >&2
104 | 
105 | # OS specific support (must be 'true' or 'false').
106 | cygwin=false
107 | msys=false
108 | darwin=false
109 | nonstop=false
110 | case "$( uname )" in                #(
111 |   CYGWIN* )         cygwin=true  ;; #(
112 |   Darwin* )         darwin=true  ;; #(
113 |   MSYS* | MINGW* )  msys=true    ;; #(
114 |   NONSTOP* )        nonstop=true ;;
115 | esac
116 | 
117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
118 | 
119 | 
120 | # Determine the Java command to use to start the JVM.
121 | if [ -n "$JAVA_HOME" ] ; then
122 |     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
123 |         # IBM's JDK on AIX uses strange locations for the executables
124 |         JAVACMD=$JAVA_HOME/jre/sh/java
125 |     else
126 |         JAVACMD=$JAVA_HOME/bin/java
127 |     fi
128 |     if [ ! -x "$JAVACMD" ] ; then
129 |         die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
130 | 
131 | Please set the JAVA_HOME variable in your environment to match the
132 | location of your Java installation."
133 |     fi
134 | else
135 |     JAVACMD=java
136 |     which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
137 | 
138 | Please set the JAVA_HOME variable in your environment to match the
139 | location of your Java installation."
140 | fi
141 | 
142 | # Increase the maximum file descriptors if we can.
143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
144 |     case $MAX_FD in #(
145 |       max*)
146 |         MAX_FD=$( ulimit -H -n ) ||
147 |             warn "Could not query maximum file descriptor limit"
148 |     esac
149 |     case $MAX_FD in  #(
150 |       '' | soft) :;; #(
151 |       *)
152 |         ulimit -n "$MAX_FD" ||
153 |             warn "Could not set maximum file descriptor limit to $MAX_FD"
154 |     esac
155 | fi
156 | 
157 | # Collect all arguments for the java command, stacking in reverse order:
158 | #   * args from the command line
159 | #   * the main class name
160 | #   * -classpath
161 | #   * -D...appname settings
162 | #   * --module-path (only if needed)
163 | #   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
164 | 
165 | # For Cygwin or MSYS, switch paths to Windows format before running java
166 | if "$cygwin" || "$msys" ; then
167 |     APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
168 |     CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
169 | 
170 |     JAVACMD=$( cygpath --unix "$JAVACMD" )
171 | 
172 |     # Now convert the arguments - kludge to limit ourselves to /bin/sh
173 |     for arg do
174 |         if
175 |             case $arg in                                #(
176 |               -*)   false ;;                            # don't mess with options #(
177 |               /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
178 |                     [ -e "$t" ] ;;                      #(
179 |               *)    false ;;
180 |             esac
181 |         then
182 |             arg=$( cygpath --path --ignore --mixed "$arg" )
183 |         fi
184 |         # Roll the args list around exactly as many times as the number of
185 |         # args, so each arg winds up back in the position where it started, but
186 |         # possibly modified.
187 |         #
188 |         # NB: a `for` loop captures its iteration list before it begins, so
189 |         # changing the positional parameters here affects neither the number of
190 |         # iterations, nor the values presented in `arg`.
191 |         shift                   # remove old arg
192 |         set -- "$@" "$arg"      # push replacement arg
193 |     done
194 | fi
195 | 
196 | # Collect all arguments for the java command;
197 | #   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
198 | #     shell script including quotes and variable substitutions, so put them in
199 | #     double quotes to make sure that they get re-expanded; and
200 | #   * put everything else in single quotes, so that it's not re-expanded.
201 | 
202 | set -- \
203 |         "-Dorg.gradle.appname=$APP_BASE_NAME" \
204 |         -classpath "$CLASSPATH" \
205 |         org.gradle.wrapper.GradleWrapperMain \
206 |         "$@"
207 | 
208 | # Use "xargs" to parse quoted args.
209 | #
210 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed.
211 | #
212 | # In Bash we could simply go:
213 | #
214 | #   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
215 | #   set -- "${ARGS[@]}" "$@"
216 | #
217 | # but POSIX shell has neither arrays nor command substitution, so instead we
218 | # post-process each arg (as a line of input to sed) to backslash-escape any
219 | # character that might be a shell metacharacter, then use eval to reverse
220 | # that process (while maintaining the separation between arguments), and wrap
221 | # the whole thing up as a single "set" statement.
222 | #
223 | # This will of course break if any of these variables contains a newline or
224 | # an unmatched quote.
225 | #
226 | 
227 | eval "set -- $(
228 |         printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
229 |         xargs -n1 |
230 |         sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
231 |         tr '\n' ' '
232 |     )" '"$@"'
233 | 
234 | exec "$JAVACMD" "$@"
235 | 


--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
 1 | @rem
 2 | @rem Copyright 2015 the original author or authors.
 3 | @rem
 4 | @rem Licensed under the Apache License, Version 2.0 (the "License");
 5 | @rem you may not use this file except in compliance with the License.
 6 | @rem You may obtain a copy of the License at
 7 | @rem
 8 | @rem      https://www.apache.org/licenses/LICENSE-2.0
 9 | @rem
10 | @rem Unless required by applicable law or agreed to in writing, software
11 | @rem distributed under the License is distributed on an "AS IS" BASIS,
12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | @rem See the License for the specific language governing permissions and
14 | @rem limitations under the License.
15 | @rem
16 | 
17 | @if "%DEBUG%" == "" @echo off
18 | @rem ##########################################################################
19 | @rem
20 | @rem  Gradle startup script for Windows
21 | @rem
22 | @rem ##########################################################################
23 | 
24 | @rem Set local scope for the variables with windows NT shell
25 | if "%OS%"=="Windows_NT" setlocal
26 | 
27 | set DIRNAME=%~dp0
28 | if "%DIRNAME%" == "" set DIRNAME=.
29 | set APP_BASE_NAME=%~n0
30 | set APP_HOME=%DIRNAME%
31 | 
32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter.
33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
34 | 
35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
37 | 
38 | @rem Find java.exe
39 | if defined JAVA_HOME goto findJavaFromJavaHome
40 | 
41 | set JAVA_EXE=java.exe
42 | %JAVA_EXE% -version >NUL 2>&1
43 | if "%ERRORLEVEL%" == "0" goto execute
44 | 
45 | echo.
46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
47 | echo.
48 | echo Please set the JAVA_HOME variable in your environment to match the
49 | echo location of your Java installation.
50 | 
51 | goto fail
52 | 
53 | :findJavaFromJavaHome
54 | set JAVA_HOME=%JAVA_HOME:"=%
55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
56 | 
57 | if exist "%JAVA_EXE%" goto execute
58 | 
59 | echo.
60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
61 | echo.
62 | echo Please set the JAVA_HOME variable in your environment to match the
63 | echo location of your Java installation.
64 | 
65 | goto fail
66 | 
67 | :execute
68 | @rem Setup the command line
69 | 
70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
71 | 
72 | 
73 | @rem Execute Gradle
74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
75 | 
76 | :end
77 | @rem End local scope for the variables with windows NT shell
78 | if "%ERRORLEVEL%"=="0" goto mainEnd
79 | 
80 | :fail
81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
82 | rem the _cmd.exe /c_ return code!
83 | if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
84 | exit /b 1
85 | 
86 | :mainEnd
87 | if "%OS%"=="Windows_NT" endlocal
88 | 
89 | :omega
90 | 


--------------------------------------------------------------------------------
/settings.gradle:
--------------------------------------------------------------------------------
1 | rootProject.name = 'AnimationSystem'
2 | 
3 | 


--------------------------------------------------------------------------------
/src/main/java/me/surge/animation/Animation.kt:
--------------------------------------------------------------------------------
 1 | package me.surge.animation
 2 | 
 3 | /**
 4 |  * @author Surge
 5 |  * @since 26/07/2022
 6 |  */
 7 | open class Animation(val length: () -> Float, val initialState: Boolean, val easing: () -> Easing) {
 8 | 
 9 |     // Time since last state update
10 |     private var lastMillis: Long = 0L
11 | 
12 |     // Current state of the animation
13 |     // True = Expanding / Expanded
14 |     // False = Contracting / Collapsed
15 |     var state: Boolean = initialState
16 |         set(value) {
17 |             lastMillis = if (!value) {
18 |                 System.currentTimeMillis() - ((1 - getLinearFactor()) * length.invoke().toLong()).toLong()
19 |             } else {
20 |                 System.currentTimeMillis() - (getLinearFactor() * length.invoke().toLong()).toLong()
21 |             }
22 | 
23 |             field = value
24 |         }
25 | 
26 |     /**
27 |      * Constructor that does not take suppliers as parameters
28 |      */
29 |     constructor(length: Float, initialState: Boolean, easing: Easing) : this({ length }, initialState, { easing })
30 | 
31 |     /**
32 |      * Constructor that only takes one supplier (length) and an immutable easing
33 |      */
34 |     constructor(length: () -> Float, initialState: Boolean, easing: Easing) : this(length, initialState, { easing })
35 | 
36 |     /**
37 |      * Constructor that only takes one supplier (easing) and an immutable length
38 |      */
39 |     constructor(length: Float, initialState: Boolean, easing: () -> Easing) : this({ length }, initialState, easing)
40 | 
41 |     /**
42 |      * Gets the animation factor (value between 0 and 1)
43 |      *
44 |      * @return The animation factor
45 |      */
46 |     open fun getAnimationFactor(): Double = if (state) {
47 |         easing.invoke().ease(((System.currentTimeMillis() - lastMillis.toDouble()) / length.invoke().toDouble()).coerceIn(0.0, 1.0))
48 |     } else {
49 |         easing.invoke().ease((1 - (System.currentTimeMillis() - lastMillis.toDouble()) / length.invoke().toDouble()).coerceIn(0.0, 1.0))
50 |     }
51 | 
52 |     /**
53 |      * Resets the animation to the original constructor parameters
54 |      */
55 |     fun resetToDefault() {
56 |         state = initialState
57 | 
58 |         lastMillis = if (initialState) {
59 |             System.currentTimeMillis() - ((1 - getLinearFactor()) * length.invoke().toLong()).toLong()
60 |         } else {
61 |             System.currentTimeMillis() - (getLinearFactor() * length.invoke().toLong()).toLong()
62 |         }
63 |     }
64 | 
65 |     /**
66 |      * For internal use only!
67 |      */
68 |     private fun getLinearFactor(): Double = if (!state) { (1 - (System.currentTimeMillis() - lastMillis.toDouble()) / length.invoke().toDouble()).coerceIn(0.0, 1.0) } else { ((System.currentTimeMillis() - lastMillis.toDouble()) / length.invoke().toDouble()).coerceIn(0.0, 1.0) }
69 | 
70 | }


--------------------------------------------------------------------------------
/src/main/java/me/surge/animation/BoundedAnimation.kt:
--------------------------------------------------------------------------------
 1 | package me.surge.animation
 2 | 
 3 | /**
 4 |  * @author Surge
 5 |  * @since 06/09/2022
 6 |  *
 7 |  * I was debating whether to have @param minimum and @param maximum as suppliers, but there would be too many constructors to make :P
 8 |  */
 9 | class BoundedAnimation(var minimum: Float, var maximum: Float, length: () -> Float, initialState: Boolean, easing: () -> Easing) : Animation(length, initialState, easing) {
10 | 
11 |     /********************* CONSTRUCTORS *********************/
12 | 
13 |     init {
14 |         // Just in case??
15 |         if (minimum > maximum) {
16 |             val min = minimum
17 |             val max = maximum
18 | 
19 |             minimum = max
20 |             maximum = min
21 |         }
22 |     }
23 | 
24 |     /**
25 |      * Constructor that does not take suppliers as parameters
26 |      */
27 |     constructor(minimum: Float, maximum: Float, length: Float, initialState: Boolean, easing: Easing) : this(minimum, maximum, { length }, initialState, { easing })
28 | 
29 |     /**
30 |      * Constructor that only takes one supplier (length) and an immutable easing
31 |      */
32 |     constructor(minimum: Float, maximum: Float, length: () -> Float, initialState: Boolean, easing: Easing) : this(minimum, maximum, length, initialState, { easing })
33 | 
34 |     /**
35 |      * Constructor that only takes one supplier (easing) and an immutable length
36 |      */
37 |     constructor(minimum: Float, maximum: Float, length: Float, initialState: Boolean, easing: () -> Easing) : this(minimum, maximum, { length }, initialState, easing)
38 | 
39 |     override fun getAnimationFactor(): Double {
40 |         return minimum + ((maximum - minimum) * super.getAnimationFactor())
41 |     }
42 | 
43 | }


--------------------------------------------------------------------------------
/src/main/java/me/surge/animation/ColourAnimation.kt:
--------------------------------------------------------------------------------
 1 | package me.surge.animation
 2 | 
 3 | import java.awt.Color
 4 | 
 5 | /**
 6 |  * @author Surge
 7 |  * @since 06/09/2022
 8 |  *
 9 |  * I'M SORRY AMERICANS BUT LIKE I'M WELSH SO I'M SPELLING IT WITH A U
10 |  * at least I didn't spell it the Welsh way (lliw)
11 |  */
12 | class ColourAnimation(val from: Color, val to: Color, length: () -> Float, initialState: Boolean, easing: () -> Easing) : Animation(length, initialState, easing) {
13 | 
14 |     /********************* CONSTRUCTORS *********************/
15 | 
16 |     /**
17 |      * Constructor that does not take suppliers as parameters
18 |      */
19 |     constructor(from: Color, to: Color, length: Float, initialState: Boolean, easing: Easing) : this(from, to, { length }, initialState, { easing })
20 | 
21 |     /**
22 |      * Constructor that only takes one supplier (length) and an immutable easing
23 |      */
24 |     constructor(from: Color, to: Color, length: () -> Float, initialState: Boolean, easing: Easing) : this(from, to, length, initialState, { easing })
25 | 
26 |     /**
27 |      * Constructor that only takes one supplier (easing) and an immutable length
28 |      */
29 |     constructor(from: Color, to: Color, length: Float, initialState: Boolean, easing: () -> Easing) : this(from, to, { length }, initialState, easing)
30 | 
31 |     /**
32 |      * Gets the transitioned colour
33 |      */
34 |     fun getColour(): Color {
35 |         val factor = getAnimationFactor()
36 | 
37 |         return Color(
38 |             (from.red + (to.red - from.red) * factor).toInt(),
39 |             (from.green + (to.green - from.green) * factor).toInt(),
40 |             (from.blue + (to.blue - from.blue) * factor).toInt(),
41 |             (from.alpha + (to.alpha - from.alpha) * factor).toInt()
42 |         )
43 |     }
44 | 
45 | }


--------------------------------------------------------------------------------
/src/main/java/me/surge/animation/Easing.kt:
--------------------------------------------------------------------------------
  1 | package me.surge.animation
  2 | 
  3 | import java.lang.Math.pow
  4 | import kotlin.math.PI
  5 | import kotlin.math.sqrt
  6 | import kotlin.math.pow
  7 | import kotlin.math.sin
  8 | import kotlin.math.cos
  9 | 
 10 | /**
 11 |  * @author Surge
 12 |  * @since 26/07/22
 13 |  */
 14 | enum class Easing(private val easeFunction: (Double) -> Double) {
 15 | 
 16 |     /**
 17 |      * No easing
 18 |      */
 19 |     LINEAR({ input -> input }),
 20 | 
 21 |     /**
 22 |      * Speed gradually increases
 23 |      */
 24 |     SINE_IN({ input -> 1 - cos((input * PI) / 2) }),
 25 | 
 26 |     /**
 27 |      * Speed gradually decreases
 28 |      */
 29 |     SINE_OUT({ input -> sin((input * PI) / 2) }),
 30 | 
 31 |     /**
 32 |      * Speed gradually increases until halfway and then decreases
 33 |      */
 34 |     SINE_IN_OUT({ input -> -(cos(PI * input) - 1) / 2 }),
 35 | 
 36 |     /**
 37 |      * Speed gradually increases
 38 |      */
 39 |     CUBIC_IN({ input -> input * input * input }),
 40 | 
 41 |     /**
 42 |      * Speed gradually decreases
 43 |      */
 44 |     CUBIC_OUT({ input -> 1 - (1 - input).pow(3.0) }),
 45 | 
 46 |     /**
 47 |      * Speed gradually increases until halfway and then decreases
 48 |      */
 49 |     CUBIC_IN_OUT({ input -> if (input < 0.5) 4 * input * input * input else 1 - (-2 * input + 2).pow(3.0) / 2 }),
 50 | 
 51 |     /**
 52 |      * Speed gradually increases
 53 |      */
 54 |     QUAD_IN({ input -> input * input }),
 55 | 
 56 |     /**
 57 |      * Speed gradually decreases
 58 |      */
 59 |     QUAD_OUT({ input -> 1 - (1 - input) * (1 - input) }),
 60 | 
 61 |     /**
 62 |      * Speed gradually increases until halfway and then decreases
 63 |      */
 64 |     QUAD_IN_OUT({ input -> if (input < 0.5) 2.0 * input * input else 1 - (-2 * input + 2).pow(2.0) / 2 }),
 65 | 
 66 |     /**
 67 |      * Speed gradually increases
 68 |      */
 69 |     QUART_IN({ input -> input * input * input * input }),
 70 | 
 71 |     /**
 72 |      * Speed gradually decreases
 73 |      */
 74 |     QUART_OUT({ input -> 1 - (1 - input).pow(4.0) }),
 75 | 
 76 |     /**
 77 |      * Speed gradually increases until halfway and then decreases
 78 |      */
 79 |     QUART_IN_OUT({ input -> if (input < 0.5) 8 * input * input * input * input else 1 - (-2 * input + 2).pow(4.0) / 2 }),
 80 | 
 81 |     /**
 82 |      * Speed gradually increases
 83 |      */
 84 |     QUINT_IN({ input -> input * input * input * input * input }),
 85 | 
 86 |     /**
 87 |      * Speed gradually decreases
 88 |      */
 89 |     QUINT_OUT({ input -> 1 - (1 - input).pow(5.0) }),
 90 | 
 91 |     /**
 92 |      * Speed gradually increases until halfway and then decreases
 93 |      */
 94 |     QUINT_IN_OUT({ input -> if (input < 0.5) 16 * input * input * input * input * input else 1 - (-2 * input + 2).pow(5.0) / 2 }),
 95 | 
 96 |     /**
 97 |      * Speed gradually increases
 98 |      */
 99 |     CIRC_IN({ input -> 1 - sqrt(1 - input.pow(2.0)) }),
100 | 
101 |     /**
102 |      * Speed gradually decreases
103 |      */
104 |     CIRC_OUT({ input -> sqrt(1 - (input - 1).pow(2)) }),
105 | 
106 |     /**
107 |      * Speed gradually increases until halfway and then decreases
108 |      */
109 |     CIRC_IN_OUT({ input -> if (input < 0.5) (1 - sqrt(1 - (2 * input).pow(2.0))) / 2 else (sqrt(1 - (-2 * input + 2).pow(2.0)) + 1) / 2 }),
110 | 
111 |     /**
112 |      * Speed gradually increases
113 |      */
114 |     EXPO_IN({ input -> if (input == 0.0) 0.0 else 2.0.pow(10.0 * input - 10.0) }),
115 | 
116 |     /**
117 |      * Speed gradually decreases
118 |      */
119 |     EXPO_OUT({ input -> if (input == 1.0) 1.0 else 1 - 2.0.pow(-10 * input) }),
120 | 
121 |     /**
122 |      * Speed gradually increases until halfway and then decreases
123 |      */
124 |     EXPO_IN_OUT({ input -> if (input == 0.0) 0.0 else if (input == 1.0) 1.0 else if (input < 0.5) 2.0.pow(20 * input - 10) / 2.0 else (2 - 2.0.pow(-20 * input + 10)) / 2.0 }),
125 | 
126 |     /**
127 |      * Speed gradually increases
128 |      */
129 |     ELASTIC_IN({ input -> if (input == 0.0) 0.0 else if (input == 1.0) 1.0 else (-2.0).pow(10 * input - 10) * sin((input * 10 - 10.75) * ((2 * PI) / 3)) }),
130 | 
131 |     /**
132 |      * Speed gradually decreases
133 |      */
134 |     ELASTIC_OUT({ input -> if (input == 0.0) 0.0 else if (input == 1.0) 1.0 else 2.0.pow(-10 * input) * sin((input * 10 - 0.75) * ((2 * PI) / 3)) + 1 }),
135 | 
136 |     /**
137 |      * Speed gradually increases until halfway and then decreases
138 |      */
139 |     ELASTIC_IN_OUT({ input -> if (input == 0.0) 0.0 else if (input == 1.0) 1.0 else if (input < 0.5) -(2.0.pow(20 * input - 10) * sin((20 * input - 11.125) * ((2 * Math.PI) / 4.5))) / 2 else (2.0.pow(-20 * input + 10) * sin((20 * input - 11.125) * ((2 * Math.PI) / 4.5))) / 2 + 1 }),
140 | 
141 |     /**
142 |      * Speed gradually increases
143 |      */
144 |     BACK_IN({ input -> 2.70158 + 1 * input * input * input - 1.70158 * input * input }),
145 | 
146 |     /**
147 |      * Speed gradually decreases
148 |      */
149 |     BACK_OUT({ input -> 1 + 2.70158 * (input - 1).pow(3.0) + 1.70158 * (input - 1).pow(2.0) }),
150 | 
151 |     /**
152 |      * Speed gradually increases until halfway and then decreases
153 |      */
154 |     BACK_IN_OUT({ input -> if (input < 0.5) ((2 * input).pow(2.0) * ((2.5949095 + 1) * 2 * input - 2.5949095)) / 2 else ((2 * input - 2).pow(2.0) * ((2.5949095 + 1) * (input * 2 - 2) + 2.5949095) + 2) / 2 });
155 | 
156 |     /**
157 |      * Apply the easing function to the input
158 |      *
159 |      * @param input The linear animation that we want to ease
160 |      * @return The eased animation
161 |      */
162 |     open fun ease(input: Double) = easeFunction.invoke(input)
163 | 
164 | }


--------------------------------------------------------------------------------
/src/test/java/me/surge/test/Main.kt:
--------------------------------------------------------------------------------
 1 | package me.surge.test
 2 | 
 3 | import me.surge.animation.Animation
 4 | import me.surge.animation.BoundedAnimation
 5 | import me.surge.animation.ColourAnimation
 6 | import me.surge.animation.Easing
 7 | import java.awt.Color
 8 | 
 9 | /**
10 |  * @author Surge
11 |  * @since 06/09/2022
12 |  */
13 | fun main() {
14 |     /************** NORMAL **************/
15 |     println("NORMAL ANIMATION")
16 | 
17 |     // Create animation object
18 |     val animation = Animation({ 200f }, false, { Easing.LINEAR })
19 | 
20 |     // Set animation state
21 |     animation.state = true
22 | 
23 |     // Get and print animation factor
24 |     while (animation.getAnimationFactor() < 1.0) {
25 |         println(animation.getAnimationFactor())
26 |     }
27 | 
28 | 
29 | 
30 |     /************** BOUNDED **************/
31 |     println("BOUNDED ANIMATION")
32 | 
33 |     // Create bounded animation object
34 |     val bounded = BoundedAnimation(5f, 20f, 200f, false, Easing.LINEAR)
35 | 
36 |     // Set animation state
37 |     bounded.state = true
38 | 
39 |     // Get and print animation factor
40 |     while (bounded.getAnimationFactor() < bounded.maximum) {
41 |         println(bounded.getAnimationFactor())
42 |     }
43 | 
44 | 
45 | 
46 |     /************** COLOUR **************/
47 |     println("COLOUR ANIMATION")
48 | 
49 |     // Create bounded animation object
50 |     val colourAnimation = ColourAnimation(Color.RED, Color.BLUE, 200f, false, Easing.LINEAR)
51 | 
52 |     // Set animation state
53 |     colourAnimation.state = true
54 | 
55 |     // Get and print animation factor
56 |     while (colourAnimation.getColour() != colourAnimation.to) {
57 |         // Colour
58 |         val colour = colourAnimation.getColour()
59 | 
60 |         println("R ${colour.red} G ${colour.green} B ${colour.blue} A ${colour.alpha}")
61 |     }
62 | }


--------------------------------------------------------------------------------