Rectangle

Members

east :Number

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

Default Value:

• 0.0

north :Number

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

Default Value:

• 0.0

south :Number

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

Default Value:

• 0.0

west :Number

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

Default Value:

• 0.0

<static> MAX_VALUE :Rectangle

The largest possible rectangle.

<static> packedLength :Number

The number of elements used to pack the object into an array.

Methods

clone

Duplicates this Rectangle.

Parameters:

Name	Type	Argument	Description
result	Rectangle	<optional>	The object onto which to store the result.

Returns:

Rectangle The modified result parameter or a new Rectangle instance if none was provided.

equals

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

Parameters:

Name	Type	Argument	Description
other	Rectangle	<optional>	The Rectangle to compare.

Returns:

Boolean true if the Rectangles are equal, false otherwise.

equalsEpsilon

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

Parameters:

Name	Type	Argument	Description
other	Rectangle	<optional>	The Rectangle to compare.
epsilon	Number		The epsilon to use for equality testing.

Returns:

Boolean true if the Rectangles are within the provided epsilon, false otherwise.

<static> clone

Duplicates an Rectangle.

Parameters:

Name	Type	Argument	Description
rectangle	Rectangle		The rectangle to clone.
result	Rectangle	<optional>	The object onto which to store the result, or undefined if a new instance should be created.

Returns:

Rectangle The modified result parameter or a new Rectangle instance if none was provided. (Returns undefined if rectangle is undefined)

<static> contains

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

Parameters:

Name	Type	Description
rectangle	Rectangle	The rectangle
cartographic	Cartographic	The cartographic to test.

Returns:

Boolean true if the provided cartographic is inside the rectangle, false otherwise.

<static> equals

Compares the provided rectangles and returns true if they are equal, false otherwise.

Parameters:

Name	Type	Argument	Description
left	Rectangle	<optional>	The first Rectangle.
right	Rectangle	<optional>	The second Rectangle.

Returns:

Boolean true if left and right are equal; otherwise false.

<static> fromCartographicArray

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

Parameters:

Name	Type	Argument	Description
cartographics	Array		The list of Cartographic instances.
result	Rectangle	<optional>	The object onto which to store the result, or undefined if a new instance should be created.

Returns:

Rectangle The modified result parameter or a new Rectangle instance if none was provided.

<static> fromDegrees

Creates an rectangle given the boundary longitude and latitude in degrees.

Parameters:

Name	Type	Argument	Default	Description
west	Number	<optional>	0.0	The westernmost longitude in degrees in the range [-180.0, 180.0].
south	Number	<optional>	0.0	The southernmost latitude in degrees in the range [-90.0, 90.0].
east	Number	<optional>	0.0	The easternmost longitude in degrees in the range [-180.0, 180.0].
north	Number	<optional>	0.0	The northernmost latitude in degrees in the range [-90.0, 90.0].
result	Rectangle	<optional>		The object onto which to store the result, or undefined if a new instance should be created.

Returns:

Rectangle The modified result parameter or a new Rectangle instance if none was provided.

Example

var rectangle = Cesium.Rectangle.fromDegrees(0.0, 20.0, 10.0, 30.0);

<static> getCenter

Computes the center of an rectangle.

Parameters:

Name	Type	Argument	Description
rectangle	Rectangle		The rectangle for which to find the center
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.

<static> getNortheast

Computes the northeast corner of an rectangle.

Parameters:

Name	Type	Argument	Description
rectangle	Rectangle		The rectangle for which to find the corner
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.

<static> getNorthwest

Computes the northwest corner of an rectangle.

Parameters:

Name	Type	Argument	Description
rectangle	Rectangle		The rectangle for which to find the corner
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.

<static> getSoutheast

Computes the southeast corner of an rectangle.

Parameters:

Name	Type	Argument	Description
rectangle	Rectangle		The rectangle for which to find the corner
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.

<static> getSouthwest

Computes the southwest corner of an rectangle.

Parameters:

Name	Type	Argument	Description
rectangle	Rectangle		The rectangle for which to find the corner
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.

<static> intersectWith

Computes the intersection of two rectangles

Parameters:

Name	Type	Argument	Description
rectangle	Rectangle		On rectangle to find an intersection
otherRectangle			Another rectangle to find an intersection
result	Rectangle	<optional>	The object onto which to store the result.

Returns:

Rectangle The modified result parameter or a new Rectangle instance if none was provided.

<static> isEmpty

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

Parameters:

Name	Type	Description
rectangle	Rectangle	The rectangle

Returns:

Boolean True if the rectangle is empty; otherwise, false.

<static> pack

Stores the provided instance into the provided array.

Parameters:

Name	Type	Argument	Default	Description
value	Rectangle			The value to pack.
array	Array			The array to pack into.
startingIndex	Number	<optional>	0	The index into the array at which to start packing the elements.

<static> subsample

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

Parameters:

Name	Type	Argument	Default	Description
rectangle	Rectangle			The rectangle to subsample.
ellipsoid	Ellipsoid	<optional>	Ellipsoid.WGS84	The ellipsoid to use.
surfaceHeight	Number	<optional>	0.0	The height of the rectangle above the ellipsoid.
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> unpack

Retrieves an instance from a packed array.

Parameters:

Name	Type	Argument	Default	Description
array	Array			The packed array.
startingIndex	Number	<optional>	0	The starting index of the element to be unpacked.
result	Rectangle	<optional>		The object into which to store the result.

<static> validate

Checks an Rectangle's properties and throws if they are not in valid ranges.

Parameters:

Name	Type	Description
rectangle	Rectangle	The rectangle to validate

Throws:

• DeveloperError : north must be in the interval [-Pi/2, Pi/2].
• DeveloperError : south must be in the interval [-Pi/2, Pi/2].
• DeveloperError : east must be in the interval [-Pi, Pi].
• DeveloperError : west must be in the interval [-Pi, Pi].