gov/nasa/worldwind/WorldWindowGLAutoDrawable.java

   1 /*
   2 Copyright (C) 2001, 2006 United States Government
   3 as represented by the Administrator of the
   4 National Aeronautics and Space Administration.
   5 All Rights Reserved.
   6 */
   7 package gov.nasa.worldwind;
   8
   9 import javax.media.opengl.*;
  10 import javax.swing.event.*;
  11 import java.beans.*;
  12
  13 /**
  14  * A non-platform specific {@link WorldWindow} class. This class can be aggregated into platform-specific classes to
  15  * provide the core functionality of World Wind.
  16  *
  17  * @author Tom Gaskins
  18  * @version $Id: WorldWindowGLAutoDrawable.java 1757 2007-05-07 09:17:09Z tgaskins $
  19  */
  20 public class WorldWindowGLAutoDrawable extends WorldWindowImpl implements GLEventListener
  21 {
  22     private final GLAutoDrawable drawable;
  23     private final EventListenerList eventListeners = new EventListenerList();
  24
  25     private java.awt.Point pickPoint; // used to pass pick point to display method
  26
  27     /**
  28      * Construct a new <code>WorldWindowGLCanvase</code> for a specified {@link GLDrawable}.
  29      *
  30      * @param drawable the drawable associated with the window.
  31      * @throws IllegalArgumentException if <code>drawable</code> is <code>null</code>.
  32      */
  33     public WorldWindowGLAutoDrawable(GLAutoDrawable drawable)
  34     {
  35         if (drawable == null)
  36         {
  37             String message = WorldWind.retrieveErrMsg("WorldWindowGLCanvas.GLAutoDrawableNullToConstructor");
  38             WorldWind.logger().log(java.util.logging.Level.FINE, message);
  39             throw new IllegalArgumentException(message);
  40         }
  41
  42         this.drawable = drawable;
  43         this.drawable.setAutoSwapBufferMode(false); // to prevent buffer swapping after a pick traversal
  44         drawable.addGLEventListener(this);
  45
  46         SceneController sc = this.getSceneController();
  47         if (sc != null)
  48         {
  49             sc.addPropertyChangeListener(this);
  50         }
  51     }
  52
  53     @Override
  54     public void propertyChange(PropertyChangeEvent propertyChangeEvent)
  55     {
  56         if (propertyChangeEvent == null)
  57         {
  58             String msg = WorldWind.retrieveErrMsg("nullValue.PropertyChangeEventIsNull");
  59             WorldWind.logger().log(java.util.logging.Level.FINE, msg);
  60             throw new IllegalArgumentException(msg);
  61         }
  62         this.drawable.repaint(); // Queue a JOGL repaint request.
  63     }
  64
  65     /**
  66      * See {@link GLEventListener#init(GLAutoDrawable)}.
  67      *
  68      * @param glAutoDrawable the drawable
  69      */
  70     public void init(GLAutoDrawable glAutoDrawable)
  71     {
  72         // This GLEventListener callback method is not used.
  73 //        this.drawable.setGL(new DebugGL(this.drawable.getGL()));
  74     }
  75
  76     /**
  77      * See {@link GLEventListener#display(GLAutoDrawable)}.
  78      *
  79      * @param glAutoDrawable the drawable
  80      * @throws IllegalStateException if no {@link SceneController} exists for this canvas
  81      */
  82     public void display(GLAutoDrawable glAutoDrawable)
  83     {
  84         try
  85         {
  86             SceneController sc = this.getSceneController();
  87             if (sc == null)
  88             {
  89                 String message = WorldWind.retrieveErrMsg("WorldWindowGLCanvas.ScnCntrllerNullOnRepaint");
  90                 WorldWind.logger().log(java.util.logging.Level.FINE, message);
  91                 throw new IllegalStateException(message);
  92             }
  93
  94             if (this.pickPoint != null)
  95             {
  96                 sc.pick(this.pickPoint);
  97                 this.pickPoint = null;
  98                 // Keep going here in order to repair the back buffer and affect any highlighting the app may have made.
  99             }
 100
 101             try
 102             {
 103                 this.callRenderingListeners(new RenderingEvent(this.drawable, RenderingEvent.BEGIN));
 104             }
 105             catch (Exception e)
 106             {
 107                 WorldWind.logger().log(java.util.logging.Level.FINE, WorldWind.retrieveErrMsg(
 108                     "WorldWindowGLAutoDrawable.ExceptionDuringGLEventListenerDisplay"), e);
 109             }
 110
 111             sc.repaint();
 112             try
 113             {
 114                 this.callRenderingListeners(new RenderingEvent(this.drawable, RenderingEvent.END));
 115             }
 116             catch (Exception e)
 117             {
 118                 WorldWind.logger().log(java.util.logging.Level.FINE, WorldWind.retrieveErrMsg(
 119                     "WorldWindowGLAutoDrawable.ExceptionDuringGLEventListenerDisplay"), e);
 120             }
 121
 122             this.drawable.swapBuffers();
 123         }
 124         catch (Exception e)
 125         {
 126             WorldWind.logger().log(java.util.logging.Level.FINE, WorldWind.retrieveErrMsg(
 127                 "WorldWindowGLCanvas.ExceptionAttemptingRepaintWorldWindow"), e);
 128         }
 129         finally
 130         {
 131             this.pickPoint = null;
 132         }
 133     }
 134
 135     /**
 136      * See {@link GLEventListener#reshape(GLAutoDrawable,int,int,int,int)}.
 137      *
 138      * @param glAutoDrawable the drawable
 139      */
 140     public void reshape(GLAutoDrawable glAutoDrawable, int x, int y, int w, int h)
 141     {
 142     }
 143
 144     /**
 145      * See {@link GLEventListener#displayChanged(GLAutoDrawable,boolean,boolean)}.
 146      *
 147      * @param glAutoDrawable the drawable
 148      */
 149     public void displayChanged(GLAutoDrawable glAutoDrawable, boolean b, boolean b1)
 150     {
 151         WorldWind.logger().log(java.util.logging.Level.FINEST, WorldWind.retrieveErrMsg(
 152             "WorldWindowGLCanvas.DisplayEventListenersDisplayChangedMethodCalled"));
 153     }
 154
 155     public PickedObjectList pick(java.awt.Point pickPoint)
 156     {
 157         if (pickPoint == null)
 158         {
 159             String msg = WorldWind.retrieveErrMsg("nullValue.PickPoint");
 160             WorldWind.logger().log(java.util.logging.Level.FINE, msg);
 161             throw new IllegalArgumentException(msg);
 162         }
 163
 164         this.pickPoint = pickPoint;
 165         this.drawable.display();
 166
 167         return this.getSceneController().getPickedObjectList();
 168     }
 169
 170     public void addRenderingListener(RenderingListener listener)
 171     {
 172         this.eventListeners.add(RenderingListener.class, listener);
 173     }
 174
 175     public void removeRenderingListener(RenderingListener listener)
 176     {
 177         this.eventListeners.remove(RenderingListener.class, listener);
 178     }
 179
 180     private void callRenderingListeners(RenderingEvent event)
 181     {
 182         for (RenderingListener listener : this.eventListeners.getListeners(RenderingListener.class))
 183         {
 184             listener.stageChanged(event);
 185         }
 186     }
 187 }