/
RectangleGraphics.js
317 lines (290 loc) · 14.1 KB
/
RectangleGraphics.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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
define([
'../Core/defaultValue',
'../Core/defined',
'../Core/defineProperties',
'../Core/DeveloperError',
'../Core/Event',
'./createMaterialPropertyDescriptor',
'./createPropertyDescriptor'
], function(
defaultValue,
defined,
defineProperties,
DeveloperError,
Event,
createMaterialPropertyDescriptor,
createPropertyDescriptor) {
'use strict';
/**
* Describes graphics for a {@link Rectangle}.
* The rectangle conforms to the curvature of the globe and can be placed on the surface or
* at altitude and can optionally be extruded into a volume.
*
* @alias RectangleGraphics
* @constructor
*
* @param {Object} [options] Object with the following properties:
* @param {Property} [options.coordinates] The Property specifying the {@link Rectangle}.
* @param {Property} [options.height=0] A numeric Property specifying the altitude of the rectangle relative to the ellipsoid surface.
* @param {Property} [options.heightReference] A Property specifying what the height is relative to.
* @param {Property} [options.extrudedHeight] A numeric Property specifying the altitude of the rectangle's extruded face relative to the ellipsoid surface.
* @param {Property} [options.extrudedHeightReference] A Property specifying what the extrudedHeight is relative to.
* @param {Property} [options.show=true] A boolean Property specifying the visibility of the rectangle.
* @param {Property} [options.fill=true] A boolean Property specifying whether the rectangle is filled with the provided material.
* @param {MaterialProperty} [options.material=Color.WHITE] A Property specifying the material used to fill the rectangle.
* @param {Property} [options.outline=false] A boolean Property specifying whether the rectangle is outlined.
* @param {Property} [options.outlineColor=Color.BLACK] A Property specifying the {@link Color} of the outline.
* @param {Property} [options.outlineWidth=1.0] A numeric Property specifying the width of the outline.
* @param {Property} [options.rotation=0.0] A numeric property specifying the rotation of the rectangle clockwise from north.
* @param {Property} [options.stRotation=0.0] A numeric property specifying the rotation of the rectangle texture counter-clockwise from north.
* @param {Property} [options.granularity=Cesium.Math.RADIANS_PER_DEGREE] A numeric Property specifying the angular distance between points on the rectangle.
* @param {Property} [options.shadows=ShadowMode.DISABLED] An enum Property specifying whether the rectangle casts or receives shadows from each light source.
* @param {Property} [options.distanceDisplayCondition] A Property specifying at what distance from the camera that this rectangle will be displayed.
* @param {Property} [options.classificationType=ClassificationType.BOTH] An enum Property specifying whether this rectangle 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 the rectangle is constant and neither height or extrudedHeight are specified.
*
* @see Entity
* @demo {@link https://cesiumjs.org/Cesium/Apps/Sandcastle/index.html?src=Rectangle.html|Cesium Sandcastle Rectangle Demo}
*/
function RectangleGraphics(options) {
this._show = undefined;
this._showSubscription = undefined;
this._material = undefined;
this._materialSubscription = undefined;
this._coordinates = undefined;
this._coordinatesSubscription = undefined;
this._height = undefined;
this._heightSubscription = undefined;
this._heightReference = undefined;
this._heightReferenceSubscription = undefined;
this._extrudedHeight = undefined;
this._extrudedHeightSubscription = undefined;
this._extrudedHeightReference = undefined;
this._extrudedHeightReferenceSubscription = undefined;
this._granularity = undefined;
this._granularitySubscription = undefined;
this._stRotation = undefined;
this._stRotationSubscription = undefined;
this._rotation = undefined;
this._rotationSubscription = undefined;
this._fill = undefined;
this._fillSubscription = undefined;
this._outline = undefined;
this._outlineSubscription = undefined;
this._outlineColor = undefined;
this._outlineColorSubscription = undefined;
this._outlineWidth = undefined;
this._outlineWidthSubscription = 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._definitionChanged = new Event();
this.merge(defaultValue(options, defaultValue.EMPTY_OBJECT));
}
defineProperties(RectangleGraphics.prototype, {
/**
* Gets the event that is raised whenever a property or sub-property is changed or modified.
* @memberof RectangleGraphics.prototype
*
* @type {Event}
* @readonly
*/
definitionChanged : {
get : function() {
return this._definitionChanged;
}
},
/**
* Gets or sets the boolean Property specifying the visibility of the rectangle.
* @memberof RectangleGraphics.prototype
* @type {Property}
* @default true
*/
show : createPropertyDescriptor('show'),
/**
* Gets or sets the Property specifying the {@link Rectangle}.
* @memberof RectangleGraphics.prototype
* @type {Property}
*/
coordinates : createPropertyDescriptor('coordinates'),
/**
* Gets or sets the Property specifying the material used to fill the rectangle.
* @memberof RectangleGraphics.prototype
* @type {MaterialProperty}
* @default Color.WHITE
*/
material : createMaterialPropertyDescriptor('material'),
/**
* Gets or sets the numeric Property specifying the altitude of the rectangle.
* @memberof RectangleGraphics.prototype
* @type {Property}
* @default 0.0
*/
height : createPropertyDescriptor('height'),
/**
* Gets or sets the Property specifying the {@link HeightReference}.
* @memberof RectangleGraphics.prototype
* @type {Property}
* @default HeightReference.NONE
*/
heightReference : createPropertyDescriptor('heightReference'),
/**
* Gets or sets the numeric Property specifying the altitude of the rectangle extrusion.
* Setting this property creates volume starting at height and ending at this altitude.
* @memberof RectangleGraphics.prototype
* @type {Property}
*/
extrudedHeight : createPropertyDescriptor('extrudedHeight'),
/**
* Gets or sets the Property specifying the extruded {@link HeightReference}.
* @memberof RectangleGraphics.prototype
* @type {Property}
* @default HeightReference.NONE
*/
extrudedHeightReference : createPropertyDescriptor('extrudedHeightReference'),
/**
* Gets or sets the numeric Property specifying the angular distance between points on the rectangle.
* @memberof RectangleGraphics.prototype
* @type {Property}
* @default {CesiumMath.RADIANS_PER_DEGREE}
*/
granularity : createPropertyDescriptor('granularity'),
/**
* Gets or sets the numeric property specifying the rotation of the rectangle texture counter-clockwise from north.
* @memberof RectangleGraphics.prototype
* @type {Property}
* @default 0
*/
stRotation : createPropertyDescriptor('stRotation'),
/**
* Gets or sets the numeric property specifying the rotation of the rectangle clockwise from north.
* @memberof RectangleGraphics.prototype
* @type {Property}
* @default 0
*/
rotation : createPropertyDescriptor('rotation'),
/**
* Gets or sets the boolean Property specifying whether the rectangle is filled with the provided material.
* @memberof RectangleGraphics.prototype
* @type {Property}
* @default true
*/
fill : createPropertyDescriptor('fill'),
/**
* Gets or sets the Property specifying whether the rectangle is outlined.
* @memberof RectangleGraphics.prototype
* @type {Property}
* @default false
*/
outline : createPropertyDescriptor('outline'),
/**
* Gets or sets the Property specifying the {@link Color} of the outline.
* @memberof RectangleGraphics.prototype
* @type {Property}
* @default Color.BLACK
*/
outlineColor : createPropertyDescriptor('outlineColor'),
/**
* Gets or sets the numeric Property specifying the width of the outline.
* @memberof RectangleGraphics.prototype
* @type {Property}
* @default 1.0
*/
outlineWidth : createPropertyDescriptor('outlineWidth'),
/**
* Get or sets the enum Property specifying whether the rectangle
* casts or receives shadows from each light source.
* @memberof RectangleGraphics.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 rectangle will be displayed.
* @memberof RectangleGraphics.prototype
* @type {Property}
*/
distanceDisplayCondition : createPropertyDescriptor('distanceDisplayCondition'),
/**
* Gets or sets the {@link ClassificationType} Property specifying whether this rectangle will classify terrain, 3D Tiles, or both when on the ground.
* @memberof RectangleGraphics.prototype
* @type {Property}
* @default ClassificationType.BOTH
*/
classificationType : createPropertyDescriptor('classificationType'),
/**
* Gets or sets the zIndex Property specifying the ordering of the rectangle. Only has an effect if the rectangle is constant and neither height or extrudedHeight are specified.
* @memberof RectangleGraphics.prototype
* @type {ConstantProperty}
* @default 0
*/
zIndex : createPropertyDescriptor('zIndex')
});
/**
* Duplicates this instance.
*
* @param {RectangleGraphics} [result] The object onto which to store the result.
* @returns {RectangleGraphics} The modified result parameter or a new instance if one was not provided.
*/
RectangleGraphics.prototype.clone = function(result) {
if (!defined(result)) {
return new RectangleGraphics(this);
}
result.show = this.show;
result.coordinates = this.coordinates;
result.material = this.material;
result.height = this.height;
result.heightReference = this.heightReference;
result.extrudedHeight = this.extrudedHeight;
result.extrudedHeightReference = this.extrudedHeightReference;
result.granularity = this.granularity;
result.stRotation = this.stRotation;
result.rotation = this.rotation;
result.fill = this.fill;
result.outline = this.outline;
result.outlineColor = this.outlineColor;
result.outlineWidth = this.outlineWidth;
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 {RectangleGraphics} source The object to be merged into this object.
*/
RectangleGraphics.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.coordinates = defaultValue(this.coordinates, source.coordinates);
this.material = defaultValue(this.material, source.material);
this.height = defaultValue(this.height, source.height);
this.heightReference = defaultValue(this.heightReference, source.heightReference);
this.extrudedHeight = defaultValue(this.extrudedHeight, source.extrudedHeight);
this.extrudedHeightReference = defaultValue(this.extrudedHeightReference, source.extrudedHeightReference);
this.granularity = defaultValue(this.granularity, source.granularity);
this.stRotation = defaultValue(this.stRotation, source.stRotation);
this.rotation = defaultValue(this.rotation, source.rotation);
this.fill = defaultValue(this.fill, source.fill);
this.outline = defaultValue(this.outline, source.outline);
this.outlineColor = defaultValue(this.outlineColor, source.outlineColor);
this.outlineWidth = defaultValue(this.outlineWidth, source.outlineWidth);
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);
};
return RectangleGraphics;
});