org.cesiumjs.cs.core

Class Ellipsoid

java.lang.Object

org.cesiumjs.cs.core.Ellipsoid

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
static int	packedLength The number of elements used to pack the object into an array.

Constructor Summary

Constructors

Constructor and Description
Ellipsoid()

Method Summary

Modifier and Type	Method and Description
Cartographic[]	cartesianArrayToCartographicArray(Cartesian3[] cartesians) Converts the provided array of cartesians to an array of cartographics.
Cartographic[]	cartesianArrayToCartographicArray(Cartesian3[] cartesians, Cartographic[] result) Converts the provided array of cartesians to an array of cartographics.
Cartographic	cartesianToCartographic(Cartesian3 cartesian) Converts the provided cartesian to cartographic representation.
Cartographic	cartesianToCartographic(Cartesian3 cartesian, Cartographic result) Converts the provided cartesian to cartographic representation.
Cartesian3[]	cartographicArrayToCartesianArray(Cartographic[] cartographics) Converts the provided array of cartographics to an array of Cartesians.
Cartesian3[]	cartographicArrayToCartesianArray(Cartographic[] cartographics, Cartesian3[] result) Converts the provided array of cartographics to an array of Cartesians.
Cartesian3	cartographicToCartesian(Cartographic cartographic) Converts the provided cartographic to Cartesian representation.
Cartesian3	cartographicToCartesian(Cartographic cartographic, Cartesian3 result) Converts the provided cartographic to Cartesian representation.
static Ellipsoid	clone(Ellipsoid ellipsoid) Duplicates an Ellipsoid instance.
static Ellipsoid	clone(Ellipsoid ellipsoid, Ellipsoid result) Duplicates an Ellipsoid instance.
boolean	equals(Ellipsoid right) Compares this Ellipsoid against the provided Ellipsoid componentwise and returns true if they are equal, false otherwise.
static Ellipsoid	fromCartesian3(Cartesian3 radii) Computes an Ellipsoid from a Cartesian specifying the radii in x, y, and z directions.
Cartesian3	geocentricSurfaceNormal(Cartesian3 cartesian) Computes the unit vector directed from the center of this ellipsoid toward the provided Cartesian position.
Cartesian3	geocentricSurfaceNormal(Cartesian3 cartesian, Cartesian3 result) Computes the unit vector directed from the center of this ellipsoid toward the provided Cartesian position.
Cartesian3	geodeticSurfaceNormal(Cartesian3 cartesian) Computes the normal of the plane tangent to the surface of the ellipsoid at the provided position.
Cartesian3	geodeticSurfaceNormal(Cartesian3 cartesian, Cartesian3 result) Computes the normal of the plane tangent to the surface of the ellipsoid at the provided position.
Cartesian3	geodeticSurfaceNormalCartographic(Cartographic cartographic) Computes the normal of the plane tangent to the surface of the ellipsoid at the provided position.
Cartesian3	geodeticSurfaceNormalCartographic(Cartographic cartographic, Cartesian3 result) Computes the normal of the plane tangent to the surface of the ellipsoid at the provided position.
double	maximumRadius() Gets the maximum radius of the ellipsoid.
double	minimumRadius() Gets the minimum radius of the ellipsoid.
static Ellipsoid	MOON() An Ellipsoid instance initialized to a sphere with the lunar radius.
Cartesian3	oneOverRadii() Gets one over the radii of the ellipsoid.
Cartesian3	oneOverRadiiSquared() Gets one over the squared radii of the ellipsoid.
static double[]	pack(Ellipsoid value, double[] array) Stores the provided instance into the provided array.
static double[]	pack(Ellipsoid value, double[] array, int startingIndex) Stores the provided instance into the provided array.
Cartesian3	radii() Gets the radii of the ellipsoid.
Cartesian3	radiiSquared() Gets the squared radii of the ellipsoid.
Cartesian3	radiiToTheFourth() Gets the radii of the ellipsoid raise to the fourth power.
Cartesian3	scaleToGeocentricSurface(Cartesian3 cartesian) Scales the provided Cartesian position along the geocentric surface normal so that it is on the surface of this ellipsoid.
Cartesian3	scaleToGeocentricSurface(Cartesian3 cartesian, Cartesian3 result) Scales the provided Cartesian position along the geocentric surface normal so that it is on the surface of this ellipsoid.
Cartesian3	scaleToGeodeticSurface(Cartesian3 cartesian) Scales the provided Cartesian position along the geodetic surface normal so that it is on the surface of this ellipsoid.
Cartesian3	scaleToGeodeticSurface(Cartesian3 cartesian, Cartesian3 result) Scales the provided Cartesian position along the geodetic surface normal so that it is on the surface of this ellipsoid.
String	toString() Creates a string representing this Ellipsoid in the format '(radii.x, radii.y, radii.z)'.
Cartesian3	transformPositionFromScaledSpace(Cartesian3 position) Transforms a Cartesian X, Y, Z position from the ellipsoid-scaled space by multiplying its components by the result of Ellipsoid#radii.
Cartesian3	transformPositionFromScaledSpace(Cartesian3 position, Cartesian3 result) Transforms a Cartesian X, Y, Z position from the ellipsoid-scaled space by multiplying its components by the result of Ellipsoid#radii.
Cartesian3	transformPositionToScaledSpace(Cartesian3 position) Transforms a Cartesian X, Y, Z position to the ellipsoid-scaled space by multiplying its components by the result of Ellipsoid#oneOverRadii.
Cartesian3	transformPositionToScaledSpace(Cartesian3 position, Cartesian3 result) Transforms a Cartesian X, Y, Z position to the ellipsoid-scaled space by multiplying its components by the result of Ellipsoid#oneOverRadii.
static Ellipsoid	UNIT_SPHERE() An Ellipsoid instance initialized to radii of (1.0, 1.0, 1.0).
static Ellipsoid	unpack(double[] array) Retrieves an instance from a packed array.
static Ellipsoid	unpack(double[] array, int startingIndex, Ellipsoid result) Retrieves an instance from a packed array.
static Ellipsoid	WGS84() An Ellipsoid instance initialized to the WGS84 standard.

Methods inherited from class java.lang.Object

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

Field Detail

packedLength

public static int packedLength

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

Constructor Detail

Ellipsoid

public Ellipsoid()

Method Detail

MOON

@JsProperty(name="MOON")
public static Ellipsoid MOON()

An Ellipsoid instance initialized to a sphere with the lunar radius.

UNIT_SPHERE

@JsProperty(name="UNIT_SPHERE")
public static Ellipsoid UNIT_SPHERE()

An Ellipsoid instance initialized to radii of (1.0, 1.0, 1.0).

WGS84

@JsProperty(name="WGS84")
public static Ellipsoid WGS84()

An Ellipsoid instance initialized to the WGS84 standard.

maximumRadius

@JsProperty(name="maximumRadius")
public double maximumRadius()

Gets the maximum radius of the ellipsoid.

minimumRadius

@JsProperty(name="minimumRadius")
public double minimumRadius()

Gets the minimum radius of the ellipsoid.

oneOverRadii

@JsProperty(name="oneOverRadii")
public Cartesian3 oneOverRadii()

Gets one over the radii of the ellipsoid.

oneOverRadiiSquared

@JsProperty(name="oneOverRadiiSquared")
public Cartesian3 oneOverRadiiSquared()

Gets one over the squared radii of the ellipsoid.

radii

@JsProperty(name="radii")
public Cartesian3 radii()

Gets the radii of the ellipsoid.

radiiSquared

@JsProperty(name="radiiSquared")
public Cartesian3 radiiSquared()

Gets the squared radii of the ellipsoid.

radiiToTheFourth

@JsProperty(name="radiiToTheFourth")
public Cartesian3 radiiToTheFourth()

Gets the radii of the ellipsoid raise to the fourth power.

clone

@JsMethod
public static Ellipsoid clone(Ellipsoid ellipsoid)

Duplicates an Ellipsoid instance.

Parameters:

ellipsoid - The ellipsoid to duplicate.

Returns:

The cloned Ellipsoid. (Returns undefined if ellipsoid is undefined)

clone

@JsMethod
public static Ellipsoid clone(Ellipsoid ellipsoid,
                                        Ellipsoid result)

Duplicates an Ellipsoid instance.

Parameters:

ellipsoid - The ellipsoid to duplicate.

result - The object onto which to store the result, or undefined if a new instance should be created. Optional.

Returns:

The cloned Ellipsoid. (Returns undefined if ellipsoid is undefined)

fromCartesian3

@JsMethod
public static Ellipsoid fromCartesian3(Cartesian3 radii)

Computes an Ellipsoid from a Cartesian specifying the radii in x, y, and z directions.

Parameters:

radii - The ellipsoid's radius in the x, y, and z directions. Optional. Default: Cartesian3.ZERO.

Returns:

A new Ellipsoid instance.

See Also:

WGS84(), UNIT_SPHERE()

pack

@JsMethod
public static double[] pack(Ellipsoid value,
                                      double[] array)

Stores the provided instance into the provided array.

Parameters:

value - The value to pack.

array - The array to pack into.

Returns:

The array that was packed into

pack

@JsMethod
public static double[] pack(Ellipsoid value,
                                      double[] array,
                                      int startingIndex)

Stores the provided instance into the provided array.

Parameters:

value - The value to pack.

array - The array to pack into.

startingIndex - The index into the array at which to start packing the elements. Optional. Default: 0.

Returns:

The array that was packed into

unpack

@JsMethod
public static Ellipsoid unpack(double[] array)

Retrieves an instance from a packed array.

Parameters:

array - The packed array.

Returns:

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

unpack

@JsMethod
public static Ellipsoid unpack(double[] array,
                                         int startingIndex,
                                         Ellipsoid result)

Retrieves an instance from a packed array.

Parameters:

array - The packed array.

startingIndex - The starting index of the element to be unpacked. Optional.

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

Returns:

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

cartesianArrayToCartographicArray

@JsMethod
public Cartographic[] cartesianArrayToCartographicArray(Cartesian3[] cartesians)

Converts the provided array of cartesians to an array of cartographics.

Parameters:

cartesians - An array of Cartesian positions.

Returns:

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

cartesianArrayToCartographicArray

@JsMethod
public Cartographic[] cartesianArrayToCartographicArray(Cartesian3[] cartesians,
                                                                  Cartographic[] result)

Converts the provided array of cartesians to an array of cartographics.

     Example:
     
     //Create an array of Cartesians and determine their Cartographic representation on a WGS84 ellipsoid.
     Cartesian3[] positions = {new Cartesian3(17832.12, 83234.52, 952313.73),
                               new Cartesian3(17832.13, 83234.53, 952313.73),
                               new Cartesian3(17832.14, 83234.54, 952313.73)};
     Cartographic[] cartographicPositions = Ellipsoid.WGS84.cartesianArrayToCartographicArray(positions);
     
 

Parameters:

cartesians - An array of Cartesian positions.

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

Returns:

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

cartesianToCartographic

@JsMethod
public Cartographic cartesianToCartographic(Cartesian3 cartesian)

Converts the provided cartesian to cartographic representation. The cartesian is undefined at the center of the ellipsoid.

     <
         //Create a Cartesian and determine it's Cartographic representation on a WGS84 ellipsoid.
         Cartesian3 position = new Cartesian3(17832.12, 83234.52, 952313.73);
         Cartographic cartographicPosition = Ellipsoid.WGS84.cartesianToCartographic(position);
     
 

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.

cartesianToCartographic

@JsMethod
public Cartographic cartesianToCartographic(Cartesian3 cartesian,
                                                      Cartographic result)

Converts the provided cartesian to cartographic representation. The cartesian is undefined at the center of the ellipsoid.

     <
         //Create a Cartesian and determine it's Cartographic representation on a WGS84 ellipsoid.
         Cartesian3 position = new Cartesian3(17832.12, 83234.52, 952313.73);
         Cartographic cartographicPosition = Ellipsoid.WGS84.cartesianToCartographic(position);
     
 

Parameters:

cartesian - The Cartesian position to convert to cartographic representation.

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.

cartographicArrayToCartesianArray

@JsMethod
public Cartesian3[] cartographicArrayToCartesianArray(Cartographic[] cartographics)

Converts the provided array of cartographics to an array of Cartesians.

     
         Cartographic[] positions = {new Cartographic(Math.toRadians(21), Math.toRadians(78), 0),
                                     new Cartographic(Math.toRadians(21.321), Math.toRadians(78.123), 100),
                                     new Cartographic(Math.toRadians(21.645), Math.toRadians(78.456), 250)};
         Cartesian3[] cartesianPositions = Ellipsoid.WGS84.cartographicArrayToCartesianArray(positions);
     
 

Parameters:

cartographics - An array of cartographic positions.

Returns:

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

cartographicArrayToCartesianArray

@JsMethod
public Cartesian3[] cartographicArrayToCartesianArray(Cartographic[] cartographics,
                                                                Cartesian3[] result)

Converts the provided array of cartographics to an array of Cartesians.

     
         Cartographic[] positions = {new Cartographic(Math.toRadians(21), Math.toRadians(78), 0),
                                     new Cartographic(Math.toRadians(21.321), Math.toRadians(78.123), 100),
                                     new Cartographic(Math.toRadians(21.645), Math.toRadians(78.456), 250)};
         Cartesian3[] cartesianPositions = Ellipsoid.WGS84.cartographicArrayToCartesianArray(positions);
     
 

Parameters:

cartographics - An array of cartographic positions.

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

Returns:

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

cartographicToCartesian

@JsMethod
public Cartesian3 cartographicToCartesian(Cartographic cartographic)

Converts the provided cartographic to Cartesian representation.

     
         //Create a Cartographic and determine it's Cartesian representation on a WGS84 ellipsoid.
         Cartographic position = new.Cartographic(Math.toRadians(21), Math.toRadians(78), 5000);
         Cartesian3 cartesianPosition = Ellipsoid.WGS84.cartographicToCartesian(position);
     
 

Parameters:

cartographic - The cartographic position.

Returns:

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

cartographicToCartesian

@JsMethod
public Cartesian3 cartographicToCartesian(Cartographic cartographic,
                                                    Cartesian3 result)

Converts the provided cartographic to Cartesian representation.

     
         //Create a Cartographic and determine it's Cartesian representation on a WGS84 ellipsoid.
         Cartographic position = new.Cartographic(Math.toRadians(21), Math.toRadians(78), 5000);
         Cartesian3 cartesianPosition = Ellipsoid.WGS84.cartographicToCartesian(position);
     
 

Parameters:

cartographic - The cartographic position.

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

Returns:

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

equals

@JsMethod
public boolean equals(Ellipsoid right)

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

Parameters:

right - The other Ellipsoid. Optional.

Returns:

true if they are equal, false otherwise.

geocentricSurfaceNormal

@JsMethod
public Cartesian3 geocentricSurfaceNormal(Cartesian3 cartesian)

Computes the unit vector directed from the center of this ellipsoid toward the provided Cartesian position.

Parameters:

cartesian - The Cartesian for which to to determine the geocentric normal.

Returns:

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

geocentricSurfaceNormal

@JsMethod
public Cartesian3 geocentricSurfaceNormal(Cartesian3 cartesian,
                                                    Cartesian3 result)

Computes the unit vector directed from the center of this ellipsoid toward the provided Cartesian position.

Parameters:

cartesian - The Cartesian for which to to determine the geocentric normal.

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

Returns:

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

geodeticSurfaceNormal

@JsMethod
public Cartesian3 geodeticSurfaceNormal(Cartesian3 cartesian)

Computes the normal of the plane tangent to the surface of the ellipsoid at the provided position.

Parameters:

cartesian - The Cartesian position for which to to determine the surface normal.

Returns:

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

geodeticSurfaceNormal

@JsMethod
public Cartesian3 geodeticSurfaceNormal(Cartesian3 cartesian,
                                                  Cartesian3 result)

Computes the normal of the plane tangent to the surface of the ellipsoid at the provided position.

Parameters:

cartesian - The Cartesian position for which to to determine the surface normal.

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

Returns:

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

geodeticSurfaceNormalCartographic

@JsMethod
public Cartesian3 geodeticSurfaceNormalCartographic(Cartographic cartographic)

Computes the normal of the plane tangent to the surface of the ellipsoid at the provided position.

Parameters:

cartographic - The cartographic position for which to to determine the geodetic normal.

Returns:

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

geodeticSurfaceNormalCartographic

@JsMethod
public Cartesian3 geodeticSurfaceNormalCartographic(Cartographic cartographic,
                                                              Cartesian3 result)

Computes the normal of the plane tangent to the surface of the ellipsoid at the provided position.

Parameters:

cartographic - The cartographic position for which to to determine the geodetic normal.

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

Returns:

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

scaleToGeocentricSurface

@JsMethod
public Cartesian3 scaleToGeocentricSurface(Cartesian3 cartesian)

Scales the provided Cartesian position along the geocentric surface normal so that it is on the surface of this ellipsoid.

Parameters:

cartesian - The Cartesian position to scale.

Returns:

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

scaleToGeocentricSurface

@JsMethod
public Cartesian3 scaleToGeocentricSurface(Cartesian3 cartesian,
                                                     Cartesian3 result)

Scales the provided Cartesian position along the geocentric surface normal so that it is on the surface of this ellipsoid.

Parameters:

cartesian - The Cartesian position to scale.

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

Returns:

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

scaleToGeodeticSurface

@JsMethod
public Cartesian3 scaleToGeodeticSurface(Cartesian3 cartesian)

Scales the provided Cartesian position along the geodetic surface normal so that it is on the surface of this ellipsoid. If the position is at the center of the ellipsoid, this function returns undefined.

Parameters:

cartesian - The Cartesian position to scale.

Returns:

The modified result parameter, a new Cartesian3 instance if none was provided, or undefined if the position is at the center.

scaleToGeodeticSurface

@JsMethod
public Cartesian3 scaleToGeodeticSurface(Cartesian3 cartesian,
                                                   Cartesian3 result)

Scales the provided Cartesian position along the geodetic surface normal so that it is on the surface of this ellipsoid. If the position is at the center of the ellipsoid, this function returns undefined.

Parameters:

cartesian - The Cartesian position to scale.

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

Returns:

The modified result parameter, a new Cartesian3 instance if none was provided, or undefined if the position is at the center.

toString

@JsMethod
public String toString()

Creates a string representing this Ellipsoid in the format '(radii.x, radii.y, radii.z)'.

Overrides:

toString in class Object

Returns:

A string representing this ellipsoid in the format '(radii.x, radii.y, radii.z)'.

transformPositionFromScaledSpace

@JsMethod
public Cartesian3 transformPositionFromScaledSpace(Cartesian3 position)

Transforms a Cartesian X, Y, Z position from the ellipsoid-scaled space by multiplying its components by the result of Ellipsoid#radii.

Parameters:

position - The position to transform.

Returns:

The position expressed in the unscaled space. The returned instance is the one passed as the result parameter if it is not undefined, or a new instance of it is.

transformPositionFromScaledSpace

@JsMethod
public Cartesian3 transformPositionFromScaledSpace(Cartesian3 position,
                                                             Cartesian3 result)

Transforms a Cartesian X, Y, Z position from the ellipsoid-scaled space by multiplying its components by the result of Ellipsoid#radii.

Parameters:

position - The position to transform.

result - The position to which to copy the result, or undefined to create and return a new instance.

Returns:

The position expressed in the unscaled space. The returned instance is the one passed as the result parameter if it is not undefined, or a new instance of it is.

transformPositionToScaledSpace

@JsMethod
public Cartesian3 transformPositionToScaledSpace(Cartesian3 position)

Transforms a Cartesian X, Y, Z position to the ellipsoid-scaled space by multiplying its components by the result of Ellipsoid#oneOverRadii.

Parameters:

position - The position to transform.

Returns:

The position expressed in the scaled space. The returned instance is the one passed as the result parameter if it is not undefined, or a new instance of it is.

transformPositionToScaledSpace

@JsMethod
public Cartesian3 transformPositionToScaledSpace(Cartesian3 position,
                                                           Cartesian3 result)

Transforms a Cartesian X, Y, Z position to the ellipsoid-scaled space by multiplying its components by the result of Ellipsoid#oneOverRadii.

Parameters:

position - The position to transform.

result - The position to which to copy the result, or undefined to create and return a new instance. Optional.

Returns:

The position expressed in the scaled space. The returned instance is the one passed as the result parameter if it is not undefined, or a new instance of it is.

See Also:

oneOverRadii()