gov/nasa/worldwind/WorldWindow.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 /**
  12  * The top-level interface common to all toolkit-specific World Wind windows.
  13  *
  14  * @author Tom Gaskins
  15  * @version $Id: WorldWindow.java 2068 2007-06-16 06:26:09Z tgaskins $
  16  */
  17 public interface WorldWindow extends AVList
  18 {
  19     /**
  20      * Sets the model to display in this window. If <code>null</code> is specified for the model, the current model, if
  21      * any, is disassociated with the window.
  22      *
  23      * @param model the model to display. May be <code>null</code>.
  24      */
  25     void setModel(Model model);
  26
  27     /**
  28      * Returns the window's current model.
  29      *
  30      * @return the window's current model
  31      */
  32     Model getModel();
  33
  34     /**
  35      * Sets the view to use when displaying this window's model. If <code>null</code> is specified for the view, the
  36      * current view, if any, is disassociated with the window.
  37      *
  38      * @param view the view to use to display this window's model. May be null.
  39      */
  40     void setView(View view);
  41
  42     /**
  43      * Returns this window's current view.
  44      *
  45      * @return the window's current view
  46      */
  47     View getView();
  48
  49     /**
  50      * Sets the model to display in this window and the view used to display it. If <code>null</code> is specified for
  51      * the model, the current model, if any, is disassociated with the window. If <code>null</code> is specified for the
  52      * view, the current view, if any, is disassociated with the window.
  53      *
  54      * @param model the model to display. May be<code>null</code>.
  55      * @param view  the view to use to display this window's model. May be<code>null</code>.
  56      */
  57     void setModelAndView(Model model, View view);
  58
  59     /**
  60      * Returns the scene controller assocciated with this instance.
  61      *
  62      * @return The scene controller associated with the instance, or null if no scene controller is associated.
  63      */
  64     SceneController getSceneController();
  65
  66     InputHandler getInputHandler();
  67
  68     void setInputHandler(InputHandler eventSource);
  69
  70     void addRenderingListener(RenderingListener listener);
  71
  72     void removeRenderingListener(RenderingListener listener);
  73
  74     void addSelectListener(SelectListener listener);
  75
  76     void removeSelectListener(SelectListener listener);
  77
  78     void addPositionListener(PositionListener listener);
  79
  80     void removePositionListener(PositionListener listener);
  81
  82     void redraw();
  83
  84     void redrawNow();
  85
  86     Position getCurrentPosition();
  87
  88     PickedObjectList getObjectsAtCurrentPosition();
  89 }