Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 | 1x 1x 1x 77x 77x 77x 77x 77x 77x 77x 77x 77x 77x 77x 77x 77x 77x 1x 5x 137x 1x 2x 1x 1x 5x 1x 5x 4x 5x 5x 5x 5x 5x 1x 8x | import Cartesian2 from "../Core/Cartesian2.js";
import Color from "../Core/Color.js";
import Frozen from "../Core/Frozen.js";
import defined from "../Core/defined.js";
import Event from "../Core/Event.js";
import JulianDate from "../Core/JulianDate.js";
import createPropertyDescriptor from "./createPropertyDescriptor.js";
import Property from "./Property.js";
const defaultRepeat = new Cartesian2(1, 1);
const defaultTransparent = false;
const defaultColor = Color.WHITE;
/**
* A {@link MaterialProperty} that maps to image {@link Material} uniforms.
* @alias ImageMaterialProperty
* @constructor
*
* @param {object} [options] Object with the following properties:
* @param {Property|string|HTMLImageElement|HTMLCanvasElement|HTMLVideoElement} [options.image] A Property specifying the Image, URL, Canvas, or Video.
* @param {Property|Cartesian2} [options.repeat=new Cartesian2(1.0, 1.0)] A {@link Cartesian2} Property specifying the number of times the image repeats in each direction.
* @param {Property|Color} [options.color=Color.WHITE] The color applied to the image
* @param {Property|boolean} [options.transparent=false] Set to true when the image has transparency (for example, when a png has transparent sections)
*/
function ImageMaterialProperty(options) {
options = options ?? Frozen.EMPTY_OBJECT;
this._definitionChanged = new Event();
this._image = undefined;
this._imageSubscription = undefined;
this._repeat = undefined;
this._repeatSubscription = undefined;
this._color = undefined;
this._colorSubscription = undefined;
this._transparent = undefined;
this._transparentSubscription = undefined;
this.image = options.image;
this.repeat = options.repeat;
this.color = options.color;
this.transparent = options.transparent;
}
Object.defineProperties(ImageMaterialProperty.prototype, {
/**
* Gets a value indicating if this property is constant. A property is considered
* constant if getValue always returns the same result for the current definition.
* @memberof ImageMaterialProperty.prototype
*
* @type {boolean}
* @readonly
*/
isConstant: {
get: function () {
return (
Property.isConstant(this._image) && Property.isConstant(this._repeat)
);
},
},
/**
* Gets the event that is raised whenever the definition of this property changes.
* The definition is considered to have changed if a call to getValue would return
* a different result for the same time.
* @memberof ImageMaterialProperty.prototype
*
* @type {Event}
* @readonly
*/
definitionChanged: {
get: function () {
return this._definitionChanged;
},
},
/**
* Gets or sets the Property specifying Image, URL, Canvas, or Video to use.
* @memberof ImageMaterialProperty.prototype
* @type {Property|undefined}
*/
image: createPropertyDescriptor("image"),
/**
* Gets or sets the {@link Cartesian2} Property specifying the number of times the image repeats in each direction.
* @memberof ImageMaterialProperty.prototype
* @type {Property|undefined}
* @default new Cartesian2(1, 1)
*/
repeat: createPropertyDescriptor("repeat"),
/**
* Gets or sets the Color Property specifying the desired color applied to the image.
* @memberof ImageMaterialProperty.prototype
* @type {Property|undefined}
* @default 1.0
*/
color: createPropertyDescriptor("color"),
/**
* Gets or sets the Boolean Property specifying whether the image has transparency
* @memberof ImageMaterialProperty.prototype
* @type {Property|undefined}
* @default 1.0
*/
transparent: createPropertyDescriptor("transparent"),
});
/**
* Gets the {@link Material} type at the provided time.
*
* @param {JulianDate} time The time for which to retrieve the type.
* @returns {string} The type of material.
*/
ImageMaterialProperty.prototype.getType = function (time) {
return "Image";
};
const timeScratch = new JulianDate();
/**
* Gets the value of the property at the provided time.
*
* @param {JulianDate} [time=JulianDate.now()] The time for which to retrieve the value. If omitted, the current system time is used.
* @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned.
* @returns {object} The modified result parameter or a new instance if the result parameter was not supplied.
*/
ImageMaterialProperty.prototype.getValue = function (time, result) {
if (!defined(time)) {
time = JulianDate.now(timeScratch);
}
if (!defined(result)) {
result = {};
}
result.image = Property.getValueOrUndefined(this._image, time);
result.repeat = Property.getValueOrClonedDefault(
this._repeat,
time,
defaultRepeat,
result.repeat,
);
result.color = Property.getValueOrClonedDefault(
this._color,
time,
defaultColor,
result.color,
);
Iif (Property.getValueOrDefault(this._transparent, time, defaultTransparent)) {
result.color.alpha = Math.min(0.99, result.color.alpha);
}
return result;
};
/**
* Compares this property to the provided property and returns
* <code>true</code> if they are equal, <code>false</code> otherwise.
*
* @param {Property} [other] The other property.
* @returns {boolean} <code>true</code> if left and right are equal, <code>false</code> otherwise.
*/
ImageMaterialProperty.prototype.equals = function (other) {
return (
this === other ||
(other instanceof ImageMaterialProperty &&
Property.equals(this._image, other._image) &&
Property.equals(this._repeat, other._repeat) &&
Property.equals(this._color, other._color) &&
Property.equals(this._transparent, other._transparent))
);
};
export default ImageMaterialProperty;
|