/*global define*/ define([ '../Core/BoxGeometry', '../Core/BoxOutlineGeometry', '../Core/Color', '../Core/ColorGeometryInstanceAttribute', '../Core/defaultValue', '../Core/defined', '../Core/defineProperties', '../Core/destroyObject', '../Core/DeveloperError', '../Core/Event', '../Core/GeometryInstance', '../Core/Iso8601', '../Core/ShowGeometryInstanceAttribute', '../Scene/MaterialAppearance', '../Scene/PerInstanceColorAppearance', '../Scene/Primitive', './ColorMaterialProperty', './ConstantProperty', './MaterialProperty', './Property' ], function( BoxGeometry, BoxOutlineGeometry, Color, ColorGeometryInstanceAttribute, defaultValue, defined, defineProperties, destroyObject, DeveloperError, Event, GeometryInstance, Iso8601, ShowGeometryInstanceAttribute, MaterialAppearance, PerInstanceColorAppearance, Primitive, ColorMaterialProperty, ConstantProperty, MaterialProperty, Property) { "use strict"; var defaultMaterial = ColorMaterialProperty.fromColor(Color.WHITE); var defaultShow = new ConstantProperty(true); var defaultFill = new ConstantProperty(true); var defaultOutline = new ConstantProperty(false); var defaultOutlineColor = new ConstantProperty(Color.BLACK); var scratchColor = new Color(); var GeometryOptions = function(entity) { this.id = entity; this.vertexFormat = undefined; this.dimensions = undefined; }; /** * A {@link GeometryUpdater} for boxes. * Clients do not normally create this class directly, but instead rely on {@link DataSourceDisplay}. * @alias BoxGeometryUpdater * @constructor * * @param {Entity} entity The entity containing the geometry to be visualized. * @param {Scene} scene The scene where visualization is taking place. */ var BoxGeometryUpdater = function(entity, scene) { //>>includeStart('debug', pragmas.debug); if (!defined(entity)) { throw new DeveloperError('entity is required'); } if (!defined(scene)) { throw new DeveloperError('scene is required'); } //>>includeEnd('debug'); this._entity = entity; this._scene = scene; this._entitySubscription = entity.definitionChanged.addEventListener(BoxGeometryUpdater.prototype._onEntityPropertyChanged, this); this._fillEnabled = false; this._dynamic = false; this._outlineEnabled = false; this._geometryChanged = new Event(); this._showProperty = undefined; this._materialProperty = undefined; this._hasConstantOutline = true; this._showOutlineProperty = undefined; this._outlineColorProperty = undefined; this._outlineWidth = 1.0; this._options = new GeometryOptions(entity); this._onEntityPropertyChanged(entity, 'box', entity.box, undefined); }; defineProperties(BoxGeometryUpdater, { /** * Gets the type of Appearance to use for simple color-based geometry. * @memberof BoxGeometryUpdater * @type {Appearance} */ perInstanceColorAppearanceType : { value : PerInstanceColorAppearance }, /** * Gets the type of Appearance to use for material-based geometry. * @memberof BoxGeometryUpdater * @type {Appearance} */ materialAppearanceType : { value : MaterialAppearance } }); defineProperties(BoxGeometryUpdater.prototype, { /** * Gets the entity associated with this geometry. * @memberof BoxGeometryUpdater.prototype * * @type {Entity} * @readonly */ entity : { get : function() { return this._entity; } }, /** * Gets a value indicating if the geometry has a fill component. * @memberof BoxGeometryUpdater.prototype * * @type {Boolean} * @readonly */ fillEnabled : { get : function() { return this._fillEnabled; } }, /** * Gets a value indicating if fill visibility varies with simulation time. * @memberof BoxGeometryUpdater.prototype * * @type {Boolean} * @readonly */ hasConstantFill : { get : function() { return !this._fillEnabled || (!defined(this._entity.availability) && Property.isConstant(this._showProperty) && Property.isConstant(this._fillProperty)); } }, /** * Gets the material property used to fill the geometry. * @memberof BoxGeometryUpdater.prototype * * @type {MaterialProperty} * @readonly */ fillMaterialProperty : { get : function() { return this._materialProperty; } }, /** * Gets a value indicating if the geometry has an outline component. * @memberof BoxGeometryUpdater.prototype * * @type {Boolean} * @readonly */ outlineEnabled : { get : function() { return this._outlineEnabled; } }, /** * Gets a value indicating if the geometry has an outline component. * @memberof BoxGeometryUpdater.prototype * * @type {Boolean} * @readonly */ hasConstantOutline : { get : function() { return !this._outlineEnabled || (!defined(this._entity.availability) && Property.isConstant(this._showProperty) && Property.isConstant(this._showOutlineProperty)); } }, /** * Gets the {@link Color} property for the geometry outline. * @memberof BoxGeometryUpdater.prototype * * @type {Property} * @readonly */ outlineColorProperty : { get : function() { return this._outlineColorProperty; } }, /** * Gets the constant with of the geometry outline, in pixels. * This value is only valid if isDynamic is false. * @memberof BoxGeometryUpdater.prototype * * @type {Number} * @readonly */ outlineWidth : { get : function() { return this._outlineWidth; } }, /** * Gets a value indicating if the geometry is time-varying. * If true, all visualization is delegated to the {@link DynamicGeometryUpdater} * returned by GeometryUpdater#createDynamicUpdater. * @memberof BoxGeometryUpdater.prototype * * @type {Boolean} * @readonly */ isDynamic : { get : function() { return this._dynamic; } }, /** * Gets a value indicating if the geometry is closed. * This property is only valid for static geometry. * @memberof BoxGeometryUpdater.prototype * * @type {Boolean} * @readonly */ isClosed : { value : true }, /** * Gets an event that is raised whenever the public properties * of this updater change. * @memberof BoxGeometryUpdater.prototype * * @type {Boolean} * @readonly */ geometryChanged : { get : function() { return this._geometryChanged; } } }); /** * Checks if the geometry is outlined at the provided time. * * @param {JulianDate} time The time for which to retrieve visibility. * @returns {Boolean} true if geometry is outlined at the provided time, false otherwise. */ BoxGeometryUpdater.prototype.isOutlineVisible = function(time) { var entity = this._entity; return this._outlineEnabled && entity.isAvailable(time) && this._showProperty.getValue(time) && this._showOutlineProperty.getValue(time); }; /** * Checks if the geometry is filled at the provided time. * * @param {JulianDate} time The time for which to retrieve visibility. * @returns {Boolean} true if geometry is filled at the provided time, false otherwise. */ BoxGeometryUpdater.prototype.isFilled = function(time) { var entity = this._entity; return this._fillEnabled && entity.isAvailable(time) && this._showProperty.getValue(time) && this._fillProperty.getValue(time); }; /** * Creates the geometry instance which represents the fill of the geometry. * * @param {JulianDate} time The time to use when retrieving initial attribute values. * @returns {GeometryInstance} The geometry instance representing the filled portion of the geometry. * * @exception {DeveloperError} This instance does not represent a filled geometry. */ BoxGeometryUpdater.prototype.createFillGeometryInstance = function(time) { //>>includeStart('debug', pragmas.debug); if (!defined(time)) { throw new DeveloperError('time is required.'); } if (!this._fillEnabled) { throw new DeveloperError('This instance does not represent a filled geometry.'); } //>>includeEnd('debug'); var entity = this._entity; var isAvailable = entity.isAvailable(time); var attributes; var color; var show = new ShowGeometryInstanceAttribute(isAvailable && this._showProperty.getValue(time) && this._fillProperty.getValue(time)); if (this._materialProperty instanceof ColorMaterialProperty) { var currentColor = Color.WHITE; if (defined(this._materialProperty.color) && (this._materialProperty.color.isConstant || isAvailable)) { currentColor = this._materialProperty.color.getValue(time); } color = ColorGeometryInstanceAttribute.fromColor(currentColor); attributes = { show : show, color : color }; } else { attributes = { show : show }; } return new GeometryInstance({ id : entity, geometry : BoxGeometry.fromDimensions(this._options), modelMatrix : entity._getModelMatrix(Iso8601.MINIMUM_VALUE), attributes : attributes }); }; /** * Creates the geometry instance which represents the outline of the geometry. * * @param {JulianDate} time The time to use when retrieving initial attribute values. * @returns {GeometryInstance} The geometry instance representing the outline portion of the geometry. * * @exception {DeveloperError} This instance does not represent an outlined geometry. */ BoxGeometryUpdater.prototype.createOutlineGeometryInstance = function(time) { //>>includeStart('debug', pragmas.debug); if (!defined(time)) { throw new DeveloperError('time is required.'); } if (!this._outlineEnabled) { throw new DeveloperError('This instance does not represent an outlined geometry.'); } //>>includeEnd('debug'); var entity = this._entity; var isAvailable = entity.isAvailable(time); var outlineColor = Property.getValueOrDefault(this._outlineColorProperty, time, Color.BLACK); return new GeometryInstance({ id : entity, geometry : BoxOutlineGeometry.fromDimensions(this._options), modelMatrix : entity._getModelMatrix(Iso8601.MINIMUM_VALUE), attributes : { show : new ShowGeometryInstanceAttribute(isAvailable && this._showProperty.getValue(time) && this._showOutlineProperty.getValue(time)), color : ColorGeometryInstanceAttribute.fromColor(outlineColor) } }); }; /** * Returns true if this object was destroyed; otherwise, false. * * @returns {Boolean} True if this object was destroyed; otherwise, false. */ BoxGeometryUpdater.prototype.isDestroyed = function() { return false; }; /** * Destroys and resources used by the object. Once an object is destroyed, it should not be used. * * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called. */ BoxGeometryUpdater.prototype.destroy = function() { this._entitySubscription(); destroyObject(this); }; BoxGeometryUpdater.prototype._onEntityPropertyChanged = function(entity, propertyName, newValue, oldValue) { if (!(propertyName === 'availability' || propertyName === 'position' || propertyName === 'orientation' || propertyName === 'box')) { return; } var box = this._entity.box; if (!defined(box)) { if (this._fillEnabled || this._outlineEnabled) { this._fillEnabled = false; this._outlineEnabled = false; this._geometryChanged.raiseEvent(this); } return; } var fillProperty = box.fill; var fillEnabled = defined(fillProperty) && fillProperty.isConstant ? fillProperty.getValue(Iso8601.MINIMUM_VALUE) : true; var outlineProperty = box.outline; var outlineEnabled = defined(outlineProperty); if (outlineEnabled && outlineProperty.isConstant) { outlineEnabled = outlineProperty.getValue(Iso8601.MINIMUM_VALUE); } if (!fillEnabled && !outlineEnabled) { if (this._fillEnabled || this._outlineEnabled) { this._fillEnabled = false; this._outlineEnabled = false; this._geometryChanged.raiseEvent(this); } return; } var dimensions = box.dimensions; var position = entity.position; var show = box.show; if (!defined(dimensions) || !defined(position) || (defined(show) && show.isConstant && !show.getValue(Iso8601.MINIMUM_VALUE))) { if (this._fillEnabled || this._outlineEnabled) { this._fillEnabled = false; this._outlineEnabled = false; this._geometryChanged.raiseEvent(this); } return; } var material = defaultValue(box.material, defaultMaterial); var isColorMaterial = material instanceof ColorMaterialProperty; this._materialProperty = material; this._fillProperty = defaultValue(fillProperty, defaultFill); this._showProperty = defaultValue(show, defaultShow); this._showOutlineProperty = defaultValue(box.outline, defaultOutline); this._outlineColorProperty = outlineEnabled ? defaultValue(box.outlineColor, defaultOutlineColor) : undefined; var outlineWidth = box.outlineWidth; this._fillEnabled = fillEnabled; this._outlineEnabled = outlineEnabled; if (!position.isConstant || // !Property.isConstant(entity.orientation) || // !dimensions.isConstant || // !Property.isConstant(outlineWidth)) { if (!this._dynamic) { this._dynamic = true; this._geometryChanged.raiseEvent(this); } } else { var options = this._options; options.vertexFormat = isColorMaterial ? PerInstanceColorAppearance.VERTEX_FORMAT : MaterialAppearance.MaterialSupport.TEXTURED.vertexFormat; options.dimensions = dimensions.getValue(Iso8601.MINIMUM_VALUE, options.dimensions); this._outlineWidth = defined(outlineWidth) ? outlineWidth.getValue(Iso8601.MINIMUM_VALUE) : 1.0; this._dynamic = false; this._geometryChanged.raiseEvent(this); } }; /** * Creates the dynamic updater to be used when GeometryUpdater#isDynamic is true. * * @param {PrimitiveCollection} primitives The primitive collection to use. * @returns {DynamicGeometryUpdater} The dynamic updater used to update the geometry each frame. * * @exception {DeveloperError} This instance does not represent dynamic geometry. */ BoxGeometryUpdater.prototype.createDynamicUpdater = function(primitives) { //>>includeStart('debug', pragmas.debug); if (!this._dynamic) { throw new DeveloperError('This instance does not represent dynamic geometry.'); } if (!defined(primitives)) { throw new DeveloperError('primitives is required.'); } //>>includeEnd('debug'); return new DynamicGeometryUpdater(primitives, this); }; /** * @private */ var DynamicGeometryUpdater = function(primitives, geometryUpdater) { this._primitives = primitives; this._primitive = undefined; this._outlinePrimitive = undefined; this._geometryUpdater = geometryUpdater; this._options = new GeometryOptions(geometryUpdater._entity); }; DynamicGeometryUpdater.prototype.update = function(time) { //>>includeStart('debug', pragmas.debug); if (!defined(time)) { throw new DeveloperError('time is required.'); } //>>includeEnd('debug'); var primitives = this._primitives; primitives.remove(this._primitive); primitives.remove(this._outlinePrimitive); var geometryUpdater = this._geometryUpdater; var entity = geometryUpdater._entity; var box = entity.box; if (!entity.isAvailable(time) || !Property.getValueOrDefault(box.show, time, true)) { return; } var options = this._options; var modelMatrix = entity._getModelMatrix(time); var dimensions = Property.getValueOrUndefined(box.dimensions, time, options.dimensions); if (!defined(modelMatrix) || !defined(dimensions)) { return; } options.dimensions = dimensions; if (Property.getValueOrDefault(box.fill, time, true)) { var material = MaterialProperty.getValue(time, geometryUpdater.fillMaterialProperty, this._material); this._material = material; var appearance = new MaterialAppearance({ material : material, translucent : material.isTranslucent(), closed : true }); options.vertexFormat = appearance.vertexFormat; this._primitive = primitives.add(new Primitive({ geometryInstances : new GeometryInstance({ id : entity, geometry : BoxGeometry.fromDimensions(options), modelMatrix : modelMatrix }), appearance : appearance, asynchronous : false })); } if (Property.getValueOrDefault(box.outline, time, true)) { options.vertexFormat = PerInstanceColorAppearance.VERTEX_FORMAT; var outlineColor = Property.getValueOrClonedDefault(box.outlineColor, time, Color.BLACK, scratchColor); var outlineWidth = Property.getValueOrDefault(box.outlineWidth, 1.0); var translucent = outlineColor.alpha !== 1.0; this._outlinePrimitive = primitives.add(new Primitive({ geometryInstances : new GeometryInstance({ id : entity, geometry : BoxOutlineGeometry.fromDimensions(options), modelMatrix : modelMatrix, attributes : { color : ColorGeometryInstanceAttribute.fromColor(outlineColor) } }), appearance : new PerInstanceColorAppearance({ flat : true, translucent : translucent, renderState : { lineWidth : geometryUpdater._scene.clampLineWidth(outlineWidth) } }), asynchronous : false })); } }; DynamicGeometryUpdater.prototype.isDestroyed = function() { return false; }; DynamicGeometryUpdater.prototype.destroy = function() { var primitives = this._primitives; primitives.remove(this._primitive); primitives.remove(this._outlinePrimitive); destroyObject(this); }; return BoxGeometryUpdater; });