Cartographic

Cartographic

new

A position defined by longitude, latitude, and height.

Parameters:
Name Type Argument Default Description
longitude Number <optional>
0.0 The longitude, in radians.
latitude Number <optional>
0.0 The latitude, in radians.
height Number <optional>
0.0 The height, in meters, above the ellipsoid.
See:
Source:

Members

:Number

The height, in meters, above the ellipsoid.
Default Value:
  • 0.0

:Number

The latitude, in radians.
Default Value:
  • 0.0

:Number

The longitude, in radians.
Default Value:
  • 0.0

<static>

An immutable Cartographic instance initialized to (0.0, 0.0, 0.0).

Methods

Duplicates this instance.

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 one was not provided.

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

Parameters:
Name Type Argument Description
right Cartographic <optional>
The second cartographic.
Returns:
Boolean true if left and right are equal, false otherwise.

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

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

Creates a string representing this cartographic in the format '(longitude, latitude, height)'.

Returns:
String A string representing the provided cartographic in the format '(longitude, latitude, height)'.

<static>

Duplicates a Cartographic instance.

Parameters:
Name Type Argument Description
cartographic Cartographic The cartographic to duplicate.
result Cartographic <optional>
The object onto which to store the result.
Returns:
Cartographic The modified result parameter or a new Cartographic instance if one was not provided. (Returns undefined if cartographic is undefined)

<static>

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

Parameters:
Name Type Argument Description
left Cartographic <optional>
The first cartographic.
right Cartographic <optional>
The second cartographic.
Returns:
Boolean true if left and right are equal, false otherwise.

<static>

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

Parameters:
Name Type Argument Description
left Cartographic <optional>
The first cartographic.
right Cartographic <optional>
The second cartographic.
epsilon Number The epsilon to use for equality testing.
Throws:
DeveloperError : epsilon is required and must be a number.
Returns:
Boolean true if left and right are within the provided epsilon, false otherwise.

<static>

Creates a new Cartographic instance from longitude and latitude specified in degrees. The values in the resulting object will be in radians.

Parameters:
Name Type Argument Default Description
longitude Number <optional>
0.0 The longitude, in degrees.
latitude Number <optional>
0.0 The latitude, in degrees.
height Number <optional>
0.0 The height, in meters, above the ellipsoid.
result Cartographic <optional>
The object onto which to store the result.
Returns:
Cartographic The modified result parameter or a new Cartographic instance if one was not provided.

<static>

Creates a string representing the provided cartographic in the format '(longitude, latitude, height)'.

Parameters:
Name Type Description
cartographic Cartographic The cartographic to stringify.
Throws:
DeveloperError : cartographic is required.
Returns:
String A string representing the provided cartographic in the format '(longitude, latitude, height)'.