/*global define*/
define([
'../Core/Color',
'../Core/ColorGeometryInstanceAttribute',
'../Core/defaultValue',
'../Core/defined',
'../Core/defineProperties',
'../Core/destroyObject',
'../Core/DeveloperError',
'../Core/DistanceDisplayCondition',
'../Core/DistanceDisplayConditionGeometryInstanceAttribute',
'../Core/Event',
'../Core/GeometryInstance',
'../Core/isArray',
'../Core/Iso8601',
'../Core/oneTimeWarning',
'../Core/PolygonGeometry',
'../Core/PolygonHierarchy',
'../Core/PolygonOutlineGeometry',
'../Core/ShowGeometryInstanceAttribute',
'../Scene/GroundPrimitive',
'../Scene/MaterialAppearance',
'../Scene/PerInstanceColorAppearance',
'../Scene/Primitive',
'../Scene/ShadowMode',
'./ColorMaterialProperty',
'./ConstantProperty',
'./dynamicGeometryGetBoundingSphere',
'./MaterialProperty',
'./Property'
], function(
Color,
ColorGeometryInstanceAttribute,
defaultValue,
defined,
defineProperties,
destroyObject,
DeveloperError,
DistanceDisplayCondition,
DistanceDisplayConditionGeometryInstanceAttribute,
Event,
GeometryInstance,
isArray,
Iso8601,
oneTimeWarning,
PolygonGeometry,
PolygonHierarchy,
PolygonOutlineGeometry,
ShowGeometryInstanceAttribute,
GroundPrimitive,
MaterialAppearance,
PerInstanceColorAppearance,
Primitive,
ShadowMode,
ColorMaterialProperty,
ConstantProperty,
dynamicGeometryGetBoundingSphere,
MaterialProperty,
Property) {
'use strict';
var defaultMaterial = new ColorMaterialProperty(Color.WHITE);
var defaultShow = new ConstantProperty(true);
var defaultFill = new ConstantProperty(true);
var defaultOutline = new ConstantProperty(false);
var defaultOutlineColor = new ConstantProperty(Color.BLACK);
var defaultShadows = new ConstantProperty(ShadowMode.DISABLED);
var defaultDistanceDisplayCondition = new ConstantProperty(new DistanceDisplayCondition());
var scratchColor = new Color();
function GeometryOptions(entity) {
this.id = entity;
this.vertexFormat = undefined;
this.polygonHierarchy = undefined;
this.perPositionHeight = undefined;
this.closeTop = undefined;
this.closeBottom = undefined;
this.height = undefined;
this.extrudedHeight = undefined;
this.granularity = undefined;
this.stRotation = undefined;
}
/**
* A {@link GeometryUpdater} for polygons.
* Clients do not normally create this class directly, but instead rely on {@link DataSourceDisplay}.
* @alias PolygonGeometryUpdater
* @constructor
*
* @param {Entity} entity The entity containing the geometry to be visualized.
* @param {Scene} scene The scene where visualization is taking place.
*/
function PolygonGeometryUpdater(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(PolygonGeometryUpdater.prototype._onEntityPropertyChanged, this);
this._fillEnabled = false;
this._isClosed = 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._shadowsProperty = undefined;
this._distanceDisplayConditionProperty = undefined;
this._onTerrain = false;
this._options = new GeometryOptions(entity);
this._onEntityPropertyChanged(entity, 'polygon', entity.polygon, undefined);
}
defineProperties(PolygonGeometryUpdater, {
/**
* Gets the type of Appearance to use for simple color-based geometry.
* @memberof PolygonGeometryUpdater
* @type {Appearance}
*/
perInstanceColorAppearanceType : {
value : PerInstanceColorAppearance
},
/**
* Gets the type of Appearance to use for material-based geometry.
* @memberof PolygonGeometryUpdater
* @type {Appearance}
*/
materialAppearanceType : {
value : MaterialAppearance
}
});
defineProperties(PolygonGeometryUpdater.prototype, {
/**
* Gets the entity associated with this geometry.
* @memberof PolygonGeometryUpdater.prototype
*
* @type {Entity}
* @readonly
*/
entity : {
get : function() {
return this._entity;
}
},
/**
* Gets a value indicating if the geometry has a fill component.
* @memberof PolygonGeometryUpdater.prototype
*
* @type {Boolean}
* @readonly
*/
fillEnabled : {
get : function() {
return this._fillEnabled;
}
},
/**
* Gets a value indicating if fill visibility varies with simulation time.
* @memberof PolygonGeometryUpdater.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 PolygonGeometryUpdater.prototype
*
* @type {MaterialProperty}
* @readonly
*/
fillMaterialProperty : {
get : function() {
return this._materialProperty;
}
},
/**
* Gets a value indicating if the geometry has an outline component.
* @memberof PolygonGeometryUpdater.prototype
*
* @type {Boolean}
* @readonly
*/
outlineEnabled : {
get : function() {
return this._outlineEnabled;
}
},
/**
* Gets a value indicating if the geometry has an outline component.
* @memberof PolygonGeometryUpdater.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 PolygonGeometryUpdater.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 PolygonGeometryUpdater.prototype
*
* @type {Number}
* @readonly
*/
outlineWidth : {
get : function() {
return this._outlineWidth;
}
},
/**
* Gets the property specifying whether the geometry
* casts or receives shadows from each light source.
* @memberof PolygonGeometryUpdater.prototype
*
* @type {Property}
* @readonly
*/
shadowsProperty : {
get : function() {
return this._shadowsProperty;
}
},
/**
* Gets or sets the {@link DistanceDisplayCondition} Property specifying at what distance from the camera that this geometry will be displayed.
* @memberof PolygonGeometryUpdater.prototype
*
* @type {Property}
* @readonly
*/
distanceDisplayConditionProperty : {
get : function() {
return this._distanceDisplayConditionProperty;
}
},
/**
* 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 PolygonGeometryUpdater.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 PolygonGeometryUpdater.prototype
*
* @type {Boolean}
* @readonly
*/
isClosed : {
get : function() {
return this._isClosed;
}
},
/**
* Gets a value indicating if the geometry should be drawn on terrain.
* @memberof PolygonGeometryUpdater.prototype
*
* @type {Boolean}
* @readonly
*/
onTerrain : {
get : function() {
return this._onTerrain;
}
},
/**
* Gets an event that is raised whenever the public properties
* of this updater change.
* @memberof PolygonGeometryUpdater.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.
*/
PolygonGeometryUpdater.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.
*/
PolygonGeometryUpdater.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.
*/
PolygonGeometryUpdater.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 && entity.isShowing && this._showProperty.getValue(time) && this._fillProperty.getValue(time));
var distanceDisplayCondition = this._distanceDisplayConditionProperty.getValue(time);
var distanceDisplayConditionAttribute = DistanceDisplayConditionGeometryInstanceAttribute.fromDistanceDisplayCondition(distanceDisplayCondition);
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,
distanceDisplayCondition : distanceDisplayConditionAttribute,
color : color
};
} else {
attributes = {
show : show,
distanceDisplayCondition : distanceDisplayConditionAttribute
};
}
return new GeometryInstance({
id : entity,
geometry : new PolygonGeometry(this._options),
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.
*/
PolygonGeometryUpdater.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);
var distanceDisplayCondition = this._distanceDisplayConditionProperty.getValue(time);
return new GeometryInstance({
id : entity,
geometry : new PolygonOutlineGeometry(this._options),
attributes : {
show : new ShowGeometryInstanceAttribute(isAvailable && entity.isShowing && this._showProperty.getValue(time) && this._showOutlineProperty.getValue(time)),
color : ColorGeometryInstanceAttribute.fromColor(outlineColor),
distanceDisplayCondition : DistanceDisplayConditionGeometryInstanceAttribute.fromDistanceDisplayCondition(distanceDisplayCondition)
}
});
};
/**
* Returns true if this object was destroyed; otherwise, false.
*
* @returns {Boolean} True if this object was destroyed; otherwise, false.
*/
PolygonGeometryUpdater.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.
*/
PolygonGeometryUpdater.prototype.destroy = function() {
this._entitySubscription();
destroyObject(this);
};
PolygonGeometryUpdater.prototype._onEntityPropertyChanged = function(entity, propertyName, newValue, oldValue) {
if (!(propertyName === 'availability' || propertyName === 'polygon')) {
return;
}
var polygon = this._entity.polygon;
if (!defined(polygon)) {
if (this._fillEnabled || this._outlineEnabled) {
this._fillEnabled = false;
this._outlineEnabled = false;
this._geometryChanged.raiseEvent(this);
}
return;
}
var fillProperty = polygon.fill;
var fillEnabled = defined(fillProperty) && fillProperty.isConstant ? fillProperty.getValue(Iso8601.MINIMUM_VALUE) : true;
var perPositionHeightProperty = polygon.perPositionHeight;
var perPositionHeightEnabled = defined(perPositionHeightProperty) && (perPositionHeightProperty.isConstant ? perPositionHeightProperty.getValue(Iso8601.MINIMUM_VALUE) : true);
var outlineProperty = polygon.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 hierarchy = polygon.hierarchy;
var show = polygon.show;
if ((defined(show) && show.isConstant && !show.getValue(Iso8601.MINIMUM_VALUE)) || //
(!defined(hierarchy))) {
if (this._fillEnabled || this._outlineEnabled) {
this._fillEnabled = false;
this._outlineEnabled = false;
this._geometryChanged.raiseEvent(this);
}
return;
}
var material = defaultValue(polygon.material, defaultMaterial);
var isColorMaterial = material instanceof ColorMaterialProperty;
this._materialProperty = material;
this._fillProperty = defaultValue(fillProperty, defaultFill);
this._showProperty = defaultValue(show, defaultShow);
this._showOutlineProperty = defaultValue(polygon.outline, defaultOutline);
this._outlineColorProperty = outlineEnabled ? defaultValue(polygon.outlineColor, defaultOutlineColor) : undefined;
this._shadowsProperty = defaultValue(polygon.shadows, defaultShadows);
this._distanceDisplayConditionProperty = defaultValue(polygon.distanceDisplayCondition, defaultDistanceDisplayCondition);
var height = polygon.height;
var extrudedHeight = polygon.extrudedHeight;
var granularity = polygon.granularity;
var stRotation = polygon.stRotation;
var outlineWidth = polygon.outlineWidth;
var onTerrain = fillEnabled && !defined(height) && !defined(extrudedHeight) && isColorMaterial &&
!perPositionHeightEnabled && GroundPrimitive.isSupported(this._scene);
if (outlineEnabled && onTerrain) {
oneTimeWarning(oneTimeWarning.geometryOutlines);
outlineEnabled = false;
}
var perPositionHeight = polygon.perPositionHeight;
var closeTop = polygon.closeTop;
var closeBottom = polygon.closeBottom;
this._fillEnabled = fillEnabled;
this._onTerrain = onTerrain;
this._outlineEnabled = outlineEnabled;
if (!hierarchy.isConstant || //
!Property.isConstant(height) || //
!Property.isConstant(extrudedHeight) || //
!Property.isConstant(granularity) || //
!Property.isConstant(stRotation) || //
!Property.isConstant(outlineWidth) || //
!Property.isConstant(perPositionHeightProperty) || //
!Property.isConstant(perPositionHeight) || //
!Property.isConstant(closeTop) || //
!Property.isConstant(closeBottom) || //
(onTerrain && !Property.isConstant(material))) {
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;
var hierarchyValue = hierarchy.getValue(Iso8601.MINIMUM_VALUE);
if (isArray(hierarchyValue)) {
hierarchyValue = new PolygonHierarchy(hierarchyValue);
}
var heightValue = Property.getValueOrUndefined(height, Iso8601.MINIMUM_VALUE);
var closeTopValue = Property.getValueOrDefault(closeTop, Iso8601.MINIMUM_VALUE, true);
var closeBottomValue = Property.getValueOrDefault(closeBottom, Iso8601.MINIMUM_VALUE, true);
var extrudedHeightValue = Property.getValueOrUndefined(extrudedHeight, Iso8601.MINIMUM_VALUE);
options.polygonHierarchy = hierarchyValue;
options.height = heightValue;
options.extrudedHeight = extrudedHeightValue;
options.granularity = Property.getValueOrUndefined(granularity, Iso8601.MINIMUM_VALUE);
options.stRotation = Property.getValueOrUndefined(stRotation, Iso8601.MINIMUM_VALUE);
options.perPositionHeight = Property.getValueOrUndefined(perPositionHeight, Iso8601.MINIMUM_VALUE);
options.closeTop = closeTopValue;
options.closeBottom = closeBottomValue;
this._outlineWidth = Property.getValueOrDefault(outlineWidth, Iso8601.MINIMUM_VALUE, 1.0);
this._isClosed = defined(extrudedHeightValue) && extrudedHeightValue !== heightValue && closeTopValue && closeBottomValue;
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.
*/
PolygonGeometryUpdater.prototype.createDynamicUpdater = function(primitives, groundPrimitives) {
//>>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, groundPrimitives, this);
};
/**
* @private
*/
function DynamicGeometryUpdater(primitives, groundPrimitives, geometryUpdater) {
this._primitives = primitives;
this._groundPrimitives = groundPrimitives;
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 geometryUpdater = this._geometryUpdater;
var onTerrain = geometryUpdater._onTerrain;
var primitives = this._primitives;
var groundPrimitives = this._groundPrimitives;
if (onTerrain) {
groundPrimitives.removeAndDestroy(this._primitive);
} else {
primitives.removeAndDestroy(this._primitive);
primitives.removeAndDestroy(this._outlinePrimitive);
this._outlinePrimitive = undefined;
}
this._primitive = undefined;
var entity = geometryUpdater._entity;
var polygon = entity.polygon;
if (!entity.isShowing || !entity.isAvailable(time) || !Property.getValueOrDefault(polygon.show, time, true)) {
return;
}
var options = this._options;
var hierarchy = Property.getValueOrUndefined(polygon.hierarchy, time);
if (!defined(hierarchy)) {
return;
}
if (isArray(hierarchy)) {
options.polygonHierarchy = new PolygonHierarchy(hierarchy);
} else {
options.polygonHierarchy = hierarchy;
}
var closeTopValue = Property.getValueOrDefault(polygon.closeTop, time, true);
var closeBottomValue = Property.getValueOrDefault(polygon.closeBottom, time, true);
options.height = Property.getValueOrUndefined(polygon.height, time);
options.extrudedHeight = Property.getValueOrUndefined(polygon.extrudedHeight, time);
options.granularity = Property.getValueOrUndefined(polygon.granularity, time);
options.stRotation = Property.getValueOrUndefined(polygon.stRotation, time);
options.perPositionHeight = Property.getValueOrUndefined(polygon.perPositionHeight, time);
options.closeTop = closeTopValue;
options.closeBottom = closeBottomValue;
var shadows = this._geometryUpdater.shadowsProperty.getValue(time);
if (Property.getValueOrDefault(polygon.fill, time, true)) {
var fillMaterialProperty = geometryUpdater.fillMaterialProperty;
var material = MaterialProperty.getValue(time, fillMaterialProperty, this._material);
this._material = material;
if (onTerrain) {
var currentColor = Color.WHITE;
if (defined(fillMaterialProperty.color)) {
currentColor = fillMaterialProperty.color.getValue(time);
}
this._primitive = groundPrimitives.add(new GroundPrimitive({
geometryInstances : new GeometryInstance({
id : entity,
geometry : new PolygonGeometry(options),
attributes: {
color: ColorGeometryInstanceAttribute.fromColor(currentColor)
}
}),
asynchronous : false,
shadows : shadows
}));
} else {
var appearance = new MaterialAppearance({
material : material,
translucent : material.isTranslucent(),
closed : defined(options.extrudedHeight) && options.extrudedHeight !== options.height && closeTopValue && closeBottomValue
});
options.vertexFormat = appearance.vertexFormat;
this._primitive = primitives.add(new Primitive({
geometryInstances : new GeometryInstance({
id : entity,
geometry : new PolygonGeometry(options)
}),
appearance : appearance,
asynchronous : false,
shadows : shadows
}));
}
}
if (!onTerrain && Property.getValueOrDefault(polygon.outline, time, false)) {
options.vertexFormat = PerInstanceColorAppearance.VERTEX_FORMAT;
var outlineColor = Property.getValueOrClonedDefault(polygon.outlineColor, time, Color.BLACK, scratchColor);
var outlineWidth = Property.getValueOrDefault(polygon.outlineWidth, time, 1.0);
var translucent = outlineColor.alpha !== 1.0;
this._outlinePrimitive = primitives.add(new Primitive({
geometryInstances : new GeometryInstance({
id : entity,
geometry : new PolygonOutlineGeometry(options),
attributes : {
color : ColorGeometryInstanceAttribute.fromColor(outlineColor)
}
}),
appearance : new PerInstanceColorAppearance({
flat : true,
translucent : translucent,
renderState : {
lineWidth : geometryUpdater._scene.clampLineWidth(outlineWidth)
}
}),
asynchronous : false,
shadows : shadows
}));
}
};
DynamicGeometryUpdater.prototype.getBoundingSphere = function(entity, result) {
return dynamicGeometryGetBoundingSphere(entity, this._primitive, this._outlinePrimitive, result);
};
DynamicGeometryUpdater.prototype.isDestroyed = function() {
return false;
};
DynamicGeometryUpdater.prototype.destroy = function() {
var primitives = this._primitives;
var groundPrimitives = this._groundPrimitives;
if (this._geometryUpdater._onTerrain) {
groundPrimitives.removeAndDestroy(this._primitive);
} else {
primitives.removeAndDestroy(this._primitive);
}
primitives.removeAndDestroy(this._outlinePrimitive);
destroyObject(this);
};
return PolygonGeometryUpdater;
});