UNPKG

@cesium/engine

Version:

CesiumJS is a JavaScript library for creating 3D globes and 2D maps in a web browser without a plugin.

1,701 lines (1,534 loc) 65.5 kB
import Check from "./Check.js"; import Frozen from "./Frozen.js"; import defined from "./defined.js"; import FeatureDetection from "./FeatureDetection.js"; import CesiumMath from "./Math.js"; function hue2rgb(m1, m2, h) { if (h < 0) { h += 1; } if (h > 1) { h -= 1; } if (h * 6 < 1) { return m1 + (m2 - m1) * 6 * h; } if (h * 2 < 1) { return m2; } if (h * 3 < 2) { return m1 + (m2 - m1) * (2 / 3 - h) * 6; } return m1; } /** * A color, specified using red, green, blue, and alpha values, * which range from <code>0</code> (no intensity) to <code>1.0</code> (full intensity). * @param {number} [red=1.0] The red component. * @param {number} [green=1.0] The green component. * @param {number} [blue=1.0] The blue component. * @param {number} [alpha=1.0] The alpha component. * * @constructor * @alias Color * * @see Packable */ function Color(red, green, blue, alpha) { /** * The red component. * @type {number} * @default 1.0 */ this.red = red ?? 1.0; /** * The green component. * @type {number} * @default 1.0 */ this.green = green ?? 1.0; /** * The blue component. * @type {number} * @default 1.0 */ this.blue = blue ?? 1.0; /** * The alpha component. * @type {number} * @default 1.0 */ this.alpha = alpha ?? 1.0; } /** * Creates a Color instance from a {@link Cartesian4}. <code>x</code>, <code>y</code>, <code>z</code>, * and <code>w</code> map to <code>red</code>, <code>green</code>, <code>blue</code>, and <code>alpha</code>, respectively. * * @param {Cartesian4} cartesian The source cartesian. * @param {Color} [result] The object onto which to store the result. * @returns {Color} The modified result parameter or a new Color instance if one was not provided. */ Color.fromCartesian4 = function (cartesian, result) { //>>includeStart('debug', pragmas.debug); Check.typeOf.object("cartesian", cartesian); //>>includeEnd('debug'); if (!defined(result)) { return new Color(cartesian.x, cartesian.y, cartesian.z, cartesian.w); } result.red = cartesian.x; result.green = cartesian.y; result.blue = cartesian.z; result.alpha = cartesian.w; return result; }; /** * Creates a new Color specified using red, green, blue, and alpha values * that are in the range of 0 to 255, converting them internally to a range of 0.0 to 1.0. * * @param {number} [red=255] The red component. * @param {number} [green=255] The green component. * @param {number} [blue=255] The blue component. * @param {number} [alpha=255] The alpha component. * @param {Color} [result] The object onto which to store the result. * @returns {Color} The modified result parameter or a new Color instance if one was not provided. */ Color.fromBytes = function (red, green, blue, alpha, result) { red = Color.byteToFloat(red ?? 255.0); green = Color.byteToFloat(green ?? 255.0); blue = Color.byteToFloat(blue ?? 255.0); alpha = Color.byteToFloat(alpha ?? 255.0); if (!defined(result)) { return new Color(red, green, blue, alpha); } result.red = red; result.green = green; result.blue = blue; result.alpha = alpha; return result; }; /** * Creates a new Color that has the same red, green, and blue components * of the specified color, but with the specified alpha value. * * @param {Color} color The base color * @param {number} alpha The new alpha component. * @param {Color} [result] The object onto which to store the result. * @returns {Color} The modified result parameter or a new Color instance if one was not provided. * * @example const translucentRed = Cesium.Color.fromAlpha(Cesium.Color.RED, 0.9); */ Color.fromAlpha = function (color, alpha, result) { //>>includeStart('debug', pragmas.debug); Check.typeOf.object("color", color); Check.typeOf.number("alpha", alpha); //>>includeEnd('debug'); if (!defined(result)) { return new Color(color.red, color.green, color.blue, alpha); } result.red = color.red; result.green = color.green; result.blue = color.blue; result.alpha = alpha; return result; }; let scratchArrayBuffer; let scratchUint32Array; let scratchUint8Array; if (FeatureDetection.supportsTypedArrays()) { scratchArrayBuffer = new ArrayBuffer(4); scratchUint32Array = new Uint32Array(scratchArrayBuffer); scratchUint8Array = new Uint8Array(scratchArrayBuffer); } /** * Creates a new Color from a single numeric unsigned 32-bit RGBA value, using the endianness * of the system. * * @param {number} rgba A single numeric unsigned 32-bit RGBA value. * @param {Color} [result] The object to store the result in, if undefined a new instance will be created. * @returns {Color} The color object. * * @example * const color = Cesium.Color.fromRgba(0x67ADDFFF); * * @see Color#toRgba */ Color.fromRgba = function (rgba, result) { // scratchUint32Array and scratchUint8Array share an underlying array buffer scratchUint32Array[0] = rgba; return Color.fromBytes( scratchUint8Array[0], scratchUint8Array[1], scratchUint8Array[2], scratchUint8Array[3], result, ); }; /** * Creates a Color instance from hue, saturation, and lightness. * * @param {number} [hue=0] The hue angle 0...1 * @param {number} [saturation=0] The saturation value 0...1 * @param {number} [lightness=0] The lightness value 0...1 * @param {number} [alpha=1.0] The alpha component 0...1 * @param {Color} [result] The object to store the result in, if undefined a new instance will be created. * @returns {Color} The color object. * * @see {@link http://www.w3.org/TR/css3-color/#hsl-color|CSS color values} */ Color.fromHsl = function (hue, saturation, lightness, alpha, result) { hue = (hue ?? 0.0) % 1.0; saturation = saturation ?? 0.0; lightness = lightness ?? 0.0; alpha = alpha ?? 1.0; let red = lightness; let green = lightness; let blue = lightness; if (saturation !== 0) { let m2; if (lightness < 0.5) { m2 = lightness * (1 + saturation); } else { m2 = lightness + saturation - lightness * saturation; } const m1 = 2.0 * lightness - m2; red = hue2rgb(m1, m2, hue + 1 / 3); green = hue2rgb(m1, m2, hue); blue = hue2rgb(m1, m2, hue - 1 / 3); } if (!defined(result)) { return new Color(red, green, blue, alpha); } result.red = red; result.green = green; result.blue = blue; result.alpha = alpha; return result; }; /** * Creates a random color using the provided options. For reproducible random colors, you should * call {@link CesiumMath#setRandomNumberSeed} once at the beginning of your application. * * @param {object} [options] Object with the following properties: * @param {number} [options.red] If specified, the red component to use instead of a randomized value. * @param {number} [options.minimumRed=0.0] The maximum red value to generate if none was specified. * @param {number} [options.maximumRed=1.0] The minimum red value to generate if none was specified. * @param {number} [options.green] If specified, the green component to use instead of a randomized value. * @param {number} [options.minimumGreen=0.0] The maximum green value to generate if none was specified. * @param {number} [options.maximumGreen=1.0] The minimum green value to generate if none was specified. * @param {number} [options.blue] If specified, the blue component to use instead of a randomized value. * @param {number} [options.minimumBlue=0.0] The maximum blue value to generate if none was specified. * @param {number} [options.maximumBlue=1.0] The minimum blue value to generate if none was specified. * @param {number} [options.alpha] If specified, the alpha component to use instead of a randomized value. * @param {number} [options.minimumAlpha=0.0] The maximum alpha value to generate if none was specified. * @param {number} [options.maximumAlpha=1.0] The minimum alpha value to generate if none was specified. * @param {Color} [result] The object to store the result in, if undefined a new instance will be created. * @returns {Color} The modified result parameter or a new instance if result was undefined. * * @exception {DeveloperError} minimumRed must be less than or equal to maximumRed. * @exception {DeveloperError} minimumGreen must be less than or equal to maximumGreen. * @exception {DeveloperError} minimumBlue must be less than or equal to maximumBlue. * @exception {DeveloperError} minimumAlpha must be less than or equal to maximumAlpha. * * @example * //Create a completely random color * const color = Cesium.Color.fromRandom(); * * //Create a random shade of yellow. * const color1 = Cesium.Color.fromRandom({ * red : 1.0, * green : 1.0, * alpha : 1.0 * }); * * //Create a random bright color. * const color2 = Cesium.Color.fromRandom({ * minimumRed : 0.75, * minimumGreen : 0.75, * minimumBlue : 0.75, * alpha : 1.0 * }); */ Color.fromRandom = function (options, result) { options = options ?? Frozen.EMPTY_OBJECT; let red = options.red; if (!defined(red)) { const minimumRed = options.minimumRed ?? 0; const maximumRed = options.maximumRed ?? 1.0; //>>includeStart('debug', pragmas.debug); Check.typeOf.number.lessThanOrEquals("minimumRed", minimumRed, maximumRed); //>>includeEnd('debug'); red = minimumRed + CesiumMath.nextRandomNumber() * (maximumRed - minimumRed); } let green = options.green; if (!defined(green)) { const minimumGreen = options.minimumGreen ?? 0; const maximumGreen = options.maximumGreen ?? 1.0; //>>includeStart('debug', pragmas.debug); Check.typeOf.number.lessThanOrEquals( "minimumGreen", minimumGreen, maximumGreen, ); //>>includeEnd('debug'); green = minimumGreen + CesiumMath.nextRandomNumber() * (maximumGreen - minimumGreen); } let blue = options.blue; if (!defined(blue)) { const minimumBlue = options.minimumBlue ?? 0; const maximumBlue = options.maximumBlue ?? 1.0; //>>includeStart('debug', pragmas.debug); Check.typeOf.number.lessThanOrEquals( "minimumBlue", minimumBlue, maximumBlue, ); //>>includeEnd('debug'); blue = minimumBlue + CesiumMath.nextRandomNumber() * (maximumBlue - minimumBlue); } let alpha = options.alpha; if (!defined(alpha)) { const minimumAlpha = options.minimumAlpha ?? 0; const maximumAlpha = options.maximumAlpha ?? 1.0; //>>includeStart('debug', pragmas.debug); Check.typeOf.number.lessThanOrEquals( "minimumAlpha", minimumAlpha, maximumAlpha, ); //>>includeEnd('debug'); alpha = minimumAlpha + CesiumMath.nextRandomNumber() * (maximumAlpha - minimumAlpha); } if (!defined(result)) { return new Color(red, green, blue, alpha); } result.red = red; result.green = green; result.blue = blue; result.alpha = alpha; return result; }; //#rgba const rgbaMatcher = /^#([0-9a-f])([0-9a-f])([0-9a-f])([0-9a-f])?$/i; //#rrggbbaa const rrggbbaaMatcher = /^#([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})?$/i; //rgb(), rgba(), or rgb%() const rgbParenthesesMatcher = /^rgba?\s*\(\s*([0-9.]+%?)\s*[,\s]+\s*([0-9.]+%?)\s*[,\s]+\s*([0-9.]+%?)(?:\s*[,\s/]+\s*([0-9.]+))?\s*\)$/i; //hsl() or hsla() const hslParenthesesMatcher = /^hsla?\s*\(\s*([0-9.]+)\s*[,\s]+\s*([0-9.]+%)\s*[,\s]+\s*([0-9.]+%)(?:\s*[,\s/]+\s*([0-9.]+))?\s*\)$/i; /** * Creates a Color instance from a CSS color value. * * @param {string} color The CSS color value in #rgb, #rgba, #rrggbb, #rrggbbaa, rgb(), rgba(), hsl(), or hsla() format. * @param {Color} [result] The object to store the result in, if undefined a new instance will be created. * @returns {Color} The color object, or undefined if the string was not a valid CSS color. * * * @example * const cesiumBlue = Cesium.Color.fromCssColorString('#67ADDF'); * const green = Cesium.Color.fromCssColorString('green'); * * @see {@link http://www.w3.org/TR/css3-color|CSS color values} */ Color.fromCssColorString = function (color, result) { //>>includeStart('debug', pragmas.debug); Check.typeOf.string("color", color); //>>includeEnd('debug'); if (!defined(result)) { result = new Color(); } // Remove all surrounding whitespaces from the color string color = color.trim(); const namedColor = Color[color.toUpperCase()]; if (defined(namedColor)) { Color.clone(namedColor, result); return result; } let matches = rgbaMatcher.exec(color); if (matches !== null) { result.red = parseInt(matches[1], 16) / 15; result.green = parseInt(matches[2], 16) / 15.0; result.blue = parseInt(matches[3], 16) / 15.0; result.alpha = parseInt(matches[4] ?? "f", 16) / 15.0; return result; } matches = rrggbbaaMatcher.exec(color); if (matches !== null) { result.red = parseInt(matches[1], 16) / 255.0; result.green = parseInt(matches[2], 16) / 255.0; result.blue = parseInt(matches[3], 16) / 255.0; result.alpha = parseInt(matches[4] ?? "ff", 16) / 255.0; return result; } matches = rgbParenthesesMatcher.exec(color); if (matches !== null) { result.red = parseFloat(matches[1]) / ("%" === matches[1].substr(-1) ? 100.0 : 255.0); result.green = parseFloat(matches[2]) / ("%" === matches[2].substr(-1) ? 100.0 : 255.0); result.blue = parseFloat(matches[3]) / ("%" === matches[3].substr(-1) ? 100.0 : 255.0); result.alpha = parseFloat(matches[4] ?? "1.0"); return result; } matches = hslParenthesesMatcher.exec(color); if (matches !== null) { return Color.fromHsl( parseFloat(matches[1]) / 360.0, parseFloat(matches[2]) / 100.0, parseFloat(matches[3]) / 100.0, parseFloat(matches[4] ?? "1.0"), result, ); } result = undefined; return result; }; /** * The number of elements used to pack the object into an array. * @type {number} */ Color.packedLength = 4; /** * Stores the provided instance into the provided array. * * @param {Color} 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 */ Color.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); Check.typeOf.object("value", value); Check.defined("array", array); //>>includeEnd('debug'); startingIndex = startingIndex ?? 0; array[startingIndex++] = value.red; array[startingIndex++] = value.green; array[startingIndex++] = value.blue; array[startingIndex] = value.alpha; 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 {Color} [result] The object into which to store the result. * @returns {Color} The modified result parameter or a new Color instance if one was not provided. */ Color.unpack = function (array, startingIndex, result) { //>>includeStart('debug', pragmas.debug); Check.defined("array", array); //>>includeEnd('debug'); startingIndex = startingIndex ?? 0; if (!defined(result)) { result = new Color(); } result.red = array[startingIndex++]; result.green = array[startingIndex++]; result.blue = array[startingIndex++]; result.alpha = array[startingIndex]; return result; }; /** * Converts a 'byte' color component in the range of 0 to 255 into * a 'float' color component in the range of 0 to 1.0. * * @param {number} number The number to be converted. * @returns {number} The converted number. */ Color.byteToFloat = function (number) { return number / 255.0; }; /** * Converts a 'float' color component in the range of 0 to 1.0 into * a 'byte' color component in the range of 0 to 255. * * @param {number} number The number to be converted. * @returns {number} The converted number. */ Color.floatToByte = function (number) { return number === 1.0 ? 255.0 : (number * 256.0) | 0; }; /** * Duplicates a Color. * * @param {Color} color The Color to duplicate. * @param {Color} [result] The object to store the result in, if undefined a new instance will be created. * @returns {Color} The modified result parameter or a new instance if result was undefined. (Returns undefined if color is undefined) */ Color.clone = function (color, result) { if (!defined(color)) { return undefined; } if (!defined(result)) { return new Color(color.red, color.green, color.blue, color.alpha); } result.red = color.red; result.green = color.green; result.blue = color.blue; result.alpha = color.alpha; return result; }; /** * Returns true if the first Color equals the second color. * * @param {Color} [left] The first Color to compare for equality. * @param {Color} [right] The second Color to compare for equality. * @returns {boolean} <code>true</code> if the Colors are equal; otherwise, <code>false</code>. */ Color.equals = function (left, right) { return ( left === right || // (defined(left) && // defined(right) && // left.red === right.red && // left.green === right.green && // left.blue === right.blue && // left.alpha === right.alpha) ); }; /** * @private */ Color.equalsArray = function (color, array, offset) { return ( color.red === array[offset] && color.green === array[offset + 1] && color.blue === array[offset + 2] && color.alpha === array[offset + 3] ); }; /** * Returns a duplicate of a Color instance. * * @param {Color} [result] The object to store the result in, if undefined a new instance will be created. * @returns {Color} The modified result parameter or a new instance if result was undefined. */ Color.prototype.clone = function (result) { return Color.clone(this, result); }; /** * Returns true if this Color equals other. * * @param {Color} [other] The Color to compare for equality. * @returns {boolean} <code>true</code> if the Colors are equal; otherwise, <code>false</code>. */ Color.prototype.equals = function (other) { return Color.equals(this, other); }; /** * Returns <code>true</code> if this Color equals other componentwise within the specified epsilon. * * @param {Color} other The Color to compare for equality. * @param {number} [epsilon=0.0] The epsilon to use for equality testing. * @returns {boolean} <code>true</code> if the Colors are equal within the specified epsilon; otherwise, <code>false</code>. */ Color.prototype.equalsEpsilon = function (other, epsilon) { return ( this === other || // (defined(other) && // Math.abs(this.red - other.red) <= epsilon && // Math.abs(this.green - other.green) <= epsilon && // Math.abs(this.blue - other.blue) <= epsilon && // Math.abs(this.alpha - other.alpha) <= epsilon) ); }; /** * Creates a string representing this Color in the format '(red, green, blue, alpha)'. * * @returns {string} A string representing this Color in the format '(red, green, blue, alpha)'. */ Color.prototype.toString = function () { return `(${this.red}, ${this.green}, ${this.blue}, ${this.alpha})`; }; /** * Creates a string containing the CSS color value for this color. * * @returns {string} The CSS equivalent of this color. * * @see {@link http://www.w3.org/TR/css3-color/#rgba-color|CSS RGB or RGBA color values} */ Color.prototype.toCssColorString = function () { const red = Color.floatToByte(this.red); const green = Color.floatToByte(this.green); const blue = Color.floatToByte(this.blue); if (this.alpha === 1) { return `rgb(${red},${green},${blue})`; } return `rgba(${red},${green},${blue},${this.alpha})`; }; /** * Creates a string containing CSS hex string color value for this color. * * @returns {string} The CSS hex string equivalent of this color. */ Color.prototype.toCssHexString = function () { let r = Color.floatToByte(this.red).toString(16); if (r.length < 2) { r = `0${r}`; } let g = Color.floatToByte(this.green).toString(16); if (g.length < 2) { g = `0${g}`; } let b = Color.floatToByte(this.blue).toString(16); if (b.length < 2) { b = `0${b}`; } if (this.alpha < 1) { let hexAlpha = Color.floatToByte(this.alpha).toString(16); if (hexAlpha.length < 2) { hexAlpha = `0${hexAlpha}`; } return `#${r}${g}${b}${hexAlpha}`; } return `#${r}${g}${b}`; }; /** * Converts this color to an array of red, green, blue, and alpha values * that are in the range of 0 to 255. * * @param {number[]} [result] The array to store the result in, if undefined a new instance will be created. * @returns {number[]} The modified result parameter or a new instance if result was undefined. */ Color.prototype.toBytes = function (result) { const red = Color.floatToByte(this.red); const green = Color.floatToByte(this.green); const blue = Color.floatToByte(this.blue); const alpha = Color.floatToByte(this.alpha); if (!defined(result)) { return [red, green, blue, alpha]; } result[0] = red; result[1] = green; result[2] = blue; result[3] = alpha; return result; }; /** * Converts RGBA values in bytes to a single numeric unsigned 32-bit RGBA value, using the endianness * of the system. * * @returns {number} A single numeric unsigned 32-bit RGBA value. * * @see Color.toRgba */ Color.bytesToRgba = function (red, green, blue, alpha) { // scratchUint32Array and scratchUint8Array share an underlying array buffer scratchUint8Array[0] = red; scratchUint8Array[1] = green; scratchUint8Array[2] = blue; scratchUint8Array[3] = alpha; return scratchUint32Array[0]; }; /** * Converts this color to a single numeric unsigned 32-bit RGBA value, using the endianness * of the system. * * @returns {number} A single numeric unsigned 32-bit RGBA value. * * * @example * const rgba = Cesium.Color.BLUE.toRgba(); * * @see Color.fromRgba */ Color.prototype.toRgba = function () { return Color.bytesToRgba( Color.floatToByte(this.red), Color.floatToByte(this.green), Color.floatToByte(this.blue), Color.floatToByte(this.alpha), ); }; /** * Brightens this color by the provided magnitude. * * @param {number} magnitude A positive number indicating the amount to brighten. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. * * @example * const brightBlue = Cesium.Color.BLUE.brighten(0.5, new Cesium.Color()); */ Color.prototype.brighten = function (magnitude, result) { //>>includeStart('debug', pragmas.debug); Check.typeOf.number("magnitude", magnitude); Check.typeOf.number.greaterThanOrEquals("magnitude", magnitude, 0.0); Check.typeOf.object("result", result); //>>includeEnd('debug'); magnitude = 1.0 - magnitude; result.red = 1.0 - (1.0 - this.red) * magnitude; result.green = 1.0 - (1.0 - this.green) * magnitude; result.blue = 1.0 - (1.0 - this.blue) * magnitude; result.alpha = this.alpha; return result; }; /** * Darkens this color by the provided magnitude. * * @param {number} magnitude A positive number indicating the amount to darken. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. * * @example * const darkBlue = Cesium.Color.BLUE.darken(0.5, new Cesium.Color()); */ Color.prototype.darken = function (magnitude, result) { //>>includeStart('debug', pragmas.debug); Check.typeOf.number("magnitude", magnitude); Check.typeOf.number.greaterThanOrEquals("magnitude", magnitude, 0.0); Check.typeOf.object("result", result); //>>includeEnd('debug'); magnitude = 1.0 - magnitude; result.red = this.red * magnitude; result.green = this.green * magnitude; result.blue = this.blue * magnitude; result.alpha = this.alpha; return result; }; /** * Creates a new Color that has the same red, green, and blue components * as this Color, but with the specified alpha value. * * @param {number} alpha The new alpha component. * @param {Color} [result] The object onto which to store the result. * @returns {Color} The modified result parameter or a new Color instance if one was not provided. * * @example const translucentRed = Cesium.Color.RED.withAlpha(0.9); */ Color.prototype.withAlpha = function (alpha, result) { return Color.fromAlpha(this, alpha, result); }; /** * Computes the componentwise sum of two Colors. * * @param {Color} left The first Color. * @param {Color} right The second Color. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. */ Color.add = function (left, right, result) { //>>includeStart('debug', pragmas.debug); Check.typeOf.object("left", left); Check.typeOf.object("right", right); Check.typeOf.object("result", result); //>>includeEnd('debug'); result.red = left.red + right.red; result.green = left.green + right.green; result.blue = left.blue + right.blue; result.alpha = left.alpha + right.alpha; return result; }; /** * Computes the componentwise difference of two Colors. * * @param {Color} left The first Color. * @param {Color} right The second Color. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. */ Color.subtract = function (left, right, result) { //>>includeStart('debug', pragmas.debug); Check.typeOf.object("left", left); Check.typeOf.object("right", right); Check.typeOf.object("result", result); //>>includeEnd('debug'); result.red = left.red - right.red; result.green = left.green - right.green; result.blue = left.blue - right.blue; result.alpha = left.alpha - right.alpha; return result; }; /** * Computes the componentwise product of two Colors. * * @param {Color} left The first Color. * @param {Color} right The second Color. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. */ Color.multiply = function (left, right, result) { //>>includeStart('debug', pragmas.debug); Check.typeOf.object("left", left); Check.typeOf.object("right", right); Check.typeOf.object("result", result); //>>includeEnd('debug'); result.red = left.red * right.red; result.green = left.green * right.green; result.blue = left.blue * right.blue; result.alpha = left.alpha * right.alpha; return result; }; /** * Computes the componentwise quotient of two Colors. * * @param {Color} left The first Color. * @param {Color} right The second Color. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. */ Color.divide = function (left, right, result) { //>>includeStart('debug', pragmas.debug); Check.typeOf.object("left", left); Check.typeOf.object("right", right); Check.typeOf.object("result", result); //>>includeEnd('debug'); result.red = left.red / right.red; result.green = left.green / right.green; result.blue = left.blue / right.blue; result.alpha = left.alpha / right.alpha; return result; }; /** * Computes the componentwise modulus of two Colors. * * @param {Color} left The first Color. * @param {Color} right The second Color. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. */ Color.mod = function (left, right, result) { //>>includeStart('debug', pragmas.debug); Check.typeOf.object("left", left); Check.typeOf.object("right", right); Check.typeOf.object("result", result); //>>includeEnd('debug'); result.red = left.red % right.red; result.green = left.green % right.green; result.blue = left.blue % right.blue; result.alpha = left.alpha % right.alpha; return result; }; /** * Computes the linear interpolation or extrapolation at t between the provided colors. * * @param {Color} start The color corresponding to t at 0.0. * @param {Color} end The color corresponding to t at 1.0. * @param {number} t The point along t at which to interpolate. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. */ Color.lerp = function (start, end, t, result) { //>>includeStart('debug', pragmas.debug); Check.typeOf.object("start", start); Check.typeOf.object("end", end); Check.typeOf.number("t", t); Check.typeOf.object("result", result); //>>includeEnd('debug'); result.red = CesiumMath.lerp(start.red, end.red, t); result.green = CesiumMath.lerp(start.green, end.green, t); result.blue = CesiumMath.lerp(start.blue, end.blue, t); result.alpha = CesiumMath.lerp(start.alpha, end.alpha, t); return result; }; /** * Multiplies the provided Color componentwise by the provided scalar. * * @param {Color} color The Color to be scaled. * @param {number} scalar The scalar to multiply with. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. */ Color.multiplyByScalar = function (color, scalar, result) { //>>includeStart('debug', pragmas.debug); Check.typeOf.object("color", color); Check.typeOf.number("scalar", scalar); Check.typeOf.object("result", result); //>>includeEnd('debug'); result.red = color.red * scalar; result.green = color.green * scalar; result.blue = color.blue * scalar; result.alpha = color.alpha * scalar; return result; }; /** * Divides the provided Color componentwise by the provided scalar. * * @param {Color} color The Color to be divided. * @param {number} scalar The scalar to divide with. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. */ Color.divideByScalar = function (color, scalar, result) { //>>includeStart('debug', pragmas.debug); Check.typeOf.object("color", color); Check.typeOf.number("scalar", scalar); Check.typeOf.object("result", result); //>>includeEnd('debug'); result.red = color.red / scalar; result.green = color.green / scalar; result.blue = color.blue / scalar; result.alpha = color.alpha / scalar; return result; }; /** * An immutable Color instance initialized to CSS color #F0F8FF * <span class="colorSwath" style="background: #F0F8FF;"></span> * * @constant * @type {Color} */ Color.ALICEBLUE = Object.freeze(Color.fromCssColorString("#F0F8FF")); /** * An immutable Color instance initialized to CSS color #FAEBD7 * <span class="colorSwath" style="background: #FAEBD7;"></span> * * @constant * @type {Color} */ Color.ANTIQUEWHITE = Object.freeze(Color.fromCssColorString("#FAEBD7")); /** * An immutable Color instance initialized to CSS color #00FFFF * <span class="colorSwath" style="background: #00FFFF;"></span> * * @constant * @type {Color} */ Color.AQUA = Object.freeze(Color.fromCssColorString("#00FFFF")); /** * An immutable Color instance initialized to CSS color #7FFFD4 * <span class="colorSwath" style="background: #7FFFD4;"></span> * * @constant * @type {Color} */ Color.AQUAMARINE = Object.freeze(Color.fromCssColorString("#7FFFD4")); /** * An immutable Color instance initialized to CSS color #F0FFFF * <span class="colorSwath" style="background: #F0FFFF;"></span> * * @constant * @type {Color} */ Color.AZURE = Object.freeze(Color.fromCssColorString("#F0FFFF")); /** * An immutable Color instance initialized to CSS color #F5F5DC * <span class="colorSwath" style="background: #F5F5DC;"></span> * * @constant * @type {Color} */ Color.BEIGE = Object.freeze(Color.fromCssColorString("#F5F5DC")); /** * An immutable Color instance initialized to CSS color #FFE4C4 * <span class="colorSwath" style="background: #FFE4C4;"></span> * * @constant * @type {Color} */ Color.BISQUE = Object.freeze(Color.fromCssColorString("#FFE4C4")); /** * An immutable Color instance initialized to CSS color #000000 * <span class="colorSwath" style="background: #000000;"></span> * * @constant * @type {Color} */ Color.BLACK = Object.freeze(Color.fromCssColorString("#000000")); /** * An immutable Color instance initialized to CSS color #FFEBCD * <span class="colorSwath" style="background: #FFEBCD;"></span> * * @constant * @type {Color} */ Color.BLANCHEDALMOND = Object.freeze(Color.fromCssColorString("#FFEBCD")); /** * An immutable Color instance initialized to CSS color #0000FF * <span class="colorSwath" style="background: #0000FF;"></span> * * @constant * @type {Color} */ Color.BLUE = Object.freeze(Color.fromCssColorString("#0000FF")); /** * An immutable Color instance initialized to CSS color #8A2BE2 * <span class="colorSwath" style="background: #8A2BE2;"></span> * * @constant * @type {Color} */ Color.BLUEVIOLET = Object.freeze(Color.fromCssColorString("#8A2BE2")); /** * An immutable Color instance initialized to CSS color #A52A2A * <span class="colorSwath" style="background: #A52A2A;"></span> * * @constant * @type {Color} */ Color.BROWN = Object.freeze(Color.fromCssColorString("#A52A2A")); /** * An immutable Color instance initialized to CSS color #DEB887 * <span class="colorSwath" style="background: #DEB887;"></span> * * @constant * @type {Color} */ Color.BURLYWOOD = Object.freeze(Color.fromCssColorString("#DEB887")); /** * An immutable Color instance initialized to CSS color #5F9EA0 * <span class="colorSwath" style="background: #5F9EA0;"></span> * * @constant * @type {Color} */ Color.CADETBLUE = Object.freeze(Color.fromCssColorString("#5F9EA0")); /** * An immutable Color instance initialized to CSS color #7FFF00 * <span class="colorSwath" style="background: #7FFF00;"></span> * * @constant * @type {Color} */ Color.CHARTREUSE = Object.freeze(Color.fromCssColorString("#7FFF00")); /** * An immutable Color instance initialized to CSS color #D2691E * <span class="colorSwath" style="background: #D2691E;"></span> * * @constant * @type {Color} */ Color.CHOCOLATE = Object.freeze(Color.fromCssColorString("#D2691E")); /** * An immutable Color instance initialized to CSS color #FF7F50 * <span class="colorSwath" style="background: #FF7F50;"></span> * * @constant * @type {Color} */ Color.CORAL = Object.freeze(Color.fromCssColorString("#FF7F50")); /** * An immutable Color instance initialized to CSS color #6495ED * <span class="colorSwath" style="background: #6495ED;"></span> * * @constant * @type {Color} */ Color.CORNFLOWERBLUE = Object.freeze(Color.fromCssColorString("#6495ED")); /** * An immutable Color instance initialized to CSS color #FFF8DC * <span class="colorSwath" style="background: #FFF8DC;"></span> * * @constant * @type {Color} */ Color.CORNSILK = Object.freeze(Color.fromCssColorString("#FFF8DC")); /** * An immutable Color instance initialized to CSS color #DC143C * <span class="colorSwath" style="background: #DC143C;"></span> * * @constant * @type {Color} */ Color.CRIMSON = Object.freeze(Color.fromCssColorString("#DC143C")); /** * An immutable Color instance initialized to CSS color #00FFFF * <span class="colorSwath" style="background: #00FFFF;"></span> * * @constant * @type {Color} */ Color.CYAN = Object.freeze(Color.fromCssColorString("#00FFFF")); /** * An immutable Color instance initialized to CSS color #00008B * <span class="colorSwath" style="background: #00008B;"></span> * * @constant * @type {Color} */ Color.DARKBLUE = Object.freeze(Color.fromCssColorString("#00008B")); /** * An immutable Color instance initialized to CSS color #008B8B * <span class="colorSwath" style="background: #008B8B;"></span> * * @constant * @type {Color} */ Color.DARKCYAN = Object.freeze(Color.fromCssColorString("#008B8B")); /** * An immutable Color instance initialized to CSS color #B8860B * <span class="colorSwath" style="background: #B8860B;"></span> * * @constant * @type {Color} */ Color.DARKGOLDENROD = Object.freeze(Color.fromCssColorString("#B8860B")); /** * An immutable Color instance initialized to CSS color #A9A9A9 * <span class="colorSwath" style="background: #A9A9A9;"></span> * * @constant * @type {Color} */ Color.DARKGRAY = Object.freeze(Color.fromCssColorString("#A9A9A9")); /** * An immutable Color instance initialized to CSS color #006400 * <span class="colorSwath" style="background: #006400;"></span> * * @constant * @type {Color} */ Color.DARKGREEN = Object.freeze(Color.fromCssColorString("#006400")); /** * An immutable Color instance initialized to CSS color #A9A9A9 * <span class="colorSwath" style="background: #A9A9A9;"></span> * * @constant * @type {Color} */ Color.DARKGREY = Color.DARKGRAY; /** * An immutable Color instance initialized to CSS color #BDB76B * <span class="colorSwath" style="background: #BDB76B;"></span> * * @constant * @type {Color} */ Color.DARKKHAKI = Object.freeze(Color.fromCssColorString("#BDB76B")); /** * An immutable Color instance initialized to CSS color #8B008B * <span class="colorSwath" style="background: #8B008B;"></span> * * @constant * @type {Color} */ Color.DARKMAGENTA = Object.freeze(Color.fromCssColorString("#8B008B")); /** * An immutable Color instance initialized to CSS color #556B2F * <span class="colorSwath" style="background: #556B2F;"></span> * * @constant * @type {Color} */ Color.DARKOLIVEGREEN = Object.freeze(Color.fromCssColorString("#556B2F")); /** * An immutable Color instance initialized to CSS color #FF8C00 * <span class="colorSwath" style="background: #FF8C00;"></span> * * @constant * @type {Color} */ Color.DARKORANGE = Object.freeze(Color.fromCssColorString("#FF8C00")); /** * An immutable Color instance initialized to CSS color #9932CC * <span class="colorSwath" style="background: #9932CC;"></span> * * @constant * @type {Color} */ Color.DARKORCHID = Object.freeze(Color.fromCssColorString("#9932CC")); /** * An immutable Color instance initialized to CSS color #8B0000 * <span class="colorSwath" style="background: #8B0000;"></span> * * @constant * @type {Color} */ Color.DARKRED = Object.freeze(Color.fromCssColorString("#8B0000")); /** * An immutable Color instance initialized to CSS color #E9967A * <span class="colorSwath" style="background: #E9967A;"></span> * * @constant * @type {Color} */ Color.DARKSALMON = Object.freeze(Color.fromCssColorString("#E9967A")); /** * An immutable Color instance initialized to CSS color #8FBC8F * <span class="colorSwath" style="background: #8FBC8F;"></span> * * @constant * @type {Color} */ Color.DARKSEAGREEN = Object.freeze(Color.fromCssColorString("#8FBC8F")); /** * An immutable Color instance initialized to CSS color #483D8B * <span class="colorSwath" style="background: #483D8B;"></span> * * @constant * @type {Color} */ Color.DARKSLATEBLUE = Object.freeze(Color.fromCssColorString("#483D8B")); /** * An immutable Color instance initialized to CSS color #2F4F4F * <span class="colorSwath" style="background: #2F4F4F;"></span> * * @constant * @type {Color} */ Color.DARKSLATEGRAY = Object.freeze(Color.fromCssColorString("#2F4F4F")); /** * An immutable Color instance initialized to CSS color #2F4F4F * <span class="colorSwath" style="background: #2F4F4F;"></span> * * @constant * @type {Color} */ Color.DARKSLATEGREY = Color.DARKSLATEGRAY; /** * An immutable Color instance initialized to CSS color #00CED1 * <span class="colorSwath" style="background: #00CED1;"></span> * * @constant * @type {Color} */ Color.DARKTURQUOISE = Object.freeze(Color.fromCssColorString("#00CED1")); /** * An immutable Color instance initialized to CSS color #9400D3 * <span class="colorSwath" style="background: #9400D3;"></span> * * @constant * @type {Color} */ Color.DARKVIOLET = Object.freeze(Color.fromCssColorString("#9400D3")); /** * An immutable Color instance initialized to CSS color #FF1493 * <span class="colorSwath" style="background: #FF1493;"></span> * * @constant * @type {Color} */ Color.DEEPPINK = Object.freeze(Color.fromCssColorString("#FF1493")); /** * An immutable Color instance initialized to CSS color #00BFFF * <span class="colorSwath" style="background: #00BFFF;"></span> * * @constant * @type {Color} */ Color.DEEPSKYBLUE = Object.freeze(Color.fromCssColorString("#00BFFF")); /** * An immutable Color instance initialized to CSS color #696969 * <span class="colorSwath" style="background: #696969;"></span> * * @constant * @type {Color} */ Color.DIMGRAY = Object.freeze(Color.fromCssColorString("#696969")); /** * An immutable Color instance initialized to CSS color #696969 * <span class="colorSwath" style="background: #696969;"></span> * * @constant * @type {Color} */ Color.DIMGREY = Color.DIMGRAY; /** * An immutable Color instance initialized to CSS color #1E90FF * <span class="colorSwath" style="background: #1E90FF;"></span> * * @constant * @type {Color} */ Color.DODGERBLUE = Object.freeze(Color.fromCssColorString("#1E90FF")); /** * An immutable Color instance initialized to CSS color #B22222 * <span class="colorSwath" style="background: #B22222;"></span> * * @constant * @type {Color} */ Color.FIREBRICK = Object.freeze(Color.fromCssColorString("#B22222")); /** * An immutable Color instance initialized to CSS color #FFFAF0 * <span class="colorSwath" style="background: #FFFAF0;"></span> * * @constant * @type {Color} */ Color.FLORALWHITE = Object.freeze(Color.fromCssColorString("#FFFAF0")); /** * An immutable Color instance initialized to CSS color #228B22 * <span class="colorSwath" style="background: #228B22;"></span> * * @constant * @type {Color} */ Color.FORESTGREEN = Object.freeze(Color.fromCssColorString("#228B22")); /** * An immutable Color instance initialized to CSS color #FF00FF * <span class="colorSwath" style="background: #FF00FF;"></span> * * @constant * @type {Color} */ Color.FUCHSIA = Object.freeze(Color.fromCssColorString("#FF00FF")); /** * An immutable Color instance initialized to CSS color #DCDCDC * <span class="colorSwath" style="background: #DCDCDC;"></span> * * @constant * @type {Color} */ Color.GAINSBORO = Object.freeze(Color.fromCssColorString("#DCDCDC")); /** * An immutable Color instance initialized to CSS color #F8F8FF * <span class="colorSwath" style="background: #F8F8FF;"></span> * * @constant * @type {Color} */ Color.GHOSTWHITE = Object.freeze(Color.fromCssColorString("#F8F8FF")); /** * An immutable Color instance initialized to CSS color #FFD700 * <span class="colorSwath" style="background: #FFD700;"></span> * * @constant * @type {Color} */ Color.GOLD = Object.freeze(Color.fromCssColorString("#FFD700")); /** * An immutable Color instance initialized to CSS color #DAA520 * <span class="colorSwath" style="background: #DAA520;"></span> * * @constant * @type {Color} */ Color.GOLDENROD = Object.freeze(Color.fromCssColorString("#DAA520")); /** * An immutable Color instance initialized to CSS color #808080 * <span class="colorSwath" style="background: #808080;"></span> * * @constant * @type {Color} */ Color.GRAY = Object.freeze(Color.fromCssColorString("#808080")); /** * An immutable Color instance initialized to CSS color #008000 * <span class="colorSwath" style="background: #008000;"></span> * * @constant * @type {Color} */ Color.GREEN = Object.freeze(Color.fromCssColorString("#008000")); /** * An immutable Color instance initialized to CSS color #ADFF2F * <span class="colorSwath" style="background: #ADFF2F;"></span> * * @constant * @type {Color} */ Color.GREENYELLOW = Object.freeze(Color.fromCssColorString("#ADFF2F")); /** * An immutable Color instance initialized to CSS color #808080 * <span class="colorSwath" style="background: #808080;"></span> * * @constant * @type {Color} */ Color.GREY = Color.GRAY; /** * An immutable Color instance initialized to CSS color #F0FFF0 * <span class="colorSwath" style="background: #F0FFF0;"></span> * * @constant * @type {Color} */ Color.HONEYDEW = Object.freeze(Color.fromCssColorString("#F0FFF0")); /** * An immutable Color instance initialized to CSS color #FF69B4 * <span class="colorSwath" style="background: #FF69B4;"></span> * * @constant * @type {Color} */ Color.HOTPINK = Object.freeze(Color.fromCssColorString("#FF69B4")); /** * An immutable Color instance initialized to CSS color #CD5C5C * <span class="colorSwath" style="background: #CD5C5C;"></span> * * @constant * @type {Color} */ Color.INDIANRED = Object.freeze(Color.fromCssColorString("#CD5C5C")); /** * An immutable Color instance initialized to CSS color #4B0082 * <span class="colorSwath" style="background: #4B0082;"></span> * * @constant * @type {Color} */ Color.INDIGO = Object.freeze(Color.fromCssColorString("#4B0082")); /** * An immutable Color instance initialized to CSS color #FFFFF0 * <span class="colorSwath" style="background: #FFFFF0;"></span> * * @constant * @type {Color} */ Color.IVORY = Object.freeze(Color.fromCssColorString("#FFFFF0")); /** * An immutable Color instance initialized to CSS color #F0E68C * <span class="colorSwath" style="background: #F0E68C;"></span> * * @constant * @type {Color} */ Color.KHAKI = Object.freeze(Color.fromCssColorString("#F0E68C")); /** * An immutable Color instance initialized to CSS color #E6E6FA * <span class="colorSwath" style="background: #E6E6FA;"></span> * * @constant * @type {Color} */ Color.LAVENDER = Object.freeze(Color.fromCssColorString("#E6E6FA")); /** * An immutable Color instance initialized to CSS color #FFF0F5 * <span class="colorSwath" style="background: #FFF0F5;"></span> * * @constant * @type {Color} */ Color.LAVENDAR_BLUSH = Object.freeze(Color.fromCssColorString("#FFF0F5")); /** * An immutable Color instance initialized to CSS color #7CFC00 * <span class="colorSwath" style="background: #7CFC00;"></span> * * @constant * @type {Color} */ Color.LAWNGREEN = Object.freeze(Color.fromCssColorString("#7CFC00")); /** * An immutable Color instance initialized to CSS color #FFFACD * <span class="colorSwath" style="background: #FFFACD;"></span> * * @constant * @type {Color} */ Color.LEMONCHIFFON = Object.freeze(Color.fromCssColorString("#FFFACD")); /** * An immutable Color instance initialized to CSS color #ADD8E6 * <span class="colorSwath" style="background: #ADD8E6;"></span> * * @constant * @type {Color} */ Color.LIGHTBLUE = Object.freeze(Color.fromCssColorString("#ADD8E6")); /** * An immutable Color instance initialized to CSS color #F08080 * <span class="colorSwath" style="background: #F08080;"></span> * * @constant * @type {Color} */ Color.LIGHTCORAL = Object.freeze(Color.fromCssColorString("#F08080")); /** * An immutable Color instance initialized to CSS color #E0FFFF * <span class="colorSwath" style="background: #E0FFFF;"></span> * * @constant * @type {Color} */ Color.LIGHTCYAN = Object.freeze(Color.fromCssColorString("#E0FFFF")); /** * An immutable Color instance initialized to CSS color #FAFAD2 * <span class="colorSwath" style="background: #FAFAD2;"></span> * * @constant * @type {Color} */ Color.LIGHTGOLDENRODYELLOW = Object.freeze(Color.fromCssColorString("#FAFAD2")); /** * An immutable Color instance initialized to CSS color #D3D3D3 * <span class="colorSwath" style="background: #D3D3D3;"></span> * * @constant * @type {Color} */ Color.LIGHTGRAY = Object.freeze(Color.fromCssColorString("#D3D3D3")); /** * An immutable Color instance initialized to CSS color #90EE90 * <span class="colorSwath" style="background: #90EE90;"></span> * * @constant * @type {Color} */ Color.LIGHTGREEN = Object.freeze(Color.fromCssColorString("#90EE90")); /** * An immutable Color instance initialized to CSS color #D3D3D3 * <span class="colorSwath" style="background: #D3D3D3;"></span> * * @constant * @type {Color} */ Color.LIGHTGREY = Color.LIGHTGRAY; /** * An immutable Color instance initialized to CSS color #FFB6C1 * <span class="colorSwath" style="background: #FFB6C1;"></span> * * @constant * @type {Color} */ Color.LIGHTPINK = Object.freeze(Color.fromCssColorString("#FFB6C1")); /** * An immutable Color instance initialized to CSS color #20B2AA * <span class="colorSwath" style="background: #20B2AA;"></span> * * @constant * @type {Color} */ Color.LIGHTSEAGREEN = Object.freeze(Color.fromCssColorString("#20B2AA")); /** * An immutable Color instance initialized to CSS color #87CEFA * <span class="colorSwath" style="background: #87CEFA;"></span> * * @constant * @type {Color} */ Color.LIGHTSKYBLUE = Object.freeze(Color.fromCssColorString("#87CEFA")); /** * An immutable Color instance initialized to CSS color #778899 * <span class="colorSwath" style="background: #778899;"></span> * * @constant * @type {Color} */ Color.LIGHTSLATEGRAY = Object.freeze(Color.fromCssColorString("#778899")); /** * An immutable Color instance initialized to CSS color #778899 * <span class="colorSwath" style="background: #778899;"></span> * * @constant * @type {Color} */ Color.LIGHTSLATEGREY = Color.LIGHTSLATEGRAY; /** * An immutable Color instance initialized to CSS color #B0C4DE * <span class="colorSwath" style="background: #B0C4DE;"></span> * * @constant * @type {Color} */ Color.LIGHTSTEELBLUE = Object.freeze(Color.fromCssColorString("#B0C4DE")); /** * An immutable Color instance initialized to CSS color #FFFFE0 * <span class="colorSwath" style="background: #FFFFE0;"></span> * * @constant * @type {Color} */ Color.LIGHTYELLOW = Object.freeze(Color.fromCssColorString("#FFFFE0")); /** * An immutable Color instance initialized to CSS color #00FF00 * <span class="colorSwath" style="background: #00FF00;"></span> * * @constant * @type {Color} */ Color.LIME = Object.freeze(Color.fromCssColorString("#00FF00")); /** * An immutable Color instance initialized to CSS color #32CD32 * <span class="colorSwath" sty