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 /**
  10  * The top-level interface common to all toolkit-specific World Wind windows.
  11  *
  12  * @author Tom Gaskins
  13  * @version $Id: WorldWindow.java 1765 2007-05-07 20:51:41Z tgaskins $
  14  */
  15 public interface WorldWindow
  16 {
  17     /**
  18      * Sets the model to display in this window. If <code>null</code> is specified for the model, the current model, if
  19      * any, is disassociated with the window.
  20      *
  21      * @param model the model to display. May be <code>null</code>.
  22      */
  23     void setModel(Model model);
  24
  25     /**
  26      * Returns the window's current model.
  27      *
  28      * @return the window's current model
  29      */
  30     Model getModel();
  31
  32     /**
  33      * Sets the view to use when displaying this window's model. If <code>null</code> is specified for the view, the
  34      * current view, if any, is disassociated with the window.
  35      *
  36      * @param view the view to use to display this window's model. May be null.
  37      */
  38     void setView(View view);
  39
  40     /**
  41      * Returns this window's current view.
  42      *
  43      * @return the window's current view
  44      */
  45     View getView();
  46
  47     /**
  48      * Sets the model to display in this window and the view used to display it. If <code>null</code> is specified for
  49      * the model, the current model, if any, is disassociated with the window. If <code>null</code> is specified for the
  50      * view, the current view, if any, is disassociated with the window.
  51      *
  52      * @param model the model to display. May be<code>null</code>.
  53      * @param view  the view to use to display this window's model. May be<code>null</code>.
  54      */
  55     void setModelAndView(Model model, View view);
  56
  57     /**
  58      * Returns the scene controller assocciated with this instance.
  59      *
  60      * @return The scene controller associated with the instance, or null if no scene controller is associated.
  61      */
  62     SceneController getSceneController();
  63
  64     PickedObjectList pick(java.awt.Point pickPoint);
  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 }