rle.core.board.path
Class Path

java.lang.Object
  rle.core.board.path.Path

Direct Known Subclasses:

CirclePath, LinePath, ListPath, RectanglePath

public abstract class Path
extends java.lang.Object

A base class for classes that can construct a list of Board locations.

Constructor Summary

Path()

Method Summary

static RLPoint	endPoint(RLPoint start, java.lang.String dir, int dist) A utility method to find a grid that lies in a given cardinal direction from the supplied start grid with a minimum distance of dist.
static Path	fillCircle(RLPoint ctr, int radius) Create a Path that fills a circular area.
static Path	fillCircle(RLRectangle ctr, int radius) Create a Path that fills a circular area outside a rectangular area.
static Path	fillRect(RLRectangle r) Create a Path that fills a rectangular area.
static Path	frameCircle(RLPoint ctr, int radius) Create a Path that frames a circular area.
static Path	frameCircle(RLRectangle ctr, int radius) Create a Path that frames a circular area outside a rectangular area.
static Path	frameRect(RLRectangle r) Create a Path that frames a rectangular area.
java.util.List<RLPoint>	legalPoints(Board b) Return the steps in this path that are legal for a Board.
static Path	linePath(RLPoint source, RLPoint target) Create a Path that forms a line between two points, inclusive.
static Path	listPath(java.util.List<RLPoint> points) Create a Path for an arbitrary List of points.
abstract java.util.List<RLPoint>	points() Return the steps in this path.
java.util.Set<Thing>	things(Board b) Return the things in this path for a Board.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Path

public Path()

Method Detail

points

public abstract java.util.List<RLPoint> points()

Return the steps in this path.

legalPoints

public java.util.List<RLPoint> legalPoints(Board b)

Return the steps in this path that are legal for a Board.

things

public java.util.Set<Thing> things(Board b)

Return the things in this path for a Board.

listPath

public static Path listPath(java.util.List<RLPoint> points)

Create a Path for an arbitrary List of points.

linePath

public static Path linePath(RLPoint source,
                            RLPoint target)

Create a Path that forms a line between two points, inclusive.

frameRect

public static Path frameRect(RLRectangle r)

Create a Path that frames a rectangular area.

fillRect

public static Path fillRect(RLRectangle r)

Create a Path that fills a rectangular area.

frameCircle

public static Path frameCircle(RLPoint ctr,
                               int radius)

Create a Path that frames a circular area.

fillCircle

public static Path fillCircle(RLPoint ctr,
                              int radius)

Create a Path that fills a circular area.

frameCircle

public static Path frameCircle(RLRectangle ctr,
                               int radius)

Create a Path that frames a circular area outside a rectangular area.

fillCircle

public static Path fillCircle(RLRectangle ctr,
                              int radius)

Create a Path that fills a circular area outside a rectangular area.

endPoint

public static RLPoint endPoint(RLPoint start,
                               java.lang.String dir,
                               int dist)

A utility method to find a grid that lies in a given cardinal direction from the supplied start grid with a minimum distance of dist.

Parameters:

dir - - one of sw,s,se,w,e,nw,n,ne referring to the 8 cardinal directions

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object