WorldWindow (WorldWindJava API)

All Superinterfaces:

AVList

All Known Subinterfaces:

WorldWindowGLDrawable

All Known Implementing Classes:

ConfiguringGLRuntimeCapabilities.MyGLAutoDrawable, DebuggingGLErrors.MyGLAutoDrawable, GliderWorldWindow, WorldWindowGLAutoDrawable, WorldWindowGLCanvas, WorldWindowGLJPanel, WorldWindowImpl
```
public interface WorldWindow
extends AVList
```
The top-level interface common to all toolkit-specific WorldWind windows.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addPositionListener(PositionListener listener)` Adds a position listener to this WorldWindow.
`void`	`addRenderingExceptionListener(RenderingExceptionListener listener)` Adds an exception listener to this WorldWindow.
`void`	`addRenderingListener(RenderingListener listener)` Adds a rendering listener to this WorldWindow.
`void`	`addSelectListener(SelectListener listener)` Adds a select listener to this WorldWindow.
`com.jogamp.opengl.GLContext`	`getContext()` Returns the `GLContext` associated with this `WorldWindow`.
`Position`	`getCurrentPosition()` Returns the current latitude, longitude and altitude of the current cursor position, or `null` if the cursor is not on the globe.
`GpuResourceCache`	`getGpuResourceCache()` Returns the GPU Resource used by this WorldWindow.
`InputHandler`	`getInputHandler()` Returns the input handler associated with this instance.
`Model`	`getModel()` Returns the window's current model.
`PickedObjectList`	`getObjectsAtCurrentPosition()` Returns the WorldWind objects at the current cursor position.
`PickedObjectList`	`getObjectsInSelectionBox()` Returns the WorldWind objects intersecting the current selection box.
`java.util.Collection<PerformanceStatistic>`	`getPerFrameStatistics()` Returns the active per-frame performance statistics such as number of tiles drawn in the most recent frame.
`SceneController`	`getSceneController()` Returns the scene controller associated with this instance.
`View`	`getView()` Returns this window's current view.
`boolean`	`isEnableGpuCacheReinitialization()` Indicates whether the GPU resource cache is reinitialized when this window is reinitialized.
`void`	`redraw()` Causes a repaint event to be enqueued with the window system for this WorldWindow.
`void`	`redrawNow()` Immediately repaints the WorldWindow without waiting for a window system repaint event.
`void`	`removePositionListener(PositionListener listener)` Removes the specified position listener associated with this WorldWindow.
`void`	`removeRenderingExceptionListener(RenderingExceptionListener listener)` Removes the specified rendering exception listener associated with this WorldWindow.
`void`	`removeRenderingListener(RenderingListener listener)` Removes a specified rendering listener associated with this WorldWindow.
`void`	`removeSelectListener(SelectListener listener)` Removes the specified select listener associated with this WorldWindow.
`void`	`setEnableGpuCacheReinitialization(boolean enableGpuCacheReinitialization)` Specifies whether to reinitialize the GPU resource cache when this window is reinitialized.
`void`	`setInputHandler(InputHandler inputHandler)` Sets the input handler to use for this instance.
`void`	`setModel(Model model)` Sets the model to display in this window.
`void`	`setModelAndView(Model model, View view)` Sets the model to display in this window and the view used to display it.
`void`	`setPerFrameStatisticsKeys(java.util.Set<java.lang.String> keys)` Activates the per-frame performance statistic specified.
`void`	`setSceneController(SceneController sceneController)` Specifies a new scene controller for the window.
`void`	`setView(View view)` Sets the view to use when displaying this window's model.
`void`	`shutdown()` Causes resources used by the WorldWindow to be freed.

Methods inherited from interface gov.nasa.worldwind.avlist.AVList
addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getEntries, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues

- Method Detail
  - addPositionListener
```
void addPositionListener(PositionListener listener)
```
    Adds a position listener to this WorldWindow. Position listeners are called when the cursor's position changes. They identify the position of the cursor on the globe, or that the cursor is not on the globe.
    
    Parameters:
    
    listener - The position listener to add.
  - addRenderingExceptionListener
```
void addRenderingExceptionListener(RenderingExceptionListener listener)
```
    Adds an exception listener to this WorldWindow. Exception listeners are called when an exception or other critical event occurs during drawable initialization or during rendering.
    
    Parameters:
    
    listener - the The exception listener to add.
  - addRenderingListener
```
void addRenderingListener(RenderingListener listener)
```
    Adds a rendering listener to this WorldWindow. Rendering listeners are called at key point during WorldWind drawing and provide applications the ability to participate or monitor rendering.
    
    Parameters:
    
    listener - The rendering listener to add to those notified of rendering events by this WorldWindow.
  - addSelectListener
```
void addSelectListener(SelectListener listener)
```
    Adds a select listener to this WorldWindow. Select listeners are called when a selection is made by the user in the WorldWindow. A selection is any operation that identifies a visible item.
    
    Parameters:
    
    listener - The select listener to add.
  - getContext
```
com.jogamp.opengl.GLContext getContext()
```
    Returns the GLContext associated with this WorldWindow.
    
    Returns:
    
    the GLContext associated with this window. May be null.
  - getCurrentPosition
```
Position getCurrentPosition()
```
    Returns the current latitude, longitude and altitude of the current cursor position, or null if the cursor is not on the globe.
    
    Returns:
    
    The current position of the cursor, or null if the cursor is not positioned on the globe.
  - getGpuResourceCache
```
GpuResourceCache getGpuResourceCache()
```
    Returns the GPU Resource used by this WorldWindow. This method is for internal use only.
    Note: Applications do not need to interact with the GPU resource cache. It is self managed. Modifying it in any way will cause significant problems such as excessive memory usage or application crashes. The only reason to use the GPU resource cache is to request management of GPU resources within implementations of shapes or layers. And then access should be only through the draw context only.
    
    Returns:
    
    The GPU Resource cache used by this WorldWindow.
  - getInputHandler
```
InputHandler getInputHandler()
```
    Returns the input handler associated with this instance.
    
    Returns:
    
    The input handler associated with this instance, or null if no input handler is associated.
  - getModel
```
Model getModel()
```
    Returns the window's current model.
    
    Returns:
    
    the window's current model.
  - getObjectsAtCurrentPosition
```
PickedObjectList getObjectsAtCurrentPosition()
```
    Returns the WorldWind objects at the current cursor position. The list of objects under the cursor is determined each time the WorldWindow is repainted. This method returns the list of objects determined when the most recent repaint was performed.
    
    Returns:
    
    The list of objects at the cursor position, or null if no objects are under the cursor.
  - getObjectsInSelectionBox
```
PickedObjectList getObjectsInSelectionBox()
```
    Returns the WorldWind objects intersecting the current selection box. The list of objects in the selection box is determined each time the WorldWindow is repainted. This method returns the list of objects determined when the most recent repaint was performed.
    
    Returns:
    
    The list of objects intersecting the selection box, or null if no objects are in the box.
  - getPerFrameStatistics
```
java.util.Collection<PerformanceStatistic> getPerFrameStatistics()
```
    Returns the active per-frame performance statistics such as number of tiles drawn in the most recent frame.
    
    Returns:
    
    The keys and values of the active per-frame statistics.
  - getSceneController
```
SceneController getSceneController()
```
    Returns the scene controller associated with this instance.
    
    Returns:
    
    The scene controller associated with the instance, or null if no scene controller is associated.
  - getView
```
View getView()
```
    Returns this window's current view.
    
    Returns:
    
    the window's current view.
  - isEnableGpuCacheReinitialization
```
boolean isEnableGpuCacheReinitialization()
```
    Indicates whether the GPU resource cache is reinitialized when this window is reinitialized.
    
    Returns:
    
    true if reinitialization is enabled, otherwise false.
  - redraw
```
void redraw()
```
    Causes a repaint event to be enqueued with the window system for this WorldWindow. The repaint will occur at the window system's discretion, within the window system toolkit's event loop, and on the thread of that loop. This is the preferred method for requesting a repaint of the WorldWindow.
  - redrawNow
```
void redrawNow()
```
    Immediately repaints the WorldWindow without waiting for a window system repaint event. This is not the preferred way to cause a repaint, but is provided for the rare cases that require it.
  - removePositionListener
```
void removePositionListener(PositionListener listener)
```
    Removes the specified position listener associated with this WorldWindow.
    
    Parameters:
    
    listener - The listener to remove.
  - removeRenderingExceptionListener
```
void removeRenderingExceptionListener(RenderingExceptionListener listener)
```
    Removes the specified rendering exception listener associated with this WorldWindow.
    
    Parameters:
    
    listener - The listener to remove.
  - removeRenderingListener
```
void removeRenderingListener(RenderingListener listener)
```
    Removes a specified rendering listener associated with this WorldWindow.
    
    Parameters:
    
    listener - The rendering listener to remove.
  - removeSelectListener
```
void removeSelectListener(SelectListener listener)
```
    Removes the specified select listener associated with this WorldWindow.
    
    Parameters:
    
    listener - The select listener to remove.
  - setEnableGpuCacheReinitialization
```
void setEnableGpuCacheReinitialization(boolean enableGpuCacheReinitialization)
```
    Specifies whether to reinitialize the GPU resource cache when this window is reinitialized. A value of true indicates that the GPU resource cache this window is using should be cleared when its init() method is called, typically when re-parented. Set this to false when this window is sharing context with other windows and is likely to be re-parented. It prevents the flashing caused by clearing and re-populating the GPU resource cache during re-parenting. The default value is true.
    
    Parameters:
    
    enableGpuCacheReinitialization - true to enable reinitialization, otherwise false.
  - setInputHandler
```
void setInputHandler(InputHandler inputHandler)
```
    Sets the input handler to use for this instance.
    
    Parameters:
    
    inputHandler - The input handler to use for this WorldWindow. May by null if null is specified, the current input handler, if any, is disassociated with the WorldWindow.
  - setModel
```
void setModel(Model model)
```
    Sets the model to display in this window. If null is specified for the model, the current model, if any, is disassociated with the window.
    
    Parameters:
    
    model - the model to display. May be null.
  - setModelAndView
```
void setModelAndView(Model model,
                     View view)
```
    Sets the model to display in this window and the view used to display it. If null is specified for the model, the current model, if any, is disassociated with the window. If null is specified for the view, the current view, if any, is disassociated with the window.
    
    Parameters:
    
    model - the model to display. May benull.
    
    view - the view to use to display this window's model. May benull.
  - setPerFrameStatisticsKeys
```
void setPerFrameStatisticsKeys(java.util.Set<java.lang.String> keys)
```
    Activates the per-frame performance statistic specified. Per-frame statistics measure values within a single frame of rendering, such as number of tiles drawn to produce the frame.
    
    Parameters:
    
    keys - The statistics to activate.
  - setSceneController
```
void setSceneController(SceneController sceneController)
```
    Specifies a new scene controller for the window. The caller is responsible for populating the new scene controller with a View, Model and any desired per-frame statistics keys.
    
    Parameters:
    
    sceneController - the new scene controller.
    
    See Also:
    
    SceneController.setView(View), SceneController.setModel(Model), SceneController.setPerFrameStatisticsKeys(java.util.Set)
  - setView
```
void setView(View view)
```
    Sets the view to use when displaying this window's model. If null is specified for the view, the current view, if any, is disassociated with the window.
    
    Parameters:
    
    view - the view to use to display this window's model. May be null.
  - shutdown
```
void shutdown()
```
    Causes resources used by the WorldWindow to be freed. The WorldWindow cannot be used once this method is called.

Interface WorldWindow

Method Summary

Methods inherited from interface gov.nasa.worldwind.avlist.AVList

Method Detail

addPositionListener

addRenderingExceptionListener

addRenderingListener

addSelectListener

getContext

getCurrentPosition

getGpuResourceCache

getInputHandler

getModel

getObjectsAtCurrentPosition

getObjectsInSelectionBox

getPerFrameStatistics

getSceneController

getView

isEnableGpuCacheReinitialization

redraw

redrawNow

removePositionListener

removeRenderingExceptionListener

removeRenderingListener

removeSelectListener

setEnableGpuCacheReinitialization

setInputHandler

setModel

setModelAndView

setPerFrameStatisticsKeys

setSceneController

setView

shutdown