edu.ucdavis.cstars.client.geometry

Class Extent

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.geometry.Geometry

edu.ucdavis.cstars.client.geometry.Extent

public class Extent
extends Geometry

The minimum and maximum X- and Y- coordinates of a bounding box.

Author:

Justin Merz

Nested Class Summary

Nested classes/interfaces inherited from class edu.ucdavis.cstars.client.geometry.Geometry

Geometry.GeometryType

Method Summary

Methods

Modifier and Type	Method and Description
Extent	centerAt(Point point) A new extent is returned with the same width and height centered at the argument point.
boolean	contains(Extent extent) When "true", the geometry in the argument is contained in this extent.
boolean	contains(Point point) When "true", the geometry in the argument is contained in this extent.
static Extent	create(double xmin, double ymin, double xmax, double ymax, SpatialReference ref) Creates a new Extent object.
static Extent	create(com.google.gwt.core.client.JavaScriptObject json) Creates a new Extent object using a JSON object.
Extent	expand(float factor) Expands the extent by the factor given.
Point	getCenter() Returns the center point of the extent in map units.
float	getHeight() Distance between ymin and ymax.
float	getWidth() Distance between xmin and xmax.
float	getXMax() Top-right X-coordinate of an extent envelope.
float	getXMin() Bottom-left X-coordinate of an extent envelope.
float	getYMax() Top-right Y-coordinate of an extent envelope.
float	getYMin() Bottom-left Y-coordinate of an extent envelope.
boolean	intersects(Extent extent) Returns true if the input geometry intersects this extent.
boolean	intersects(Multipoint multipoint) Returns true if the input geometry intersects this extent.
boolean	intersects(Point point) Returns true if the input geometry intersects this extent.
boolean	intersects(Polygon polygon) Returns true if the input geometry intersects this extent.
boolean	intersects(Polyline polyline) Returns true if the input geometry intersects this extent.
Extent	offset(double dx, double dy) Offsets the current extent.
java.lang.String	toNiceString() Returns extent as a formated String
Extent	union(Extent extent) Expands this extent to include the extent of the argument.
Extent	update(double xmin, double ymin, double xmax, double ymax, SpatialReference ref) Updates this extent with the specified parameters.

Methods inherited from class edu.ucdavis.cstars.client.geometry.Geometry

fromJson, geographicToWebMercator, getExtentForScale, getJson, getJsonType, getLength, getLineIntersection, getScale, getSpatialReference, getType, isClockwise, setSpatialReference, toJson, toMapGeometry, toMapPoint, toScreenGeometry, toScreenPoint, webMercatorToGeographic

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static Extent create(double xmin,
            double ymin,
            double xmax,
            double ymax,
            SpatialReference ref)

Creates a new Extent object. The coordinates represent the lower left and upper right corners of the bounding box. A spatial reference is also required.

Parameters:

xmin - - Bottom-left X-coordinate of an extent envelope.

ymin - - Bottom-left Y-coordinate of an extent envelope.

xmax - - Top-right X-coordinate of an extent envelope.

ymax - - Top-right Y-coordinate of an extent envelope.

ref - - Spatial reference of the geometry.

Returns:

Extent

create

public static Extent create(com.google.gwt.core.client.JavaScriptObject json)

Creates a new Extent object using a JSON object.

Parameters:

json - - JSON object representing the geometry.

Returns:

Extent

toNiceString

public final java.lang.String toNiceString()

Returns extent as a formated String

Returns:

String

getXMax

public final float getXMax()

Top-right X-coordinate of an extent envelope.

Returns:

float

getXMin

public final float getXMin()

Bottom-left X-coordinate of an extent envelope.

Returns:

float

getYMax

public final float getYMax()

Top-right Y-coordinate of an extent envelope.

Returns:

float

getYMin

public final float getYMin()

Bottom-left Y-coordinate of an extent envelope.

Returns:

float

centerAt

public final Extent centerAt(Point point)

A new extent is returned with the same width and height centered at the argument point.

Parameters:

point - - Centers the extent on the specified x,y location.

Returns:

- Extent

contains

public final boolean contains(Point point)

When "true", the geometry in the argument is contained in this extent.

Parameters:

point -

Returns:

boolean

contains

public final boolean contains(Extent extent)

When "true", the geometry in the argument is contained in this extent.

Parameters:

extent -

Returns:

boolean

expand

public final Extent expand(float factor)

Expands the extent by the factor given. For example, a value of 1.5 will be 50% bigger.

Parameters:

factor - - The mulitplier value.

Returns:

Extent

getCenter

public final Point getCenter()

Returns the center point of the extent in map units.

Returns:

Point

getHeight

public final float getHeight()

Distance between ymin and ymax.

Returns:

float

getWidth

public final float getWidth()

Distance between xmin and xmax.

Returns:

float

intersects

public final boolean intersects(Extent extent)

Returns true if the input geometry intersects this extent.

Parameters:

extent -

Returns:

boolean

intersects

public final boolean intersects(Point point)

Returns true if the input geometry intersects this extent.

Parameters:

point -

Returns:

boolean

intersects

public final boolean intersects(Multipoint multipoint)

Returns true if the input geometry intersects this extent.

Parameters:

multipoint -

Returns:

boolean

intersects

public final boolean intersects(Polygon polygon)

Returns true if the input geometry intersects this extent.

Parameters:

polygon -

Returns:

boolean

intersects

public final boolean intersects(Polyline polyline)

Returns true if the input geometry intersects this extent.

Parameters:

polyline -

Returns:

boolean

offset

public final Extent offset(double dx,
            double dy)

Offsets the current extent. Units are map units.

Parameters:

dx - - The offset distance in map units for the x-coordinate.

dy - - The offset distance in map units for the y-coordinate.

Returns:

Extent

union

public final Extent union(Extent extent)

Expands this extent to include the extent of the argument.

Parameters:

extent - - Expands this extent to include the extent of the argument.

Returns:

Extent

update

public final Extent update(double xmin,
            double ymin,
            double xmax,
            double ymax,
            SpatialReference ref)

Updates this extent with the specified parameters.

Parameters:

xmin - - Bottom-left X-coordinate of an extent envelope.

ymin - - Bottom-left Y-coordinate of an extent envelope.

xmax - - Top-right X-coordinate of an extent envelope.

ymax - - Top-right Y-coordinate of an extent envelope.

ref - - Spatial reference of the geometry.

Returns:

Extent