top
all js glsl

Extent

Extent

new Extent

A two dimensional region specified as longitude and latitude coordinates.

Parameters:
Name Type Argument Default Description
west Number <optional>
 0.0 The westernmost longitude in the range [-Pi, Pi].
south Number <optional>
 0.0 The southernmost latitude in the range [-Pi/2, Pi/2].
east Number <optional>
 0.0 The easternmost longitude in the range [-Pi, Pi].
north Number <optional>
 0.0 The northernmost latitude in the range [-Pi/2, Pi/2].

Members

east :Number

The easternmost longitude in the range [-Pi, Pi].

north :Number

The northernmost latitude in the range [-Pi/2, Pi/2].

south :Number

The southernmost latitude in the range [-Pi/2, Pi/2].

west :Number

The westernmost longitude in the range [-Pi, Pi].

<static> MAX_VALUE :Extent

The largest possible extent.

Methods

clone

Duplicates this Extent.

Parameters:
Name Type Argument Description
result Extent <optional>
 The object onto which to store the result.
Returns:
Extent The modified result parameter or a new Extent instance if none was provided.

contains

Returns true if the provided cartographic is on or inside the extent, false otherwise.

Parameters:
Name Type Description
cartographic Cartographic The cartographic to test.
Throws:
DeveloperError : cartographic is required.
Returns:
Boolean true if the provided cartographic is inside the extent, false otherwise.

equals

Compares the provided Extent with this Extent componentwise and returns true if they are equal, false otherwise.

Parameters:
Name Type Argument Description
other Extent <optional>
 The Extent to compare.
Returns:
Boolean true if the Extents are equal, false otherwise.

equalsEpsilon

Compares the provided Extent with this Extent componentwise and returns true if they are within the provided epsilon, false otherwise.

Parameters:
Name Type Argument Description
other Extent <optional>
 The Extent to compare.
epsilon Number The epsilon to use for equality testing.
Throws:
DeveloperError : epsilon is required and must be a number.
Returns:
Boolean true if the Extents are within the provided epsilon, false otherwise.

getCenter

Computes the center of this extent.

Parameters:
Name Type Argument Description
result Cartographic <optional>
 The object onto which to store the result.
Returns:
Cartographic The modified result parameter or a new Cartographic instance if none was provided.

getNortheast

Computes the northeast corner of this extent.

Parameters:
Name Type Argument Description
result Cartographic <optional>
 The object onto which to store the result.
Returns:
Cartographic The modified result parameter or a new Cartographic instance if none was provided.

getNorthwest

Computes the northwest corner of this extent.

Parameters:
Name Type Argument Description
result Cartographic <optional>
 The object onto which to store the result.
Returns:
Cartographic The modified result parameter or a new Cartographic instance if none was provided.

getSoutheast

Computes the southeast corner of this extent.

Parameters:
Name Type Argument Description
result Cartographic <optional>
 The object onto which to store the result.
Returns:
Cartographic The modified result parameter or a new Cartographic instance if none was provided.

getSouthwest

Computes the southwest corner of this extent.

Parameters:
Name Type Argument Description
result Cartographic <optional>
 The object onto which to store the result.
Returns:
Cartographic The modified result parameter or a new Cartographic instance if none was provided.

intersectWith

Computes the intersection of this extent with the provided extent.

Parameters:
Name Type Argument Description
otherExtent The extent to intersect with this extent.
result Extent <optional>
 The object onto which to store the result.
Throws:
DeveloperError : otherExtent is required.
Returns:
Extent The modified result parameter or a new Extent instance if none was provided.

isEmpty

Determines if the extent is empty, i.e., if west >= east or south >= north.

Returns:
Boolean True if the extent is empty; otherwise, false.

<static> clone

Duplicates an Extent.

Parameters:
Name Type Argument Description
extent Extent The extent to clone.
result Extent <optional>
 The object onto which to store the result, or undefined if a new instance should be created.
Returns:
Extent The modified result parameter or a new Extent instance if none was provided.

<static> fromCartographicArray

Creates the smallest possible Extent that encloses all positions in the provided array.

Parameters:
Name Type Argument Description
cartographics Array The list of Cartographic instances.
result Extent <optional>
 The object onto which to store the result, or undefined if a new instance should be created.
Returns:
Extent The modified result parameter or a new Extent instance if none was provided.

<static> prototype.subsample

Samples this Extent so that it includes a list of Cartesian points suitable for passing to BoundingSphere#fromPoints. Sampling is necessary to account for extents that cover the poles or cross the equator.

Parameters:
Name Type Argument Default Description
ellipsoid Ellipsoid <optional>
 Ellipsoid.WGS84 The ellipsoid to use.
result Array <optional>
 The array of Cartesians onto which to store the result.
Returns:
Array The modified result parameter or a new Array of Cartesians instances if none was provided.

<static> prototype.validate

Checks this Extent's properties and throws if they are not in valid ranges.

Throws: