prajna.geo

Class GeoLayer

java.lang.Object

prajna.geo.GeoLayer

Direct Known Subclasses:

TimedGeoLayer

public class GeoLayer
extends java.lang.Object

This class represents a geographic layer of data. A geographic layer can be used for a particular terrain feature, such as rivers. It can also be used to represent other geographic-based data, such as restaurant locations.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
GeoLayer(java.lang.String layerName) Create a new geographic layer.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(GeoShape shape) Add a shape to this geographic layer
boolean	addAll(java.util.Collection<GeoShape> shapeColl) Add all of a collection of Geographic shapes to this layer
void	clear() Clear all shapes from this layer
void	drawLayer(java.awt.Graphics2D g2) Draw this layer into the graphics context
java.awt.Color	getDrawColor() Get the drawing color for this layer
java.awt.Color	getFillColor() Get the fill color for this layer
GeoBounds	getGeoBounds() Get the geographic bounds for this layer.
java.lang.String	getName() Get the name of this layer
int	getPickRadius() Get the radius used for picking shapes in this layer
RenderStyle	getRenderStyle() Get the rendering style for this GeoShape.
java.util.List<GeoShape>	getShapes() Get the list of shapes for this layer
boolean	isEmpty() Return whether this GeoLayer has geographic content.
boolean	isPickable() Return whether this layer is pickable.
GeoShape	pickGeo(java.awt.geom.Point2D point) Pick the shape at the specified geographic point.
void	project(Projection proj) Projects the geographic coordinates into the given projection
void	setColors(java.awt.Color drawColor, java.awt.Color fillColor) Set the draw and fill colors for this layer
void	setDrawColor(java.awt.Color color) Set the draw color for this layer
void	setFillColor(java.awt.Color color) Set the fill color for this layer
void	setMarkerShape(java.awt.Shape marker) Set the marker shape for this layer
void	setName(java.lang.String newName) Set the name of this layer
void	setPickable(boolean isPickable) Set whether this layer is pickable
void	setPickRadius(int radius) Set the radius used for picking shapes in this layer.
void	setRenderStyle(RenderStyle style) Set the rendering style for this GeoShape.
java.lang.String	toString() Return a string representation of this geographic layer

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoLayer

public GeoLayer(java.lang.String layerName)

Create a new geographic layer. The list of shapes is initially empty. A default render style for this layer is automatically created with a default draw color of red.

Parameters:

layerName - the name of the geographic layer

Method Detail

add

public boolean add(GeoShape shape)

Add a shape to this geographic layer

Parameters:

shape - the shape to add

Returns:

true

addAll

public boolean addAll(java.util.Collection<GeoShape> shapeColl)

Add all of a collection of Geographic shapes to this layer

Parameters:

shapeColl - the collection of shapes

Returns:

true

clear

public void clear()

Clear all shapes from this layer

drawLayer

public void drawLayer(java.awt.Graphics2D g2)

Draw this layer into the graphics context

Parameters:

g2 - the graphics context to draw into

getDrawColor

public java.awt.Color getDrawColor()

Get the drawing color for this layer

Returns:

the drawing color for this layer

getFillColor

public java.awt.Color getFillColor()

Get the fill color for this layer

Returns:

the fill color for this layer

getGeoBounds

public GeoBounds getGeoBounds()

Get the geographic bounds for this layer.

Returns:

the geographic bounds for this layer

getName

public java.lang.String getName()

Get the name of this layer

Returns:

the name of this layer

getPickRadius

public int getPickRadius()

Get the radius used for picking shapes in this layer

Returns:

the pick radius

getRenderStyle

public RenderStyle getRenderStyle()

Get the rendering style for this GeoShape.

Returns:

the Rendering style

getShapes

public java.util.List<GeoShape> getShapes()

Get the list of shapes for this layer

Returns:

the list of shapes

isEmpty

public boolean isEmpty()

Return whether this GeoLayer has geographic content.

Returns:

whether this GeoLayer has geographic content

isPickable

public boolean isPickable()

Return whether this layer is pickable.

Returns:

true if this layer is pickable, false otherwise

pickGeo

public GeoShape pickGeo(java.awt.geom.Point2D point)

Pick the shape at the specified geographic point. The pick radius determines how close the actual point must be to the geographic feature to be selected.

Parameters:

point - the point to query, in pixel coordinates

Returns:

the shape at the geographic point, or null if no shape is at the point

project

public void project(Projection proj)

Projects the geographic coordinates into the given projection

Parameters:

proj - the Projection for the conversion

setColors

public void setColors(java.awt.Color drawColor,
             java.awt.Color fillColor)

Set the draw and fill colors for this layer

Parameters:

drawColor - the draw color

fillColor - the fill color

setDrawColor

public void setDrawColor(java.awt.Color color)

Set the draw color for this layer

Parameters:

color - the draw color

setFillColor

public void setFillColor(java.awt.Color color)

Set the fill color for this layer

Parameters:

color - the fill color

setMarkerShape

public void setMarkerShape(java.awt.Shape marker)

Set the marker shape for this layer

Parameters:

marker - the marker shape

setName

public void setName(java.lang.String newName)

Set the name of this layer

Parameters:

newName - the new layer name

setPickable

public void setPickable(boolean isPickable)

Set whether this layer is pickable

Parameters:

isPickable - true if this layer is pickable, false otherwise

setPickRadius

public void setPickRadius(int radius)

Set the radius used for picking shapes in this layer. The default value is 2.

Parameters:

radius - the radius for picking

setRenderStyle

public void setRenderStyle(RenderStyle style)

Set the rendering style for this GeoShape. Any fields specifically set for a GeoShape should override the layer's default style.

Parameters:

style - The rendering style

toString

public java.lang.String toString()

Return a string representation of this geographic layer

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this geographic layer