EE324StandardProjectClasses

Class ShapeMap

java.lang.Object

EE324StandardProjectClasses.ShapeMap

All Implemented Interfaces:

java.lang.Iterable<Polygon2D>

public class ShapeMap
extends java.lang.Object
implements java.lang.Iterable<Polygon2D>

A collection of Polygon2D objects along with a source and a destination point which together specify a path finding problem to be solved.

NOTE: This class uses the Polygon2D and Point2D classes.

NOTE: Requires Sedgewick's and Wayne's StdDraw library.

Author:

Conor McArdle (conor.mcardle@dcu.ie)

Constructor Summary

Constructors

Constructor and Description
ShapeMap() Construct an empty ShapeMap.
ShapeMap(java.util.ArrayList<Polygon2D> polys, Point2D src, Point2D dest) Construct a ShapeMap with a specified set of polygons and a specified source and destination point.
ShapeMap(Point2D src, Point2D dest) Construct a ShapeMap with a specified source and destination point.
ShapeMap(java.lang.String fileName) Construct a ShapeMap using a specified input map file.

Method Summary

Modifier and Type	Method and Description
void	addPolygon(Polygon2D poly) Add a new polygon shape to this map.
Point2D	destinationPoint() Get the destination point (path ending point) of this map.
void	draw() Draw perimeter of each polygon in this ShapeMap.
void	draw(java.awt.Color clr) Draw perimeter of each polygon in this ShapeMap, with a given color.
void	draw(java.awt.Color clr, double penWidth) Draw perimeter of each polygon in this ShapeMap, with a given color and pen width.
void	drawFilled() Draw and fill each polygon in this ShapeMap.
void	drawFilled(java.awt.Color clr) Draw and fill each polygon in this ShapeMap, with a given color.
java.util.List<Point2D>	getAllPoints() Get all points of all polygons in this shape map - does not include the source and destination points.
java.util.Iterator<Polygon2D>	iterator() Iterator supporting for-each style iteration over all polygons in this map.
static void	shapeMapDemo() Demonstrates construction and drawing of a shape map containing a single polygon.
Point2D	sourcePoint() Get the source point (path starting point) of this map.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ShapeMap

public ShapeMap()

Construct an empty ShapeMap.

ShapeMap

public ShapeMap(java.util.ArrayList<Polygon2D> polys,
                Point2D src,
                Point2D dest)

Construct a ShapeMap with a specified set of polygons and a specified source and destination point.

Parameters:

polys - the list of polygons to construct the map with

src - the path source (starting) point

dest - the path destination (ending) point

ShapeMap

public ShapeMap(Point2D src,
                Point2D dest)

Construct a ShapeMap with a specified source and destination point. No polygons are created.

Parameters:

src - the path source (starting) point

dest - the path destination (ending) point

ShapeMap

public ShapeMap(java.lang.String fileName)

Construct a ShapeMap using a specified input map file.

Parameters:

fileName - to load map from

Method Detail

addPolygon

public void addPolygon(Polygon2D poly)

Add a new polygon shape to this map.

Parameters:

poly - the polygon to add to the map

destinationPoint

public Point2D destinationPoint()

Get the destination point (path ending point) of this map.

Returns:

the destination point as a Point2D object

draw

public void draw()

Draw perimeter of each polygon in this ShapeMap. Requires StdDraw library.

draw

public void draw(java.awt.Color clr)

Draw perimeter of each polygon in this ShapeMap, with a given color. Requires StdDraw library.

Parameters:

clr - the pen color to use

draw

public void draw(java.awt.Color clr,
                 double penWidth)

Draw perimeter of each polygon in this ShapeMap, with a given color and pen width. Requires StdDraw library.

Parameters:

clr - the pen color to use

penWidth - width of the pen to use

drawFilled

public void drawFilled()

Draw and fill each polygon in this ShapeMap. Requires StdDraw library.

drawFilled

public void drawFilled(java.awt.Color clr)

Draw and fill each polygon in this ShapeMap, with a given color. Requires StdDraw library.

Parameters:

clr - the pen color to use

getAllPoints

public java.util.List<Point2D> getAllPoints()

Get all points of all polygons in this shape map - does not include the source and destination points.

Returns:

list of all map points

iterator

public java.util.Iterator<Polygon2D> iterator()

Iterator supporting for-each style iteration over all polygons in this map. Example:
for (Polygon2D poly : sm) { poly.draw(); } // sm a ShapeMap object

Specified by:

iterator in interface java.lang.Iterable<Polygon2D>

shapeMapDemo

public static void shapeMapDemo()

Demonstrates construction and drawing of a shape map containing a single polygon.

sourcePoint

public Point2D sourcePoint()

Get the source point (path starting point) of this map.

Returns:

the source point as a Point2D object