With extensive help from Phil Race and Chris Campbell from the Java 2D

team, added a TextRenderer class which enables high-performance
rendering of bitmapped Java 2D fonts, with full Unicode support, into
arbitrary OpenGL drawables using a simple API. Builds on top of the
TextureRenderer class and its associated functionality; added
createAlphaOnlyRenderer() and other methods to enable the TextRenderer.
Caches rendering results on a string-by-string basis in an OpenGL
texture using a fully automatic least-recently-used algorithm for good
efficiency when rendering the same string or strings multiple times.
Uses a rectangle packing algorithm, currently housed in
com.sun.opengl.impl.packrect, for managing the positions of cached
strings on a larger OpenGL texture to avoid OpenGL pipeline state
changes. Added a TestTextRenderer demo which simply adds a moving text
string and frames-per-second counter to the Gears demo; more
sophisticated examples to come. (Some commented-out debugging code is
being temporarily left in the new demo, to be removed in the next
checkin, in order to have it in the version history.)


git-svn-id: file:///usr/local/projects/SUN/JOGL/git-svn/../svn-server-sync/jogl-demos/trunk@196 3298f667-5e0e-4b4a-8ed4-a3559d26a5f4

1 files changed, 246 insertions, 0 deletions

diff --git a/src/demos/j2d/TestTextRenderer.java b/src/demos/j2d/TestTextRenderer.java
new file mode 100755
index 0000000..f89b0cf
--- /dev/null
+++ b/src/demos/j2d/TestTextRenderer.java
@@ -0,0 +1,246 @@
+/*
+ * Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * 
+ * - Redistribution of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * 
+ * - Redistribution in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * 
+ * Neither the name of Sun Microsystems, Inc. or the names of
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * 
+ * This software is provided "AS IS," without a warranty of any kind. ALL
+ * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
+ * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
+ * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
+ * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
+ * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
+ * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
+ * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
+ * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
+ * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
+ * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
+ * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+ * 
+ * You acknowledge that this software is not designed or intended for use
+ * in the design, construction, operation or maintenance of any nuclear
+ * facility.
+ * 
+ * Sun gratefully acknowledges that this software was originally authored
+ * and developed by Kenneth Bradley Russell and Christopher John Kline.
+ */
+
+package demos.j2d;
+
+// Debugging only
+//import java.awt.EventQueue;
+//import java.awt.Rectangle;
+import java.awt.Font;
+import java.awt.Frame;
+import java.awt.event.*;
+import java.awt.geom.*;
+import java.text.*;
+
+import javax.media.opengl.*;
+import javax.media.opengl.glu.*;
+import com.sun.opengl.util.*;
+import com.sun.opengl.util.j2d.*;
+
+import demos.gears.Gears;
+import demos.util.*;
+import gleem.linalg.*;
+
+/** A simple test of the TextRenderer class. Draws gears underneath
+    with moving Java 2D-rendered text on top. */
+
+public class TestTextRenderer implements GLEventListener {
+  //  private static final boolean DEBUG = false;
+
+  public static void main(String[] args) {
+    Frame frame = new Frame("Text Renderer Test");
+    GLCapabilities caps = new GLCapabilities();
+    caps.setAlphaBits(8);
+    GLCanvas canvas = new GLCanvas(caps);
+    canvas.addGLEventListener(new Gears());
+    TestTextRenderer test = new TestTextRenderer();
+    canvas.addGLEventListener(test);
+    frame.add(canvas);
+    frame.setSize(512, 512);
+    final Animator animator = new Animator(canvas);
+    frame.addWindowListener(new WindowAdapter() {
+        public void windowClosing(WindowEvent e) {
+          // Run this on another thread than the AWT event queue to
+          // make sure the call to Animator.stop() completes before
+          // exiting
+          new Thread(new Runnable() {
+              public void run() {
+                animator.stop();
+                System.exit(0);
+              }
+            }).start();
+        }
+      });
+
+    /*
+    if (DEBUG) {
+      Frame dbgFrame = new Frame("Debug Output");
+      GLCanvas dbgCanvas = new GLCanvas(caps, null, canvas.getContext(), null);
+      dbgCanvas.addGLEventListener(test.new DebugListener(dbgFrame));
+      dbgFrame.add(dbgCanvas);
+      final FPSAnimator anim = new FPSAnimator(dbgCanvas, 10);
+      dbgFrame.addWindowListener(new WindowAdapter() {
+          public void windowClosing(WindowEvent e) {
+            // Run this on another thread than the AWT event queue to
+            // make sure the call to Animator.stop() completes before
+            // exiting
+            new Thread(new Runnable() {
+                public void run() {
+                  anim.stop();
+                }
+              }).start();
+          }
+        });
+      dbgFrame.setSize(256, 256);
+      dbgFrame.setVisible(true);
+      anim.start();
+    }
+    */
+
+    frame.show();
+    animator.start();
+  }
+
+  private TextRenderer renderer;
+  private Time time;
+  private Font font;
+  private Vec2f velocity = new Vec2f(100.0f, 150.0f);
+  private Vec2f position;
+  private String TEST_STRING = "Java 2D Text";
+  private int textWidth;
+  private int textHeight;
+  private String fpsText;
+  private int fpsWidth;
+  private long startTime;
+  private int frameCount;
+  private DecimalFormat format = new DecimalFormat("####.00");
+
+  public void init(GLAutoDrawable drawable) {
+    GL gl = drawable.getGL();
+
+    // Don't artificially slow us down, at least on platforms where we
+    // have control over this (note: on X11 platforms this may not
+    // have the effect of overriding the setSwapInterval(1) in the
+    // Gears demo)
+    gl.setSwapInterval(0);
+
+    renderer = new TextRenderer(new Font("SansSerif", Font.BOLD, 36));
+    time = new SystemTime();
+    ((SystemTime) time).rebase();
+
+    // Start the text half way up the left side
+    position = new Vec2f(0.0f, drawable.getHeight() / 2);
+    Rectangle2D textBounds = renderer.getBounds(TEST_STRING);
+    textWidth = (int) textBounds.getWidth();
+    textHeight = (int) textBounds.getHeight();
+  }
+
+  public void display(GLAutoDrawable drawable) {
+    if (startTime == 0) {
+      startTime = System.currentTimeMillis();
+    }
+
+    if (++frameCount == 100) {
+      long endTime = System.currentTimeMillis();
+      float fps = 100.0f / (float) (endTime - startTime) * 1000;
+      frameCount = 0;
+      startTime = System.currentTimeMillis();
+
+      fpsText = "FPS: " + format.format(fps);
+      if (fpsWidth == 0) {
+        // Place it at a fixed offset wrt the lower right corner
+        fpsWidth = (int) renderer.getBounds("FPS: 1000.00").getWidth();
+      }
+    }
+
+    time.update();
+
+    // Compute the next position of the text
+    position = position.plus(velocity.times((float) time.deltaT()));
+    // Figure out whether we have to switch directions
+    if (position.x() < 0) {
+      velocity.setX(Math.abs(velocity.x()));
+    } else if (position.x() + textWidth > drawable.getWidth()) {
+      velocity.setX(-1.0f * Math.abs(velocity.x()));
+    }      
+    if (position.y() < 0) {
+      velocity.setY(Math.abs(velocity.y()));
+    } else if (position.y() + textHeight > drawable.getHeight()) {
+      velocity.setY(-1.0f * Math.abs(velocity.y()));
+    }      
+
+    GL gl = drawable.getGL();
+
+    // Prepare to draw text
+    renderer.beginRendering(drawable.getWidth(), drawable.getHeight());
+
+    // Draw text
+    renderer.draw(TEST_STRING, (int) position.x(), (int) position.y());
+
+    if (fpsWidth != 0) {
+      renderer.draw(fpsText,
+                    drawable.getWidth() - fpsWidth - 10,
+                    20);
+    }
+
+    // Clean up rendering
+    renderer.endRendering();
+  }
+
+  // Unused methods
+  public void reshape(GLAutoDrawable drawable, int x, int y, int width, int height) {}
+  public void displayChanged(GLAutoDrawable drawable, boolean modeChanged, boolean deviceChanged) {}
+
+  /*
+  class DebugListener implements GLEventListener {
+    private GLU glu = new GLU();
+    private Frame frame;
+
+    DebugListener(Frame frame) {
+      this.frame = frame;
+    }
+
+    public void display(GLAutoDrawable drawable) {
+      GL gl = drawable.getGL();
+      gl.glClear(GL.GL_DEPTH_BUFFER_BIT | GL.GL_COLOR_BUFFER_BIT);
+      if (renderer != null) {
+        J2DTextureRenderer rend = renderer.getBackingStore();
+        final int w = rend.getWidth();
+        final int h = rend.getHeight();
+        rend.beginOrthoRendering(w, h);
+        rend.drawOrthoRect(0, 0);
+        rend.endOrthoRendering();
+        if (frame.getWidth() != w ||
+            frame.getHeight() != h) {
+          EventQueue.invokeLater(new Runnable() {
+              public void run() {
+                frame.setSize(w, h);
+              }
+            });
+        }
+      }
+    }
+
+    // Unused methods
+    public void init(GLAutoDrawable drawable) {}
+    public void reshape(GLAutoDrawable drawable, int x, int y, int width, int height) {}
+    public void displayChanged(GLAutoDrawable drawable, boolean modeChanged, boolean deviceChanged) {}
+  }
+  */
+}