org.cesiumjs.cs.core

Class Cartographic

java.lang.Object

org.cesiumjs.cs.core.Cartographic

@JsType(isNative=true,
        namespace="Cesium",
        name="Cartographic")
public class Cartographic
extends Object

A position defined by longitude, latitude, and height.

Author:

Serge Silaev aka iSergio

See Also:

Ellipsoid

Field Summary

Fields

Modifier and Type	Field and Description
double	height The height, in meters, above the ellipsoid.
double	latitude The latitude, in radians.
double	longitude The longitude, in radians.

Constructor Summary

Constructors

Constructor and Description
Cartographic() A position defined by longitude, latitude, and height.
Cartographic(double longitude, double latitude) A position defined by longitude, latitude, and height.
Cartographic(double longitude, double latitude, double height) A position defined by longitude, latitude, and height.

Method Summary

Modifier and Type	Method and Description
Cartographic	clone() Duplicates this instance.
Cartographic	clone(Cartographic result) Duplicates this instance.
static Cartographic	clone(Cartographic cartographic, Cartographic result) Duplicates a Cartographic instance.
boolean	equals() Compares the provided against this cartographic componentwise and returns true if they are equal, false otherwise.
boolean	equals(Cartographic right) Compares the provided against this cartographic componentwise and returns true if they are equal, false otherwise.
static boolean	equals(Cartographic left, Cartographic right) Compares the provided cartographics componentwise and returns true if they are equal, false otherwise.
static boolean	equalsEpsilon(Cartographic left, Cartographic right, double epsilon) Compares the provided cartographics componentwise and returns true if they are within the provided epsilon, false otherwise.
boolean	equalsEpsilon(Cartographic right, double epsilon) Compares the provided against this cartographic componentwise and returns true if they are within the provided epsilon, false otherwise.
static Cartographic	fromCartesian(Cartesian3 cartesian) Creates a new Cartographic instance from a Cartesian position.
static Cartographic	fromCartesian(Cartesian3 cartesian, Ellipsoid ellipsoid) Creates a new Cartographic instance from a Cartesian position.
static Cartographic	fromCartesian(Cartesian3 cartesian, Ellipsoid ellipsoid, Cartographic result) Creates a new Cartographic instance from a Cartesian position.
static Cartographic	fromDegrees(double longitude, double latitude) Creates a new Cartographic instance from longitude and latitude specified in degrees.
static Cartographic	fromDegrees(double longitude, double latitude, double height) Creates a new Cartographic instance from longitude and latitude specified in degrees.
static Cartographic	fromDegrees(double longitude, double latitude, double height, Cartographic result) Creates a new Cartographic instance from longitude and latitude specified in degrees.
static Cartographic	fromRadians(double longitude, double latitude) Creates a new Cartographic instance from longitude and latitude specified in radians.
static Cartographic	fromRadians(double longitude, double latitude, double height) Creates a new Cartographic instance from longitude and latitude specified in radians.
static Cartographic	fromRadians(double longitude, double latitude, double height, Cartographic result) Creates a new Cartographic instance from longitude and latitude specified in radians.
static Cartesian3	toCartesian(Cartographic cartographic, Ellipsoid ellipsoid, Cartesian3 result) Creates a new Cartesian3 instance from a Cartographic input.
String	toString() Creates a string representing this cartographic in the format '(longitude, latitude, height)'.
static Cartographic	ZERO() An immutable Cartographic instance initialized to (0.0, 0.0, 0.0).

Methods inherited from class java.lang.Object

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

Field Detail

height

@JsProperty
public double height

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

latitude

@JsProperty
public double latitude

The latitude, in radians. Default Value: 0.0

longitude

@JsProperty
public double longitude

The longitude, in radians. Default Value: 0.0

Constructor Detail

Cartographic

@JsConstructor
public Cartographic()

A position defined by longitude, latitude, and height.

See Also:

Ellipsoid

Cartographic

@JsConstructor
public Cartographic(double longitude,
                                   double latitude)

A position defined by longitude, latitude, and height.

Parameters:

longitude - The longitude, in radians.

latitude - The latitude, in radians.

See Also:

Ellipsoid

Cartographic

@JsConstructor
public Cartographic(double longitude,
                                   double latitude,
                                   double height)

A position defined by longitude, latitude, and height.

Parameters:

longitude - The longitude, in radians.

latitude - The latitude, in radians.

height - The height, in meters, above the ellipsoid.

See Also:

Ellipsoid

Method Detail

ZERO

@JsProperty(name="ZERO")
public static Cartographic ZERO()

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

clone

@JsMethod
public static Cartographic clone(Cartographic cartographic,
                                           Cartographic result)

Duplicates a Cartographic instance.

Parameters:

cartographic - The cartographic to duplicate.

result - The object onto which to store the result.

Returns:

The modified result parameter or a new Cartographic instance if one was not provided. (Returns undefined if cartographic is undefined)

equals

@JsMethod
public static boolean equals(Cartographic left,
                                       Cartographic right)

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

Parameters:

left - The first cartographic. Optional.

right - The second cartographic. Optional.

Returns:

true if left and right are equal, false otherwise.

equalsEpsilon

@JsMethod
public static boolean equalsEpsilon(Cartographic left,
                                              Cartographic right,
                                              double epsilon)

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

Parameters:

left - The first cartographic. Optional.

right - The second cartographic. Optional.

epsilon - The epsilon to use for equality testing.

Returns:

true if left and right are within the provided epsilon, false otherwise.

fromCartesian

@JsMethod
public static Cartographic fromCartesian(Cartesian3 cartesian)

Creates a new Cartographic instance from a Cartesian position. The values in the resulting object will be in radians.

Parameters:

cartesian - The Cartesian position to convert to cartographic representation.

Returns:

The modified result parameter, new Cartographic instance if none was provided, or undefined if the cartesian is at the center of the ellipsoid.

fromCartesian

@JsMethod
public static Cartographic fromCartesian(Cartesian3 cartesian,
                                                   Ellipsoid ellipsoid)

Creates a new Cartographic instance from a Cartesian position. The values in the resulting object will be in radians.

Parameters:

cartesian - The Cartesian position to convert to cartographic representation.

ellipsoid - The ellipsoid on which the position lies. Optional. Default Ellipsoid.WGS84().

Returns:

The modified result parameter, new Cartographic instance if none was provided, or undefined if the cartesian is at the center of the ellipsoid.

fromCartesian

@JsMethod
public static Cartographic fromCartesian(Cartesian3 cartesian,
                                                   Ellipsoid ellipsoid,
                                                   Cartographic result)

Creates a new Cartographic instance from a Cartesian position. The values in the resulting object will be in radians.

Parameters:

cartesian - The Cartesian position to convert to cartographic representation.

ellipsoid - The ellipsoid on which the position lies. Optional. Default Ellipsoid.WGS84().

result - The object onto which to store the result. Optional.

Returns:

The modified result parameter, new Cartographic instance if none was provided, or undefined if the cartesian is at the center of the ellipsoid.

fromDegrees

@JsMethod
public static Cartographic fromDegrees(double longitude,
                                                 double latitude)

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

Parameters:

longitude - The longitude, in degrees.

latitude - The latitude, in degrees.

Returns:

The modified result parameter or a new Cartographic instance if one was not provided.

fromDegrees

@JsMethod
public static Cartographic fromDegrees(double longitude,
                                                 double latitude,
                                                 double height)

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

Parameters:

longitude - The longitude, in degrees.

latitude - The latitude, in degrees.

height - The height, in meters, above the ellipsoid. Optional. Default: 0.0.

Returns:

The modified result parameter or a new Cartographic instance if one was not provided.

fromDegrees

@JsMethod
public static Cartographic fromDegrees(double longitude,
                                                 double latitude,
                                                 double height,
                                                 Cartographic result)

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

Parameters:

longitude - The longitude, in degrees.

latitude - The latitude, in degrees.

height - The height, in meters, above the ellipsoid. Optional. Default: 0.0.

result - The object onto which to store the result. Optional.

Returns:

The modified result parameter or a new Cartographic instance if one was not provided.

fromRadians

@JsMethod
public static Cartographic fromRadians(double longitude,
                                                 double latitude)

Creates a new Cartographic instance from longitude and latitude specified in radians.

Parameters:

longitude - The longitude, in radians.

latitude - The latitude, in radians.

Returns:

The modified result parameter or a new Cartographic instance if one was not provided.

fromRadians

@JsMethod
public static Cartographic fromRadians(double longitude,
                                                 double latitude,
                                                 double height)

Creates a new Cartographic instance from longitude and latitude specified in radians.

Parameters:

longitude - The longitude, in radians.

latitude - The latitude, in radians.

height - The height, in meters, above the ellipsoid. Optional. Default: 0.0.

Returns:

The modified result parameter or a new Cartographic instance if one was not provided.

fromRadians

@JsMethod
public static Cartographic fromRadians(double longitude,
                                                 double latitude,
                                                 double height,
                                                 Cartographic result)

Creates a new Cartographic instance from longitude and latitude specified in radians.

Parameters:

longitude - The longitude, in radians.

latitude - The latitude, in radians.

height - The height, in meters, above the ellipsoid. Optional. Default: 0.0.

result - The object onto which to store the result. Optional.

Returns:

The modified result parameter or a new Cartographic instance if one was not provided.

toCartesian

@JsMethod
public static Cartesian3 toCartesian(Cartographic cartographic,
                                               Ellipsoid ellipsoid,
                                               Cartesian3 result)

Creates a new Cartesian3 instance from a Cartographic input. The values in the inputted object should be in radians.

Parameters:

cartographic - Input to be converted into a Cartesian3 output.

ellipsoid - The ellipsoid on which the position lies. Default: Ellipsoid.WGS84().

result - The object onto which to store the result.

Returns:

The position

clone

@JsMethod
public Cartographic clone()

Duplicates this instance.

Overrides:

clone in class Object

Returns:

The modified result parameter or a new Cartographic instance if one was not provided.

clone

@JsMethod
public Cartographic clone(Cartographic result)

Duplicates this instance.

Parameters:

result - The object onto which to store the result. Optional.

Returns:

The modified result parameter or a new Cartographic instance if one was not provided.

equals

@JsMethod
public boolean equals()

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

Returns:

true if left and right are equal, false otherwise.

equals

@JsMethod
public boolean equals(Cartographic right)

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

Parameters:

right - The second cartographic. Optional.

Returns:

true if left and right are equal, false otherwise.

equalsEpsilon

@JsMethod
public boolean equalsEpsilon(Cartographic right,
                                       double epsilon)

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

Parameters:

right - The second cartographic.

epsilon - The epsilon to use for equality testing.

Returns:

true if left and right are within the provided epsilon, false otherwise.

toString

@JsMethod
public String toString()

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

Overrides:

toString in class Object

Returns:

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