From fc261655b3a266e947b11b1bdf9059d31f044385 Mon Sep 17 00:00:00 2001
From: Michael Bayne <mdb@threerings.net>
Date: Tue, 17 Sep 2002 20:08:21 +0000
Subject: [PATCH] Created an animation that can be used to display a simple
 sequence of frames.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@1696 542714f4-19e9-0310-aa3c-eee0fc999fb1
---
 .../media/animation/MultiFrameAnimation.java  | 109 ++++++++++++++++++
 1 file changed, 109 insertions(+)
 create mode 100644 src/java/com/threerings/media/animation/MultiFrameAnimation.java

diff --git a/src/java/com/threerings/media/animation/MultiFrameAnimation.java b/src/java/com/threerings/media/animation/MultiFrameAnimation.java
new file mode 100644
index 000000000..8ee2cea08
--- /dev/null
+++ b/src/java/com/threerings/media/animation/MultiFrameAnimation.java
@@ -0,0 +1,109 @@
+//
+// $Id: MultiFrameAnimation.java,v 1.1 2002/09/17 20:08:21 mdb Exp $
+
+package com.threerings.media.animation;
+
+import java.awt.Graphics2D;
+
+import com.threerings.media.util.FrameSequencer;
+import com.threerings.media.util.MultiFrameImage;
+import java.awt.Rectangle;
+
+/**
+ * Animates a sequence of image frames in place with a particular frame
+ * rate.
+ */
+public class MultiFrameAnimation extends Animation
+{
+    /**
+     * Creates a multi-frame animation with the specified source image
+     * frames and the specified target frame rate (in frames per second).
+     *
+     * @param frames the source frames of the animation.
+     * @param fps the target number of frames per second.
+     * @param loop whether the animation should loop indefinitely or
+     * finish after one shot.
+     */
+    public MultiFrameAnimation (
+        MultiFrameImage frames, double fps, boolean loop)
+    {
+        this(frames, new FrameSequencer.ConstantRate(fps, loop));
+    }
+
+    /**
+     * Creates a multi-frame animation with the specified source image
+     * frames and the specified target frame rate (in frames per second).
+     */
+    public MultiFrameAnimation (MultiFrameImage frames, FrameSequencer seeker)
+    {
+        // we'll set up our bounds via setLocation() and in reset()
+        super(new Rectangle());
+
+        _frames = frames;
+        _seeker = seeker;
+
+        // reset ourselves to start things off
+        reset();
+    }
+
+    // documentation inherited
+    public Rectangle getBounds ()
+    {
+        // fill in the bounds with our current animation frame's bounds
+        return _bounds;
+    }
+
+    /**
+     * If this animation has run to completion, it can be reset to prepare
+     * it for another go.
+     */
+    public void reset ()
+    {
+        super.reset();
+
+        // reset ourselves to frame zero
+        setFrameIndex(0);
+
+        // reset our frame sequencer
+        _seeker.init(_frames);
+    }
+
+    // documentation inherited
+    public void tick (long tickStamp)
+    {
+        int fidx = _seeker.tick(tickStamp);
+        if (fidx != _fidx) {
+            // update our frame index and bounds
+            setFrameIndex(fidx);
+
+            // and have ourselves repainted
+            invalidate();
+        }
+    }
+
+    /**
+     * Sets the frame index and updates our dimensions.
+     */
+    protected void setFrameIndex (int fidx)
+    {
+        _fidx = fidx;
+        _bounds.width = _frames.getWidth(_fidx);
+        _bounds.height = _frames.getHeight(_fidx);
+    }
+
+    // documentation inherited
+    public void paint (Graphics2D gfx)
+    {
+        _frames.paintFrame(gfx, _fidx, _bounds.x, _bounds.y);
+    }
+
+    // documentation inherited
+    public void fastForward (long timeDelta)
+    {
+        _seeker.fastForward(timeDelta);
+    }
+
+    protected MultiFrameImage _frames;
+    protected FrameSequencer _seeker;
+    protected int _fidx;
+}