Cartesian4

Members

w : Number

Core/Cartesian4.js 58

The W component.

Default Value: 0.0

x : Number

Core/Cartesian4.js 37

The X component.

Default Value: 0.0

y : Number

Core/Cartesian4.js 44

The Y component.

Default Value: 0.0

z : Number

Core/Cartesian4.js 51

The Z component.

Default Value: 0.0

staticCesium.Cartesian4.packedLength : Number

Core/Cartesian4.js 133

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

staticconstantCesium.Cartesian4.UNIT_W : Cartesian4

Core/Cartesian4.js 774

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

staticconstantCesium.Cartesian4.UNIT_X : Cartesian4

Core/Cartesian4.js 750

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

staticconstantCesium.Cartesian4.UNIT_Y : Cartesian4

Core/Cartesian4.js 758

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

staticconstantCesium.Cartesian4.UNIT_Z : Cartesian4

Core/Cartesian4.js 766

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

staticconstantCesium.Cartesian4.ZERO : Cartesian4

Core/Cartesian4.js 742

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

Methods

clone(result) → Cartesian4

Core/Cartesian4.js 782

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.

equals(right) → Boolean

Core/Cartesian4.js 793

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.

equalsEpsilon(right, relativeEpsilon, absoluteEpsilon) → Boolean

Core/Cartesian4.js 807

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.

toString() → String

Core/Cartesian4.js 816

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

Returns:

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

staticCesium.Cartesian4.abs(cartesian, result) → Cartesian4

Core/Cartesian4.js 607

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.

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

Core/Cartesian4.js 500

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.

staticCesium.Cartesian4.clone(cartesian, result) → Cartesian4

Core/Cartesian4.js 113

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)

staticCesium.Cartesian4.distance(left, right) → Number

Core/Cartesian4.js 369

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));

staticCesium.Cartesian4.distanceSquared(left, right) → Number

Core/Cartesian4.js 393

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));

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

Core/Cartesian4.js 566

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.

staticCesium.Cartesian4.divideComponents(left, right, result) → Cartesian4

Core/Cartesian4.js 478

Computes the componentwise quotient 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.

staticCesium.Cartesian4.dot(left, right) → Number

Core/Cartesian4.js 439

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.

staticCesium.Cartesian4.equals(left, right) → Boolean

Core/Cartesian4.js 695

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.

staticCesium.Cartesian4.equalsEpsilon(left, right, relativeEpsilon, absoluteEpsilon) → Boolean

Core/Cartesian4.js 726

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.

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

Core/Cartesian4.js 254

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);

staticCesium.Cartesian4.fromColor(color, result) → Cartesian4

Core/Cartesian4.js 91

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.

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

Core/Cartesian4.js 71

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.

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

Core/Cartesian4.js 630

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.

staticCesium.Cartesian4.magnitude(cartesian) → Number

Core/Cartesian4.js 350

Computes the Cartesian's magnitude (length).

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

Returns:

The magnitude.

staticCesium.Cartesian4.magnitudeSquared(cartesian) → Number

Core/Cartesian4.js 336

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.

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

Core/Cartesian4.js 315

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.

staticCesium.Cartesian4.maximumComponent(cartesian) → Number

Core/Cartesian4.js 262

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.

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

Core/Cartesian4.js 292

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.

staticCesium.Cartesian4.minimumComponent(cartesian) → Number

Core/Cartesian4.js 276

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.

staticCesium.Cartesian4.mostOrthogonalAxis(cartesian, result) → Cartesian4

Core/Cartesian4.js 651

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.

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

Core/Cartesian4.js 544

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.

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

Core/Cartesian4.js 456

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.

staticCesium.Cartesian4.negate(cartesian, result) → Cartesian4

Core/Cartesian4.js 587

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.

staticCesium.Cartesian4.normalize(cartesian, result) → Cartesian4

Core/Cartesian4.js 410

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.

staticCesium.Cartesian4.pack(value, array, startingIndex) → Array.<Number>

Core/Cartesian4.js 144

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.

Returns:

The array that was packed into

staticCesium.Cartesian4.packArray(array, result) → Array.<Number>

Core/Cartesian4.js 192

Flattens an array of Cartesian4s into and array of components.

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

Returns:

The packed array.

staticCesium.Cartesian4.packFloat(value, result) → Cartesian4

Core/Cartesian4.js 838

Packs an arbitrary floating point value to 4 values representable using uint8.

Name	Type	Description
value	Number	A floating point number
result	Cartesian4	optional The Cartesian4 that will contain the packed float.

Returns:

A Cartesian4 representing the float packed to values in x, y, z, and w.

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

Core/Cartesian4.js 522

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.

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

Core/Cartesian4.js 168

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.

staticCesium.Cartesian4.unpackArray(array, result) → Array.<Cartesian4>

Core/Cartesian4.js 217

Unpacks an array of cartesian components into and array of Cartesian4s.

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

Returns:

The unpacked array.