planner.geography

Class GeoRectangle

java.lang.Object

planner.geography.GeoArea

planner.geography.GeoPolygon

planner.geography.GeoRectangle

public class GeoRectangle
extends GeoPolygon

Convenience class for a special case of GeoPolygon--a NSEW oriented rectangle

Author:

dtdavis

Constructor Summary

Constructors

Constructor and Description
GeoRectangle(double[] nwCorner, double xDim, double yDim) Creates a new instance of GeoRectangle
GeoRectangle(double[] nwCorner, double xDim, double yDim, double orientation) Creates a new instance of GeoRectangle

Method Summary

Modifier and Type	Method and Description
AreaElementType	convertToAreaElementType() Converts the GeoRectangle to an AVCL area object
double	getArea() Returns the area (square meters) of the GeoRectangle
boolean	isConcave() Returns true if the polygon is concave.
List<double[]>	orientedBoundingBox() Returns the corner points of an oriented bounding box for the region Will default to the orthogonal bounding box, so must be over-ridden for GeoArea types that are not necessarily orthogonally oriented (polygon)
String	toString() Generates a string representation of the GeoRectangle object

Methods inherited from class planner.geography.GeoPolygon

boundingBox, boundingCircleRadius, closestPoint, contains, getAdjacentVertices, getCentroid, getIntersection, getSegmentIntersection, getSegmentIntersection2, getTangents, getVertex, isOnEdge, main, numIntersections, numVertices, onVertex, resetOrientedBoundingBox, setVertices, toMATLABString

Methods inherited from class planner.geography.GeoArea

distance, distance, dotProduct, getLineIntersection, getLineSegmentIntersection, getLineToSegmentIntersection, isColocated, isColocated, isInLineSegment, isInSegment, isOnSegment, isOnSegment

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoRectangle

public GeoRectangle(double[] nwCorner,
                    double xDim,
                    double yDim,
                    double orientation)

Creates a new instance of GeoRectangle

Parameters:

nwCorner - the X, Y position of the rectangle's northwest corner

xDim - the north/south size of the rectangle

yDim - the east/west size of the rectangle

orientation - the rotation of the area about the northwest corner (-90 to 90 degrees)

GeoRectangle

public GeoRectangle(double[] nwCorner,
                    double xDim,
                    double yDim)

Creates a new instance of GeoRectangle

Parameters:

nwCorner - the X, Y position of the rectangle's northwest corner

xDim - the north/south size of the rectangle

yDim - the east/west size of the rectangle

Method Detail

getArea

public double getArea()

Returns the area (square meters) of the GeoRectangle

Overrides:

getArea in class GeoPolygon

Returns:

Returns the area (square meters) of the GeoArea

orientedBoundingBox

public List<double[]> orientedBoundingBox()

Returns the corner points of an oriented bounding box for the region Will default to the orthogonal bounding box, so must be over-ridden for GeoArea types that are not necessarily orthogonally oriented (polygon)

Overrides:

orientedBoundingBox in class GeoPolygon

Returns:

Returns the corner points of an oriented bounding box for the region

isConcave

public boolean isConcave()

Returns true if the polygon is concave. This is false for all rectangles, so this method simply over-rides the parent class's method and returns false

Overrides:

isConcave in class GeoPolygon

Returns:

Returns true if the polygon is concave. By default, areas are assumed to be convex, so if a child class can be concave, it should override this method

toString

public String toString()

Generates a string representation of the GeoRectangle object

Overrides:

toString in class GeoPolygon

convertToAreaElementType

public AreaElementType convertToAreaElementType()

Converts the GeoRectangle to an AVCL area object

Overrides:

convertToAreaElementType in class GeoPolygon

Returns:

Object AVCL area object corresponding to the GeoPoint