Class: Cartesian2

Cartesian2

new Cartesian2(xopt, yopt)

A 2D Cartesian point.
Parameters:
Name Type Attributes Default Description
x Number <optional>
 0.0 The X component.
y Number <optional>
 0.0 The Y component.
Source:
See:

Members

x :Number

The X component.
Type:
  • Number
Default Value:
  • 0.0
Source:

y :Number

The Y component.
Type:
  • Number
Default Value:
  • 0.0
Source:

(static) packedLength :Number

The number of elements used to pack the object into an array.
Type:
  • Number
Source:

(static, constant) UNIT_X :Cartesian2

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

(static, constant) UNIT_Y :Cartesian2

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

(static, constant) ZERO :Cartesian2

An immutable Cartesian2 instance initialized to (0.0, 0.0).
Type:
Source:

Methods

clone(resultopt) → {Cartesian2}

Duplicates this Cartesian2 instance.
Parameters:
Name Type Attributes Description
result Cartesian2 <optional>
 The object onto which to store the result.
Source:
Returns:
The modified result parameter or a new Cartesian2 instance if one was not provided.
Type
Cartesian2

equals(rightopt) → {Boolean}

Compares this Cartesian against the provided Cartesian componentwise and returns true if they are equal, false otherwise.
Parameters:
Name Type Attributes Description
right Cartesian2 <optional>
 The right hand side Cartesian.
Source:
Returns:
true if they are equal, false otherwise.
Type
Boolean

equalsEpsilon(rightopt, relativeEpsilon, absoluteEpsilonopt) → {Boolean}

Compares this Cartesian against the provided Cartesian componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.
Parameters:
Name Type Attributes Default Description
right Cartesian2 <optional>
 The right hand side Cartesian.
relativeEpsilon Number The relative epsilon tolerance to use for equality testing.
absoluteEpsilon Number <optional>
 relativeEpsilon The absolute epsilon tolerance to use for equality testing.
Source:
Returns:
true if they are within the provided epsilon, false otherwise.
Type
Boolean

toString() → {String}

Creates a string representing this Cartesian in the format '(x, y)'.
Source:
Returns:
A string representing the provided Cartesian in the format '(x, y)'.
Type
String

(static) abs(cartesian, result) → {Cartesian2}

Computes the absolute value of the provided Cartesian.
Parameters:
Name Type Description
cartesian Cartesian2 The Cartesian whose absolute value is to be computed.
result Cartesian2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Cartesian2

(static) add(left, right, result) → {Cartesian2}

Computes the componentwise sum of two Cartesians.
Parameters:
Name Type Description
left Cartesian2 The first Cartesian.
right Cartesian2 The second Cartesian.
result Cartesian2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Cartesian2

(static) angleBetween(left, right) → {Number}

Returns the angle, in radians, between the provided Cartesians.
Parameters:
Name Type Description
left Cartesian2 The first Cartesian.
right Cartesian2 The second Cartesian.
Source:
Returns:
The angle between the Cartesians.
Type
Number

(static) clone(cartesian, resultopt) → {Cartesian2}

Duplicates a Cartesian2 instance.
Parameters:
Name Type Attributes Description
cartesian Cartesian2 The Cartesian to duplicate.
result Cartesian2 <optional>
 The object onto which to store the result.
Source:
Returns:
The modified result parameter or a new Cartesian2 instance if one was not provided. (Returns undefined if cartesian is undefined)
Type
Cartesian2

(static) distance(left, right) → {Number}

Computes the distance between two points.
Parameters:
Name Type Description
left Cartesian2 The first point to compute the distance from.
right Cartesian2 The second point to compute the distance to.
Source:
Returns:
The distance between two points.
Type
Number
Example
// Returns 1.0
var d = Cesium.Cartesian2.distance(new Cesium.Cartesian2(1.0, 0.0), new Cesium.Cartesian2(2.0, 0.0));

(static) 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.
Parameters:
Name Type Description
left Cartesian2 The first point to compute the distance from.
right Cartesian2 The second point to compute the distance to.
Source:
Returns:
The distance between two points.
Type
Number
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));

(static) divideByScalar(cartesian, scalar, result) → {Cartesian2}

Divides the provided Cartesian componentwise by the provided scalar.
Parameters:
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.
Source:
Returns:
The modified result parameter.
Type
Cartesian2

(static) dot(left, right) → {Number}

Computes the dot (scalar) product of two Cartesians.
Parameters:
Name Type Description
left Cartesian2 The first Cartesian.
right Cartesian2 The second Cartesian.
Source:
Returns:
The dot product.
Type
Number

(static) equals(leftopt, rightopt) → {Boolean}

Compares the provided Cartesians componentwise and returns true if they are equal, false otherwise.
Parameters:
Name Type Attributes Description
left Cartesian2 <optional>
 The first Cartesian.
right Cartesian2 <optional>
 The second Cartesian.
Source:
Returns:
true if left and right are equal, false otherwise.
Type
Boolean

(static) equalsEpsilon(leftopt, rightopt, relativeEpsilon, absoluteEpsilonopt) → {Boolean}

Compares the provided Cartesians componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.
Parameters:
Name Type Attributes 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 <optional>
 relativeEpsilon The absolute epsilon tolerance to use for equality testing.
Source:
Returns:
true if left and right are within the provided epsilon, false otherwise.
Type
Boolean

(static) fromArray(array, startingIndexopt, resultopt) → {Cartesian2}

Creates a Cartesian2 from two consecutive elements in an array.
Parameters:
Name Type Attributes Default Description
array Array.<Number> The array whose two consecutive elements correspond to the x and y components, respectively.
startingIndex Number <optional>
 0 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.
Source:
Returns:
The modified result parameter or a new Cartesian2 instance if one was not provided.
Type
Cartesian2
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);

(static) fromCartesian3(cartesian, resultopt) → {Cartesian2}

Creates a Cartesian2 instance from an existing Cartesian3. This simply takes the x and y properties of the Cartesian3 and drops z.
Parameters:
Name Type Attributes Description
cartesian Cartesian3 The Cartesian3 instance to create a Cartesian2 instance from.
result Cartesian2 <optional>
 The object onto which to store the result.
Source:
Returns:
The modified result parameter or a new Cartesian2 instance if one was not provided.
Type
Cartesian2

(static) fromCartesian4(cartesian, resultopt) → {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.
Parameters:
Name Type Attributes Description
cartesian Cartesian4 The Cartesian4 instance to create a Cartesian2 instance from.
result Cartesian2 <optional>
 The object onto which to store the result.
Source:
Returns:
The modified result parameter or a new Cartesian2 instance if one was not provided.
Type
Cartesian2

(static) fromElements(x, y, resultopt) → {Cartesian2}

Creates a Cartesian2 instance from x and y coordinates.
Parameters:
Name Type Attributes Description
x Number The x coordinate.
y Number The y coordinate.
result Cartesian2 <optional>
 The object onto which to store the result.
Source:
Returns:
The modified result parameter or a new Cartesian2 instance if one was not provided.
Type
Cartesian2

(static) lerp(start, end, t, result) → {Cartesian2}

Computes the linear interpolation or extrapolation at t using the provided cartesians.
Parameters:
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.
Source:
Returns:
The modified result parameter.
Type
Cartesian2

(static) magnitude(cartesian) → {Number}

Computes the Cartesian's magnitude (length).
Parameters:
Name Type Description
cartesian Cartesian2 The Cartesian instance whose magnitude is to be computed.
Source:
Returns:
The magnitude.
Type
Number

(static) magnitudeSquared(cartesian) → {Number}

Computes the provided Cartesian's squared magnitude.
Parameters:
Name Type Description
cartesian Cartesian2 The Cartesian instance whose squared magnitude is to be computed.
Source:
Returns:
The squared magnitude.
Type
Number

(static) maximumByComponent(first, second, result) → {Cartesian2}

Compares two Cartesians and computes a Cartesian which contains the maximum components of the supplied Cartesians.
Parameters:
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.
Source:
Returns:
A cartesian with the maximum components.
Type
Cartesian2

(static) maximumComponent(cartesian) → {Number}

Computes the value of the maximum component for the supplied Cartesian.
Parameters:
Name Type Description
cartesian Cartesian2 The cartesian to use.
Source:
Returns:
The value of the maximum component.
Type
Number

(static) minimumByComponent(first, second, result) → {Cartesian2}

Compares two Cartesians and computes a Cartesian which contains the minimum components of the supplied Cartesians.
Parameters:
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.
Source:
Returns:
A cartesian with the minimum components.
Type
Cartesian2

(static) minimumComponent(cartesian) → {Number}

Computes the value of the minimum component for the supplied Cartesian.
Parameters:
Name Type Description
cartesian Cartesian2 The cartesian to use.
Source:
Returns:
The value of the minimum component.
Type
Number

(static) mostOrthogonalAxis(cartesian, result) → {Cartesian2}

Returns the axis that is most orthogonal to the provided Cartesian.
Parameters:
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.
Source:
Returns:
The most orthogonal axis.
Type
Cartesian2

(static) multiplyByScalar(cartesian, scalar, result) → {Cartesian2}

Multiplies the provided Cartesian componentwise by the provided scalar.
Parameters:
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.
Source:
Returns:
The modified result parameter.
Type
Cartesian2

(static) multiplyComponents(left, right, result) → {Cartesian2}

Computes the componentwise product of two Cartesians.
Parameters:
Name Type Description
left Cartesian2 The first Cartesian.
right Cartesian2 The second Cartesian.
result Cartesian2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Cartesian2

(static) negate(cartesian, result) → {Cartesian2}

Negates the provided Cartesian.
Parameters:
Name Type Description
cartesian Cartesian2 The Cartesian to be negated.
result Cartesian2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Cartesian2

(static) normalize(cartesian, result) → {Cartesian2}

Computes the normalized form of the supplied Cartesian.
Parameters:
Name Type Description
cartesian Cartesian2 The Cartesian to be normalized.
result Cartesian2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Cartesian2

(static) pack(value, array, startingIndexopt) → {Array.<Number>}

Stores the provided instance into the provided array.
Parameters:
Name Type Attributes Default Description
value Cartesian2 The value to pack.
array Array.<Number> The array to pack into.
startingIndex Number <optional>
 0 The index into the array at which to start packing the elements.
Source:
Returns:
The array that was packed into
Type
Array.<Number>

(static) packArray(array, result) → {Array.<Number>}

Flattens an array of Cartesian2s into and array of components.
Parameters:
Name Type Description
array Array.<Cartesian2> The array of cartesians to pack.
result Array.<Number> The array onto which to store the result.
Source:
Returns:
The packed array.
Type
Array.<Number>

(static) subtract(left, right, result) → {Cartesian2}

Computes the componentwise difference of two Cartesians.
Parameters:
Name Type Description
left Cartesian2 The first Cartesian.
right Cartesian2 The second Cartesian.
result Cartesian2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Cartesian2

(static) unpack(array, startingIndexopt, resultopt) → {Cartesian2}

Retrieves an instance from a packed array.
Parameters:
Name Type Attributes Default Description
array Array.<Number> The packed array.
startingIndex Number <optional>
 0 The starting index of the element to be unpacked.
result Cartesian2 <optional>
 The object into which to store the result.
Source:
Returns:
The modified result parameter or a new Cartesian2 instance if one was not provided.
Type
Cartesian2

(static) unpackArray(array, result) → {Array.<Cartesian2>}

Unpacks an array of cartesian components into and array of Cartesian2s.
Parameters:
Name Type Description
array Array.<Number> The array of components to unpack.
result Array.<Cartesian2> The array onto which to store the result.
Source:
Returns:
The unpacked array.
Type
Array.<Cartesian2>