Created a basic application framework that integrates JME's rendering loop

(in fixed framerate format) with the Presents event queue in what will
hopefully be happy harmony. Also made some edits to the Presents code to
not sound like we assume things run on the AWT thread which we don't and
which is not the case in this framework.


git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@3510 542714f4-19e9-0310-aa3c-eee0fc999fb1

src/java/com/threerings/jme/JmeApp.java

@@ -0,0 +1,215 @@
+//
+// $Id$
+//
+// Narya library - tools for developing networked games
+// Copyright (C) 2002-2005 Three Rings Design, Inc., All Rights Reserved
+// http://www.threerings.net/code/narya/
+//
+// This library is free software; you can redistribute it and/or modify it
+// under the terms of the GNU Lesser General Public License as published
+// by the Free Software Foundation; either version 2.1 of the License, or
+// (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+package com.threerings.jme;
+
+import java.io.File;
+import java.util.logging.Level;
+
+import com.samskivert.util.Queue;
+import com.samskivert.util.RunQueue;
+import com.samskivert.util.StringUtil;
+
+import com.jme.app.AbstractGame;
+import com.jme.system.PropertiesIO;
+import com.jme.system.lwjgl.LWJGLPropertiesDialog;
+import com.jme.util.Timer;
+
+import com.threerings.presents.client.Client;
+
+/**
+ * Extends the {@link AbstractGame} providing integration with the
+ * <a href="../presents/package.html">Presents</a> networking system and
+ * targeting a fixed framerate.
+ */
+public abstract class JmeApp extends AbstractGame
+    implements RunQueue
+{
+    /**
+     * Returns our average frames per second since the last call to this
+     * method.
+     */
+    public float getFramesPerSecond ()
+    {
+        float now = _timer.getTime(), delta = now - _lastFPSStamp;
+        float fps = _frames / delta;
+        _lastFPSStamp = now;
+        _frames = 0;
+        return fps;
+    }
+
+    /**
+     * Configures the target frame rate in frames per second.
+     */
+    public void setTargetFrameRate (long framesPerSecond)
+    {
+        if (framesPerSecond <= 0) {
+            throw new IllegalArgumentException("FPS must be > 0.");
+        }
+        _targetTicksPerFrame = _timer.getResolution() / framesPerSecond;
+    }
+
+    // documentation inherited
+    public void start ()
+    {
+        synchronized (this) {
+            _dispatchThread = Thread.currentThread();
+        }
+
+        try {
+            // load up our renderer configuration
+            properties = new PropertiesIO(getConfigPath("jme.cfg"));
+            if (!properties.load()) {
+                LWJGLPropertiesDialog dialog =
+                    new LWJGLPropertiesDialog(properties, (String)null);
+                while (dialog.isVisible()) {
+                    try {
+                        Thread.sleep(5);
+                    } catch (InterruptedException e) {
+                        Log.warning("Error waiting for dialog system, " +
+                                    "using defaults.");
+                    }
+                }
+            }
+
+            // create an appropriate timer
+            _timer = Timer.getTimer(properties.getRenderer());
+
+            // default to 60 fps
+            setTargetFrameRate(60);
+
+            // initialize the AbstractGame
+            initSystem();
+            assertDisplayCreated();
+
+            // initialize our derived class
+            initGame();
+
+        } catch (Throwable t) {
+            Log.logStackTrace(t);
+            quit();
+            return;
+        }
+
+        // enter the main rendering and event processing loop
+        while (!finished && !display.isClosing()) {
+            try {
+                processFrame();
+                _failures = 0;
+
+            } catch (Throwable t) {
+                Log.logStackTrace(t);
+                // stick a fork in things if we fail too many times in a row
+                if (++_failures > MAX_SUCCESSIVE_FAILURES) {
+                    finish();
+                }
+            }
+        }
+
+        try {
+            cleanup();
+            display.reset();
+        } catch (Throwable t) {
+            Log.logStackTrace(t);
+        } finally {
+            quit();
+        }
+    }
+
+    // documentation inherited from interface RunQueue
+    public void postRunnable (Runnable r)
+    {
+        _evqueue.append(r);
+    }
+
+    // documentation inherited from interface RunQueue
+    public boolean isDispatchThread ()
+    {
+        return Thread.currentThread() == _dispatchThread;
+    }
+
+    /**
+     * Processes a single frame.
+     */
+    protected final void processFrame ()
+    {
+        _frameStart = _timer.getTime();
+
+        // update our simulation and render a frame
+        update(-1f);
+        render(-1f);
+
+        display.getRenderer().displayBackBuffer();
+        _frames++;
+
+        // now process events or sleep until the next frame
+        do {
+            Runnable r = (Runnable)_evqueue.getNonBlocking();
+            if (r == null) {
+                try {
+                    Thread.sleep(1);
+                } catch (InterruptedException ie) {
+                    Log.warning("Ticker interrupted: " + ie);
+                }
+            } else {
+                r.run();
+            }
+        } while (_timer.getTime() - _frameStart < _targetTicksPerFrame);
+    }
+
+    // documentation inherited
+    protected void quit ()
+    {
+        if (display != null) {
+            display.close();
+        }
+        System.exit(0);
+    }
+
+    /**
+     * Prepends the necessary bits onto the supplied path to properly
+     * locate it in our configuration directory.
+     */
+    protected String getConfigPath (String file)
+    {
+        String cfgdir = ".narya";
+        String home = System.getProperty("user.dir");
+        if (!StringUtil.blank(home)) {
+            cfgdir = home + File.separator + cfgdir;
+        }
+        return cfgdir + File.separator + file;
+    }
+
+    protected Timer _timer;
+    protected Thread _dispatchThread;
+    protected Queue _evqueue = new Queue();
+
+    protected int _failures;
+
+    protected int _frames;
+    protected float _lastFPSStamp;
+
+    protected long _targetTicksPerFrame;
+    protected long _frameStart;
+
+    /** If we fail 100 frames in a row, stick a fork in ourselves. */
+    protected static final int MAX_SUCCESSIVE_FAILURES = 100;
+}

src/java/com/threerings/jme/Log.java

@@ -0,0 +1,56 @@
+//
+// $Id: Log.java 3099 2004-08-27 02:21:06Z mdb $
+//
+// Narya library - tools for developing networked games
+// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
+// http://www.threerings.net/code/narya/
+//
+// This library is free software; you can redistribute it and/or modify it
+// under the terms of the GNU Lesser General Public License as published
+// by the Free Software Foundation; either version 2.1 of the License, or
+// (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+package com.threerings.jme;
+
+/**
+ * A placeholder class that contains a reference to the log object used by
+ * this package.
+ */
+public class Log
+{
+    public static com.samskivert.util.Log log =
+	new com.samskivert.util.Log("jme");
+
+    /** Convenience function. */
+    public static void debug (String message)
+    {
+	log.debug(message);
+    }
+
+    /** Convenience function. */
+    public static void info (String message)
+    {
+	log.info(message);
+    }
+
+    /** Convenience function. */
+    public static void warning (String message)
+    {
+	log.warning(message);
+    }
+
+    /** Convenience function. */
+    public static void logStackTrace (Throwable t)
+    {
+	log.logStackTrace(com.samskivert.util.Log.WARNING, t);
+    }
+}

src/java/com/threerings/jme/package.html

@@ -0,0 +1,15 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+  <head>
+    <!-- $Id: package.html 617 2001-11-13 00:12:20Z mdb $ -->
+  </head>
+
+  <body bgcolor="white">
+
+    Defines extensions to <a href="http://jmonkeyengine.com">jMonkeyEngine</a>
+    an OpenGL-based 3D rendering engine. An application framework is
+    provided that integrates jME with the Presents distributed object
+    system and other useful bits and bobs are also included.
+
+  </body>
+</html>

src/java/com/threerings/presents/client/Client.java

@@ -702,7 +702,7 @@ public class Client
     protected String _version = "";
 
     /** An entity that gives us the ability to process events on the main
-     * client thread (which is also the AWT thread). */
+     * client thread. */
     protected RunQueue _runQueue;
 
     /** The distributed object manager we're using during this session. */

src/java/com/threerings/presents/client/ClientDObjectMgr.java

@@ -173,8 +173,8 @@ public class ClientDObjectMgr
     }
 
     /**
-     * Invoked on the AWT thread to process any newly arrived messages
-     * that we have waiting in our queue.
+     * Invoked on the main client thread to process any newly arrived
+     * messages that we have waiting in our queue.
      */
     public void run ()
     {