rescuecore2.standard.entities

Class Edge

java.lang.Object

rescuecore2.standard.entities.Edge

public class Edge
extends java.lang.Object

An edge is a line segment with an optional neighbouring entity. Edges without neighbours are impassable, edges with neighbours are passable.

Constructor Summary

Constructors

Constructor and Description
Edge(int startX, int startY, int endX, int endY) Constuct an impassable Edge.
Edge(int startX, int startY, int endX, int endY, EntityID neighbour) Constuct an Edge.
Edge(Point2D start, Point2D end) Constuct an impassable Edge.
Edge(Point2D start, Point2D end, EntityID neighbour) Constuct an Edge.

Method Summary

Modifier and Type	Method and Description
Point2D	getEnd() Get the end point.
int	getEndX() Get the X coordinate of the second endpoint.
int	getEndY() Get the Y coordinate of the second endpoint.
Line2D	getLine() Get a line representing this edge.
EntityID	getNeighbour() Get the ID of the neighbour.
Point2D	getStart() Get the start point.
int	getStartX() Get the X coordinate of the first endpoint.
int	getStartY() Get the Y coordinate of the first endpoint.
boolean	isPassable() Find out if this edge is passable or not.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Edge

public Edge(int startX,
            int startY,
            int endX,
            int endY)

Constuct an impassable Edge.

Parameters:

startX - The X coordinate of the first endpoint.

startY - The Y coordinate of the first endpoint.

endX - The X coordinate of the second endpoint.

endY - The Y coordinate of the second endpoint.

Edge

public Edge(Point2D start,
            Point2D end)

Constuct an impassable Edge.

Parameters:

start - The first endpoint coordinates.

end - The second endpoint coordinates.

Edge

public Edge(int startX,
            int startY,
            int endX,
            int endY,
            EntityID neighbour)

Constuct an Edge. If the neighbour is null then this edge is impassable; if it is non-null then this edge is passable.

Parameters:

startX - The X coordinate of the first endpoint.

startY - The Y coordinate of the first endpoint.

endX - The X coordinate of the second endpoint.

endY - The Y coordinate of the second endpoint.

neighbour - The ID of the neighbour on the other side of this edge. This may be null to indicate an impassable edge.

Edge

public Edge(Point2D start,
            Point2D end,
            EntityID neighbour)

Constuct an Edge. If the neighbour is null then this edge is impassable; if it is non-null then this edge is passable.

Parameters:

start - The first endpoint coordinates.

end - The second endpoint coordinates.

neighbour - The ID of the neighbour on the other side of this edge. This may be null to indicate an impassable edge.

Method Detail

getStartX

public int getStartX()

Get the X coordinate of the first endpoint.

Returns:

The X coordinate of the first endpoint.

getStartY

public int getStartY()

Get the Y coordinate of the first endpoint.

Returns:

The Y coordinate of the first endpoint.

getEndX

public int getEndX()

Get the X coordinate of the second endpoint.

Returns:

The X coordinate of the second endpoint.

getEndY

public int getEndY()

Get the Y coordinate of the second endpoint.

Returns:

The Y coordinate of the second endpoint.

getStart

public Point2D getStart()

Get the start point.

Returns:

The start point.

getEnd

public Point2D getEnd()

Get the end point.

Returns:

The end point.

getNeighbour

public EntityID getNeighbour()

Get the ID of the neighbour.

Returns:

The ID of the neighbour or null if this edge is impassable.

isPassable

public boolean isPassable()

Find out if this edge is passable or not.

Returns:

True iff the neighbour is non-null.

getLine

public Line2D getLine()

Get a line representing this edge.

Returns:

A Line2D representing this edge.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object