delay).
* - * {@link #getTimeScale()} affects the delay. */ + * {@link #getTimeScale()} affects the delay. + *
+ * When using {@link AnimationState#addAnimation(int, Animation, boolean, float)} with a delay <= 0, the delay
+ * is set using the mix duration from the {@link AnimationStateData}. If {@link #mixDuration} is set afterward, the delay
+ * may need to be adjusted. */
public float getDelay () {
return delay;
}
@@ -963,6 +960,18 @@ public class AnimationState {
this.trackEnd = trackEnd;
}
+ /** If this track entry is non-looping, the track time in seconds when {@link #getAnimationEnd()} is reached, or the current
+ * {@link #getTrackTime()} if it has already been reached. If this track entry is looping, the track time when this
+ * animation will reach its next {@link #getAnimationEnd()} (the next loop completion). */
+ public float getTrackComplete () {
+ float duration = animationEnd - animationStart;
+ if (duration != 0) {
+ if (loop) return duration * (1 + (int)(trackTime / duration)); // Completion of next loop.
+ if (trackTime < duration) return duration; // Before duration.
+ }
+ return trackTime; // Next update.
+ }
+
/** Seconds when this animation starts, both initially and after looping. Defaults to 0.
*
* When changing the animationStart time, it often makes sense to set {@link #getAnimationLast()} to the same
@@ -1018,7 +1027,7 @@ public class AnimationState {
* {@link #getMixTime()} is not affected by track entry time scale, so {@link #getMixDuration()} may need to be adjusted to
* match the animation speed.
*
- * When using {@link AnimationState#addAnimation(int, Animation, boolean, float)} with a delay <= 0, note the
+ * When using {@link AnimationState#addAnimation(int, Animation, boolean, float)} with a delay <= 0, the
* {@link #getDelay()} is set using the mix duration from the {@link AnimationStateData}, assuming time scale to be 1. If
* the time scale is not 1, the delay may need to be adjusted.
*
@@ -1089,15 +1098,17 @@ public class AnimationState {
this.drawOrderThreshold = drawOrderThreshold;
}
- /** The animation queued to start after this animation, or null if there is none. next makes up a linked list.
- * It cannot be set to null, use {@link AnimationState#clearNext(TrackEntry)} instead. */
+ /** The animation queued to start after this animation, or null if there is none. next makes up a doubly linked
+ * list.
+ *
+ * See {@link AnimationState#clearNext(TrackEntry)} to truncate the list. */
public @Null TrackEntry getNext () {
return next;
}
- public void setNext (TrackEntry next) {
- if (next == null) throw new IllegalArgumentException("next cannot be null.");
- this.next = next;
+ /** The animation queued to play before this animation, or null. previous makes up a doubly linked list. */
+ public @Null TrackEntry getPrevious () {
+ return previous;
}
/** Returns true if at least one loop has been completed.
@@ -1127,9 +1138,10 @@ public class AnimationState {
* {@link AnimationStateData#getMix(Animation, Animation)}. In that case, the mixDuration can be set for a new
* track entry only before {@link AnimationState#update(float)} is first called.
*
- * When using {@link AnimationState#addAnimation(int, Animation, boolean, float)} with a delay <= 0, note the
- * {@link #getDelay()} is set using the mix duration from the {@link AnimationStateData}, not a mix duration set
- * afterward. */
+ * When using {@link AnimationState#addAnimation(int, Animation, boolean, float)} with a delay <= 0, the
+ * {@link #getDelay()} is set using the mix duration from the {@link AnimationStateData}. If mixDuration is set
+ * afterward, the delay may need to be adjusted. For example:
+ * entry.delay = entry.previous.getTrackComplete() - entry.mixDuration; */
public float getMixDuration () {
return mixDuration;
}