cesium
Version:
CesiumJS is a JavaScript library for creating 3D globes and 2D maps in a web browser without a plugin.
1,385 lines (1,382 loc) • 119 kB
JavaScript
/**
* @license
* Cesium - https://github.com/CesiumGS/cesium
* Version 1.142.0
*
* Copyright 2011-2022 Cesium Contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Columbus View (Pat. Pend.)
*
* Portions licensed separately.
* See https://github.com/CesiumGS/cesium/blob/main/LICENSE.md for full licensing details.
*/
import {
RuntimeError_default
} from "./chunk-Y5BF6AFU.js";
import {
Cartesian3_default,
Frozen_default,
Matrix3_default
} from "./chunk-MPZHGZU6.js";
import {
Math_default
} from "./chunk-J6BWOHUF.js";
import {
Check_default,
DeveloperError_default
} from "./chunk-AYKR4VBR.js";
import {
defined_default
} from "./chunk-ZP7JMQV4.js";
// packages/engine/Source/Core/Cartesian4.js
var Cartesian4 = class _Cartesian4 {
/**
* @param {number} [x=0.0] The X component.
* @param {number} [y=0.0] The Y component.
* @param {number} [z=0.0] The Z component.
* @param {number} [w=0.0] The W component.
*/
constructor(x, y, z, w) {
this.x = x ?? 0;
this.y = y ?? 0;
this.z = z ?? 0;
this.w = w ?? 0;
}
/**
* Creates a Cartesian4 instance from x, y, z and w coordinates.
*
* @param {number} x The x coordinate.
* @param {number} y The y coordinate.
* @param {number} z The z coordinate.
* @param {number} w The w coordinate.
* @param {Cartesian4} [result] The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter or a new Cartesian4 instance if one was not provided.
*/
static fromElements(x, y, z, w, result) {
if (!defined_default(result)) {
return new _Cartesian4(x, y, z, w);
}
result.x = x;
result.y = y;
result.z = z;
result.w = w;
return result;
}
/**
* Creates a Cartesian4 instance from a {@link Color}. <code>red</code>, <code>green</code>, <code>blue</code>,
* and <code>alpha</code> map to <code>x</code>, <code>y</code>, <code>z</code>, and <code>w</code>, respectively.
*
* @param {Color} color The source color.
* @param {Cartesian4} [result] The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter or a new Cartesian4 instance if one was not provided.
*/
static fromColor(color, result) {
Check_default.typeOf.object("color", color);
if (!defined_default(result)) {
return new _Cartesian4(color.red, color.green, color.blue, color.alpha);
}
result.x = color.red;
result.y = color.green;
result.z = color.blue;
result.w = color.alpha;
return result;
}
/**
* Duplicates a Cartesian4 instance.
*
* @param {Cartesian4} cartesian The Cartesian to duplicate.
* @param {Cartesian4} [result] The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter or a new Cartesian4 instance if one was not provided. (Returns undefined if cartesian is undefined)
*/
static clone(cartesian, result) {
if (!defined_default(cartesian)) {
return void 0;
}
if (!defined_default(result)) {
return new _Cartesian4(cartesian.x, cartesian.y, cartesian.z, cartesian.w);
}
result.x = cartesian.x;
result.y = cartesian.y;
result.z = cartesian.z;
result.w = cartesian.w;
return result;
}
/**
* Stores the provided instance into the provided array.
*
* @param {Cartesian4} value The value to pack.
* @param {number[]} array The array to pack into.
* @param {number} [startingIndex=0] The index into the array at which to start packing the elements.
*
* @returns {number[]} The array that was packed into
*/
static pack(value, array, startingIndex) {
Check_default.typeOf.object("value", value);
Check_default.defined("array", array);
startingIndex = startingIndex ?? 0;
array[startingIndex++] = value.x;
array[startingIndex++] = value.y;
array[startingIndex++] = value.z;
array[startingIndex] = value.w;
return array;
}
/**
* Retrieves an instance from a packed array.
*
* @param {number[]} array The packed array.
* @param {number} [startingIndex=0] The starting index of the element to be unpacked.
* @param {Cartesian4} [result] The object into which to store the result.
* @returns {Cartesian4} The modified result parameter or a new Cartesian4 instance if one was not provided.
*/
static unpack(array, startingIndex, result) {
Check_default.defined("array", array);
startingIndex = startingIndex ?? 0;
if (!defined_default(result)) {
result = new _Cartesian4();
}
result.x = array[startingIndex++];
result.y = array[startingIndex++];
result.z = array[startingIndex++];
result.w = array[startingIndex];
return result;
}
/**
* Flattens an array of Cartesian4s into an array of components.
*
* @param {Cartesian4[]} array The array of cartesians to pack.
* @param {number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 4 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 4) elements.
* @returns {number[]} The packed array.
*/
static packArray(array, result) {
Check_default.defined("array", array);
const length = array.length;
const resultLength = length * 4;
if (!defined_default(result)) {
result = new Array(resultLength);
} else if (!Array.isArray(result) && result.length !== resultLength) {
throw new DeveloperError_default(
"If result is a typed array, it must have exactly array.length * 4 elements"
);
} else if (result.length !== resultLength) {
result.length = resultLength;
}
for (let i = 0; i < length; ++i) {
_Cartesian4.pack(array[i], result, i * 4);
}
return result;
}
/**
* Unpacks an array of cartesian components into an array of Cartesian4s.
*
* @param {number[]} array The array of components to unpack.
* @param {Cartesian4[]} [result] The array onto which to store the result.
* @returns {Cartesian4[]} The unpacked array.
*/
static unpackArray(array, result) {
Check_default.defined("array", array);
Check_default.typeOf.number.greaterThanOrEquals("array.length", array.length, 4);
if (array.length % 4 !== 0) {
throw new DeveloperError_default("array length must be a multiple of 4.");
}
const length = array.length;
if (!defined_default(result)) {
result = new Array(length / 4);
} else {
result.length = length / 4;
}
for (let i = 0; i < length; i += 4) {
const index = i / 4;
result[index] = _Cartesian4.unpack(array, i, result[index]);
}
return result;
}
/**
* Computes the value of the maximum component for the supplied Cartesian.
*
* @param {Cartesian4} cartesian The cartesian to use.
* @returns {number} The value of the maximum component.
*/
static maximumComponent(cartesian) {
Check_default.typeOf.object("cartesian", cartesian);
return Math.max(cartesian.x, cartesian.y, cartesian.z, cartesian.w);
}
/**
* Computes the value of the minimum component for the supplied Cartesian.
*
* @param {Cartesian4} cartesian The cartesian to use.
* @returns {number} The value of the minimum component.
*/
static minimumComponent(cartesian) {
Check_default.typeOf.object("cartesian", cartesian);
return Math.min(cartesian.x, cartesian.y, cartesian.z, cartesian.w);
}
/**
* Compares two Cartesians and computes a Cartesian which contains the minimum components of the supplied Cartesians.
*
* @param {Cartesian4} first A cartesian to compare.
* @param {Cartesian4} second A cartesian to compare.
* @param {Cartesian4} result The object into which to store the result.
* @returns {Cartesian4} A cartesian with the minimum components.
*/
static minimumByComponent(first, second, result) {
Check_default.typeOf.object("first", first);
Check_default.typeOf.object("second", second);
Check_default.typeOf.object("result", result);
result.x = Math.min(first.x, second.x);
result.y = Math.min(first.y, second.y);
result.z = Math.min(first.z, second.z);
result.w = Math.min(first.w, second.w);
return result;
}
/**
* Compares two Cartesians and computes a Cartesian which contains the maximum components of the supplied Cartesians.
*
* @param {Cartesian4} first A cartesian to compare.
* @param {Cartesian4} second A cartesian to compare.
* @param {Cartesian4} result The object into which to store the result.
* @returns {Cartesian4} A cartesian with the maximum components.
*/
static maximumByComponent(first, second, result) {
Check_default.typeOf.object("first", first);
Check_default.typeOf.object("second", second);
Check_default.typeOf.object("result", result);
result.x = Math.max(first.x, second.x);
result.y = Math.max(first.y, second.y);
result.z = Math.max(first.z, second.z);
result.w = Math.max(first.w, second.w);
return result;
}
/**
* Constrain a value to lie between two values.
*
* @param {Cartesian4} value The value to clamp.
* @param {Cartesian4} min The minimum bound.
* @param {Cartesian4} max The maximum bound.
* @param {Cartesian4} result The object into which to store the result.
* @returns {Cartesian4} The clamped value such that min <= result <= max.
*/
static clamp(value, min, max, result) {
Check_default.typeOf.object("value", value);
Check_default.typeOf.object("min", min);
Check_default.typeOf.object("max", max);
Check_default.typeOf.object("result", result);
const x = Math_default.clamp(value.x, min.x, max.x);
const y = Math_default.clamp(value.y, min.y, max.y);
const z = Math_default.clamp(value.z, min.z, max.z);
const w = Math_default.clamp(value.w, min.w, max.w);
result.x = x;
result.y = y;
result.z = z;
result.w = w;
return result;
}
/**
* Computes the provided Cartesian's squared magnitude.
*
* @param {Cartesian4} cartesian The Cartesian instance whose squared magnitude is to be computed.
* @returns {number} The squared magnitude.
*/
static magnitudeSquared(cartesian) {
Check_default.typeOf.object("cartesian", cartesian);
return cartesian.x * cartesian.x + cartesian.y * cartesian.y + cartesian.z * cartesian.z + cartesian.w * cartesian.w;
}
/**
* Computes the Cartesian's magnitude (length).
*
* @param {Cartesian4} cartesian The Cartesian instance whose magnitude is to be computed.
* @returns {number} The magnitude.
*/
static magnitude(cartesian) {
return Math.sqrt(_Cartesian4.magnitudeSquared(cartesian));
}
/**
* Computes the 4-space distance between two points.
*
* @param {Cartesian4} left The first point to compute the distance from.
* @param {Cartesian4} right The second point to compute the distance to.
* @returns {number} The distance between two points.
*
* @example
* // Returns 1.0
* const 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));
*/
static distance(left, right) {
Check_default.typeOf.object("left", left);
Check_default.typeOf.object("right", right);
_Cartesian4.subtract(left, right, distanceScratch);
return _Cartesian4.magnitude(distanceScratch);
}
/**
* Computes the squared distance between two points. Comparing squared distances
* using this function is more efficient than comparing distances using {@link Cartesian4#distance}.
*
* @param {Cartesian4} left The first point to compute the distance from.
* @param {Cartesian4} right The second point to compute the distance to.
* @returns {number} The distance between two points.
*
* @example
* // Returns 4.0, not 2.0
* const 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));
*/
static distanceSquared(left, right) {
Check_default.typeOf.object("left", left);
Check_default.typeOf.object("right", right);
_Cartesian4.subtract(left, right, distanceScratch);
return _Cartesian4.magnitudeSquared(distanceScratch);
}
/**
* Computes the normalized form of the supplied Cartesian.
*
* @param {Cartesian4} cartesian The Cartesian to be normalized.
* @param {Cartesian4} result The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter.
*/
static normalize(cartesian, result) {
Check_default.typeOf.object("cartesian", cartesian);
Check_default.typeOf.object("result", result);
const magnitude = _Cartesian4.magnitude(cartesian);
result.x = cartesian.x / magnitude;
result.y = cartesian.y / magnitude;
result.z = cartesian.z / magnitude;
result.w = cartesian.w / magnitude;
if (isNaN(result.x) || isNaN(result.y) || isNaN(result.z) || isNaN(result.w)) {
throw new DeveloperError_default("normalized result is not a number");
}
return result;
}
/**
* Computes the dot (scalar) product of two Cartesians.
*
* @param {Cartesian4} left The first Cartesian.
* @param {Cartesian4} right The second Cartesian.
* @returns {number} The dot product.
*/
static dot(left, right) {
Check_default.typeOf.object("left", left);
Check_default.typeOf.object("right", right);
return left.x * right.x + left.y * right.y + left.z * right.z + left.w * right.w;
}
/**
* Computes the componentwise product of two Cartesians.
*
* @param {Cartesian4} left The first Cartesian.
* @param {Cartesian4} right The second Cartesian.
* @param {Cartesian4} result The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter.
*/
static multiplyComponents(left, right, result) {
Check_default.typeOf.object("left", left);
Check_default.typeOf.object("right", right);
Check_default.typeOf.object("result", result);
result.x = left.x * right.x;
result.y = left.y * right.y;
result.z = left.z * right.z;
result.w = left.w * right.w;
return result;
}
/**
* Computes the componentwise quotient of two Cartesians.
*
* @param {Cartesian4} left The first Cartesian.
* @param {Cartesian4} right The second Cartesian.
* @param {Cartesian4} result The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter.
*/
static divideComponents(left, right, result) {
Check_default.typeOf.object("left", left);
Check_default.typeOf.object("right", right);
Check_default.typeOf.object("result", result);
result.x = left.x / right.x;
result.y = left.y / right.y;
result.z = left.z / right.z;
result.w = left.w / right.w;
return result;
}
/**
* Computes the componentwise sum of two Cartesians.
*
* @param {Cartesian4} left The first Cartesian.
* @param {Cartesian4} right The second Cartesian.
* @param {Cartesian4} result The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter.
*/
static add(left, right, result) {
Check_default.typeOf.object("left", left);
Check_default.typeOf.object("right", right);
Check_default.typeOf.object("result", result);
result.x = left.x + right.x;
result.y = left.y + right.y;
result.z = left.z + right.z;
result.w = left.w + right.w;
return result;
}
/**
* Computes the componentwise difference of two Cartesians.
*
* @param {Cartesian4} left The first Cartesian.
* @param {Cartesian4} right The second Cartesian.
* @param {Cartesian4} result The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter.
*/
static subtract(left, right, result) {
Check_default.typeOf.object("left", left);
Check_default.typeOf.object("right", right);
Check_default.typeOf.object("result", result);
result.x = left.x - right.x;
result.y = left.y - right.y;
result.z = left.z - right.z;
result.w = left.w - right.w;
return result;
}
/**
* Multiplies the provided Cartesian componentwise by the provided scalar.
*
* @param {Cartesian4} cartesian The Cartesian to be scaled.
* @param {number} scalar The scalar to multiply with.
* @param {Cartesian4} result The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter.
*/
static multiplyByScalar(cartesian, scalar, result) {
Check_default.typeOf.object("cartesian", cartesian);
Check_default.typeOf.number("scalar", scalar);
Check_default.typeOf.object("result", result);
result.x = cartesian.x * scalar;
result.y = cartesian.y * scalar;
result.z = cartesian.z * scalar;
result.w = cartesian.w * scalar;
return result;
}
/**
* Divides the provided Cartesian componentwise by the provided scalar.
*
* @param {Cartesian4} cartesian The Cartesian to be divided.
* @param {number} scalar The scalar to divide by.
* @param {Cartesian4} result The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter.
*/
static divideByScalar(cartesian, scalar, result) {
Check_default.typeOf.object("cartesian", cartesian);
Check_default.typeOf.number("scalar", scalar);
Check_default.typeOf.object("result", result);
result.x = cartesian.x / scalar;
result.y = cartesian.y / scalar;
result.z = cartesian.z / scalar;
result.w = cartesian.w / scalar;
return result;
}
/**
* Negates the provided Cartesian.
*
* @param {Cartesian4} cartesian The Cartesian to be negated.
* @param {Cartesian4} result The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter.
*/
static negate(cartesian, result) {
Check_default.typeOf.object("cartesian", cartesian);
Check_default.typeOf.object("result", result);
result.x = -cartesian.x;
result.y = -cartesian.y;
result.z = -cartesian.z;
result.w = -cartesian.w;
return result;
}
/**
* Computes the absolute value of the provided Cartesian.
*
* @param {Cartesian4} cartesian The Cartesian whose absolute value is to be computed.
* @param {Cartesian4} result The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter.
*/
static abs(cartesian, result) {
Check_default.typeOf.object("cartesian", cartesian);
Check_default.typeOf.object("result", result);
result.x = Math.abs(cartesian.x);
result.y = Math.abs(cartesian.y);
result.z = Math.abs(cartesian.z);
result.w = Math.abs(cartesian.w);
return result;
}
/**
* Computes the linear interpolation or extrapolation at t using the provided cartesians.
*
* @param {Cartesian4} start The value corresponding to t at 0.0.
* @param {Cartesian4}end The value corresponding to t at 1.0.
* @param {number} t The point along t at which to interpolate.
* @param {Cartesian4} result The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter.
*/
static lerp(start, end, t, result) {
Check_default.typeOf.object("start", start);
Check_default.typeOf.object("end", end);
Check_default.typeOf.number("t", t);
Check_default.typeOf.object("result", result);
_Cartesian4.multiplyByScalar(end, t, lerpScratch);
result = _Cartesian4.multiplyByScalar(start, 1 - t, result);
return _Cartesian4.add(lerpScratch, result, result);
}
/**
* Returns the axis that is most orthogonal to the provided Cartesian.
*
* @param {Cartesian4} cartesian The Cartesian on which to find the most orthogonal axis.
* @param {Cartesian4} result The object onto which to store the result.
* @returns {Cartesian4} The most orthogonal axis.
*/
static mostOrthogonalAxis(cartesian, result) {
Check_default.typeOf.object("cartesian", cartesian);
Check_default.typeOf.object("result", result);
const f = _Cartesian4.normalize(cartesian, mostOrthogonalAxisScratch);
_Cartesian4.abs(f, f);
if (f.x <= f.y) {
if (f.x <= f.z) {
if (f.x <= f.w) {
result = _Cartesian4.clone(_Cartesian4.UNIT_X, result);
} else {
result = _Cartesian4.clone(_Cartesian4.UNIT_W, result);
}
} else if (f.z <= f.w) {
result = _Cartesian4.clone(_Cartesian4.UNIT_Z, result);
} else {
result = _Cartesian4.clone(_Cartesian4.UNIT_W, result);
}
} else if (f.y <= f.z) {
if (f.y <= f.w) {
result = _Cartesian4.clone(_Cartesian4.UNIT_Y, result);
} else {
result = _Cartesian4.clone(_Cartesian4.UNIT_W, result);
}
} else if (f.z <= f.w) {
result = _Cartesian4.clone(_Cartesian4.UNIT_Z, result);
} else {
result = _Cartesian4.clone(_Cartesian4.UNIT_W, result);
}
return result;
}
/**
* Compares the provided Cartesians componentwise and returns
* <code>true</code> if they are equal, <code>false</code> otherwise.
*
* @param {Cartesian4} [left] The first Cartesian.
* @param {Cartesian4} [right] The second Cartesian.
* @returns {boolean} <code>true</code> if left and right are equal, <code>false</code> otherwise.
*/
static equals(left, right) {
return left === right || defined_default(left) && defined_default(right) && left.x === right.x && left.y === right.y && left.z === right.z && left.w === right.w;
}
/**
* @param {Cartesian4} cartesian
* @param {number[]} array
* @param {number} offset
* @ignore
*/
static equalsArray(cartesian, array, offset) {
return cartesian.x === array[offset] && cartesian.y === array[offset + 1] && cartesian.z === array[offset + 2] && cartesian.w === array[offset + 3];
}
/**
* Compares the provided Cartesians componentwise and returns
* <code>true</code> if they pass an absolute or relative tolerance test,
* <code>false</code> otherwise.
*
* @param {Cartesian4} [left] The first Cartesian.
* @param {Cartesian4} [right] The second Cartesian.
* @param {number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing.
* @param {number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing.
* @returns {boolean} <code>true</code> if left and right are within the provided epsilon, <code>false</code> otherwise.
*/
static equalsEpsilon(left, right, relativeEpsilon, absoluteEpsilon) {
return left === right || defined_default(left) && defined_default(right) && Math_default.equalsEpsilon(
left.x,
right.x,
relativeEpsilon,
absoluteEpsilon
) && Math_default.equalsEpsilon(
left.y,
right.y,
relativeEpsilon,
absoluteEpsilon
) && Math_default.equalsEpsilon(
left.z,
right.z,
relativeEpsilon,
absoluteEpsilon
) && Math_default.equalsEpsilon(
left.w,
right.w,
relativeEpsilon,
absoluteEpsilon
);
}
/**
* Duplicates this Cartesian4 instance.
*
* @param {Cartesian4} [result] The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter or a new Cartesian4 instance if one was not provided.
*/
clone(result) {
return _Cartesian4.clone(this, result);
}
/**
* Compares this Cartesian against the provided Cartesian componentwise and returns
* <code>true</code> if they are equal, <code>false</code> otherwise.
*
* @param {Cartesian4} [right] The right hand side Cartesian.
* @returns {boolean} <code>true</code> if they are equal, <code>false</code> otherwise.
*/
equals(right) {
return _Cartesian4.equals(this, right);
}
/**
* Compares this Cartesian against the provided Cartesian componentwise and returns
* <code>true</code> if they pass an absolute or relative tolerance test,
* <code>false</code> otherwise.
*
* @param {Cartesian4} [right] The right hand side Cartesian.
* @param {number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing.
* @param {number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing.
* @returns {boolean} <code>true</code> if they are within the provided epsilon, <code>false</code> otherwise.
*/
equalsEpsilon(right, relativeEpsilon, absoluteEpsilon) {
return _Cartesian4.equalsEpsilon(
this,
right,
relativeEpsilon,
absoluteEpsilon
);
}
/**
* Creates a string representing this Cartesian in the format '(x, y, z, w)'.
*
* @returns {string} A string representing the provided Cartesian in the format '(x, y, z, w)'.
*/
toString() {
return `(${this.x}, ${this.y}, ${this.z}, ${this.w})`;
}
/**
* Packs an arbitrary floating point value to 4 values representable using uint8.
*
* @param {number} value A floating point number.
* @param {Cartesian4} [result] The Cartesian4 that will contain the packed float.
* @returns {Cartesian4} A Cartesian4 representing the float packed to values in x, y, z, and w.
*/
static packFloat(value, result) {
Check_default.typeOf.number("value", value);
if (!defined_default(result)) {
result = new _Cartesian4();
}
scratchF32Array[0] = value;
if (littleEndian) {
result.x = scratchU8Array[0];
result.y = scratchU8Array[1];
result.z = scratchU8Array[2];
result.w = scratchU8Array[3];
} else {
result.x = scratchU8Array[3];
result.y = scratchU8Array[2];
result.z = scratchU8Array[1];
result.w = scratchU8Array[0];
}
return result;
}
/**
* Unpacks a float packed using Cartesian4.packFloat.
*
* @param {Cartesian4} packedFloat A Cartesian4 containing a float packed to 4 values representable using uint8.
* @returns {number} The unpacked float.
* @private
*/
static unpackFloat(packedFloat) {
Check_default.typeOf.object("packedFloat", packedFloat);
if (littleEndian) {
scratchU8Array[0] = packedFloat.x;
scratchU8Array[1] = packedFloat.y;
scratchU8Array[2] = packedFloat.z;
scratchU8Array[3] = packedFloat.w;
} else {
scratchU8Array[0] = packedFloat.w;
scratchU8Array[1] = packedFloat.z;
scratchU8Array[2] = packedFloat.y;
scratchU8Array[3] = packedFloat.x;
}
return scratchF32Array[0];
}
};
Cartesian4.packedLength = 4;
Cartesian4.fromArray = Cartesian4.unpack;
var distanceScratch = new Cartesian4();
var lerpScratch = new Cartesian4();
var mostOrthogonalAxisScratch = new Cartesian4();
Cartesian4.ZERO = Object.freeze(new Cartesian4(0, 0, 0, 0));
Cartesian4.ONE = Object.freeze(new Cartesian4(1, 1, 1, 1));
Cartesian4.UNIT_X = Object.freeze(new Cartesian4(1, 0, 0, 0));
Cartesian4.UNIT_Y = Object.freeze(new Cartesian4(0, 1, 0, 0));
Cartesian4.UNIT_Z = Object.freeze(new Cartesian4(0, 0, 1, 0));
Cartesian4.UNIT_W = Object.freeze(new Cartesian4(0, 0, 0, 1));
var scratchF32Array = new Float32Array(1);
var scratchU8Array = new Uint8Array(scratchF32Array.buffer);
var testU32 = new Uint32Array([287454020]);
var testU8 = new Uint8Array(testU32.buffer);
var littleEndian = testU8[0] === 68;
var Cartesian4_default = Cartesian4;
// packages/engine/Source/Core/Matrix4.js
var Matrix4 = class _Matrix4 {
/**
* @param {number} [column0Row0=0.0] The value for column 0, row 0.
* @param {number} [column1Row0=0.0] The value for column 1, row 0.
* @param {number} [column2Row0=0.0] The value for column 2, row 0.
* @param {number} [column3Row0=0.0] The value for column 3, row 0.
* @param {number} [column0Row1=0.0] The value for column 0, row 1.
* @param {number} [column1Row1=0.0] The value for column 1, row 1.
* @param {number} [column2Row1=0.0] The value for column 2, row 1.
* @param {number} [column3Row1=0.0] The value for column 3, row 1.
* @param {number} [column0Row2=0.0] The value for column 0, row 2.
* @param {number} [column1Row2=0.0] The value for column 1, row 2.
* @param {number} [column2Row2=0.0] The value for column 2, row 2.
* @param {number} [column3Row2=0.0] The value for column 3, row 2.
* @param {number} [column0Row3=0.0] The value for column 0, row 3.
* @param {number} [column1Row3=0.0] The value for column 1, row 3.
* @param {number} [column2Row3=0.0] The value for column 2, row 3.
* @param {number} [column3Row3=0.0] The value for column 3, row 3.
*/
constructor(column0Row0, column1Row0, column2Row0, column3Row0, column0Row1, column1Row1, column2Row1, column3Row1, column0Row2, column1Row2, column2Row2, column3Row2, column0Row3, column1Row3, column2Row3, column3Row3) {
this[0] = column0Row0 ?? 0;
this[1] = column0Row1 ?? 0;
this[2] = column0Row2 ?? 0;
this[3] = column0Row3 ?? 0;
this[4] = column1Row0 ?? 0;
this[5] = column1Row1 ?? 0;
this[6] = column1Row2 ?? 0;
this[7] = column1Row3 ?? 0;
this[8] = column2Row0 ?? 0;
this[9] = column2Row1 ?? 0;
this[10] = column2Row2 ?? 0;
this[11] = column2Row3 ?? 0;
this[12] = column3Row0 ?? 0;
this[13] = column3Row1 ?? 0;
this[14] = column3Row2 ?? 0;
this[15] = column3Row3 ?? 0;
}
/**
* Stores the provided instance into the provided array.
*
* @param {Matrix4} value The value to pack.
* @param {number[]} array The array to pack into.
* @param {number} [startingIndex=0] The index into the array at which to start packing the elements.
*
* @returns {number[]} The array that was packed into
*/
static pack(value, array, startingIndex) {
Check_default.typeOf.object("value", value);
Check_default.defined("array", array);
startingIndex = startingIndex ?? 0;
array[startingIndex++] = value[0];
array[startingIndex++] = value[1];
array[startingIndex++] = value[2];
array[startingIndex++] = value[3];
array[startingIndex++] = value[4];
array[startingIndex++] = value[5];
array[startingIndex++] = value[6];
array[startingIndex++] = value[7];
array[startingIndex++] = value[8];
array[startingIndex++] = value[9];
array[startingIndex++] = value[10];
array[startingIndex++] = value[11];
array[startingIndex++] = value[12];
array[startingIndex++] = value[13];
array[startingIndex++] = value[14];
array[startingIndex] = value[15];
return array;
}
/**
* Retrieves an instance from a packed array.
*
* @param {number[]} array The packed array.
* @param {number} [startingIndex=0] The starting index of the element to be unpacked.
* @param {Matrix4} [result] The object into which to store the result.
* @returns {Matrix4} The modified result parameter or a new Matrix4 instance if one was not provided.
*/
static unpack(array, startingIndex, result) {
Check_default.defined("array", array);
startingIndex = startingIndex ?? 0;
if (!defined_default(result)) {
result = new _Matrix4();
}
result[0] = array[startingIndex++];
result[1] = array[startingIndex++];
result[2] = array[startingIndex++];
result[3] = array[startingIndex++];
result[4] = array[startingIndex++];
result[5] = array[startingIndex++];
result[6] = array[startingIndex++];
result[7] = array[startingIndex++];
result[8] = array[startingIndex++];
result[9] = array[startingIndex++];
result[10] = array[startingIndex++];
result[11] = array[startingIndex++];
result[12] = array[startingIndex++];
result[13] = array[startingIndex++];
result[14] = array[startingIndex++];
result[15] = array[startingIndex];
return result;
}
/**
* Flattens an array of Matrix4s into an array of components. The components
* are stored in column-major order.
*
* @param {Matrix4[]} array The array of matrices to pack.
* @param {number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 16 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 16) elements.
* @returns {number[]} The packed array.
*/
static packArray(array, result) {
Check_default.defined("array", array);
const length = array.length;
const resultLength = length * 16;
if (!defined_default(result)) {
result = new Array(resultLength);
} else if (!Array.isArray(result) && result.length !== resultLength) {
throw new DeveloperError_default(
"If result is a typed array, it must have exactly array.length * 16 elements"
);
} else if (result.length !== resultLength) {
result.length = resultLength;
}
for (let i = 0; i < length; ++i) {
_Matrix4.pack(array[i], result, i * 16);
}
return result;
}
/**
* Unpacks an array of column-major matrix components into an array of Matrix4s.
*
* @param {number[]} array The array of components to unpack.
* @param {Matrix4[]} [result] The array onto which to store the result.
* @returns {Matrix4[]} The unpacked array.
*/
static unpackArray(array, result) {
Check_default.defined("array", array);
Check_default.typeOf.number.greaterThanOrEquals("array.length", array.length, 16);
if (array.length % 16 !== 0) {
throw new DeveloperError_default("array length must be a multiple of 16.");
}
const length = array.length;
if (!defined_default(result)) {
result = new Array(length / 16);
} else {
result.length = length / 16;
}
for (let i = 0; i < length; i += 16) {
const index = i / 16;
result[index] = _Matrix4.unpack(array, i, result[index]);
}
return result;
}
/**
* Duplicates a Matrix4 instance.
*
* @param {Matrix4} matrix The matrix to duplicate.
* @param {Matrix4} [result] The object onto which to store the result.
* @returns {Matrix4} The modified result parameter or a new Matrix4 instance if one was not provided. (Returns undefined if matrix is undefined)
*/
static clone(matrix, result) {
if (!defined_default(matrix)) {
return void 0;
}
if (!defined_default(result)) {
return new _Matrix4(
matrix[0],
matrix[4],
matrix[8],
matrix[12],
matrix[1],
matrix[5],
matrix[9],
matrix[13],
matrix[2],
matrix[6],
matrix[10],
matrix[14],
matrix[3],
matrix[7],
matrix[11],
matrix[15]
);
}
result[0] = matrix[0];
result[1] = matrix[1];
result[2] = matrix[2];
result[3] = matrix[3];
result[4] = matrix[4];
result[5] = matrix[5];
result[6] = matrix[6];
result[7] = matrix[7];
result[8] = matrix[8];
result[9] = matrix[9];
result[10] = matrix[10];
result[11] = matrix[11];
result[12] = matrix[12];
result[13] = matrix[13];
result[14] = matrix[14];
result[15] = matrix[15];
return result;
}
/**
* Computes a Matrix4 instance from a column-major order array.
*
* @param {number[]} values The column-major order array.
* @param {Matrix4} [result] The object in which the result will be stored, if undefined a new instance will be created.
* @returns {Matrix4} The modified result parameter, or a new Matrix4 instance if one was not provided.
*/
static fromColumnMajorArray(values, result) {
Check_default.defined("values", values);
return _Matrix4.clone(values, result);
}
/**
* Computes a Matrix4 instance from a row-major order array.
* The resulting matrix will be in column-major order.
*
* @param {number[]} values The row-major order array.
* @param {Matrix4} [result] The object in which the result will be stored, if undefined a new instance will be created.
* @returns {Matrix4} The modified result parameter, or a new Matrix4 instance if one was not provided.
*/
static fromRowMajorArray(values, result) {
Check_default.defined("values", values);
if (!defined_default(result)) {
return new _Matrix4(
values[0],
values[1],
values[2],
values[3],
values[4],
values[5],
values[6],
values[7],
values[8],
values[9],
values[10],
values[11],
values[12],
values[13],
values[14],
values[15]
);
}
result[0] = values[0];
result[1] = values[4];
result[2] = values[8];
result[3] = values[12];
result[4] = values[1];
result[5] = values[5];
result[6] = values[9];
result[7] = values[13];
result[8] = values[2];
result[9] = values[6];
result[10] = values[10];
result[11] = values[14];
result[12] = values[3];
result[13] = values[7];
result[14] = values[11];
result[15] = values[15];
return result;
}
/**
* Computes a Matrix4 instance from a Matrix3 representing the rotation
* and a Cartesian3 representing the translation.
*
* @param {Matrix3} rotation The upper left portion of the matrix representing the rotation.
* @param {Cartesian3} [translation=Cartesian3.ZERO] The upper right portion of the matrix representing the translation.
* @param {Matrix4} [result] The object in which the result will be stored, if undefined a new instance will be created.
* @returns {Matrix4} The modified result parameter, or a new Matrix4 instance if one was not provided.
*/
static fromRotationTranslation(rotation, translation, result) {
Check_default.typeOf.object("rotation", rotation);
translation = translation ?? Cartesian3_default.ZERO;
if (!defined_default(result)) {
return new _Matrix4(
rotation[0],
rotation[3],
rotation[6],
translation.x,
rotation[1],
rotation[4],
rotation[7],
translation.y,
rotation[2],
rotation[5],
rotation[8],
translation.z,
0,
0,
0,
1
);
}
result[0] = rotation[0];
result[1] = rotation[1];
result[2] = rotation[2];
result[3] = 0;
result[4] = rotation[3];
result[5] = rotation[4];
result[6] = rotation[5];
result[7] = 0;
result[8] = rotation[6];
result[9] = rotation[7];
result[10] = rotation[8];
result[11] = 0;
result[12] = translation.x;
result[13] = translation.y;
result[14] = translation.z;
result[15] = 1;
return result;
}
/**
* Computes a Matrix4 instance from a translation, rotation, and scale (TRS)
* representation with the rotation represented as a quaternion.
*
* @param {Cartesian3} translation The translation transformation.
* @param {Quaternion} rotation The rotation transformation.
* @param {Cartesian3} scale The non-uniform scale transformation.
* @param {Matrix4} [result] The object in which the result will be stored, if undefined a new instance will be created.
* @returns {Matrix4} The modified result parameter, or a new Matrix4 instance if one was not provided.
*
* @example
* const result = Cesium.Matrix4.fromTranslationQuaternionRotationScale(
* new Cesium.Cartesian3(1.0, 2.0, 3.0), // translation
* Cesium.Quaternion.IDENTITY, // rotation
* new Cesium.Cartesian3(7.0, 8.0, 9.0), // scale
* result);
*/
static fromTranslationQuaternionRotationScale(translation, rotation, scale, result) {
Check_default.typeOf.object("translation", translation);
Check_default.typeOf.object("rotation", rotation);
Check_default.typeOf.object("scale", scale);
if (!defined_default(result)) {
result = new _Matrix4();
}
const scaleX = scale.x;
const scaleY = scale.y;
const scaleZ = scale.z;
const x2 = rotation.x * rotation.x;
const xy = rotation.x * rotation.y;
const xz = rotation.x * rotation.z;
const xw = rotation.x * rotation.w;
const y2 = rotation.y * rotation.y;
const yz = rotation.y * rotation.z;
const yw = rotation.y * rotation.w;
const z2 = rotation.z * rotation.z;
const zw = rotation.z * rotation.w;
const w2 = rotation.w * rotation.w;
const m00 = x2 - y2 - z2 + w2;
const m01 = 2 * (xy - zw);
const m02 = 2 * (xz + yw);
const m10 = 2 * (xy + zw);
const m11 = -x2 + y2 - z2 + w2;
const m12 = 2 * (yz - xw);
const m20 = 2 * (xz - yw);
const m21 = 2 * (yz + xw);
const m22 = -x2 - y2 + z2 + w2;
result[0] = m00 * scaleX;
result[1] = m10 * scaleX;
result[2] = m20 * scaleX;
result[3] = 0;
result[4] = m01 * scaleY;
result[5] = m11 * scaleY;
result[6] = m21 * scaleY;
result[7] = 0;
result[8] = m02 * scaleZ;
result[9] = m12 * scaleZ;
result[10] = m22 * scaleZ;
result[11] = 0;
result[12] = translation.x;
result[13] = translation.y;
result[14] = translation.z;
result[15] = 1;
return result;
}
/**
* Creates a Matrix4 instance from a {@link TranslationRotationScale} instance.
*
* @param {TranslationRotationScale} translationRotationScale The instance.
* @param {Matrix4} [result] The object in which the result will be stored, if undefined a new instance will be created.
* @returns {Matrix4} The modified result parameter, or a new Matrix4 instance if one was not provided.
*/
static fromTranslationRotationScale(translationRotationScale, result) {
Check_default.typeOf.object("translationRotationScale", translationRotationScale);
return _Matrix4.fromTranslationQuaternionRotationScale(
translationRotationScale.translation,
translationRotationScale.rotation,
translationRotationScale.scale,
result
);
}
/**
* Creates a Matrix4 instance from a Cartesian3 representing the translation.
*
* @param {Cartesian3} translation The upper right portion of the matrix representing the translation.
* @param {Matrix4} [result] The object in which the result will be stored, if undefined a new instance will be created.
* @returns {Matrix4} The modified result parameter, or a new Matrix4 instance if one was not provided.
*
* @see Matrix4.multiplyByTranslation
*/
static fromTranslation(translation, result) {
Check_default.typeOf.object("translation", translation);
return _Matrix4.fromRotationTranslation(
Matrix3_default.IDENTITY,
translation,
result
);
}
/**
* Computes a Matrix4 instance representing a non-uniform scale.
*
* @param {Cartesian3} scale The x, y, and z scale factors.
* @param {Matrix4} [result] The object in which the result will be stored, if undefined a new instance will be created.
* @returns {Matrix4} The modified result parameter, or a new Matrix4 instance if one was not provided.
*
* @example
* // Creates
* // [7.0, 0.0, 0.0, 0.0]
* // [0.0, 8.0, 0.0, 0.0]
* // [0.0, 0.0, 9.0, 0.0]
* // [0.0, 0.0, 0.0, 1.0]
* const m = Cesium.Matrix4.fromScale(new Cesium.Cartesian3(7.0, 8.0, 9.0));
*/
static fromScale(scale, result) {
Check_default.typeOf.object("scale", scale);
if (!defined_default(result)) {
return new _Matrix4(
scale.x,
0,
0,
0,
0,
scale.y,
0,
0,
0,
0,
scale.z,
0,
0,
0,
0,
1
);
}
result[0] = scale.x;
result[1] = 0;
result[2] = 0;
result[3] = 0;
result[4] = 0;
result[5] = scale.y;
result[6] = 0;
result[7] = 0;
result[8] = 0;
result[9] = 0;
result[10] = scale.z;
result[11] = 0;
result[12] = 0;
result[13] = 0;
result[14] = 0;
result[15] = 1;
return result;
}
/**
* Computes a Matrix4 instance representing a uniform scale.
*
* @param {number} scale The uniform scale factor.
* @param {Matrix4} [result] The object in which the result will be stored, if undefined a new instance will be created.
* @returns {Matrix4} The modified result parameter, or a new Matrix4 instance if one was not provided.
*
* @example
* // Creates
* // [2.0, 0.0, 0.0, 0.0]
* // [0.0, 2.0, 0.0, 0.0]
* // [0.0, 0.0, 2.0, 0.0]
* // [0.0, 0.0, 0.0, 1.0]
* const m = Cesium.Matrix4.fromUniformScale(2.0);
*/
static fromUniformScale(scale, result) {
Check_default.typeOf.number("scale", scale);
if (!defined_default(result)) {
return new _Matrix4(
scale,
0,
0,
0,
0,
scale,
0,
0,
0,
0,
scale,
0,
0,
0,
0,
1
);
}
result[0] = scale;
result[1] = 0;
result[2] = 0;
result[3] = 0;
result[4] = 0;
result[5] = scale;
result[6] = 0;
result[7] = 0;
result[8] = 0;
result[9] = 0;
result[10] = scale;
result[11] = 0;
result[12] = 0;
result[13] = 0;
result[14] = 0;
result[15] = 1;
return result;
}
/**
* Creates a rotation matrix.
*
* @param {Matrix3} rotation The rotation matrix.
* @param {Matrix4} [result] The object in which the result will be stored, if undefined a new instance will be created.
* @returns {Matrix4} The modified result parameter, or a new Matrix4 instance if one was not provided.
*/
static fromRotation(rotation, result) {
Check_default.typeOf.object("rotation", rotation);
if (!defined_default(result)) {
result = new _Matrix4();
}
result[0] = rotation[0];
result[1] = rotation[1];
result[2] = rotation[2];
result[3] = 0;
result[4] = rotation[3];
result[5] = rotation[4];
result[6] = rotation[5];
result[7] = 0;
result[8] = rotation[6];
result[9] = rotation[7];
result[10] = rotation[8];
result[11] = 0;
result[12] = 0;
result[13] = 0;
result[14] = 0;
result[15] = 1;
return result;
}
/**
* Computes a Matrix4 instance from a Camera.
*
* @param {Camera} camera The camera to use.
* @param {Matrix4} [result] The object in which the result will be stored, if undefined a new instance will be created.
* @returns {Matrix4} The modified result parameter, or a new Matrix4 instance if one was not provided.
*/
static fromCamera(camera, result) {
Check_default.typeOf.object("camera", camera);
const position = camera.position;
const direction = camera.direction;
const up = camera.up;
Check_default.typeOf.object("camera.position", position);
Check_default.typeOf.object("camera.direction", direction);
Check_default.typeOf.object("camera.up", up);
Cartesian3_default.normalize(direction, fromCameraF);
Cartesian3_default.normalize(
Cartesian3_default.cross(fromCameraF, up, fromCameraR),
fromCameraR
);
Cartesian3_default.normalize(
Cartesian3_default.cross(fromCameraR, fromCameraF, fromCameraU),
fromCameraU
);
const sX = fromCameraR.x;
const sY = fromCameraR.y;
const sZ = fromCameraR.z;
const fX = fromCameraF.x;
const fY = fromCameraF.y;
const fZ = fromCameraF.z;
const uX = fromCameraU.x;
const uY = fromCameraU.y;
const uZ = fromCameraU.z;
const positionX = position.x;
const positionY = position.y;
const positionZ = position.z;
const t0 = sX * -positionX + sY * -positionY + sZ * -positionZ;
const t1 = uX * -positionX + uY * -positionY + uZ * -positionZ;
const t2 = fX * positionX + fY * positionY + fZ * positionZ;
if (!defined_default(result)) {
return new _Matrix4(
sX,
sY,
sZ,
t0,
uX,
uY,
uZ,
t1,
-fX,
-fY,
-fZ,
t2,
0,
0,
0,
1
);
}
result[0] = sX;
result[1] = uX;
result[2] = -fX;
result[3] = 0;
result[4] = sY;
result[5] = uY;
result[6] = -fY;
result[7] = 0;
result[8] = sZ;
result[9] = uZ;
result[10] = -fZ;
result[11] = 0;
result[12] = t0;
result[13] = t1;
result[14] = t2;
result[15] = 1;
return result;
}
/**
* Computes a Matrix4 instance representing a perspective transformation matrix.
*
* @param {number} fovY The field of view along the Y axis in radians.
* @param {number} aspectRatio The aspect ratio.
* @param {number} near The distance to the near plane in meters.
* @param {number} far The distance to the far plane in meters.
* @param {Matrix4} result The object in which the result will be stored.
* @returns {Matrix4} The modified result parameter.
*
* @exception {DeveloperError} fovY must be in (0, PI].
* @exception {DeveloperError} aspectRatio must be greater than zero.
* @exception {DeveloperError} near must be greater than zero.
* @exception {DeveloperError} far must be greater than zero.
*/
static computePerspectiveFieldOfView(fovY, aspectRatio, near, far, result) {
Check_default.typeOf.number.greaterThan("fovY", fovY, 0);
Check_default.typeOf.number.lessThan("fovY", fovY, Math.PI);
Check_default.typeOf.number.greaterThan("near", near, 0);
Check_default.typeOf.number.greaterThan("far", far, 0);
Check_default.typeOf.object("result", result);
const bottom = Math.tan(fovY * 0.5);
const column1Row1 = 1 / bottom;
const column0Row