import Color from "../Core/Color.js"; import defaultValue from "../Core/defaultValue.js"; import defined from "../Core/defined.js"; import Event from "../Core/Event.js"; import createPropertyDescriptor from "./createPropertyDescriptor.js"; import Property from "./Property.js"; import StripeOrientation from "./StripeOrientation.js"; const defaultOrientation = StripeOrientation.HORIZONTAL; const defaultEvenColor = Color.WHITE; const defaultOddColor = Color.BLACK; const defaultOffset = 0; const defaultRepeat = 1; /** * A {@link MaterialProperty} that maps to stripe {@link Material} uniforms. * @alias StripeMaterialProperty * @constructor * * @param {Object} [options] Object with the following properties: * @param {Property|StripeOrientation} [options.orientation=StripeOrientation.HORIZONTAL] A Property specifying the {@link StripeOrientation}. * @param {Property|Color} [options.evenColor=Color.WHITE] A Property specifying the first {@link Color}. * @param {Property|Color} [options.oddColor=Color.BLACK] A Property specifying the second {@link Color}. * @param {Property|Number} [options.offset=0] A numeric Property specifying how far into the pattern to start the material. * @param {Property|Number} [options.repeat=1] A numeric Property specifying how many times the stripes repeat. */ function StripeMaterialProperty(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); this._definitionChanged = new Event(); this._orientation = undefined; this._orientationSubscription = undefined; this._evenColor = undefined; this._evenColorSubscription = undefined; this._oddColor = undefined; this._oddColorSubscription = undefined; this._offset = undefined; this._offsetSubscription = undefined; this._repeat = undefined; this._repeatSubscription = undefined; this.orientation = options.orientation; this.evenColor = options.evenColor; this.oddColor = options.oddColor; this.offset = options.offset; this.repeat = options.repeat; } Object.defineProperties(StripeMaterialProperty.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 StripeMaterialProperty.prototype * * @type {Boolean} * @readonly */ isConstant: { get: function () { return ( Property.isConstant(this._orientation) && // Property.isConstant(this._evenColor) && // Property.isConstant(this._oddColor) && // Property.isConstant(this._offset) && // 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 StripeMaterialProperty.prototype * * @type {Event} * @readonly */ definitionChanged: { get: function () { return this._definitionChanged; }, }, /** * Gets or sets the Property specifying the {@link StripeOrientation}/ * @memberof StripeMaterialProperty.prototype * @type {Property|undefined} * @default StripeOrientation.HORIZONTAL */ orientation: createPropertyDescriptor("orientation"), /** * Gets or sets the Property specifying the first {@link Color}. * @memberof StripeMaterialProperty.prototype * @type {Property|undefined} * @default Color.WHITE */ evenColor: createPropertyDescriptor("evenColor"), /** * Gets or sets the Property specifying the second {@link Color}. * @memberof StripeMaterialProperty.prototype * @type {Property|undefined} * @default Color.BLACK */ oddColor: createPropertyDescriptor("oddColor"), /** * Gets or sets the numeric Property specifying the point into the pattern * to begin drawing; with 0.0 being the beginning of the even color, 1.0 the beginning * of the odd color, 2.0 being the even color again, and any multiple or fractional values * being in between. * @memberof StripeMaterialProperty.prototype * @type {Property|undefined} * @default 0.0 */ offset: createPropertyDescriptor("offset"), /** * Gets or sets the numeric Property specifying how many times the stripes repeat. * @memberof StripeMaterialProperty.prototype * @type {Property|undefined} * @default 1.0 */ repeat: createPropertyDescriptor("repeat"), }); /** * 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. */ StripeMaterialProperty.prototype.getType = function (time) { return "Stripe"; }; /** * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. * @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. */ StripeMaterialProperty.prototype.getValue = function (time, result) { if (!defined(result)) { result = {}; } result.horizontal = Property.getValueOrDefault(this._orientation, time, defaultOrientation) === StripeOrientation.HORIZONTAL; result.evenColor = Property.getValueOrClonedDefault( this._evenColor, time, defaultEvenColor, result.evenColor ); result.oddColor = Property.getValueOrClonedDefault( this._oddColor, time, defaultOddColor, result.oddColor ); result.offset = Property.getValueOrDefault(this._offset, time, defaultOffset); result.repeat = Property.getValueOrDefault(this._repeat, time, defaultRepeat); return result; }; /** * Compares this property to the provided property and returns * true if they are equal, false otherwise. * * @param {Property} [other] The other property. * @returns {Boolean} true if left and right are equal, false otherwise. */ StripeMaterialProperty.prototype.equals = function (other) { return ( this === other || // (other instanceof StripeMaterialProperty && // Property.equals(this._orientation, other._orientation) && // Property.equals(this._evenColor, other._evenColor) && // Property.equals(this._oddColor, other._oddColor) && // Property.equals(this._offset, other._offset) && // Property.equals(this._repeat, other._repeat)) ); }; export default StripeMaterialProperty;