diff --git a/README.md b/README.md index a921cbf820..d2a9afd19e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,6 @@ # Quark Small things. + +This mod makes use of the [Java Universal Tween Engine](https://code.google.com/p/java-universal-tween-engine/) by Aurelien Ribon, licensed under the Apache 2.0 License. + +To run in a dev env, add *-Dfml.coreMods.load=vazkii.quark.base.asm.LoadingPlugin* to your VM arguments. \ No newline at end of file diff --git a/build.gradle b/build.gradle index 98abf79239..57cc8a2800 100644 --- a/build.gradle +++ b/build.gradle @@ -43,6 +43,11 @@ minecraft { jar { exclude "**/*.bat" exclude "**/*.psd" + + manifest { + attributes("FMLCorePluginContainsFMLMod": "true", "FMLCorePlugin": "vazkii.quark.base.asm.LoadingPlugin") + } + } processResources { diff --git a/src/main/java/vazkii/aurelienribon/APACHE-LICENSE.txt b/src/main/java/vazkii/aurelienribon/APACHE-LICENSE.txt new file mode 100644 index 0000000000..da4d695e14 --- /dev/null +++ b/src/main/java/vazkii/aurelienribon/APACHE-LICENSE.txt @@ -0,0 +1,73 @@ +Apache License, Version 2.0 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. + +"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). + +"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. + +2. Grant of Copyright License. + +Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. + +Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. + +4. Redistribution. + +You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: + +You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. + +5. Submission of Contributions. + +Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. + +6. Trademarks. + +This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. + +Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. + +In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. + +While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work + +To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. \ No newline at end of file diff --git a/src/main/java/vazkii/aurelienribon/tweenengine/BaseTween.java b/src/main/java/vazkii/aurelienribon/tweenengine/BaseTween.java new file mode 100644 index 0000000000..9bb5956f6c --- /dev/null +++ b/src/main/java/vazkii/aurelienribon/tweenengine/BaseTween.java @@ -0,0 +1,543 @@ +package vazkii.aurelienribon.tweenengine; + +/** + * BaseTween is the base class of Tween and Timeline. It defines the + * iteration engine used to play animations for any number of times, and in + * any direction, at any speed. + *

+ * + * It is responsible for calling the different callbacks at the right moments, + * and for making sure that every callbacks are triggered, even if the update + * engine gets a big delta time at once. + * + * @see Tween + * @see Timeline + * @author Aurelien Ribon | http://www.aurelienribon.com/ + */ +public abstract class BaseTween { + // General + private int step; + private int repeatCnt; + private boolean isIterationStep; + private boolean isYoyo; + + // Timings + protected float delay; + protected float duration; + private float repeatDelay; + private float currentTime; + private float deltaTime; + private boolean isStarted; // true when the object is started + private boolean isInitialized; // true after the delay + private boolean isFinished; // true when all repetitions are done + private boolean isKilled; // true if kill() was called + private boolean isPaused; // true if pause() was called + + // Misc + private TweenCallback callback; + private int callbackTriggers; + private Object userData; + + // Package access + boolean isAutoRemoveEnabled; + boolean isAutoStartEnabled; + + // ------------------------------------------------------------------------- + + protected void reset() { + step = -2; + repeatCnt = 0; + isIterationStep = isYoyo = false; + + delay = duration = repeatDelay = currentTime = deltaTime = 0; + isStarted = isInitialized = isFinished = isKilled = isPaused = false; + + callback = null; + callbackTriggers = TweenCallback.COMPLETE; + userData = null; + + isAutoRemoveEnabled = isAutoStartEnabled = true; + } + + // ------------------------------------------------------------------------- + // Public API + // ------------------------------------------------------------------------- + + /** + * Builds and validates the object. Only needed if you want to finalize a + * tween or timeline without starting it, since a call to ".start()" also + * calls this method. + * + * @return The current object, for chaining instructions. + */ + public T build() { + return (T) this; + } + + /** + * Starts or restarts the object unmanaged. You will need to take care of + * its life-cycle. If you want the tween to be managed for you, use a + * {@link TweenManager}. + * + * @return The current object, for chaining instructions. + */ + public T start() { + build(); + currentTime = 0; + isStarted = true; + return (T) this; + } + + /** + * Convenience method to add an object to a manager. Its life-cycle will be + * handled for you. Relax and enjoy the animation. + * + * @return The current object, for chaining instructions. + */ + public T start(TweenManager manager) { + manager.add(this); + return (T) this; + } + + /** + * Adds a delay to the tween or timeline. + * + * @param delay A duration. + * @return The current object, for chaining instructions. + */ + public T delay(float delay) { + this.delay += delay; + return (T) this; + } + + /** + * Kills the tween or timeline. If you are using a TweenManager, this object + * will be removed automatically. + */ + public void kill() { + isKilled = true; + } + + /** + * Stops and resets the tween or timeline, and sends it to its pool, for ++ * later reuse. Note that if you use a {@link TweenManager}, this method ++ * is automatically called once the animation is finished. + */ + public void free() { + } + + /** + * Pauses the tween or timeline. Further update calls won't have any effect. + */ + public void pause() { + isPaused = true; + } + + /** + * Resumes the tween or timeline. Has no effect is it was no already paused. + */ + public void resume() { + isPaused = false; + } + + /** + * Repeats the tween or timeline for a given number of times. + * @param count The number of repetitions. For infinite repetition, + * use Tween.INFINITY, or a negative number. + * + * @param delay A delay between each iteration. + * @return The current tween or timeline, for chaining instructions. + */ + public T repeat(int count, float delay) { + if (isStarted) throw new RuntimeException("You can't change the repetitions of a tween or timeline once it is started"); + repeatCnt = count; + repeatDelay = delay >= 0 ? delay : 0; + isYoyo = false; + return (T) this; + } + + /** + * Repeats the tween or timeline for a given number of times. + * Every two iterations, it will be played backwards. + * + * @param count The number of repetitions. For infinite repetition, + * use Tween.INFINITY, or '-1'. + * @param delay A delay before each repetition. + * @return The current tween or timeline, for chaining instructions. + */ + public T repeatYoyo(int count, float delay) { + if (isStarted) throw new RuntimeException("You can't change the repetitions of a tween or timeline once it is started"); + repeatCnt = count; + repeatDelay = delay >= 0 ? delay : 0; + isYoyo = true; + return (T) this; + } + + /** + * Sets the callback. By default, it will be fired at the completion of the + * tween or timeline (event COMPLETE). If you want to change this behavior + * and add more triggers, use the {@link setCallbackTriggers()} method. + * + * @see TweenCallback + */ + public T setCallback(TweenCallback callback) { + this.callback = callback; + return (T) this; + } + + /** + * Changes the triggers of the callback. The available triggers, listed as + * members of the {@link TweenCallback} interface, are: + *

+ * + * BEGIN: right after the delay (if any)
+ * START: at each iteration beginning
+ * END: at each iteration ending, before the repeat delay
+ * COMPLETE: at last END event
+ * BACK_BEGIN: at the beginning of the first backward iteration
+ * BACK_START: at each backward iteration beginning, after the repeat delay
+ * BACK_END: at each backward iteration ending
+ * BACK_COMPLETE: at last BACK_END event + *

+ * + * 

 {@code
+	 * forward :      BEGIN                                   COMPLETE
+	 * forward :      START    END      START    END      START    END
+	 * |--------------[XXXXXXXXXX]------[XXXXXXXXXX]------[XXXXXXXXXX]
+	 * backward:      bEND  bSTART      bEND  bSTART      bEND  bSTART
+	 * backward:      bCOMPLETE                                 bBEGIN
+	 * }
+ * + * @param flags one or more triggers, separated by the '|' operator. + * @see TweenCallback + */ + public T setCallbackTriggers(int flags) { + this.callbackTriggers = flags; + return (T) this; + } + + /** + * Attaches an object to this tween or timeline. It can be useful in order + * to retrieve some data from a TweenCallback. + * + * @param data Any kind of object. + * @return The current tween or timeline, for chaining instructions. + */ + public T setUserData(Object data) { + userData = data; + return (T) this; + } + + // ------------------------------------------------------------------------- + // Getters + // ------------------------------------------------------------------------- + + /** + * Gets the delay of the tween or timeline. Nothing will happen before + * this delay. + */ + public float getDelay() { + return delay; + } + + /** + * Gets the duration of a single iteration. + */ + public float getDuration() { + return duration; + } + + /** + * Gets the number of iterations that will be played. + */ + public int getRepeatCount() { + return repeatCnt; + } + + /** + * Gets the delay occuring between two iterations. + */ + public float getRepeatDelay() { + return repeatDelay; + } + + /** + * Returns the complete duration, including initial delay and repetitions. + * The formula is as follows: + * 
+	 * fullDuration = delay + duration + (repeatDelay + duration) * repeatCnt
+	 *
+ */ + public float getFullDuration() { + if (repeatCnt < 0) return -1; + return delay + duration + (repeatDelay + duration) * repeatCnt; + } + + /** + * Gets the attached data, or null if none. + */ + public Object getUserData() { + return userData; + } + + /** + * Gets the id of the current step. Values are as follows:
+ *