Cartesian2

Members

x :Number

The X component.

Default Value: 0.0

Source: Core/Cartesian2.js, line 34

y :Number

The Y component.

Default Value: 0.0

Source: Core/Cartesian2.js, line 41

staticCartesian2.packedLength :Number

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

Source: Core/Cartesian2.js, line 108

staticconstantCartesian2.UNIT_X :Cartesian2

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

Source: Core/Cartesian2.js, line 696

staticconstantCartesian2.UNIT_Y :Cartesian2

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

Source: Core/Cartesian2.js, line 704

staticconstantCartesian2.ZERO :Cartesian2

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

Source: Core/Cartesian2.js, line 688

Methods

clone(result) → Cartesian2

Duplicates this Cartesian2 instance.

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

Returns:

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

Source: Core/Cartesian2.js, line 712

equals(right) → Boolean

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

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

Returns:

true if they are equal, false otherwise.

Source: Core/Cartesian2.js, line 723

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	Cartesian2		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/Cartesian2.js, line 737

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/Cartesian2.js, line 746

staticCartesian2.abs(cartesian, result) → Cartesian2

Computes the absolute value of the provided Cartesian.

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

Returns:

The modified result parameter.

Source: Core/Cartesian2.js, line 539

staticCartesian2.add(left, right, result) → Cartesian2

Computes the componentwise sum of two Cartesians.

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

Returns:

The modified result parameter.

Source: Core/Cartesian2.js, line 414

staticCartesian2.angleBetween(left, right) → Number

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

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

Returns:

The angle between the Cartesians.

Source: Core/Cartesian2.js, line 594

staticCartesian2.clone(cartesian, result) → Cartesian2

Duplicates a Cartesian2 instance.

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

Returns:

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

Source: Core/Cartesian2.js, line 69

staticCartesian2.distance(left, right) → Number

Computes the distance between two points.

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

Returns:

The distance between two points.

Example:

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

Source: Core/Cartesian2.js, line 302

staticCartesian2.distanceSquared(left, right) → Number

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

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

Returns:

The distance between two points.

Example:

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

Source: Core/Cartesian2.js, line 325

staticCartesian2.divideByScalar(cartesian, scalar, result) → Cartesian2

Divides the provided Cartesian componentwise by the provided scalar.

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

Returns:

The modified result parameter.

Source: Core/Cartesian2.js, line 492

staticCartesian2.dot(left, right) → Number

Computes the dot (scalar) product of two Cartesians.

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

Returns:

The dot product.

Source: Core/Cartesian2.js, line 367

staticCartesian2.equals(left, right) → Boolean

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

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

Returns:

true if left and right are equal, false otherwise.

Source: Core/Cartesian2.js, line 647

staticCartesian2.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	Cartesian2		optional The first Cartesian.
right	Cartesian2		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/Cartesian2.js, line 674

staticCartesian2.fromArray(array, startingIndex, result) → Cartesian2

Creates a Cartesian2 from two consecutive elements in an array.

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

Returns:

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

Example:

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

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

Source: Core/Cartesian2.js, line 175

staticCartesian2.fromCartesian3(cartesian, result) → Cartesian2

Creates a Cartesian2 instance from an existing Cartesian3. This simply takes the x and y properties of the Cartesian3 and drops z.

Name	Type	Description
cartesian	Cartesian3	The Cartesian3 instance to create a Cartesian2 instance from.
result	Cartesian2	optional The object onto which to store the result.

Returns:

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

Source: Core/Cartesian2.js, line 91

staticCartesian2.fromCartesian4(cartesian, result) → Cartesian2

Creates a Cartesian2 instance from an existing Cartesian4. This simply takes the x and y properties of the Cartesian4 and drops z and w.

Name	Type	Description
cartesian	Cartesian4	The Cartesian4 instance to create a Cartesian2 instance from.
result	Cartesian2	optional The object onto which to store the result.

Returns:

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

Source: Core/Cartesian2.js, line 102

staticCartesian2.fromElements(x, y, result) → Cartesian2

Creates a Cartesian2 instance from x and y coordinates.

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

Returns:

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

Source: Core/Cartesian2.js, line 52

staticCartesian2.lerp(start, end, t, result) → Cartesian2

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

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

Returns:

The modified result parameter.

Source: Core/Cartesian2.js, line 564

staticCartesian2.magnitude(cartesian) → Number

Computes the Cartesian's magnitude (length).

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

Returns:

The magnitude.

Source: Core/Cartesian2.js, line 285

staticCartesian2.magnitudeSquared(cartesian) → Number

Computes the provided Cartesian's squared magnitude.

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

Returns:

The squared magnitude.

Source: Core/Cartesian2.js, line 269

staticCartesian2.maximumByComponent(first, second, result) → Cartesian2

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

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

Returns:

A cartesian with the maximum components.

Source: Core/Cartesian2.js, line 245

staticCartesian2.maximumComponent(cartesian) → Number

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

Name	Type	Description
cartesian	Cartesian2	The cartesian to use.

Returns:

The value of the maximum component.

Source: Core/Cartesian2.js, line 183

staticCartesian2.minimumByComponent(first, second, result) → Cartesian2

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

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

Returns:

A cartesian with the minimum components.

Source: Core/Cartesian2.js, line 217

staticCartesian2.minimumComponent(cartesian) → Number

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

Name	Type	Description
cartesian	Cartesian2	The cartesian to use.

Returns:

The value of the minimum component.

Source: Core/Cartesian2.js, line 199

staticCartesian2.mostOrthogonalAxis(cartesian, result) → Cartesian2

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

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

Returns:

The most orthogonal axis.

Source: Core/Cartesian2.js, line 617

staticCartesian2.multiplyByScalar(cartesian, scalar, result) → Cartesian2

Multiplies the provided Cartesian componentwise by the provided scalar.

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

Returns:

The modified result parameter.

Source: Core/Cartesian2.js, line 466

staticCartesian2.multiplyComponents(left, right, result) → Cartesian2

Computes the componentwise product of two Cartesians.

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

Returns:

The modified result parameter.

Source: Core/Cartesian2.js, line 388

staticCartesian2.negate(cartesian, result) → Cartesian2

Negates the provided Cartesian.

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

Returns:

The modified result parameter.

Source: Core/Cartesian2.js, line 517

staticCartesian2.normalize(cartesian, result) → Cartesian2

Computes the normalized form of the supplied Cartesian.

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

Returns:

The modified result parameter.

Source: Core/Cartesian2.js, line 343

staticCartesian2.pack(value, array, startingIndex)

Stores the provided instance into the provided array.

Name	Type	Default	Description
value	Cartesian2		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/Cartesian2.js, line 117

staticCartesian2.subtract(left, right, result) → Cartesian2

Computes the componentwise difference of two Cartesians.

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

Returns:

The modified result parameter.

Source: Core/Cartesian2.js, line 440

staticCartesian2.unpack(array, startingIndex, result)

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

Source: Core/Cartesian2.js, line 140