Cartesian3

Members

x : Number

X component

Default Value: 0.0

y : Number

Y component

Default Value: 0.0

z : Number

Z component

Default Value: 0.0

staticSuperMap3D.Cartesian3.packedLength : Number

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

staticconstantSuperMap3D.Cartesian3.UNIT_X : Cartesian3

An immutable Cartesian3 instance initialized to (1.0, 0.0, 0.0).

staticconstantSuperMap3D.Cartesian3.UNIT_Y : Cartesian3

An immutable Cartesian3 instance initialized to (0.0, 1.0, 0.0).

staticconstantSuperMap3D.Cartesian3.UNIT_Z : Cartesian3

An immutable Cartesian3 instance initialized to (0.0, 0.0, 1.0).

staticconstantSuperMap3D.Cartesian3.ZERO : Cartesian3

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

Methods

clone(result) → Cartesian3

Duplicates this Cartesian3 instance.

Name	Type	Description
result	Cartesian3	optional The object onto which to store the result.

Returns:

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

equals(right) → Boolean

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

Name	Type	Description
right	Cartesian3	optional The right hand side Cartesian.

Returns:

true if they are equal, false otherwise.

equalsEpsilon(right, relativeEpsilon, absoluteEpsilon) → Boolean

Compares this Cartesian against the provided Cartesian componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.

Name	Type	Default	Description
right	Cartesian3		optional The right hand side Cartesian.
relativeEpsilon	Number		The relative epsilon tolerance to use for equality testing.
absoluteEpsilon	Number	relativeEpsilon	optional The absolute epsilon tolerance to use for equality testing.

Returns:

true if they are within the provided epsilon, false otherwise.

toString()

Convert Cartesian coordinates to (x, y, z) in string format.

staticSuperMap3D.Cartesian3.abs(cartesian, result) → Cartesian3

Computes the absolute value of the provided Cartesian.

Name	Type	Description
cartesian	Cartesian3	The Cartesian whose absolute value is to be computed.
result	Cartesian3	The object onto which to store the result.

Returns:

The modified result parameter.

staticSuperMap3D.Cartesian3.add(left, right, result) → Cartesian3

Computes the componentwise sum of two Cartesians.

Name	Type	Description
left	Cartesian3	The first Cartesian.
right	Cartesian3	The second Cartesian.
result	Cartesian3	The object onto which to store the result.

Returns:

The modified result parameter.

staticSuperMap3D.Cartesian3.angleBetween(left, right) → Number

Returns the angle, in radians, between the provided Cartesians.

Name	Type	Description
left	Cartesian3	The first Cartesian.
right	Cartesian3	The second Cartesian.

Returns:

The angle between the Cartesians.

staticSuperMap3D.Cartesian3.clone(cartesian, result) → Cartesian3

Copy a Cartesian3 instance.

Name	Type	Description
cartesian	Cartesian3	The object to be copied.
result	Cartesian3	optional object to store the result

Returns:

The modified result parameter, if not provided a new Cartesian3 instance is returned. Returns undefined if cartesian is not defined.

staticSuperMap3D.Cartesian3.cross(left, right, result) → Cartesian3

Computes the cross (outer) product of two Cartesians.

Name	Type	Description
left	Cartesian3	The first Cartesian.
right	Cartesian3	The second Cartesian.
result	Cartesian3	The object onto which to store the result.

Returns:

The cross product.

staticSuperMap3D.Cartesian3.distance(left, right) → Number

Calculate the distance between two points

Name	Type	Description
left	Cartesian3	The first point used to calculate the distance.
right	Cartesian3	The second point used to calculate the distance.

Returns:

The distance between two points.

Example:

// Calculate the distance between two points , return 1.0。
var d = SuperMap3D.Cartesian3.distance(new SuperMap3D.Cartesian3(1.0, 0.0, 0.0), new SuperMap3D.Cartesian3(2.0, 0.0, 0.0));

staticSuperMap3D.Cartesian3.distanceSquared(left, right) → Number

Computes the squared distance between two points. Comparing squared distances using this function is more efficient than comparing distances using Cartesian3#distance.

Name	Type	Description
left	Cartesian3	The first point to compute the distance from.
right	Cartesian3	The second point to compute the distance to.

Returns:

The distance between two points.

Example:

// Returns 4.0, not 2.0
var d = SuperMap3D.Cartesian3.distanceSquared(new SuperMap3D.Cartesian3(1.0, 0.0, 0.0), new SuperMap3D.Cartesian3(3.0, 0.0, 0.0));

staticSuperMap3D.Cartesian3.divideByScalar(cartesian, scalar, result) → Cartesian3

Divides the provided Cartesian componentwise by the provided scalar.

Name	Type	Description
cartesian	Cartesian3	The Cartesian to be divided.
scalar	Number	The scalar to divide by.
result	Cartesian3	The object onto which to store the result.

Returns:

The modified result parameter.

staticSuperMap3D.Cartesian3.divideComponents(left, right, result) → Cartesian3

Computes the componentwise quotient of two Cartesians.

Name	Type	Description
left	Cartesian3	The first Cartesian.
right	Cartesian3	The second Cartesian.
result	Cartesian3	The object onto which to store the result.

Returns:

The modified result parameter.

staticSuperMap3D.Cartesian3.dot(left, right) → Number

Computes the dot (scalar) product of two Cartesians.

Name	Type	Description
left	Cartesian3	The first Cartesian.
right	Cartesian3	The second Cartesian.

Returns:

The dot product.

staticSuperMap3D.Cartesian3.equals(left, right) → Boolean

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

Name	Type	Description
left	Cartesian3	optional The first Cartesian.
right	Cartesian3	optional The second Cartesian.

Returns:

true if left and right are equal, false otherwise.

staticSuperMap3D.Cartesian3.equalsEpsilon(left, right, relativeEpsilon, absoluteEpsilon) → Boolean

Compares the provided Cartesians componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.

Name	Type	Default	Description
left	Cartesian3		optional The first Cartesian.
right	Cartesian3		optional The second Cartesian.
relativeEpsilon	Number		The relative epsilon tolerance to use for equality testing.
absoluteEpsilon	Number	relativeEpsilon	optional The absolute epsilon tolerance to use for equality testing.

Returns:

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

staticSuperMap3D.Cartesian3.fromArray(array, startingIndex, result) → Cartesian3

Creates a Cartesian3 instance from three consecutive elements of the array.

Name	Type	Default	Description
array	Array.<Number>		Array object, three consecutive elements in the array correspond to x, y, z components respectively.
startingIndex	Number	0	optional The offset of the first element in the array, that is, the "startingIndex+1"th element of the array corresponds to the x component.
result	Cartesian3		optional An object to store the results.

Returns:

The modified result parameter, if not provided a new Cartesian3 instance is returned.

Example:

//Create a Cartesian3 instance (1.0, 2.0, 3.0).
var v = [1.0, 2.0, 3.0];
var p = SuperMap3D.Cartesian3.fromArray(v);
// Create a Cartesian3 instance (1.0, 2.0, 3.0), specify the offset as 2, then the third data corresponds to the x component.
var v2 = [0.0, 0.0, 1.0, 2.0, 3.0];
var p2 = SuperMap3D.Cartesian3.fromArray(v2, 2);

staticSuperMap3D.Cartesian3.fromCartesian4(cartesian, result) → Cartesian3

Create a Cartesian3 instance based on the known Cartesian4. The x, y, z components of Cartesian4 will be kept, and the w component will be discarded.

Name	Type	Description
cartesian	Cartesian4	Cartesian4 object used to create Cartesian3 instances.
result	Cartesian3	optional The object used to store the results.

Returns:

The modified result parameter, if not provided a new Cartesian3 instance is returned.

staticSuperMap3D.Cartesian3.fromDegrees(longitude, latitude, height, ellipsoid, result) → Cartesian3

Convert latitude and longitude values ​​in degrees to Cartesian coordinates.

Name	Type	Default	Description
longitude	Number		The longitude value in degrees.
latitude	Number		The latitude value in degrees.
height	Number	0.0	optional Ellipsoid height in meters.
ellipsoid	Ellipsoid	Ellipsoid.WGS84	optional Ellipsoid.
result	Cartesian3		optional The object used to store the results.

Returns:

The transformed position coordinates.

Example:

var position = SuperMap3D.Cartesian3.fromDegrees(-115.0, 37.0);

staticSuperMap3D.Cartesian3.fromDegreesArray(coordinates, ellipsoid, result) → Array.<Cartesian3>

Returns an array of Cartesian3 positions given an array of longitude and latitude values given in degrees.

Name	Type	Default	Description
coordinates	Array.<Number>		A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...].
ellipsoid	Ellipsoid	Ellipsoid.WGS84	optional The ellipsoid on which the coordinates lie.
result	Array.<Cartesian3>		optional An array of Cartesian3 objects to store the result.

Returns:

The array of positions.

Example:

var positions = SuperMap3D.Cartesian3.fromDegreesArray([-115.0, 37.0, -107.0, 33.0]);

staticSuperMap3D.Cartesian3.fromDegreesArrayHeights(coordinates, ellipsoid, result) → Array.<Cartesian3>

Returns an array of Cartesian3 positions given an array of longitude, latitude and height values where longitude and latitude are given in degrees.

Name	Type	Default	Description
coordinates	Array.<Number>		A list of longitude, latitude and height values. Values alternate [longitude, latitude, height, longitude, latitude, height...].
ellipsoid	Ellipsoid	Ellipsoid.WGS84	optional The ellipsoid on which the position lies.
result	Array.<Cartesian3>		optional An array of Cartesian3 objects to store the result.

Returns:

The array of positions.

Example:

var positions = SuperMap3D.Cartesian3.fromDegreesArrayHeights([-115.0, 37.0, 100000.0, -107.0, 33.0, 150000.0]);

staticSuperMap3D.Cartesian3.fromElements(x, y, z, result) → Cartesian3

Creates a Cartesian3 instance from x, y, z coordinates.

Name	Type	Description
x	Number	x-coordinate.
y	Number	y-coordinate.
z	Number	z-coordinate.
result	Cartesian3	optional An object to store the results.

Returns:

The modified result parameter, if not provided a new Cartesian3 instance is returned.

staticSuperMap3D.Cartesian3.fromRadians(longitude, latitude, height, ellipsoid, result) → Cartesian3

Convert latitude and longitude values ​​in radians to Cartesian coordinates.

Name	Type	Default	Description
longitude	Number		The longitude value in radians.
latitude	Number		The latitude value in radians.
height	Number	0.0	optional Ellipsoid height in meters.
ellipsoid	Ellipsoid	Ellipsoid.WGS84	optional Ellipsoid.
result	Cartesian3		optional The object used to store the results.

Returns:

Transformed position coordinates

Example:

var position = SuperMap3D.Cartesian3.fromRadians(-2.007, 0.645);

staticSuperMap3D.Cartesian3.fromRadiansArray(coordinates, ellipsoid, result) → Array.<Cartesian3>

Returns an array of Cartesian3 positions given an array of longitude and latitude values given in radians.

Name	Type	Default	Description
coordinates	Array.<Number>		A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...].
ellipsoid	Ellipsoid	Ellipsoid.WGS84	optional The ellipsoid on which the coordinates lie.
result	Array.<Cartesian3>		optional An array of Cartesian3 objects to store the result.

Returns:

The array of positions.

Example:

var positions = SuperMap3D.Cartesian3.fromRadiansArray([-2.007, 0.645, -1.867, .575]);

staticSuperMap3D.Cartesian3.fromRadiansArrayHeights(coordinates, ellipsoid, result) → Array.<Cartesian3>

Returns an array of Cartesian3 positions given an array of longitude, latitude and height values where longitude and latitude are given in radians.

Name	Type	Default	Description
coordinates	Array.<Number>		A list of longitude, latitude and height values. Values alternate [longitude, latitude, height, longitude, latitude, height...].
ellipsoid	Ellipsoid	Ellipsoid.WGS84	optional The ellipsoid on which the position lies.
result	Array.<Cartesian3>		optional An array of Cartesian3 objects to store the result.

Returns:

The array of positions.

Example:

var positions = SuperMap3D.Cartesian3.fromRadiansArrayHeights([-2.007, 0.645, 100000.0, -1.867, .575, 150000.0]);

staticSuperMap3D.Cartesian3.fromSpherical(spherical, result) → Cartesian3

Convert spherical coordinates to Cartesian coordinates.

Name	Type	Description
spherical	Spherical	The spherical coordinates to be transformed.
result	Cartesian3	optional An object to store the results.

Returns:

The modified result parameter, if not provided a new Cartesian3 instance is returned.

staticSuperMap3D.Cartesian3.lerp(start, end, t, result) → Cartesian3

Computes the linear interpolation or extrapolation at t using the provided cartesians.

Name	Type	Description
start	Cartesian3	The value corresponding to t at 0.0.
end	Cartesian3	The value corresponding to t at 1.0.
t	Number	The point along t at which to interpolate.
result	Cartesian3	The object onto which to store the result.

Returns:

The modified result parameter.

staticSuperMap3D.Cartesian3.magnitude(cartesian) → Number

Computes the Cartesian's magnitude (length).

Name	Type	Description
cartesian	Cartesian3	The Cartesian instance whose magnitude is to be computed.

Returns:

The magnitude.

staticSuperMap3D.Cartesian3.magnitudeSquared(cartesian) → Number

Computes the provided Cartesian's squared magnitude.

Name	Type	Description
cartesian	Cartesian3	The Cartesian instance whose squared magnitude is to be computed.

Returns:

The squared magnitude.

staticSuperMap3D.Cartesian3.maximumByComponent(first, second, result) → Cartesian3

Compares two Cartesians and computes a Cartesian which contains the maximum components of the supplied Cartesians.

Name	Type	Description
first	Cartesian3	A cartesian to compare.
second	Cartesian3	A cartesian to compare.
result	Cartesian3	The object into which to store the result.

Returns:

A cartesian with the maximum components.

staticSuperMap3D.Cartesian3.maximumComponent(cartesian) → Number

Computes the value of the maximum component for the supplied Cartesian.

Name	Type	Description
cartesian	Cartesian3	The cartesian to use.

Returns:

The value of the maximum component.

staticSuperMap3D.Cartesian3.minimumByComponent(first, second, result) → Cartesian3

Compares two Cartesians and computes a Cartesian which contains the minimum components of the supplied Cartesians.

Name	Type	Description
first	Cartesian3	A cartesian to compare.
second	Cartesian3	A cartesian to compare.
result	Cartesian3	The object into which to store the result.

Returns:

A cartesian with the minimum components.

staticSuperMap3D.Cartesian3.minimumComponent(cartesian) → Number

Computes the value of the minimum component for the supplied Cartesian.

Name	Type	Description
cartesian	Cartesian3	The cartesian to use.

Returns:

The value of the minimum component.

staticSuperMap3D.Cartesian3.mostOrthogonalAxis(cartesian, result) → Cartesian3

Returns the axis that is most orthogonal to the provided Cartesian.

Name	Type	Description
cartesian	Cartesian3	The Cartesian on which to find the most orthogonal axis.
result	Cartesian3	The object onto which to store the result.

Returns:

The most orthogonal axis.

staticSuperMap3D.Cartesian3.multiplyByScalar(cartesian, scalar, result) → Cartesian3

Multiplies the provided Cartesian componentwise by the provided scalar.

Name	Type	Description
cartesian	Cartesian3	The Cartesian to be scaled.
scalar	Number	The scalar to multiply with.
result	Cartesian3	The object onto which to store the result.

Returns:

The modified result parameter.

staticSuperMap3D.Cartesian3.multiplyComponents(left, right, result) → Cartesian3

Computes the componentwise product of two Cartesians.

Name	Type	Description
left	Cartesian3	The first Cartesian.
right	Cartesian3	The second Cartesian.
result	Cartesian3	The object onto which to store the result.

Returns:

The modified result parameter.

staticSuperMap3D.Cartesian3.negate(cartesian, result) → Cartesian3

Negates the provided Cartesian.

Name	Type	Description
cartesian	Cartesian3	The Cartesian to be negated.
result	Cartesian3	The object onto which to store the result.

Returns:

The modified result parameter.

staticSuperMap3D.Cartesian3.normalize(cartesian, result) → Cartesian3

Computes the normalized form of the supplied Cartesian.

Name	Type	Description
cartesian	Cartesian3	The Cartesian to be normalized.
result	Cartesian3	The object onto which to store the result.

Returns:

The modified result parameter.

staticSuperMap3D.Cartesian3.pack(value, array, startingIndex) → Array.<Number>

Stores the provided instance into the provided array.

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

Returns:

The array that was packed into

staticSuperMap3D.Cartesian3.packArray(array, result) → Array.<Number>

Flattens an array of Cartesian3s into an array of components.

Name	Type	Description
array	Array.<Cartesian3>	The array of cartesians to pack.
result	Array.<Number>	The array onto which to store the result.

Returns:

The packed array.

staticSuperMap3D.Cartesian3.subtract(left, right, result) → Cartesian3

Computes the componentwise difference of two Cartesians.

Name	Type	Description
left	Cartesian3	The first Cartesian.
right	Cartesian3	The second Cartesian.
result	Cartesian3	The object onto which to store the result.

Returns:

The modified result parameter.

staticSuperMap3D.Cartesian3.unpack(array, startingIndex, result) → Cartesian3

Retrieves an instance from a packed array.

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

Returns:

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

staticSuperMap3D.Cartesian3.unpackArray(array, result) → Array.<Cartesian3>

Unpacks an array of cartesian components into an array of Cartesian3s.

Name	Type	Description
array	Array.<Number>	The array of components to unpack.
result	Array.<Cartesian3>	The array onto which to store the result.

Returns:

The unpacked array.