gov/nasa/worldwind/render/DrawContext.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.render;
   8
   9 import com.sun.opengl.util.texture.TextureCoords;
  10 import gov.nasa.worldwind.*;
  11 import gov.nasa.worldwind.cache.TextureCache;
  12 import gov.nasa.worldwind.geom.*;
  13 import gov.nasa.worldwind.globes.*;
  14 import gov.nasa.worldwind.layers.LayerList;
  15 import gov.nasa.worldwind.pick.*;
  16 import gov.nasa.worldwind.util.PerformanceStatistic;
  17 import gov.nasa.worldwind.view.View;
  18
  19 import javax.media.opengl.*;
  20 import javax.media.opengl.glu.GLU;
  21 import java.awt.*;
  22 import java.util.*;
  23
  24 /**
  25  * @author Tom Gaskins
  26  * @version $Id: DrawContext.java 2533 2007-08-13 05:59:08Z tgaskins $
  27  */
  28 public interface DrawContext extends WWObject
  29 {
  30     /**
  31      * Assigns this <code>DrawContext</code> a new </code>javax.media.opengl.GLContext</code>. May throw a
  32      * <code>NullPointerException</code> if <code>glContext</code> is null.
  33      *
  34      * @param glContext the new <code>javax.media.opengl.GLContext</code>
  35      * @throws NullPointerException if glContext is null
  36      * @since 1.5
  37      */
  38     void setGLContext(GLContext glContext);
  39
  40     /**
  41      * Retrieves this <code>DrawContext</code>s </code>javax.media.opengl.GLContext</code>. If this method returns null,
  42      * then there are potentially no active <code>GLContext</code>s and rendering should be aborted.
  43      *
  44      * @return this <code>DrawContext</code>s </code>javax.media.opengl.GLContext</code>.
  45      * @since 1.5
  46      */
  47     GLContext getGLContext();
  48
  49     /**
  50      * Retrieves the current <code>javax.media.opengl.GL</code>. A <code>GL</code> or <code>GLU</code> is required for
  51      * all graphical rendering in World Wind Raptor.
  52      *
  53      * @return the current <code>GL</code> if available, null otherwise
  54      * @since 1.5
  55      */
  56     GL getGL();
  57
  58     /**
  59      * Retrieves the current <code>javax.media.opengl.glu.GLU</code>. A <code>GLU</code> or <code>GL</code> is required
  60      * for all graphical rendering in World Wind Raptor.
  61      *
  62      * @return the current <code>GLU</code> if available, null otherwise
  63      * @since 1.5
  64      */
  65     GLU getGLU();
  66
  67     /**
  68      * Retrieves the current<code>javax.media.opengl.GLDrawable</code>. A <code>GLDrawable</code> can be used to create
  69      * a <code>GLContext</code>, which can then be used for rendering.
  70      *
  71      * @return the current <code>GLDrawable</code>, null if none available
  72      * @since 1.5
  73      */
  74     GLDrawable getGLDrawable();
  75
  76     /**
  77      * Retrieves the drawable width of this <code>DrawContext</code>.
  78      *
  79      * @return the drawable width of this <code>DrawCOntext</code>
  80      * @since 1.5
  81      */
  82     int getDrawableWidth();
  83
  84     /**
  85      * Retrieves the drawable height of this <code>DrawContext</code>.
  86      *
  87      * @return the drawable height of this <code>DrawCOntext</code>
  88      * @since 1.5
  89      */
  90     int getDrawableHeight();
  91
  92     /**
  93      * Initializes this <code>DrawContext</code>. This method should be called at the beginning of each frame to prepare
  94      * the <code>DrawContext</code> for the coming render pass.
  95      *
  96      * @param glContext the <code>javax.media.opengl.GLContext</code> to use for this render pass
  97      * @since 1.5
  98      */
  99     void initialize(GLContext glContext);
 100
 101     /**
 102      * Assigns a new <code>View</code>. Some layers cannot function properly with a null <code>View</code>. It is
 103      * recommended that the <code>View</code> is never set to null during a normal render pass.
 104      *
 105      * @param view the enw <code>View</code>
 106      * @since 1.5
 107      */
 108     void setView(View view);
 109
 110     /**
 111      * Retrieves the current <code>View</code>, which may be null.
 112      *
 113      * @return the current <code>View</code>, which may be null
 114      * @since 1.5
 115      */
 116     View getView();
 117
 118     /**
 119      * Assign a new <code>Model</code>. Some layers cannot function properly with a null <code>Model</code>. It is
 120      * recommended that the <code>Model</code> is never set to null during a normal render pass.
 121      *
 122      * @param model the new <code>Model</code>
 123      * @since 1.5
 124      */
 125     void setModel(Model model);
 126
 127     /**
 128      * Retrieves the current <code>Model</code>, which may be null.
 129      *
 130      * @return the current <code>Model</code>, which may be null
 131      * @since 1.5
 132      */
 133     Model getModel();
 134
 135     /**
 136      * Retrieves the current <code>Globe</code>, which may be null.
 137      *
 138      * @return the current <code>Globe</code>, which may be null
 139      * @since 1.5
 140      */
 141     Globe getGlobe();
 142
 143     /**
 144      * Retrieves a list containing all the current layers. No guarantee is made about the order of the layers.
 145      *
 146      * @return a <code>LayerList</code> containing all the current layers
 147      * @since 1.5
 148      */
 149     LayerList getLayers();
 150
 151     /**
 152      * Retrieves a <code>Sector</code> which is at least as large as the current visible sector. The value returned is
 153      * the value passed to <code>SetVisibleSector</code>. This method may return null.
 154      *
 155      * @return a <code>Sector</code> at least the size of the curernt visible sector, null if unavailable
 156      * @since 1.5
 157      */
 158     Sector getVisibleSector();
 159
 160     /**
 161      * Sets the visible <code>Sector</code>. The new visible sector must completely encompass the Sector which is
 162      * visible on the display.
 163      *
 164      * @param s the new visible <code>Sector</code>
 165      * @since 1.5
 166      */
 167     void setVisibleSector(Sector s);
 168
 169     /**
 170      * Sets the vertical exaggeration. Vertical exaggeration affects the appearance of areas with varied elevation. A
 171      * vertical exaggeration of zero creates a surface which exactly fits the shape of the underlying
 172      * <code>Globe</code>. A vertical exaggeration of 3 will create mountains and valleys which are three times as
 173      * high/deep as they really are.
 174      *
 175      * @param verticalExaggeration the new vertical exaggeration.
 176      * @since 1.5
 177      */
 178     void setVerticalExaggeration(double verticalExaggeration);
 179
 180     /**
 181      * Retrieves the current vertical exaggeration. Vertical exaggeration affects the appearance of areas with varied
 182      * elevation. A vertical exaggeration of zero creates a surface which exactly fits the shape of the underlying
 183      * <code>Globe</code>. A vertical exaggeration of 3 will create mountains and valleys which are three times as
 184      * high/deep as they really are.
 185      *
 186      * @return the current vertical exaggeration
 187      * @since 1.5
 188      */
 189     double getVerticalExaggeration();
 190
 191     // not used (12th January 2007)
 192     final static String HIGH_PRIORITY = "gov.nasa.worldwind.DrawContext.HighPriority";
 193     final static String LOW_PRIORITY = "gov.nasa.worldwind.DrawContext.LowPriority";
 194
 195     /**
 196      * Retrieves a list of all the sectors rendered so far this frame.
 197      *
 198      * @return a <code>SectorGeometryList</code> containing every <code>SectorGeometry</code> rendered so far this
 199      *         render pass.
 200      * @since 1.5
 201      */
 202     SectorGeometryList getSurfaceGeometry();
 203
 204     //
 205 //    /**
 206 //     * Sets the average render time per frame in milliseconds.
 207 //     *
 208 //     * @param timeMillis the new average time in milliseconds
 209 //     * @since 1.5
 210 //     */
 211 //    void setAverageRenderTimeMillis(double timeMillis);
 212 //
 213 //    /**
 214 //     * Retrieves the current average render time for a frame. The average render time can be used to calculate the
 215 //     * framerate.
 216 //     *
 217 //     * @return the current average render time for a frame
 218 //     * @since 1.5
 219 //     */
 220 //    double getAverageRenderTimeMillis();
 221
 222     /**
 223      * Returns the list of objects picked during the most recent pick traversal.
 224      *
 225      * @return the list of picked objects
 226      */
 227     PickedObjectList getPickedObjects();
 228
 229     /**
 230      * Adds a collection of picked objects to the current picked-object list
 231      *
 232      * @param pickedObjects the objects to add
 233      */
 234     void addPickedObjects(PickedObjectList pickedObjects);
 235
 236     /**
 237      * Adds a single insatnce of the picked object to the current picked-object list
 238      *
 239      * @param pickedObject the object to add
 240      */
 241     void addPickedObject(PickedObject pickedObject);
 242
 243     /**
 244      * Returns a unique color to serve as a pick identifier during picking.
 245      *
 246      * @return a unique pick color
 247      */
 248     java.awt.Color getUniquePickColor();
 249
 250     java.awt.Color getClearColor();
 251
 252     /**
 253      * Enables color picking mode
 254      */
 255     void enablePickingMode();
 256
 257     /**
 258      * Returns true if the Picking mode is active, otherwise return false
 259      *
 260      * @return true for Picking mode, otherwise false
 261      */
 262     boolean isPickingMode();
 263
 264     /**
 265      * Disables color picking mode
 266      */
 267     void disablePickingMode();
 268
 269     void addOrderedRenderable(OrderedRenderable orderedRenderable);
 270
 271     java.util.Queue<OrderedRenderable> getOrderedRenderables();
 272
 273     void drawUnitQuad();
 274
 275     void drawUnitQuad(TextureCoords texCoords);
 276
 277     int getNumTextureUnits();
 278
 279     void setNumTextureUnits(int numTextureUnits);
 280
 281     void setSurfaceGeometry(SectorGeometryList surfaceGeometry);
 282
 283     Vec4 getPointOnGlobe(Angle latitude, Angle longitude);
 284
 285     SurfaceTileRenderer getGeographicSurfaceTileRenderer();
 286
 287     Point getPickPoint();
 288
 289     void setPickPoint(Point pickPoint);
 290
 291     TextureCache getTextureCache();
 292
 293     void setTextureCache(TextureCache textureCache);
 294
 295     Collection<PerformanceStatistic> getPerFrameStatistics();
 296
 297     void setPerFrameStatisticsKeys(Set<String> statKeys, Collection<PerformanceStatistic> stats);
 298
 299     void setPerFrameStatistic(String key, String displayName, Object statistic);
 300
 301     void setPerFrameStatistics(Collection<PerformanceStatistic> stats);
 302
 303     Set<String> getPerFrameStatisticsKeys();
 304 }