You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
249 lines
9.8 KiB
JavaScript
249 lines
9.8 KiB
JavaScript
import defaultValue from "../Core/defaultValue.js";
|
|
import defined from "../Core/defined.js";
|
|
import DeveloperError from "../Core/DeveloperError.js";
|
|
import Event from "../Core/Event.js";
|
|
import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor.js";
|
|
import createPropertyDescriptor from "./createPropertyDescriptor.js";
|
|
|
|
/**
|
|
* @typedef {Object} PolylineGraphics.ConstructorOptions
|
|
*
|
|
* Initialization options for the PolylineGraphics constructor
|
|
*
|
|
* @property {Property | boolean} [show=true] A boolean Property specifying the visibility of the polyline.
|
|
* @property {Property | Array<Cartesian3>} [positions] A Property specifying the array of {@link Cartesian3} positions that define the line strip.
|
|
* @property {Property | number} [width=1.0] A numeric Property specifying the width in pixels.
|
|
* @property {Property | number} [granularity=Cesium.Math.RADIANS_PER_DEGREE] A numeric Property specifying the angular distance between each latitude and longitude if arcType is not ArcType.NONE.
|
|
* @property {MaterialProperty | Color} [material=Color.WHITE] A Property specifying the material used to draw the polyline.
|
|
* @property {MaterialProperty | Color} [depthFailMaterial] A property specifying the material used to draw the polyline when it is below the terrain.
|
|
* @property {Property | ArcType} [arcType=ArcType.GEODESIC] The type of line the polyline segments must follow.
|
|
* @property {Property | boolean} [clampToGround=false] A boolean Property specifying whether the Polyline should be clamped to the ground.
|
|
* @property {Property | ShadowMode} [shadows=ShadowMode.DISABLED] An enum Property specifying whether the polyline casts or receives shadows from light sources.
|
|
* @property {Property | DistanceDisplayCondition} [distanceDisplayCondition] A Property specifying at what distance from the camera that this polyline will be displayed.
|
|
* @property {Property | ClassificationType} [classificationType=ClassificationType.BOTH] An enum Property specifying whether this polyline will classify terrain, 3D Tiles, or both when on the ground.
|
|
* @property {Property | number} [zIndex=0] A Property specifying the zIndex used for ordering ground geometry. Only has an effect if `clampToGround` is true and polylines on terrain is supported.
|
|
*/
|
|
|
|
/**
|
|
* Describes a polyline. The first two positions define a line segment,
|
|
* and each additional position defines a line segment from the previous position. The segments
|
|
* can be linear connected points, great arcs, or clamped to terrain.
|
|
*
|
|
* @alias PolylineGraphics
|
|
* @constructor
|
|
*
|
|
* @param {PolylineGraphics.ConstructorOptions} [options] Object describing initialization options
|
|
*
|
|
* @see Entity
|
|
* @demo {@link https://sandcastle.cesium.com/index.html?src=Polyline.html|Cesium Sandcastle Polyline Demo}
|
|
*/
|
|
function PolylineGraphics(options) {
|
|
this._definitionChanged = new Event();
|
|
this._show = undefined;
|
|
this._showSubscription = undefined;
|
|
this._positions = undefined;
|
|
this._positionsSubscription = undefined;
|
|
this._width = undefined;
|
|
this._widthSubscription = undefined;
|
|
this._granularity = undefined;
|
|
this._granularitySubscription = undefined;
|
|
this._material = undefined;
|
|
this._materialSubscription = undefined;
|
|
this._depthFailMaterial = undefined;
|
|
this._depthFailMaterialSubscription = undefined;
|
|
this._arcType = undefined;
|
|
this._arcTypeSubscription = undefined;
|
|
this._clampToGround = undefined;
|
|
this._clampToGroundSubscription = undefined;
|
|
this._shadows = undefined;
|
|
this._shadowsSubscription = undefined;
|
|
this._distanceDisplayCondition = undefined;
|
|
this._distanceDisplayConditionSubscription = undefined;
|
|
this._classificationType = undefined;
|
|
this._classificationTypeSubscription = undefined;
|
|
this._zIndex = undefined;
|
|
this._zIndexSubscription = undefined;
|
|
|
|
this.merge(defaultValue(options, defaultValue.EMPTY_OBJECT));
|
|
}
|
|
|
|
Object.defineProperties(PolylineGraphics.prototype, {
|
|
/**
|
|
* Gets the event that is raised whenever a property or sub-property is changed or modified.
|
|
* @memberof PolylineGraphics.prototype
|
|
*
|
|
* @type {Event}
|
|
* @readonly
|
|
*/
|
|
definitionChanged: {
|
|
get: function () {
|
|
return this._definitionChanged;
|
|
},
|
|
},
|
|
|
|
/**
|
|
* Gets or sets the boolean Property specifying the visibility of the polyline.
|
|
* @memberof PolylineGraphics.prototype
|
|
* @type {Property|undefined}
|
|
* @default true
|
|
*/
|
|
show: createPropertyDescriptor("show"),
|
|
|
|
/**
|
|
* Gets or sets the Property specifying the array of {@link Cartesian3}
|
|
* positions that define the line strip.
|
|
* @memberof PolylineGraphics.prototype
|
|
* @type {Property|undefined}
|
|
*/
|
|
positions: createPropertyDescriptor("positions"),
|
|
|
|
/**
|
|
* Gets or sets the numeric Property specifying the width in pixels.
|
|
* @memberof PolylineGraphics.prototype
|
|
* @type {Property|undefined}
|
|
* @default 1.0
|
|
*/
|
|
width: createPropertyDescriptor("width"),
|
|
|
|
/**
|
|
* Gets or sets the numeric Property specifying the angular distance between each latitude and longitude if arcType is not ArcType.NONE and clampToGround is false.
|
|
* @memberof PolylineGraphics.prototype
|
|
* @type {Property|undefined}
|
|
* @default Cesium.Math.RADIANS_PER_DEGREE
|
|
*/
|
|
granularity: createPropertyDescriptor("granularity"),
|
|
|
|
/**
|
|
* Gets or sets the Property specifying the material used to draw the polyline.
|
|
* @memberof PolylineGraphics.prototype
|
|
* @type {MaterialProperty}
|
|
* @default Color.WHITE
|
|
*/
|
|
material: createMaterialPropertyDescriptor("material"),
|
|
|
|
/**
|
|
* Gets or sets the Property specifying the material used to draw the polyline when it fails the depth test.
|
|
* <p>
|
|
* Requires the EXT_frag_depth WebGL extension to render properly. If the extension is not supported,
|
|
* there may be artifacts.
|
|
* </p>
|
|
* @memberof PolylineGraphics.prototype
|
|
* @type {MaterialProperty}
|
|
* @default undefined
|
|
*/
|
|
depthFailMaterial: createMaterialPropertyDescriptor("depthFailMaterial"),
|
|
|
|
/**
|
|
* Gets or sets the {@link ArcType} Property specifying whether the line segments should be great arcs, rhumb lines or linearly connected.
|
|
* @memberof PolylineGraphics.prototype
|
|
* @type {Property|undefined}
|
|
* @default ArcType.GEODESIC
|
|
*/
|
|
arcType: createPropertyDescriptor("arcType"),
|
|
|
|
/**
|
|
* Gets or sets the boolean Property specifying whether the polyline
|
|
* should be clamped to the ground.
|
|
* @memberof PolylineGraphics.prototype
|
|
* @type {Property|undefined}
|
|
* @default false
|
|
*/
|
|
clampToGround: createPropertyDescriptor("clampToGround"),
|
|
|
|
/**
|
|
* Get or sets the enum Property specifying whether the polyline
|
|
* casts or receives shadows from light sources.
|
|
* @memberof PolylineGraphics.prototype
|
|
* @type {Property|undefined}
|
|
* @default ShadowMode.DISABLED
|
|
*/
|
|
shadows: createPropertyDescriptor("shadows"),
|
|
|
|
/**
|
|
* Gets or sets the {@link DistanceDisplayCondition} Property specifying at what distance from the camera that this polyline will be displayed.
|
|
* @memberof PolylineGraphics.prototype
|
|
* @type {Property|undefined}
|
|
*/
|
|
distanceDisplayCondition: createPropertyDescriptor(
|
|
"distanceDisplayCondition"
|
|
),
|
|
|
|
/**
|
|
* Gets or sets the {@link ClassificationType} Property specifying whether this polyline will classify terrain, 3D Tiles, or both when on the ground.
|
|
* @memberof PolylineGraphics.prototype
|
|
* @type {Property|undefined}
|
|
* @default ClassificationType.BOTH
|
|
*/
|
|
classificationType: createPropertyDescriptor("classificationType"),
|
|
|
|
/**
|
|
* Gets or sets the zIndex Property specifying the ordering of the polyline. Only has an effect if `clampToGround` is true and polylines on terrain is supported.
|
|
* @memberof PolylineGraphics.prototype
|
|
* @type {ConstantProperty|undefined}
|
|
* @default 0
|
|
*/
|
|
zIndex: createPropertyDescriptor("zIndex"),
|
|
});
|
|
|
|
/**
|
|
* Duplicates this instance.
|
|
*
|
|
* @param {PolylineGraphics} [result] The object onto which to store the result.
|
|
* @returns {PolylineGraphics} The modified result parameter or a new instance if one was not provided.
|
|
*/
|
|
PolylineGraphics.prototype.clone = function (result) {
|
|
if (!defined(result)) {
|
|
return new PolylineGraphics(this);
|
|
}
|
|
result.show = this.show;
|
|
result.positions = this.positions;
|
|
result.width = this.width;
|
|
result.granularity = this.granularity;
|
|
result.material = this.material;
|
|
result.depthFailMaterial = this.depthFailMaterial;
|
|
result.arcType = this.arcType;
|
|
result.clampToGround = this.clampToGround;
|
|
result.shadows = this.shadows;
|
|
result.distanceDisplayCondition = this.distanceDisplayCondition;
|
|
result.classificationType = this.classificationType;
|
|
result.zIndex = this.zIndex;
|
|
return result;
|
|
};
|
|
|
|
/**
|
|
* Assigns each unassigned property on this object to the value
|
|
* of the same property on the provided source object.
|
|
*
|
|
* @param {PolylineGraphics} source The object to be merged into this object.
|
|
*/
|
|
PolylineGraphics.prototype.merge = function (source) {
|
|
//>>includeStart('debug', pragmas.debug);
|
|
if (!defined(source)) {
|
|
throw new DeveloperError("source is required.");
|
|
}
|
|
//>>includeEnd('debug');
|
|
|
|
this.show = defaultValue(this.show, source.show);
|
|
this.positions = defaultValue(this.positions, source.positions);
|
|
this.width = defaultValue(this.width, source.width);
|
|
this.granularity = defaultValue(this.granularity, source.granularity);
|
|
this.material = defaultValue(this.material, source.material);
|
|
this.depthFailMaterial = defaultValue(
|
|
this.depthFailMaterial,
|
|
source.depthFailMaterial
|
|
);
|
|
this.arcType = defaultValue(this.arcType, source.arcType);
|
|
this.clampToGround = defaultValue(this.clampToGround, source.clampToGround);
|
|
this.shadows = defaultValue(this.shadows, source.shadows);
|
|
this.distanceDisplayCondition = defaultValue(
|
|
this.distanceDisplayCondition,
|
|
source.distanceDisplayCondition
|
|
);
|
|
this.classificationType = defaultValue(
|
|
this.classificationType,
|
|
source.classificationType
|
|
);
|
|
this.zIndex = defaultValue(this.zIndex, source.zIndex);
|
|
};
|
|
export default PolylineGraphics;
|