On request from James Gosling and others, added a J2DTextureRenderer

class to com.sun.opengl.util to make it easier to render into OpenGL
textures using Java 2D. Added convenience methods to this class to
make it easy to draw sub-rectangles of the resulting texture to the
screen. Added a J2DOverlay class which acts like a Java 2D-based
heads-up display for an arbitrary GLDrawable, tracking its size and
making it easier to render the entire contents of the HUD. There
appear to be performance issues with the J2DOverlay class as the
window gets large, at least on older hardware, as it allocates very
large OpenGL textures internally. Added tests for both the
J2DTextureRenderer and J2DOverlay classes which have similar
functionality but different implementation approaches and different
performance characteristics.


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

2 files changed, 407 insertions, 0 deletions

diff --git a/src/demos/j2d/TestJ2DOverlay.java b/src/demos/j2d/TestJ2DOverlay.java
new file mode 100755
index 0000000..a3104ac
--- /dev/null
+++ b/src/demos/j2d/TestJ2DOverlay.java
@@ -0,0 +1,204 @@
+/*
+ * 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;
+
+import java.awt.AlphaComposite;
+import java.awt.Color;
+import java.awt.Font;
+import java.awt.Frame;
+import java.awt.Graphics2D;
+import java.awt.Rectangle;
+import java.awt.event.*;
+import java.awt.font.*;
+import java.text.*;
+
+import javax.media.opengl.*;
+import com.sun.opengl.util.*;
+import com.sun.opengl.util.texture.*;
+
+import demos.gears.Gears;
+import demos.util.*;
+import gleem.linalg.*;
+
+/** A simple test of the J2DOverlay class. Draws gears underneath with
+    moving Java 2D-rendered text on top. */
+
+public class TestJ2DOverlay implements GLEventListener {
+  public static void main(String[] args) {
+    Frame frame = new Frame("Java 2D Overlay Test");
+    GLCapabilities caps = new GLCapabilities();
+    caps.setAlphaBits(8);
+    GLCanvas canvas = new GLCanvas(caps);
+    canvas.addGLEventListener(new Gears());
+    canvas.addGLEventListener(new TestJ2DOverlay());
+    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();
+        }
+      });
+    frame.show();
+    animator.start();
+  }
+
+  private J2DOverlay overlay;
+  private Time time;
+  private Font font;
+  private Color TRANSPARENT_BLACK = new Color(0.0f, 0.0f, 0.0f, 0.0f);
+  private FontRenderContext frc;
+  private GlyphVector gv;
+  private Vec2f velocity = new Vec2f(100.0f, 150.0f);
+  private Vec2f position;
+  private Rectangle textBounds;
+  private Rectangle lastTextBounds;
+  private String TEST_STRING = "Java 2D Text";
+  private long startTime;
+  private int frameCount;
+  private DecimalFormat format = new DecimalFormat("####.00");
+
+  public void init(GLAutoDrawable drawable) {
+    GL gl = drawable.getGL();
+    gl.setSwapInterval(0);
+
+    overlay = new J2DOverlay(drawable);
+    time = new SystemTime();
+    ((SystemTime) time).rebase();
+
+    // Start the text half way up the left side
+    position = new Vec2f(0.0f, drawable.getHeight() / 2);
+
+    // Create the font, render context, and glyph vector
+    font = new Font("SansSerif", Font.BOLD, 36);
+  }
+
+  public void display(GLAutoDrawable drawable) {
+    if (startTime == 0) {
+      startTime = System.currentTimeMillis();
+    }
+
+    Graphics2D g2d = overlay.createGraphics();
+
+    if (++frameCount == 30) {
+      long endTime = System.currentTimeMillis();
+      float fps = 30.0f / (float) (endTime - startTime) * 1000;
+      frameCount = 0;
+      startTime = System.currentTimeMillis();
+
+      FontRenderContext frc = g2d.getFontRenderContext();
+      String fpsString = "FPS: " + format.format(fps);
+      GlyphVector gv = font.createGlyphVector(frc, TEST_STRING);
+      int x = drawable.getWidth() - 200;
+      int y = drawable.getHeight() - 20;
+      Rectangle fpsBounds = gv.getPixelBounds(frc, x, y);
+      g2d.setFont(font);
+      g2d.setComposite(AlphaComposite.Src);
+      g2d.setColor(TRANSPARENT_BLACK);
+      g2d.fillRect(fpsBounds.x, fpsBounds.y, fpsBounds.width, fpsBounds.height);
+      g2d.setColor(Color.WHITE);
+      g2d.drawString(fpsString, x, y);
+      overlay.sync(fpsBounds.x, fpsBounds.y, fpsBounds.width, fpsBounds.height);
+    }
+
+    time.update();
+
+    // Move down the text bounds
+    lastTextBounds = textBounds;
+
+    g2d.setFont(font);
+    g2d.setComposite(AlphaComposite.Src);
+    if (overlay.contentsLost()) {
+      frc = g2d.getFontRenderContext();
+      gv = font.createGlyphVector(frc, TEST_STRING);
+    }
+
+    // Compute the next position of the text
+    position = position.plus(velocity.times((float) time.deltaT()));
+    // Figure out whether we have to switch directions
+    textBounds = gv.getPixelBounds(frc, position.x(), position.y());
+    if (textBounds.getMinX() < 0) {
+      velocity.setX(Math.abs(velocity.x()));
+    } else if (textBounds.getMaxX() > drawable.getWidth()) {
+      velocity.setX(-1.0f * Math.abs(velocity.x()));
+    }
+    if (textBounds.getMinY() < 0) {
+      velocity.setY(Math.abs(velocity.y()));
+    } else if (textBounds.getMaxY() > drawable.getHeight()) {
+      velocity.setY(-1.0f * Math.abs(velocity.y()));
+    }
+
+    // Clear the last text (if any) and draw the current
+    if (lastTextBounds != null) {
+      g2d.setColor(TRANSPARENT_BLACK);
+      g2d.fillRect((int) lastTextBounds.getMinX(), (int) lastTextBounds.getMinY(),
+                   (int) (lastTextBounds.getWidth() + 1), (int) (lastTextBounds.getHeight() + 1));
+    } else if (overlay.contentsLost()) {
+      g2d.setColor(TRANSPARENT_BLACK);
+      g2d.fillRect(0, 0, drawable.getWidth(), drawable.getHeight());
+    }
+    g2d.setColor(Color.WHITE);
+    g2d.drawString(TEST_STRING, position.x(), position.y());
+
+    // Compute the union of these rectangles to push an update to
+    // the overlay
+    Rectangle union = new Rectangle(textBounds);
+    if (lastTextBounds != null) {
+      union.add(lastTextBounds);
+    }
+    overlay.sync(union.x, union.y, union.width, union.height);
+
+    // Draw the overlay
+    overlay.drawAll();
+    g2d.dispose();
+  }
+
+  // Unused methods
+  public void reshape(GLAutoDrawable drawable, int x, int y, int width, int height) {}
+  public void displayChanged(GLAutoDrawable drawable, boolean modeChanged, boolean deviceChanged) {}
+}
diff --git a/src/demos/j2d/TestJ2DRenderer.java b/src/demos/j2d/TestJ2DRenderer.java
new file mode 100755
index 0000000..f7ea8c3
--- /dev/null
+++ b/src/demos/j2d/TestJ2DRenderer.java
@@ -0,0 +1,203 @@
+/*
+ * 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;
+
+import java.awt.AlphaComposite;
+import java.awt.Color;
+import java.awt.Font;
+import java.awt.Frame;
+import java.awt.Graphics2D;
+import java.awt.Rectangle;
+import java.awt.event.*;
+import java.awt.font.*;
+import java.text.*;
+
+import javax.media.opengl.*;
+import javax.media.opengl.glu.*;
+import com.sun.opengl.util.*;
+import com.sun.opengl.util.texture.*;
+
+import demos.gears.Gears;
+import demos.util.*;
+import gleem.linalg.*;
+
+/** A simple test of the J2DTextureRenderer class. Draws gears
+    underneath with moving Java 2D-rendered text on top. */
+
+public class TestJ2DRenderer implements GLEventListener {
+  public static void main(String[] args) {
+    Frame frame = new Frame("Java 2D Renderer Test");
+    GLCapabilities caps = new GLCapabilities();
+    caps.setAlphaBits(8);
+    GLCanvas canvas = new GLCanvas(caps);
+    canvas.addGLEventListener(new Gears());
+    canvas.addGLEventListener(new TestJ2DRenderer());
+    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();
+        }
+      });
+    frame.show();
+    animator.start();
+  }
+
+  private J2DTextureRenderer renderer;
+  private Time time;
+  private Font font;
+  private Color TRANSPARENT_BLACK = new Color(0.0f, 0.0f, 0.0f, 0.0f);
+  private Vec2f velocity = new Vec2f(100.0f, 150.0f);
+  private Vec2f position;
+  private Rectangle textBounds;
+  private Rectangle fpsBounds;
+  private String TEST_STRING = "Java 2D Text";
+  private GLU glu = new GLU();
+  private long startTime;
+  private int frameCount;
+  private DecimalFormat format = new DecimalFormat("####.00");
+
+  public void init(GLAutoDrawable drawable) {
+    GL gl = drawable.getGL();
+    gl.setSwapInterval(0);
+
+    renderer = new J2DTextureRenderer(256, 256, true);
+    time = new SystemTime();
+    ((SystemTime) time).rebase();
+
+    // Start the text half way up the left side
+    position = new Vec2f(0.0f, drawable.getHeight() / 2);
+
+    // Create the font, render context, and glyph vector
+    font = new Font("SansSerif", Font.BOLD, 36);
+    Graphics2D g2d = renderer.createGraphics();
+    g2d.setFont(font);
+    g2d.setComposite(AlphaComposite.Src);
+    FontRenderContext frc = g2d.getFontRenderContext();
+    GlyphVector gv = font.createGlyphVector(frc, TEST_STRING);
+    g2d.setColor(TRANSPARENT_BLACK);
+    g2d.fillRect(0, 0, renderer.getWidth(), renderer.getHeight());
+    g2d.setColor(Color.WHITE);
+    g2d.drawString(TEST_STRING, 10, 50);
+    textBounds = gv.getPixelBounds(frc, 10, 50);
+    renderer.sync(textBounds.x, textBounds.y, textBounds.width, textBounds.height);
+  }
+
+  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();
+
+      Graphics2D g2d = renderer.createGraphics();
+      g2d.setFont(font);
+      g2d.setComposite(AlphaComposite.Src);
+      FontRenderContext frc = g2d.getFontRenderContext();
+      String fpsString = "FPS: " + format.format(fps);
+      GlyphVector gv = font.createGlyphVector(frc, TEST_STRING);
+      fpsBounds = gv.getPixelBounds(frc, 10, 100);
+      g2d.setColor(TRANSPARENT_BLACK);
+      g2d.fillRect(fpsBounds.x, fpsBounds.y, fpsBounds.width, fpsBounds.height);
+      g2d.setColor(Color.WHITE);
+      g2d.drawString(fpsString, 10, 100);
+    }
+
+    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
+    Rectangle tmpBounds = new Rectangle((int) position.x(), (int) position.y(),
+                                        textBounds.width, textBounds.height);
+    if (tmpBounds.getMinX() < 0) {
+      velocity.setX(Math.abs(velocity.x()));
+    } else if (tmpBounds.getMaxX() > drawable.getWidth()) {
+      velocity.setX(-1.0f * Math.abs(velocity.x()));
+    }
+    if (tmpBounds.getMinY() < 0) {
+      velocity.setY(Math.abs(velocity.y()));
+    } else if (tmpBounds.getMaxY() > drawable.getHeight()) {
+      velocity.setY(-1.0f * Math.abs(velocity.y()));
+    }
+
+    GL gl = drawable.getGL();
+
+    // Prepare to draw from the renderer's texture
+    renderer.beginOrthoRendering(drawable.getWidth(), drawable.getHeight());
+
+    // Draw from the renderer's texture
+    renderer.drawOrthoRect((int) position.x(), (int) position.y(),
+                           textBounds.x,
+                           renderer.getHeight() - textBounds.y - textBounds.height,
+                           textBounds.width,
+                           textBounds.height);
+
+    // If we have the FPS, draw it
+    if (fpsBounds != null) {
+      renderer.drawOrthoRect(drawable.getWidth() - fpsBounds.width,
+                             20,
+                             fpsBounds.x,
+                             renderer.getHeight() - fpsBounds.y - fpsBounds.height,
+                             fpsBounds.width,
+                             fpsBounds.height);
+    }
+    
+    // Clean up rendering
+    renderer.endOrthoRendering();
+  }
+
+  // Unused methods
+  public void reshape(GLAutoDrawable drawable, int x, int y, int width, int height) {}
+  public void displayChanged(GLAutoDrawable drawable, boolean modeChanged, boolean deviceChanged) {}
+}