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 gov.nasa.worldwind.geom.*;
  10
  11 import javax.media.opengl.*;
  12 import javax.swing.event.*;
  13 import java.beans.*;
  14 import java.awt.*;
  15
  16 /**
  17  * A non-platform specific {@link WorldWindow} class. This class can be aggregated into platform-specific classes to
  18  * provide the core functionality of World Wind.
  19  *
  20  * @author Tom Gaskins
  21  * @version $Id: WorldWindowGLAutoDrawable.java 2150 2007-06-26 07:40:58Z tgaskins $
  22  */
  23 public class WorldWindowGLAutoDrawable extends WorldWindowImpl implements GLEventListener
  24 {
  25     private final GLAutoDrawable drawable;
  26     private final EventListenerList eventListeners = new EventListenerList();
  27
  28     /**
  29      * Construct a new <code>WorldWindowGLCanvase</code> for a specified {@link GLDrawable}.
  30      *
  31      * @param drawable the drawable associated with the window.
  32      * @throws IllegalArgumentException if <code>drawable</code> is <code>null</code>.
  33      */
  34     public WorldWindowGLAutoDrawable(GLAutoDrawable drawable)
  35     {
  36         if (drawable == null)
  37         {
  38             String message = WorldWind.retrieveErrMsg("WorldWindowGLCanvas.GLAutoDrawableNullToConstructor");
  39             WorldWind.logger().log(java.util.logging.Level.FINE, message);
  40             throw new IllegalArgumentException(message);
  41         }
  42
  43         this.drawable = drawable;
  44         this.drawable.setAutoSwapBufferMode(false); // to prevent buffer swapping after a pick traversal
  45         drawable.addGLEventListener(this);
  46
  47         SceneController sc = this.getSceneController();
  48         if (sc != null)
  49         {
  50             sc.addPropertyChangeListener(this);
  51         }
  52     }
  53
  54     @Override
  55     public void propertyChange(PropertyChangeEvent propertyChangeEvent)
  56     {
  57         if (propertyChangeEvent == null)
  58         {
  59             String msg = WorldWind.retrieveErrMsg("nullValue.PropertyChangeEventIsNull");
  60             WorldWind.logger().log(java.util.logging.Level.FINE, msg);
  61             throw new IllegalArgumentException(msg);
  62         }
  63         this.drawable.repaint(); // Queue a JOGL repaint request.
  64     }
  65
  66     /**
  67      * See {@link GLEventListener#init(GLAutoDrawable)}.
  68      *
  69      * @param glAutoDrawable the drawable
  70      */
  71     public void init(GLAutoDrawable glAutoDrawable)
  72     {
  73         // This GLEventListener callback method is not used.
  74 //        this.drawable.setGL(new DebugGL(this.drawable.getGL()));
  75     }
  76
  77     /**
  78      * See {@link GLEventListener#display(GLAutoDrawable)}.
  79      *
  80      * @param glAutoDrawable the drawable
  81      * @throws IllegalStateException if no {@link SceneController} exists for this canvas
  82      */
  83     public void display(GLAutoDrawable glAutoDrawable)
  84     {
  85         try
  86         {
  87             SceneController sc = this.getSceneController();
  88             if (sc == null)
  89             {
  90                 String message = WorldWind.retrieveErrMsg("WorldWindowGLCanvas.ScnCntrllerNullOnRepaint");
  91                 WorldWind.logger().log(java.util.logging.Level.FINE, message);
  92                 throw new IllegalStateException(message);
  93             }
  94
  95             Position positionAtStart = this.getCurrentPosition();
  96             PickedObject selectionAtStart = this.getCurrentSelection();
  97
  98             try
  99             {
 100                 this.callRenderingListeners(new RenderingEvent(this.drawable, RenderingEvent.BEFORE_RENDERING));
 101             }
 102             catch (Exception e)
 103             {
 104                 WorldWind.logger().log(java.util.logging.Level.FINE, WorldWind.retrieveErrMsg(
 105                     "WorldWindowGLAutoDrawable.ExceptionDuringGLEventListenerDisplay"), e);
 106             }
 107
 108             sc.repaint();
 109             try
 110             {
 111                 this.callRenderingListeners(new RenderingEvent(this.drawable, RenderingEvent.BEFORE_BUFFER_SWAP));
 112             }
 113             catch (Exception e)
 114             {
 115                 WorldWind.logger().log(java.util.logging.Level.FINE, WorldWind.retrieveErrMsg(
 116                     "WorldWindowGLAutoDrawable.ExceptionDuringGLEventListenerDisplay"), e);
 117             }
 118
 119             this.drawable.swapBuffers();
 120
 121             Double frameTime = this.sceneController.getFrameTime();
 122             if (frameTime != null)
 123                 this.setValue(AVKey.FRAME_TIME, frameTime);
 124
 125             Double frameRate = this.sceneController.getFramesPerSecond();
 126             if (frameTime != null)
 127                 this.setValue(AVKey.FRAME_RATE, frameRate);
 128
 129             this.callRenderingListeners(new RenderingEvent(this.drawable, RenderingEvent.AFTER_BUFFER_SWAP));
 130
 131             Position positionAtEnd = this.getCurrentPosition();
 132             if (positionAtStart == null || positionAtEnd == null)
 133             {
 134                 if (positionAtStart != positionAtEnd)
 135                     this.callPositionListeners(new PositionEvent(this.drawable, this.sceneController.getPickPoint(),
 136                         positionAtStart, positionAtEnd));
 137             }
 138             else if (!positionAtEnd.equals(positionAtStart))
 139             {
 140                 this.callPositionListeners(new PositionEvent(this.drawable, this.sceneController.getPickPoint(),
 141                     positionAtStart, positionAtEnd));
 142             }
 143
 144             PickedObject selectionAtEnd = this.getCurrentSelection();
 145             if (selectionAtStart == null || selectionAtEnd == null)
 146             {
 147                 if (selectionAtStart != selectionAtEnd)
 148                     this.callSelectListeners(new SelectEvent(this.drawable, SelectEvent.ROLLOVER,
 149                         this.sceneController.getPickPoint(), this.sceneController.getPickedObjectList()));
 150             }
 151             else if (!selectionAtEnd.equals(selectionAtStart))
 152             {
 153                 this.callSelectListeners(new SelectEvent(this.drawable, SelectEvent.ROLLOVER,
 154                     this.sceneController.getPickPoint(), this.sceneController.getPickedObjectList()));
 155             }
 156         }
 157         catch (Exception e)
 158         {
 159             WorldWind.logger().log(java.util.logging.Level.FINE, WorldWind.retrieveErrMsg(
 160                 "WorldWindowGLCanvas.ExceptionAttemptingRepaintWorldWindow"), e);
 161         }
 162     }
 163
 164     /**
 165      * See {@link GLEventListener#reshape(GLAutoDrawable,int,int,int,int)}.
 166      *
 167      * @param glAutoDrawable the drawable
 168      */
 169     public void reshape(GLAutoDrawable glAutoDrawable, int x, int y, int w, int h)
 170     {
 171     }
 172
 173     /**
 174      * See {@link GLEventListener#displayChanged(GLAutoDrawable,boolean,boolean)}.
 175      *
 176      * @param glAutoDrawable the drawable
 177      */
 178     public void displayChanged(GLAutoDrawable glAutoDrawable, boolean b, boolean b1)
 179     {
 180         WorldWind.logger().log(java.util.logging.Level.FINEST, WorldWind.retrieveErrMsg(
 181             "WorldWindowGLCanvas.DisplayEventListenersDisplayChangedMethodCalled"));
 182     }
 183
 184     public void displayNow()
 185     {
 186         this.drawable.display();
 187     }
 188
 189     public Position getCurrentPosition()
 190     {
 191         if (this.sceneController == null)
 192             return null;
 193
 194         PickedObjectList pol = this.getSceneController().getPickedObjectList();
 195         if (pol == null || pol.size() < 1)
 196             return null;
 197
 198         Position p = null;
 199         PickedObject top = pol.getTopPickedObject();
 200         if (top != null && top.hasPosition())
 201             p = top.getPosition();
 202         else if (pol.getTerrainObject() != null)
 203             p = pol.getTerrainObject().getPosition();
 204
 205         return p;
 206     }
 207
 208     private PickedObject getCurrentSelection()
 209     {
 210         if (this.sceneController == null)
 211             return null;
 212
 213         PickedObjectList pol = this.getSceneController().getPickedObjectList();
 214         if (pol == null || pol.size() < 1)
 215             return null;
 216
 217         PickedObject top = pol.getTopPickedObject();
 218         return top.isTerrain() ? null : top;
 219     }
 220
 221     public void addRenderingListener(RenderingListener listener)
 222     {
 223         this.eventListeners.add(RenderingListener.class, listener);
 224     }
 225
 226     public void removeRenderingListener(RenderingListener listener)
 227     {
 228         this.eventListeners.remove(RenderingListener.class, listener);
 229     }
 230
 231     private void callRenderingListeners(RenderingEvent event)
 232     {
 233         for (RenderingListener listener : this.eventListeners.getListeners(RenderingListener.class))
 234         {
 235             listener.stageChanged(event);
 236         }
 237     }
 238
 239     public void addPositionListener(PositionListener listener)
 240     {
 241         this.eventListeners.add(PositionListener.class, listener);
 242     }
 243
 244     public void removePositionListener(PositionListener listener)
 245     {
 246         this.eventListeners.remove(PositionListener.class, listener);
 247     }
 248
 249     private void callPositionListeners(final PositionEvent event)
 250     {
 251         EventQueue.invokeLater(new Runnable()
 252         {
 253             public void run()
 254             {
 255                 for (PositionListener listener : eventListeners.getListeners(PositionListener.class))
 256                 {
 257                     listener.moved(event);
 258                 }
 259             }
 260         });
 261     }
 262
 263     public void addSelectListener(SelectListener listener)
 264     {
 265         this.eventListeners.add(SelectListener.class, listener);
 266     }
 267
 268     public void removeSelectListener(SelectListener listener)
 269     {
 270         this.eventListeners.remove(SelectListener.class, listener);
 271     }
 272
 273     private void callSelectListeners(final SelectEvent event)
 274     {
 275         EventQueue.invokeLater(new Runnable()
 276         {
 277             public void run()
 278             {
 279                 for (SelectListener listener : eventListeners.getListeners(SelectListener.class))
 280                 {
 281                     listener.selected(event);
 282                 }
 283             }
 284         });
 285     }
 286 }