A 2D Cartesian point.
Name | Type | Default | Description |
---|---|---|---|
x |
number |
0.0
|
optional The X component. |
y |
number |
0.0
|
optional The Y component. |
See:
Members
The X component.
-
Default Value:
0.0
The Y component.
-
Default Value:
0.0
static constant Cesium.Cartesian2.ONE : Cartesian2
An immutable Cartesian2 instance initialized to (1.0, 1.0).
The number of elements used to pack the object into an array.
static constant Cesium.Cartesian2.UNIT_X : Cartesian2
An immutable Cartesian2 instance initialized to (1.0, 0.0).
static constant Cesium.Cartesian2.UNIT_Y : Cartesian2
An immutable Cartesian2 instance initialized to (0.0, 1.0).
static constant Cesium.Cartesian2.ZERO : Cartesian2
An immutable Cartesian2 instance initialized to (0.0, 0.0).
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.
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.
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 |
0
|
optional 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.
Creates a string representing this Cartesian in the format '(x, y)'.
Returns:
A string representing the provided Cartesian in the format '(x, y)'.
static Cesium.Cartesian2.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.
static Cesium.Cartesian2.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.
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.
static Cesium.Cartesian2.clamp(value, min, max, result) → Cartesian2
Constrain a value to lie between two values.
Name | Type | Description |
---|---|---|
value |
Cartesian2 | The value to clamp. |
min |
Cartesian2 | The minimum bound. |
max |
Cartesian2 | The maximum bound. |
result |
Cartesian2 | The object into which to store the result. |
Returns:
The clamped value such that min <= result <= max.
static Cesium.Cartesian2.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)
Computes the magnitude of the cross product that would result from implicitly setting the Z coordinate of the input vectors to 0
Name | Type | Description |
---|---|---|
left |
Cartesian2 | The first Cartesian. |
right |
Cartesian2 | The second Cartesian. |
Returns:
The cross product.
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
const d = Cesium.Cartesian2.distance(new Cesium.Cartesian2(1.0, 0.0), new Cesium.Cartesian2(2.0, 0.0));
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
const d = Cesium.Cartesian2.distance(new Cesium.Cartesian2(1.0, 0.0), new Cesium.Cartesian2(3.0, 0.0));
static Cesium.Cartesian2.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.
static Cesium.Cartesian2.divideComponents(left, right, result) → Cartesian2
Computes the componentwise quotient 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.
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.
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.
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 |
0
|
optional 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.
static Cesium.Cartesian2.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)
const v = [1.0, 2.0];
const p = Cesium.Cartesian2.fromArray(v);
// Create a Cartesian2 with (1.0, 2.0) using an offset into an array
const v2 = [0.0, 0.0, 1.0, 2.0];
const p2 = Cesium.Cartesian2.fromArray(v2, 2);
static Cesium.Cartesian2.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.
static Cesium.Cartesian2.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.
static Cesium.Cartesian2.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.
static Cesium.Cartesian2.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.
Computes the Cartesian's magnitude (length).
Name | Type | Description |
---|---|---|
cartesian |
Cartesian2 | The Cartesian instance whose magnitude is to be computed. |
Returns:
The magnitude.
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.
static Cesium.Cartesian2.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.
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.
static Cesium.Cartesian2.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.
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.
static Cesium.Cartesian2.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.
static Cesium.Cartesian2.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.
static Cesium.Cartesian2.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.
static Cesium.Cartesian2.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.
static Cesium.Cartesian2.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.
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. |
Returns:
The array that was packed into
Flattens an array of Cartesian2s into an array of components.
Name | Type | Description |
---|---|---|
array |
Array.<Cartesian2> | The array of cartesians to pack. |
result |
Array.<number> |
optional
The array onto which to store the result. If this is a typed array, it must have array.length * 2 components, else a DeveloperError will be thrown. If it is a regular array, it will be resized to have (array.length * 2) elements. |
Returns:
The packed array.
static Cesium.Cartesian2.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.
static Cesium.Cartesian2.unpack(array, startingIndex, result) → Cartesian2
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. |
Returns:
The modified result parameter or a new Cartesian2 instance if one was not provided.
static Cesium.Cartesian2.unpackArray(array, result) → Array.<Cartesian2>
Unpacks an array of cartesian components into an array of Cartesian2s.
Name | Type | Description |
---|---|---|
array |
Array.<number> | The array of components to unpack. |
result |
Array.<Cartesian2> | optional The array onto which to store the result. |
Returns:
The unpacked array.