gov.nasa.worldwind

Class WorldWindow

java.lang.Object

GLSurfaceView

gov.nasa.worldwind.WorldWindow

All Implemented Interfaces:

MessageListener

public class WorldWindow
extends GLSurfaceView
implements MessageListener

Provides a WorldWind window that implements a virtual globe inside of the Android view hierarchy. By default, World Window is configured to display an ellipsoidal globe using the WGS 84 reference values.

Constructor Summary

Constructors

Constructor and Description
WorldWindow(Context context) Constructs a WorldWindow associated with the specified application context.
WorldWindow(Context context, AttributeSet attrs) Constructs a WorldWindow associated with the specified application context and attributes from an XML tag.
WorldWindow(Context context, EGLConfigChooser configChooser) Constructs a WorldWindow associated with the specified application context and EGL configuration chooser.

Method Summary

Modifier and Type	Method and Description
void	addNavigatorListener(NavigatorListener listener)
boolean	cartesianToScreenPoint(double x, double y, double z, PointF result) Transforms a Cartesian coordinate point to Android screen coordinates.
double	distanceToViewGlobeExtents() Returns the minimum distance from the globe's surface necessary to make the globe's extents visible in this World Window.
void	doFrame(long frameTimeNanos)
boolean	geographicToScreenPoint(double latitude, double longitude, double altitude, PointF result) Transforms a geographic position to Android screen coordinates.
double	getFieldOfView()
FrameController	getFrameController()
FrameMetrics	getFrameMetrics()
Globe	getGlobe() Indicates the planet or celestial object displayed by this WorldWindow.
LayerList	getLayers()
Navigator	getNavigator()
long	getNavigatorStoppedDelay()
RenderResourceCache	getRenderResourceCache()
Tessellator	getTessellator()
double	getVerticalExaggeration()
WorldWindowController	getWorldWindowController()
void	onDrawFrame(GL10 unused) Implements the GLSurfaceView.Renderer.onDrawFrame interface which is called on the GLThread when rendering is requested.
void	onMessage(java.lang.String name, java.lang.Object sender, java.util.Map<java.lang.Object,java.lang.Object> userProperties)
void	onPause() Called when the activity is paused.
void	onResume() Called when the activity is resumed.
void	onSurfaceChanged(GL10 unused, int width, int height) Implements the GLSurfaceView.Renderer.onSurfaceChanged interface which is called on the GLThread when the window size changes.
void	onSurfaceCreated(GL10 unused, EGLConfig config) Implements the GLSurfaceView.Renderer.onSurfaceChanged interface which is called on the GLThread when the surface is created.
boolean	onTouchEvent(MotionEvent event)
PickedObjectList	pick(float x, float y) Determines the WorldWind objects displayed at a screen point.
PickedObjectList	pickShapesInRect(float x, float y, float width, float height) Determines the WorldWind shapes displayed in a screen rectangle.
double	pixelSizeAtDistance(double distance) Returns the height of a pixel at a given distance from the eye point.
void	queueEvent(java.lang.Runnable r) Deprecated. See Communicating with the UI Thread instead.
boolean	rayThroughScreenPoint(float x, float y, Line result) Computes a Cartesian coordinate ray that passes through through a screen point.
void	removeNavigatorListener(NavigatorListener listener)
void	requestRedraw() Request that this WorldWindow update its display.
void	requestRender() Deprecated. Use requestRedraw() instead.
void	setFieldOfView(double fovyDegrees)
void	setFrameController(FrameController frameController)
void	setFrameMetrics(FrameMetrics frameMetrics)
void	setGlobe(Globe globe) Sets the planet or celestial object displayed by this WorldWindow.
void	setLayers(LayerList layers)
void	setNavigator(Navigator navigator)
void	setNavigatorStoppedDelay(long delay, java.util.concurrent.TimeUnit unit)
void	setRenderResourceCache(RenderResourceCache cache)
void	setTessellator(Tessellator tessellator)
void	setVerticalExaggeration(double verticalExaggeration)
void	setWorldWindowController(WorldWindowController controller)
void	surfaceCreated(SurfaceHolder holder) Called immediately after the surface is first created, in which case the WorldWindow instance adds itself as a listener to the WorldWind.messageService().
void	surfaceDestroyed(SurfaceHolder holder) Called immediately before a surface is being destroyed, in which case the WorldWindow instance removes itself from WorldWind.messageService().

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorldWindow

public WorldWindow(Context context)

Constructs a WorldWindow associated with the specified application context. This is the constructor to use when creating a WorldWindow from code.

WorldWindow

public WorldWindow(Context context,
                   EGLConfigChooser configChooser)

Constructs a WorldWindow associated with the specified application context and EGL configuration chooser. This is the constructor to use when creating a WorldWindow from code.

WorldWindow

public WorldWindow(Context context,
                   AttributeSet attrs)

Constructs a WorldWindow associated with the specified application context and attributes from an XML tag. This constructor is included to provide support for creating WorldWindow from an Android XML layout file, and is not intended to be used directly.

This is called when a view is being constructed from an XML file, supplying attributes that were specified in the XML file. This version uses a default style of 0, so the only attribute values applied are those in the Context's Theme and the given AttributeSet.

Method Detail

getGlobe

public Globe getGlobe()

Indicates the planet or celestial object displayed by this WorldWindow. Defines the reference ellipsoid and elevation models. Globe expresses its ellipsoidal parameters and elevation values in meters.

WorldWindow's globe is initially configured with the WGS 84 reference ellipsoid.

Returns:

the globe displayed by this WorldWindow

setGlobe

public void setGlobe(Globe globe)

Sets the planet or celestial object displayed by this WorldWindow. Defines the reference ellipsoid and elevation models. Globe expresses its ellipsoidal parameters and elevation values in meters.

Parameters:

globe - the globe to display

Throws:

java.lang.IllegalArgumentException - If the globe is null

getTessellator

public Tessellator getTessellator()

setTessellator

public void setTessellator(Tessellator tessellator)

getLayers

public LayerList getLayers()

setLayers

public void setLayers(LayerList layers)

getVerticalExaggeration

public double getVerticalExaggeration()

setVerticalExaggeration

public void setVerticalExaggeration(double verticalExaggeration)

getFieldOfView

public double getFieldOfView()

setFieldOfView

public void setFieldOfView(double fovyDegrees)

getNavigator

public Navigator getNavigator()

setNavigator

public void setNavigator(Navigator navigator)

addNavigatorListener

public void addNavigatorListener(NavigatorListener listener)

removeNavigatorListener

public void removeNavigatorListener(NavigatorListener listener)

getNavigatorStoppedDelay

public long getNavigatorStoppedDelay()

setNavigatorStoppedDelay

public void setNavigatorStoppedDelay(long delay,
                                     java.util.concurrent.TimeUnit unit)

getFrameController

public FrameController getFrameController()

setFrameController

public void setFrameController(FrameController frameController)

getFrameMetrics

public FrameMetrics getFrameMetrics()

setFrameMetrics

public void setFrameMetrics(FrameMetrics frameMetrics)

getWorldWindowController

public WorldWindowController getWorldWindowController()

setWorldWindowController

public void setWorldWindowController(WorldWindowController controller)

getRenderResourceCache

public RenderResourceCache getRenderResourceCache()

setRenderResourceCache

public void setRenderResourceCache(RenderResourceCache cache)

pick

public PickedObjectList pick(float x,
                             float y)

Determines the WorldWind objects displayed at a screen point. The screen point is interpreted as coordinates in Android screen pixels relative to this View.

If the screen point intersects any number of WorldWind shapes, the returned list contains a picked object identifying the top shape at the screen point. This picked object includes the shape renderable (or its non-null pick delegate) and the WorldWind layer that displayed the shape. Shapes which are either hidden behind another shape at the screen point or hidden behind terrain at the screen point are omitted from the returned list. Therefore if the returned list contains a picked object identifying a shape, it is always marked as 'on top'.

If the screen point intersects the WorldWind terrain, the returned list contains a picked object identifying the associated geographic position. If there are no shapes in the WorldWind scene between the terrain and the screen point, the terrain picked object is marked as 'on top'.

This returns an empty list when nothing in the WorldWind scene intersects the screen point, when the screen point is outside this View's bounds, or if the OpenGL thread displaying the WorldWindow's scene is paused (or becomes paused while this method is executing).

Parameters:

x - the screen point's X coordinate in Android screen pixels

y - the screen point's Y coordinate in Android screen pixels

Returns:

a list of WorldWind objects at the screen point

pickShapesInRect

public PickedObjectList pickShapesInRect(float x,
                                         float y,
                                         float width,
                                         float height)

Determines the WorldWind shapes displayed in a screen rectangle. The screen rectangle is interpreted as coordinates in Android screen pixels relative to this view.

If the screen rectangle intersects any number of WorldWind shapes, the returned list contains a picked object identifying the all of the top shapes in the rectangle. This picked object includes the shape renderable (or its non-null pick delegate) and the WorldWind layer that displayed the shape. Shapes which are entirely hidden behind another shape in the screen rectangle or are entirely hidden behind terrain in the screen rectangle are omitted from the returned list.

This returns an empty list when no shapes in the WorldWind scene intersect the screen rectangle, when the screen rectangle is outside this View's bounds, or if the OpenGL thread displaying the WorldWindow's scene is paused (or becomes paused while this method is executing).

Parameters:

x - the screen rectangle's X coordinate in Android screen pixels

y - the screen rectangle's Y coordinate in Android screen pixels

width - the screen rectangle's width in Android screen pixels

height - the screen rectangle's height in Android screen pixels

Returns:

a list of WorldWind shapes in the screen rectangle

cartesianToScreenPoint

public boolean cartesianToScreenPoint(double x,
                                      double y,
                                      double z,
                                      PointF result)

Transforms a Cartesian coordinate point to Android screen coordinates. The resultant screen point is in Android screen pixels relative to this View.

This stores the converted point in the result argument, and returns a boolean value indicating whether or not the converted is successful. This returns false if the Cartesian point is clipped by either the WorldWindow's near clipping plane or far clipping plane.

Parameters:

x - the Cartesian point's x component in meters

y - the Cartesian point's y component in meters

z - the Cartesian point's z component in meters

result - a pre-allocated PointF in which to return the screen point

Returns:

true if the transformation is successful, otherwise false

Throws:

java.lang.IllegalArgumentException - If the result is null

geographicToScreenPoint

public boolean geographicToScreenPoint(double latitude,
                                       double longitude,
                                       double altitude,
                                       PointF result)

Transforms a geographic position to Android screen coordinates. The resultant screen point is in Android screen pixels relative to this View.

This stores the converted point in the result argument, and returns a boolean value indicating whether or not the converted is successful. This returns false if the Cartesian point is clipped by either of the WorldWindow's near clipping plane or far clipping plane.

Parameters:

latitude - the position's latitude in degrees

longitude - the position's longitude in degrees

altitude - the position's altitude in meters

result - a pre-allocated PointF in which to return the screen point

Returns:

true if the transformation is successful, otherwise false

Throws:

java.lang.IllegalArgumentException - If the result is null

rayThroughScreenPoint

public boolean rayThroughScreenPoint(float x,
                                     float y,
                                     Line result)

Computes a Cartesian coordinate ray that passes through through a screen point. The screen point is interpreted as coordinates in Android screen pixels relative to this View.

Parameters:

x - the screen point's X coordinate in Android screen pixels

y - the screen point's Y coordinate in Android screen pixels

result - a pre-allocated Line in which to return the computed ray

Returns:

the result set to the computed ray in Cartesian coordinates

Throws:

java.lang.IllegalArgumentException - If the result is null

pixelSizeAtDistance

public double pixelSizeAtDistance(double distance)

Returns the height of a pixel at a given distance from the eye point. This method assumes the model of a screen composed of rectangular pixels, where pixel coordinates denote infinitely thin space between pixels. The units of the returned size are in meters per pixel.

The result of this method is undefined if the distance is negative.

Parameters:

distance - the distance from the eye point in meters

Returns:

the pixel height in meters per pixel

distanceToViewGlobeExtents

public double distanceToViewGlobeExtents()

Returns the minimum distance from the globe's surface necessary to make the globe's extents visible in this World Window.

Returns:

the distance in meters needed to view the entire globe

requestRedraw

public void requestRedraw()

Request that this WorldWindow update its display. Prior changes to this WorldWindow's Navigator, Globe and Layers (including the contents of layers) are reflected on screen sometime after calling this method. May be called from any thread.

doFrame

public void doFrame(long frameTimeNanos)

requestRender

@Deprecated
public void requestRender()

Deprecated. Use requestRedraw() instead.

Requests that this WorldWindow's OpenGL renderer display another frame on the OpenGL thread. Does not cause the WorldWindow's to display changes in its Navigator, Globe or Layers. Use requestRedraw() instead.

queueEvent

@Deprecated
public void queueEvent(java.lang.Runnable r)

Deprecated. See Communicating with the UI Thread instead.

Queues a runnable to be executed on this WorldWindow's OpenGL thread. Must not be used to affect changes to this WorldWindow's state, including the Navigator, Globe and Layers. See the Android developers guide on Communicating with the UI Thread instead.

Parameters:

r - the runnable to execute

onSurfaceCreated

public void onSurfaceCreated(GL10 unused,
                             EGLConfig config)

Implements the GLSurfaceView.Renderer.onSurfaceChanged interface which is called on the GLThread when the surface is created.

onSurfaceChanged

public void onSurfaceChanged(GL10 unused,
                             int width,
                             int height)

Implements the GLSurfaceView.Renderer.onSurfaceChanged interface which is called on the GLThread when the window size changes.

onDrawFrame

public void onDrawFrame(GL10 unused)

Implements the GLSurfaceView.Renderer.onDrawFrame interface which is called on the GLThread when rendering is requested.

surfaceCreated

public void surfaceCreated(SurfaceHolder holder)

Called immediately after the surface is first created, in which case the WorldWindow instance adds itself as a listener to the WorldWind.messageService(). The WorldWind.messageService is a facility for broadcasting global redraw requests to active WorldWindows.

Parameters:

holder - the SurfaceHolder whose surface is being created

surfaceDestroyed

public void surfaceDestroyed(SurfaceHolder holder)

Called immediately before a surface is being destroyed, in which case the WorldWindow instance removes itself from WorldWind.messageService(). Failure to do so may result in a memory leak this WorldWindow instance when its owner is release/collected.

Parameters:

holder - the SurfaceHolder whose surface is being destroyed

onPause

public void onPause()

Called when the activity is paused. Calling this method will pause the rendering thread, cause any outstanding pick operations to return an empty pick list, and prevent subsequent calls to pick and requestRedraw to return without performing any action.

onResume

public void onResume()

Called when the activity is resumed. Calling this method will resume the rendering thread and enable subsequent calls to pick and requestRedraw to function normally.

onTouchEvent

public boolean onTouchEvent(MotionEvent event)

onMessage

public void onMessage(java.lang.String name,
                      java.lang.Object sender,
                      java.util.Map<java.lang.Object,java.lang.Object> userProperties)

Specified by:

onMessage in interface MessageListener