-
Notifications
You must be signed in to change notification settings - Fork 3.5k
/
PolylineGraphics.js
231 lines (213 loc) · 10.6 KB
/
PolylineGraphics.js
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
import defaultValue from '../Core/defaultValue.js';
import defined from '../Core/defined.js';
import defineProperties from '../Core/defineProperties.js';
import DeveloperError from '../Core/DeveloperError.js';
import Event from '../Core/Event.js';
import createMaterialPropertyDescriptor from './createMaterialPropertyDescriptor.js';
import createPropertyDescriptor from './createPropertyDescriptor.js';
/**
* 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 {Object} [options] Object with the following properties:
* @param {Property} [options.show=true] A boolean Property specifying the visibility of the polyline.
* @param {Property} [options.positions] A Property specifying the array of {@link Cartesian3} positions that define the line strip.
* @param {Property} [options.width=1.0] A numeric Property specifying the width in pixels.
* @param {Property} [options.granularity=Cesium.Math.RADIANS_PER_DEGREE] A numeric Property specifying the angular distance between each latitude and longitude if arcType is not ArcType.NONE.
* @param {MaterialProperty} [options.material=Color.WHITE] A Property specifying the material used to draw the polyline.
* @param {MaterialProperty} [options.depthFailMaterial] A property specifying the material used to draw the polyline when it is below the terrain.
* @param {ArcType} [options.arcType=ArcType.GEODESIC] The type of line the polyline segments must follow.
* @param {Property} [options.clampToGround=false] A boolean Property specifying whether the Polyline should be clamped to the ground.
* @param {Property} [options.shadows=ShadowMode.DISABLED] An enum Property specifying whether the polyline casts or receives shadows from each light source.
* @param {Property} [options.distanceDisplayCondition] A Property specifying at what distance from the camera that this polyline will be displayed.
* @param {Property} [options.classificationType=ClassificationType.BOTH] An enum Property specifying whether this polyline will classify terrain, 3D Tiles, or both when on the ground.
* @param {Property} [options.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.
*
* @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));
}
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}
* @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}
*/
positions : createPropertyDescriptor('positions'),
/**
* Gets or sets the numeric Property specifying the width in pixels.
* @memberof PolylineGraphics.prototype
* @type {Property}
* @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}
* @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}
* @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}
* @default false
*/
clampToGround : createPropertyDescriptor('clampToGround'),
/**
* Get or sets the enum Property specifying whether the polyline
* casts or receives shadows from each light source.
* @memberof PolylineGraphics.prototype
* @type {Property}
* @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}
*/
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}
* @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}
* @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;