gov/nasa/worldwind/PlaceNameRenderer.java

   1 /*
   2 Copyright (C) 2001, 2006 United States Government as represented by
   3 the Administrator of the National Aeronautics and Space Administration.
   4 All Rights Reserved.
   5 */
   6 package gov.nasa.worldwind;
   7
   8 import com.sun.opengl.util.j2d.*;
   9 import gov.nasa.worldwind.geom.*;
  10
  11 import javax.media.opengl.*;
  12 import javax.media.opengl.glu.*;
  13 import java.awt.*;
  14 import java.awt.geom.*;
  15 import java.util.*;
  16 import java.util.logging.Level;
  17
  18 /**
  19  * @author dcollins
  20  * @version $Id: PlaceNameRenderer.java 1994 2007-06-11 16:33:33Z dcollins $
  21  */
  22 public class PlaceNameRenderer implements Disposable
  23 {
  24     private static final Font defaultFont = Font.decode("Arial-12-PLAIN");
  25     private static final Color defaultColor = Color.white;
  26     private final Map<Font, TextRenderer> textRenderers = new HashMap<Font, TextRenderer>();
  27     private TextRenderer lastTextRenderer = null;
  28     private final GLU glu = new GLU();
  29
  30     public PlaceNameRenderer()
  31     {
  32     }
  33
  34     public void dispose()
  35     {
  36         for (TextRenderer textRenderer : textRenderers.values())
  37         {
  38             if (textRenderer != null)
  39                 textRenderer.dispose();
  40         }
  41     }
  42
  43     public void render(DrawContext dc, Iterator<PlaceName> placeNames, boolean enableDepthTest)
  44     {
  45         this.drawMany(dc, placeNames, enableDepthTest);
  46     }
  47
  48     public void render(DrawContext dc, PlaceName placeName, Vec4 placeNamePoint, boolean enableDepthTest)
  49     {
  50         if (!isNameValid(placeName, false))
  51             return;
  52
  53         this.drawOne(dc, placeName, placeNamePoint, enableDepthTest);
  54     }
  55
  56     private void drawMany(DrawContext dc, Iterator<PlaceName> placeNames, boolean enableDepthTest)
  57     {
  58         if (dc == null)
  59         {
  60             String msg = WorldWind.retrieveErrMsg("nullValue.DrawContextIsNull");
  61             WorldWind.logger().log(Level.FINE, msg);
  62             throw new IllegalArgumentException(msg);
  63         }
  64
  65         if (dc.getVisibleSector() == null)
  66             return;
  67
  68         SectorGeometryList geos = dc.getSurfaceGeometry();
  69         if (geos == null)
  70             return;
  71
  72         if (placeNames == null)
  73         {
  74             String msg = WorldWind.retrieveErrMsg("nullValue.Iterator");
  75             WorldWind.logger().log(Level.FINE, msg);
  76             throw new IllegalArgumentException(msg);
  77         }
  78
  79         if (!placeNames.hasNext())
  80             return;
  81
  82         Frustum frustumInModelCoords = dc.getView().getFrustumInModelCoordinates();
  83         double horizon = dc.getView().computeHorizonDistance();
  84
  85         this.beginDrawNames(dc, enableDepthTest);
  86
  87         while (placeNames.hasNext())
  88         {
  89             PlaceName placeName = placeNames.next();
  90             if (!isNameValid(placeName, true))
  91                 continue;
  92
  93             if (!placeName.isVisible())
  94                 continue;
  95
  96             Angle lat = placeName.getPosition().getLatitude();
  97             Angle lon = placeName.getPosition().getLongitude();
  98
  99             if (!dc.getVisibleSector().contains(lat, lon))
 100                 continue;
 101
 102             Vec4 namePoint = geos.getSurfacePoint(lat, lon, placeName.getPosition().getElevation());
 103             if (namePoint == null)
 104                 continue;
 105
 106             double eyeDistance = dc.getView().getEyePoint().distanceTo3(namePoint);
 107             if (eyeDistance > horizon)
 108                 continue;
 109
 110             if (!frustumInModelCoords.contains(namePoint))
 111                 continue;
 112
 113             this.drawName(dc, placeName, namePoint, enableDepthTest);
 114         }
 115
 116         this.endDrawNames(dc);
 117     }
 118
 119     private void drawOne(DrawContext dc, PlaceName placeName, Vec4 namePoint, boolean enableDepthTest)
 120     {
 121         if (dc == null)
 122         {
 123             String msg = WorldWind.retrieveErrMsg("nullValue.DrawContextIsNull");
 124             WorldWind.logger().log(Level.FINE, msg);
 125             throw new IllegalArgumentException(msg);
 126         }
 127         if (dc.getView() == null)
 128         {
 129             String msg = WorldWind.retrieveErrMsg("nullValue.ViewIsNull");
 130             WorldWind.logger().log(Level.FINE, msg);
 131             throw new IllegalArgumentException(msg);
 132         }
 133
 134         if (dc.getVisibleSector() == null)
 135             return;
 136
 137         SectorGeometryList geos = dc.getSurfaceGeometry();
 138         if (geos == null)
 139             return;
 140
 141         if (!placeName.isVisible())
 142             return;
 143
 144         if (namePoint == null)
 145         {
 146             if (placeName.getPosition() == null)
 147                 return;
 148
 149             Angle lat = placeName.getPosition().getLatitude();
 150             Angle lon = placeName.getPosition().getLongitude();
 151
 152             if (!dc.getVisibleSector().contains(lat, lon))
 153                 return;
 154
 155             namePoint = geos.getSurfacePoint(lat, lon, placeName.getPosition().getElevation());
 156             if (namePoint == null)
 157                 return;
 158         }
 159
 160         double horizon = dc.getView().computeHorizonDistance();
 161         double eyeDistance = dc.getView().getEyePoint().distanceTo3(namePoint);
 162         if (eyeDistance > horizon)
 163             return;
 164
 165         if (!dc.getView().getFrustumInModelCoordinates().contains(namePoint))
 166             return;
 167
 168         this.beginDrawNames(dc, enableDepthTest);
 169         this.drawName(dc, placeName, namePoint, enableDepthTest);
 170         this.endDrawNames(dc);
 171     }
 172
 173     private static boolean isNameValid(PlaceName placeName, boolean checkPosition)
 174     {
 175         if (placeName == null || placeName.getText() == null)
 176             return false;
 177
 178         //noinspection RedundantIfStatement
 179         if (checkPosition && placeName.getPosition() == null)
 180             return false;
 181
 182         return true;
 183     }
 184
 185     private final int[] viewportArray = new int[4];
 186
 187     private void beginDrawNames(DrawContext dc, boolean enableDepthTest)
 188     {
 189         GL gl = dc.getGL();
 190         int attribBits =
 191             GL.GL_ENABLE_BIT
 192                 | GL.GL_COLOR_BUFFER_BIT // for alpha test func and ref, and blend
 193                 | GL.GL_CURRENT_BIT      // for current color
 194                 | GL.GL_TRANSFORM_BIT    // for modelview and perspective
 195                 | (enableDepthTest ? GL.GL_VIEWPORT_BIT | GL.GL_DEPTH_BUFFER_BIT : 0); // for depth func, depth range
 196         gl.glPushAttrib(attribBits);
 197
 198         gl.glGetIntegerv(GL.GL_VIEWPORT, viewportArray, 0);
 199         gl.glMatrixMode(GL.GL_PROJECTION);
 200         gl.glPushMatrix();
 201         gl.glLoadIdentity();
 202         glu.gluOrtho2D(0, viewportArray[2], 0, viewportArray[3]);
 203         gl.glMatrixMode(GL.GL_MODELVIEW);
 204         gl.glPushMatrix();
 205         gl.glLoadIdentity();
 206         gl.glMatrixMode(GL.GL_TEXTURE);
 207         gl.glPushMatrix();
 208         gl.glLoadIdentity();
 209
 210         // Enable the depth test but don't write to the depth buffer.
 211         if (enableDepthTest)
 212         {
 213             gl.glEnable(GL.GL_DEPTH_TEST);
 214             gl.glDepthFunc(GL.GL_LESS);
 215             gl.glDepthMask(false);
 216         }
 217         else
 218         {
 219             gl.glDisable(GL.GL_DEPTH_TEST);
 220         }
 221         // Suppress polygon culling.
 222         gl.glDisable(GL.GL_CULL_FACE);
 223         // Suppress any fully transparent image pixels
 224         final float ALPHA_EPSILON = 0.001f;
 225         gl.glEnable(GL.GL_ALPHA_TEST);
 226         gl.glAlphaFunc(GL.GL_GREATER, ALPHA_EPSILON);
 227     }
 228
 229     private void endDrawNames(DrawContext dc)
 230     {
 231         if (this.lastTextRenderer != null)
 232         {
 233             this.lastTextRenderer.end3DRendering();
 234             this.lastTextRenderer = null;
 235         }
 236
 237         GL gl = dc.getGL();
 238
 239         gl.glMatrixMode(GL.GL_PROJECTION);
 240         gl.glPopMatrix();
 241         gl.glMatrixMode(GL.GL_MODELVIEW);
 242         gl.glPopMatrix();
 243         gl.glMatrixMode(GL.GL_TEXTURE);
 244         gl.glPopMatrix();
 245
 246         gl.glPopAttrib();
 247     }
 248
 249     private Vec4 drawName(DrawContext dc, PlaceName name, Vec4 namePoint, boolean enableDepthTest)
 250     {
 251         if (namePoint == null)
 252         {
 253             String msg = WorldWind.retrieveErrMsg("nullValue.PointIsNull");
 254             WorldWind.logger().log(Level.FINE, msg);
 255             return null;
 256         }
 257
 258         final String text = name.getText();
 259         if (text == null)
 260             return null;
 261
 262         final Vec4 screenPoint = dc.getView().project(namePoint);
 263         if (screenPoint == null)
 264             return null;
 265
 266         if (enableDepthTest)
 267             this.setDepthFunc(dc, screenPoint);
 268
 269         Font font = name.getFont();
 270         if (font == null)
 271             font = defaultFont;
 272
 273         TextRenderer textRenderer = this.textRenderers.get(font);
 274         if (textRenderer == null)
 275             textRenderer = this.initializeTextRenderer(font);
 276         if (textRenderer != this.lastTextRenderer)
 277         {
 278             if (this.lastTextRenderer != null)
 279                 this.lastTextRenderer.end3DRendering();
 280             textRenderer.begin3DRendering();
 281             this.lastTextRenderer = textRenderer;
 282         }
 283
 284         Rectangle2D nameBound = textRenderer.getBounds(text);
 285         int x = (int) (screenPoint.x - nameBound.getWidth() / 2d);
 286         int y = (int) screenPoint.y;
 287
 288         Color color = name.getColor();
 289         if (color == null)
 290             color = defaultColor;
 291
 292         this.setBackgroundColor(textRenderer, color);
 293         textRenderer.draw(text, x + 1, y - 1);
 294         textRenderer.setColor(color);
 295         textRenderer.draw(text, x, y);
 296
 297         return screenPoint;
 298     }
 299
 300     private void setDepthFunc(DrawContext dc, Vec4 screenPoint)
 301     {
 302         double depth = screenPoint.z - (8d * 0.00048875809d);
 303         depth = (depth < 0) ? 0 : ((depth > 1) ? 1 : depth);
 304         dc.getGL().glDepthRange(depth, depth);
 305     }
 306
 307     private final float[] compArray = new float[4];
 308
 309     private void setBackgroundColor(TextRenderer textRenderer, Color color)
 310     {
 311         Color.RGBtoHSB(color.getRed(), color.getGreen(), color.getBlue(), compArray);
 312         if (compArray[2] > 0.5)
 313             textRenderer.setColor(0, 0, 0, 0.7f);
 314         else
 315             textRenderer.setColor(1, 1, 1, 0.7f);
 316     }
 317
 318     private TextRenderer initializeTextRenderer(Font font)
 319     {
 320         TextRenderer textRenderer = new TextRenderer(font, true, true);
 321         TextRenderer oldTextRenderer;
 322         oldTextRenderer = this.textRenderers.put(font, textRenderer);
 323         if (oldTextRenderer != null)
 324             oldTextRenderer.dispose();
 325         return textRenderer;
 326     }
 327
 328     public String toString()
 329     {
 330         return WorldWind.retrieveErrMsg("layers.PlaceNameLayer.Name");
 331     }
 332 }