maps.gml.view

Class RectangleOverlay

java.lang.Object

maps.gml.view.RectangleOverlay

All Implemented Interfaces:

Overlay

public class RectangleOverlay
extends java.lang.Object
implements Overlay

A rectangular overlay.

Constructor Summary

Constructors

Constructor and Description
RectangleOverlay(java.awt.Color colour, boolean useWorldCoords) Construct a RectangleOverlay with no coordinates defined..
RectangleOverlay(double left, double right, double top, double bottom, java.awt.Color colour, boolean useWorldCoords) Construct a RectangleOverlay.

Method Summary

Modifier and Type	Method and Description
void	render(java.awt.Graphics2D g, ScreenTransform transform) Render this overlay.
void	setBottom(double y) Set the bottom Y coordinate.
void	setColour(java.awt.Color c) Set the colour.
void	setLeft(double x) Set the left-hand X coordinate.
void	setRight(double x) Set the right-hand X coordinate.
void	setTop(double y) Set the top Y coordinate.
void	setUseWorldCoordinates(boolean b) Set whether to use world coordinates or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

RectangleOverlay

public RectangleOverlay(java.awt.Color colour,
                        boolean useWorldCoords)

Construct a RectangleOverlay with no coordinates defined..

Parameters:

colour - The colour to draw the rectangle.

useWorldCoords - Whether to convert the coordinates from world to screen. Set to false if you want to directly specify screen coordinates.

RectangleOverlay

public RectangleOverlay(double left,
                        double right,
                        double top,
                        double bottom,
                        java.awt.Color colour,
                        boolean useWorldCoords)

Construct a RectangleOverlay.

Parameters:

left - The left-hand X coordinate.

right - The right-hand X coordinate.

top - The top Y coordinate.

bottom - The bottom Y coordinate.

colour - The colour to draw the rectangle.

useWorldCoords - Whether to convert the coordinates from world to screen. Set to false if you want to directly specify screen coordinates.

Method Detail

setLeft

public void setLeft(double x)

Set the left-hand X coordinate.

Parameters:

x - The new coordinate.

setRight

public void setRight(double x)

Set the right-hand X coordinate.

Parameters:

x - The new coordinate.

setTop

public void setTop(double y)

Set the top Y coordinate.

Parameters:

y - The new coordinate.

setBottom

public void setBottom(double y)

Set the bottom Y coordinate.

Parameters:

y - The new coordinate.

setColour

public void setColour(java.awt.Color c)

Set the colour.

Parameters:

c - The new colour.

setUseWorldCoordinates

public void setUseWorldCoordinates(boolean b)

Set whether to use world coordinates or not. If true, the coordinates will be converted to screen coordinates; if false the coordinates will be used as given.

Parameters:

b - True to use world coordinates, false otherwise.

render

public void render(java.awt.Graphics2D g,
                   ScreenTransform transform)

Description copied from interface: Overlay

Render this overlay.

Specified by:

render in interface Overlay

Parameters:

g - The graphics to draw on.

transform - The current screen transform.