Cartesian4

Members

w :Number

The W component.

Default Value: 0.0

Source: Core/Cartesian4.js, line 57

x :Number

The X component.

Default Value: 0.0

Source: Core/Cartesian4.js, line 36

y :Number

The Y component.

Default Value: 0.0

Source: Core/Cartesian4.js, line 43

z :Number

The Z component.

Default Value: 0.0

Source: Core/Cartesian4.js, line 50

staticCartesian4.packedLength :Number

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

Source: Core/Cartesian4.js, line 135

staticconstantCartesian4.UNIT_W :Cartesian4

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

Source: Core/Cartesian4.js, line 776

staticconstantCartesian4.UNIT_X :Cartesian4

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

Source: Core/Cartesian4.js, line 752

staticconstantCartesian4.UNIT_Y :Cartesian4

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

Source: Core/Cartesian4.js, line 760

staticconstantCartesian4.UNIT_Z :Cartesian4

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

Source: Core/Cartesian4.js, line 768

staticconstantCartesian4.ZERO :Cartesian4

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

Source: Core/Cartesian4.js, line 744

Methods

clone(result) → Cartesian4

Duplicates this Cartesian4 instance.

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

Returns:

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

Source: Core/Cartesian4.js, line 784

equals(right) → Boolean

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

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

Returns:

true if they are equal, false otherwise.

Source: Core/Cartesian4.js, line 795

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	Cartesian4		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.

Source: Core/Cartesian4.js, line 809

toString() → String

Creates a string representing this Cartesian in the format '(x, y)'.

Returns:

A string representing the provided Cartesian in the format '(x, y)'.

Source: Core/Cartesian4.js, line 818

staticCartesian4.abs(cartesian, result) → Cartesian4

Computes the absolute value of the provided Cartesian.

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

Returns:

The modified result parameter.

Source: Core/Cartesian4.js, line 593

staticCartesian4.add(left, right, result) → Cartesian4

Computes the componentwise sum of two Cartesians.

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

Returns:

The modified result parameter.

Source: Core/Cartesian4.js, line 458

staticCartesian4.clone(cartesian, result) → Cartesian4

Duplicates a Cartesian4 instance.

Name	Type	Description
cartesian	Cartesian4	The Cartesian to duplicate.
result	Cartesian4	optional The object onto which to store the result.

Returns:

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

Source: Core/Cartesian4.js, line 114

staticCartesian4.distance(left, right) → Number

Computes the 4-space distance between two points.

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

Returns:

The distance between two points.

Example:

// Returns 1.0
var d = Cesium.Cartesian4.distance(
  new Cesium.Cartesian4(1.0, 0.0, 0.0, 0.0),
  new Cesium.Cartesian4(2.0, 0.0, 0.0, 0.0));

Source: Core/Cartesian4.js, line 340

staticCartesian4.distanceSquared(left, right) → Number

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

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

Returns:

The distance between two points.

Example:

// Returns 4.0, not 2.0
var d = Cesium.Cartesian4.distance(
  new Cesium.Cartesian4(1.0, 0.0, 0.0, 0.0),
  new Cesium.Cartesian4(3.0, 0.0, 0.0, 0.0));

Source: Core/Cartesian4.js, line 365

staticCartesian4.divideByScalar(cartesian, scalar, result) → Cartesian4

Divides the provided Cartesian componentwise by the provided scalar.

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

Returns:

The modified result parameter.

Source: Core/Cartesian4.js, line 542

staticCartesian4.dot(left, right) → Number

Computes the dot (scalar) product of two Cartesians.

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

Returns:

The dot product.

Source: Core/Cartesian4.js, line 409

staticCartesian4.equals(left, right) → Boolean

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

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

Returns:

true if left and right are equal, false otherwise.

Source: Core/Cartesian4.js, line 697

staticCartesian4.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	Cartesian4		optional The first Cartesian.
right	Cartesian4		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.

Source: Core/Cartesian4.js, line 728

staticCartesian4.fromArray(array, startingIndex, result) → Cartesian4

Creates a Cartesian4 from four consecutive elements in an array.

Name	Type	Default	Description
array	Array.<Number>		The array whose four consecutive elements correspond to the x, y, z, and w components, respectively.
startingIndex	Number	0	optional The offset into the array of the first element, which corresponds to the x component.
result	Cartesian4		optional The object onto which to store the result.

Returns:

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

Example:

// Create a Cartesian4 with (1.0, 2.0, 3.0, 4.0)
var v = [1.0, 2.0, 3.0, 4.0];
var p = Cesium.Cartesian4.fromArray(v);

// Create a Cartesian4 with (1.0, 2.0, 3.0, 4.0) using an offset into an array
var v2 = [0.0, 0.0, 1.0, 2.0, 3.0, 4.0];
var p2 = Cesium.Cartesian4.fromArray(v2, 2);

Source: Core/Cartesian4.js, line 207

staticCartesian4.fromColor(color, result) → Cartesian4

Creates a Cartesian4 instance from a Color. red, green, blue, and alpha map to x, y, z, and w, respectively.

Name	Type	Description
color	Color	The source color.
result	Cartesian4	optional The object onto which to store the result.

Returns:

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

Source: Core/Cartesian4.js, line 90

staticCartesian4.fromElements(x, y, z, w, result) → Cartesian4

Creates a Cartesian4 instance from x, y, z and w coordinates.

Name	Type	Description
x	Number	The x coordinate.
y	Number	The y coordinate.
z	Number	The z coordinate.
w	Number	The w coordinate.
result	Cartesian4	optional The object onto which to store the result.

Returns:

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

Source: Core/Cartesian4.js, line 70

staticCartesian4.lerp(start, end, t, result) → Cartesian4

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

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

Returns:

The modified result parameter.

Source: Core/Cartesian4.js, line 620

staticCartesian4.magnitude(cartesian) → Number

Computes the Cartesian's magnitude (length).

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

Returns:

The magnitude.

Source: Core/Cartesian4.js, line 321

staticCartesian4.magnitudeSquared(cartesian) → Number

Computes the provided Cartesian's squared magnitude.

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

Returns:

The squared magnitude.

Source: Core/Cartesian4.js, line 305

staticCartesian4.maximumByComponent(first, second, result) → Cartesian4

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

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

Returns:

A cartesian with the maximum components.

Source: Core/Cartesian4.js, line 278

staticCartesian4.maximumComponent(cartesian) → Number

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

Name	Type	Description
cartesian	Cartesian4	The cartesian to use.

Returns:

The value of the maximum component.

Source: Core/Cartesian4.js, line 215

staticCartesian4.minimumByComponent(first, second, result) → Cartesian4

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

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

Returns:

A cartesian with the minimum components.

Source: Core/Cartesian4.js, line 249

staticCartesian4.minimumComponent(cartesian) → Number

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

Name	Type	Description
cartesian	Cartesian4	The cartesian to use.

Returns:

The value of the minimum component.

Source: Core/Cartesian4.js, line 231

staticCartesian4.mostOrthogonalAxis(cartesian, result) → Cartesian4

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

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

Returns:

The most orthogonal axis.

Source: Core/Cartesian4.js, line 649

staticCartesian4.multiplyByScalar(cartesian, scalar, result) → Cartesian4

Multiplies the provided Cartesian componentwise by the provided scalar.

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

Returns:

The modified result parameter.

Source: Core/Cartesian4.js, line 514

staticCartesian4.multiplyComponents(left, right, result) → Cartesian4

Computes the componentwise product of two Cartesians.

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

Returns:

The modified result parameter.

Source: Core/Cartesian4.js, line 430

staticCartesian4.negate(cartesian, result) → Cartesian4

Negates the provided Cartesian.

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

Returns:

The modified result parameter.

Source: Core/Cartesian4.js, line 569

staticCartesian4.normalize(cartesian, result) → Cartesian4

Computes the normalized form of the supplied Cartesian.

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

Returns:

The modified result parameter.

Source: Core/Cartesian4.js, line 383

staticCartesian4.pack(value, array, startingIndex)

Stores the provided instance into the provided array.

Name	Type	Default	Description
value	Cartesian4		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.

Source: Core/Cartesian4.js, line 144

staticCartesian4.subtract(left, right, result) → Cartesian4

Computes the componentwise difference of two Cartesians.

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

Returns:

The modified result parameter.

Source: Core/Cartesian4.js, line 486

staticCartesian4.unpack(array, startingIndex, result) → Cartesian4

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	Cartesian4		optional The object into which to store the result.

Returns:

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

Source: Core/Cartesian4.js, line 170