gov.nasa.worldwind.util

Class SurfaceTileDrawContext

java.lang.Object

gov.nasa.worldwind.util.SurfaceTileDrawContext

public class SurfaceTileDrawContext
extends Object

SurfaceTileDrawContext defines a context for rendering into off-screen surface tiles. SurfaceTileDrawContext is defined by a geographic sector, a screen viewport, and a collection of pick candidates. The sector maps geographic coordinates to pixels in an abstract off-screen tile. The pick candidates provide registration of picked objects drawn into the surface tile.

Field Summary

Fields

Modifier and Type	Field and Description
protected Matrix	modelview
protected Collection<PickedObject>	pickCandidates
protected Sector	sector
protected Rectangle	viewport

Constructor Summary

Constructors

Constructor and Description
SurfaceTileDrawContext(Tile tile, Collection<PickedObject> pickCandidates) Creates a new SurfaceTileDrawContext from the specified tile and collection of pick candidates.

Method Summary

Modifier and Type	Method and Description
void	addPickCandidate(PickedObject pickedObject) Adds the specified picked object to this context's the collection of pick candidates.
Matrix	getModelviewMatrix() Returns a Matrix mapping geographic coordinates to pixels in the off-screen tile.
Matrix	getModelviewMatrix(LatLon referenceLocation) Returns a Matrix mapping geographic coordinates to pixels in the off-screen tile.
Collection<PickedObject>	getPickCandidates() Returns the collection of pick candidates associated with this context.
Sector	getSector() Returns this context's sector.
Rectangle	getViewport() Returns this context's viewport.

Methods inherited from class java.lang.Object

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

Field Detail

modelview

protected Matrix modelview

pickCandidates

protected Collection<PickedObject> pickCandidates

sector

protected Sector sector

viewport

protected Rectangle viewport

Constructor Detail

SurfaceTileDrawContext

public SurfaceTileDrawContext(Tile tile,
                              Collection<PickedObject> pickCandidates)

Creates a new SurfaceTileDrawContext from the specified tile and collection of pick candidates. The tile defines this context's geographic extent and screen viewport. The pick candidate collection is used to register picked objects drawn into the surface tile.

Parameters:

tile - the context's tile.

pickCandidates - the context's list of pick candidates.

Throws:

IllegalArgumentException - if any argument is null.

Method Detail

addPickCandidate

public void addPickCandidate(PickedObject pickedObject)

Adds the specified picked object to this context's the collection of pick candidates. This collection can be accessed by calling getPickCandidates().

Parameters:

pickedObject - the object to add.

Throws:

IllegalArgumentException - if the object is null.

getModelviewMatrix

public Matrix getModelviewMatrix()

Returns a Matrix mapping geographic coordinates to pixels in the off-screen tile.

Returns:

Matrix mapping geographic coordinates to tile coordinates.

getModelviewMatrix

public Matrix getModelviewMatrix(LatLon referenceLocation)

Returns a Matrix mapping geographic coordinates to pixels in the off-screen tile. The reference location defines the geographic coordinate origin.

Parameters:

referenceLocation - the geographic coordinate origin.

Returns:

Matrix mapping geographic coordinates to tile coordinates.

Throws:

IllegalArgumentException - if the reference location is null.

getPickCandidates

public Collection<PickedObject> getPickCandidates()

Returns the collection of pick candidates associated with this context. This collection provides a registration of picked objects drawn into the surface tile.

Returns:

this context's pick candidates.

getSector

public Sector getSector()

Returns this context's sector.

Returns:

this's sector.

getViewport

public Rectangle getViewport()

Returns this context's viewport.

Returns:

this context's viewport.