-
Notifications
You must be signed in to change notification settings - Fork 3.5k
/
ImageryLayer.js
1763 lines (1604 loc) · 61.4 KB
/
ImageryLayer.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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import Cartesian2 from "../Core/Cartesian2.js";
import Cartesian4 from "../Core/Cartesian4.js";
import Check from "../Core/Check.js";
import createWorldImageryAsync from "../Scene/createWorldImageryAsync.js";
import defaultValue from "../Core/defaultValue.js";
import defined from "../Core/defined.js";
import destroyObject from "../Core/destroyObject.js";
import DeveloperError from "../Core/DeveloperError.js";
import Event from "../Core/Event.js";
import FeatureDetection from "../Core/FeatureDetection.js";
import GeographicProjection from "../Core/GeographicProjection.js";
import IndexDatatype from "../Core/IndexDatatype.js";
import CesiumMath from "../Core/Math.js";
import PixelFormat from "../Core/PixelFormat.js";
import Rectangle from "../Core/Rectangle.js";
import Request from "../Core/Request.js";
import RequestState from "../Core/RequestState.js";
import RequestType from "../Core/RequestType.js";
import TerrainProvider from "../Core/TerrainProvider.js";
import TileProviderError from "../Core/TileProviderError.js";
import WebMercatorProjection from "../Core/WebMercatorProjection.js";
import Buffer from "../Renderer/Buffer.js";
import BufferUsage from "../Renderer/BufferUsage.js";
import ComputeCommand from "../Renderer/ComputeCommand.js";
import ContextLimits from "../Renderer/ContextLimits.js";
import MipmapHint from "../Renderer/MipmapHint.js";
import Sampler from "../Renderer/Sampler.js";
import ShaderProgram from "../Renderer/ShaderProgram.js";
import ShaderSource from "../Renderer/ShaderSource.js";
import Texture from "../Renderer/Texture.js";
import TextureMagnificationFilter from "../Renderer/TextureMagnificationFilter.js";
import TextureMinificationFilter from "../Renderer/TextureMinificationFilter.js";
import TextureWrap from "../Renderer/TextureWrap.js";
import VertexArray from "../Renderer/VertexArray.js";
import ReprojectWebMercatorFS from "../Shaders/ReprojectWebMercatorFS.js";
import ReprojectWebMercatorVS from "../Shaders/ReprojectWebMercatorVS.js";
import Imagery from "./Imagery.js";
import ImageryState from "./ImageryState.js";
import SplitDirection from "./SplitDirection.js";
import TileImagery from "./TileImagery.js";
/**
* @typedef {Object} ImageryLayer.ConstructorOptions
*
* Initialization options for the ImageryLayer constructor.
*
* @property {Rectangle} [rectangle=imageryProvider.rectangle] The rectangle of the layer. This rectangle
* can limit the visible portion of the imagery provider.
* @property {number|Function} [alpha=1.0] The alpha blending value of this layer, from 0.0 to 1.0.
* This can either be a simple number or a function with the signature
* <code>function(frameState, layer, x, y, level)</code>. The function is passed the
* current frame state, this layer, and the x, y, and level coordinates of the
* imagery tile for which the alpha is required, and it is expected to return
* the alpha value to use for the tile.
* @property {number|Function} [nightAlpha=1.0] The alpha blending value of this layer on the night side of the globe, from 0.0 to 1.0.
* This can either be a simple number or a function with the signature
* <code>function(frameState, layer, x, y, level)</code>. The function is passed the
* current frame state, this layer, and the x, y, and level coordinates of the
* imagery tile for which the alpha is required, and it is expected to return
* the alpha value to use for the tile. This only takes effect when <code>enableLighting</code> is <code>true</code>.
* @property {number|Function} [dayAlpha=1.0] The alpha blending value of this layer on the day side of the globe, from 0.0 to 1.0.
* This can either be a simple number or a function with the signature
* <code>function(frameState, layer, x, y, level)</code>. The function is passed the
* current frame state, this layer, and the x, y, and level coordinates of the
* imagery tile for which the alpha is required, and it is expected to return
* the alpha value to use for the tile. This only takes effect when <code>enableLighting</code> is <code>true</code>.
* @property {number|Function} [brightness=1.0] The brightness of this layer. 1.0 uses the unmodified imagery
* color. Less than 1.0 makes the imagery darker while greater than 1.0 makes it brighter.
* This can either be a simple number or a function with the signature
* <code>function(frameState, layer, x, y, level)</code>. The function is passed the
* current frame state, this layer, and the x, y, and level coordinates of the
* imagery tile for which the brightness is required, and it is expected to return
* the brightness value to use for the tile. The function is executed for every
* frame and for every tile, so it must be fast.
* @property {number|Function} [contrast=1.0] The contrast of this layer. 1.0 uses the unmodified imagery color.
* Less than 1.0 reduces the contrast while greater than 1.0 increases it.
* This can either be a simple number or a function with the signature
* <code>function(frameState, layer, x, y, level)</code>. The function is passed the
* current frame state, this layer, and the x, y, and level coordinates of the
* imagery tile for which the contrast is required, and it is expected to return
* the contrast value to use for the tile. The function is executed for every
* frame and for every tile, so it must be fast.
* @property {number|Function} [hue=0.0] The hue of this layer. 0.0 uses the unmodified imagery color.
* This can either be a simple number or a function with the signature
* <code>function(frameState, layer, x, y, level)</code>. The function is passed the
* current frame state, this layer, and the x, y, and level coordinates
* of the imagery tile for which the hue is required, and it is expected to return
* the contrast value to use for the tile. The function is executed for every
* frame and for every tile, so it must be fast.
* @property {number|Function} [saturation=1.0] The saturation of this layer. 1.0 uses the unmodified imagery color.
* Less than 1.0 reduces the saturation while greater than 1.0 increases it.
* This can either be a simple number or a function with the signature
* <code>function(frameState, layer, x, y, level)</code>. The function is passed the
* current frame state, this layer, and the x, y, and level coordinates
* of the imagery tile for which the saturation is required, and it is expected to return
* the contrast value to use for the tile. The function is executed for every
* frame and for every tile, so it must be fast.
* @property {number|Function} [gamma=1.0] The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color.
* This can either be a simple number or a function with the signature
* <code>function(frameState, layer, x, y, level)</code>. The function is passed the
* current frame state, this layer, and the x, y, and level coordinates of the
* imagery tile for which the gamma is required, and it is expected to return
* the gamma value to use for the tile. The function is executed for every
* frame and for every tile, so it must be fast.
* @property {SplitDirection|Function} [splitDirection=SplitDirection.NONE] The {@link SplitDirection} split to apply to this layer.
* @property {TextureMinificationFilter} [minificationFilter=TextureMinificationFilter.LINEAR] The
* texture minification filter to apply to this layer. Possible values
* are <code>TextureMinificationFilter.LINEAR</code> and
* <code>TextureMinificationFilter.NEAREST</code>.
* @property {TextureMagnificationFilter} [magnificationFilter=TextureMagnificationFilter.LINEAR] The
* texture minification filter to apply to this layer. Possible values
* are <code>TextureMagnificationFilter.LINEAR</code> and
* <code>TextureMagnificationFilter.NEAREST</code>.
* @property {boolean} [show=true] True if the layer is shown; otherwise, false.
* @property {number} [maximumAnisotropy=maximum supported] The maximum anisotropy level to use
* for texture filtering. If this parameter is not specified, the maximum anisotropy supported
* by the WebGL stack will be used. Larger values make the imagery look better in horizon
* views.
* @property {number} [minimumTerrainLevel] The minimum terrain level-of-detail at which to show this imagery layer,
* or undefined to show it at all levels. Level zero is the least-detailed level.
* @property {number} [maximumTerrainLevel] The maximum terrain level-of-detail at which to show this imagery layer,
* or undefined to show it at all levels. Level zero is the least-detailed level.
* @property {Rectangle} [cutoutRectangle] Cartographic rectangle for cutting out a portion of this ImageryLayer.
* @property {Color} [colorToAlpha] Color to be used as alpha.
* @property {number} [colorToAlphaThreshold=0.004] Threshold for color-to-alpha.
*/
/**
* An imagery layer that displays tiled image data from a single imagery provider
* on a {@link Globe}.
*
* @alias ImageryLayer
* @constructor
*
* @param {ImageryProvider} [imageryProvider] The imagery provider to use.
* @param {ImageryLayer.ConstructorOptions} [options] An object describing initialization options
*
* @see ImageryLayer.fromProviderAsync
* @see ImageryLayer.fromWorldImagery
*
* @example
* // Add an OpenStreetMaps layer
* const imageryLayer = new Cesium.ImageryLayer(new Cesium.OpenStreetMapImageryProvider({
* url: "https://tile.openstreetmap.org/"
* }));
* scene.imageryLayers.add(imageryLayer);
*
* @example
* // Add Cesium ion's default world imagery layer
* const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
* scene.imageryLayers.add(imageryLayer);
*
* @example
* // Add a new transparent layer from Cesium ion
* const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
* imageryLayer.alpha = 0.5;
* scene.imageryLayers.add(imageryLayer);
*/
function ImageryLayer(imageryProvider, options) {
this._imageryProvider = imageryProvider;
this._readyEvent = new Event();
this._errorEvent = new Event();
options = defaultValue(options, defaultValue.EMPTY_OBJECT);
imageryProvider = defaultValue(imageryProvider, defaultValue.EMPTY_OBJECT);
/**
* The alpha blending value of this layer, with 0.0 representing fully transparent and
* 1.0 representing fully opaque.
*
* @type {number}
* @default 1.0
*/
this.alpha = defaultValue(
options.alpha,
defaultValue(imageryProvider._defaultAlpha, 1.0)
);
/**
* The alpha blending value of this layer on the night side of the globe, with 0.0 representing fully transparent and
* 1.0 representing fully opaque. This only takes effect when {@link Globe#enableLighting} is <code>true</code>.
*
* @type {number}
* @default 1.0
*/
this.nightAlpha = defaultValue(
options.nightAlpha,
defaultValue(imageryProvider._defaultNightAlpha, 1.0)
);
/**
* The alpha blending value of this layer on the day side of the globe, with 0.0 representing fully transparent and
* 1.0 representing fully opaque. This only takes effect when {@link Globe#enableLighting} is <code>true</code>.
*
* @type {number}
* @default 1.0
*/
this.dayAlpha = defaultValue(
options.dayAlpha,
defaultValue(imageryProvider._defaultDayAlpha, 1.0)
);
/**
* The brightness of this layer. 1.0 uses the unmodified imagery color. Less than 1.0
* makes the imagery darker while greater than 1.0 makes it brighter.
*
* @type {number}
* @default {@link ImageryLayer.DEFAULT_BRIGHTNESS}
*/
this.brightness = defaultValue(
options.brightness,
defaultValue(
imageryProvider._defaultBrightness,
ImageryLayer.DEFAULT_BRIGHTNESS
)
);
/**
* The contrast of this layer. 1.0 uses the unmodified imagery color. Less than 1.0 reduces
* the contrast while greater than 1.0 increases it.
*
* @type {number}
* @default {@link ImageryLayer.DEFAULT_CONTRAST}
*/
this.contrast = defaultValue(
options.contrast,
defaultValue(
imageryProvider._defaultContrast,
ImageryLayer.DEFAULT_CONTRAST
)
);
/**
* The hue of this layer in radians. 0.0 uses the unmodified imagery color.
*
* @type {number}
* @default {@link ImageryLayer.DEFAULT_HUE}
*/
this.hue = defaultValue(
options.hue,
defaultValue(imageryProvider._defaultHue, ImageryLayer.DEFAULT_HUE)
);
/**
* The saturation of this layer. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the
* saturation while greater than 1.0 increases it.
*
* @type {number}
* @default {@link ImageryLayer.DEFAULT_SATURATION}
*/
this.saturation = defaultValue(
options.saturation,
defaultValue(
imageryProvider._defaultSaturation,
ImageryLayer.DEFAULT_SATURATION
)
);
/**
* The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color.
*
* @type {number}
* @default {@link ImageryLayer.DEFAULT_GAMMA}
*/
this.gamma = defaultValue(
options.gamma,
defaultValue(imageryProvider._defaultGamma, ImageryLayer.DEFAULT_GAMMA)
);
/**
* The {@link SplitDirection} to apply to this layer.
*
* @type {SplitDirection}
* @default {@link ImageryLayer.DEFAULT_SPLIT}
*/
this.splitDirection = defaultValue(
options.splitDirection,
ImageryLayer.DEFAULT_SPLIT
);
/**
* The {@link TextureMinificationFilter} to apply to this layer.
* Possible values are {@link TextureMinificationFilter.LINEAR} (the default)
* and {@link TextureMinificationFilter.NEAREST}.
*
* To take effect, this property must be set immediately after adding the imagery layer.
* Once a texture is loaded it won't be possible to change the texture filter used.
*
* @type {TextureMinificationFilter}
* @default {@link ImageryLayer.DEFAULT_MINIFICATION_FILTER}
*/
this.minificationFilter = defaultValue(
options.minificationFilter,
defaultValue(
imageryProvider._defaultMinificationFilter,
ImageryLayer.DEFAULT_MINIFICATION_FILTER
)
);
/**
* The {@link TextureMagnificationFilter} to apply to this layer.
* Possible values are {@link TextureMagnificationFilter.LINEAR} (the default)
* and {@link TextureMagnificationFilter.NEAREST}.
*
* To take effect, this property must be set immediately after adding the imagery layer.
* Once a texture is loaded it won't be possible to change the texture filter used.
*
* @type {TextureMagnificationFilter}
* @default {@link ImageryLayer.DEFAULT_MAGNIFICATION_FILTER}
*/
this.magnificationFilter = defaultValue(
options.magnificationFilter,
defaultValue(
imageryProvider._defaultMagnificationFilter,
ImageryLayer.DEFAULT_MAGNIFICATION_FILTER
)
);
/**
* Determines if this layer is shown.
*
* @type {boolean}
* @default true
*/
this.show = defaultValue(options.show, true);
this._minimumTerrainLevel = options.minimumTerrainLevel;
this._maximumTerrainLevel = options.maximumTerrainLevel;
this._rectangle = defaultValue(options.rectangle, Rectangle.MAX_VALUE);
this._maximumAnisotropy = options.maximumAnisotropy;
this._imageryCache = {};
this._skeletonPlaceholder = new TileImagery(Imagery.createPlaceholder(this));
// The value of the show property on the last update.
this._show = true;
// The index of this layer in the ImageryLayerCollection.
this._layerIndex = -1;
// true if this is the base (lowest shown) layer.
this._isBaseLayer = false;
this._requestImageError = undefined;
this._reprojectComputeCommands = [];
/**
* Rectangle cutout in this layer of imagery.
*
* @type {Rectangle}
*/
this.cutoutRectangle = options.cutoutRectangle;
/**
* Color value that should be set to transparent.
*
* @type {Color}
*/
this.colorToAlpha = options.colorToAlpha;
/**
* Normalized (0-1) threshold for color-to-alpha.
*
* @type {number}
*/
this.colorToAlphaThreshold = defaultValue(
options.colorToAlphaThreshold,
ImageryLayer.DEFAULT_APPLY_COLOR_TO_ALPHA_THRESHOLD
);
}
Object.defineProperties(ImageryLayer.prototype, {
/**
* Gets the imagery provider for this layer. This should not be called before {@link ImageryLayer#ready} returns true.
* @memberof ImageryLayer.prototype
* @type {ImageryProvider}
* @readonly
*/
imageryProvider: {
get: function () {
return this._imageryProvider;
},
},
/**
* Returns true when the terrain provider has been successfully created. Otherwise, returns false.
* @memberof ImageryLayer.prototype
* @type {boolean}
* @readonly
*/
ready: {
get: function () {
return defined(this._imageryProvider);
},
},
/**
* Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing
* to the event, you will be notified of the error and can potentially recover from it. Event listeners
* are passed an instance of the thrown error.
* @memberof Imagery.prototype
* @type {Event<Imagery.ErrorEventCallback>}
* @readonly
*/
errorEvent: {
get: function () {
return this._errorEvent;
},
},
/**
* Gets an event that is raised when the imagery provider has been successfully created. Event listeners
* are passed the created instance of {@link ImageryProvider}.
* @memberof ImageryLayer.prototype
* @type {Event<ImageryLayer.ReadyEventCallback>}
* @readonly
*/
readyEvent: {
get: function () {
return this._readyEvent;
},
},
/**
* Gets the rectangle of this layer. If this rectangle is smaller than the rectangle of the
* {@link ImageryProvider}, only a portion of the imagery provider is shown.
* @memberof ImageryLayer.prototype
* @type {Rectangle}
* @readonly
*/
rectangle: {
get: function () {
return this._rectangle;
},
},
});
/**
* This value is used as the default brightness for the imagery layer if one is not provided during construction
* or by the imagery provider. This value does not modify the brightness of the imagery.
* @type {number}
* @default 1.0
*/
ImageryLayer.DEFAULT_BRIGHTNESS = 1.0;
/**
* This value is used as the default contrast for the imagery layer if one is not provided during construction
* or by the imagery provider. This value does not modify the contrast of the imagery.
* @type {number}
* @default 1.0
*/
ImageryLayer.DEFAULT_CONTRAST = 1.0;
/**
* This value is used as the default hue for the imagery layer if one is not provided during construction
* or by the imagery provider. This value does not modify the hue of the imagery.
* @type {number}
* @default 0.0
*/
ImageryLayer.DEFAULT_HUE = 0.0;
/**
* This value is used as the default saturation for the imagery layer if one is not provided during construction
* or by the imagery provider. This value does not modify the saturation of the imagery.
* @type {number}
* @default 1.0
*/
ImageryLayer.DEFAULT_SATURATION = 1.0;
/**
* This value is used as the default gamma for the imagery layer if one is not provided during construction
* or by the imagery provider. This value does not modify the gamma of the imagery.
* @type {number}
* @default 1.0
*/
ImageryLayer.DEFAULT_GAMMA = 1.0;
/**
* This value is used as the default split for the imagery layer if one is not provided during construction
* or by the imagery provider.
* @type {SplitDirection}
* @default SplitDirection.NONE
*/
ImageryLayer.DEFAULT_SPLIT = SplitDirection.NONE;
/**
* This value is used as the default texture minification filter for the imagery layer if one is not provided
* during construction or by the imagery provider.
* @type {TextureMinificationFilter}
* @default TextureMinificationFilter.LINEAR
*/
ImageryLayer.DEFAULT_MINIFICATION_FILTER = TextureMinificationFilter.LINEAR;
/**
* This value is used as the default texture magnification filter for the imagery layer if one is not provided
* during construction or by the imagery provider.
* @type {TextureMagnificationFilter}
* @default TextureMagnificationFilter.LINEAR
*/
ImageryLayer.DEFAULT_MAGNIFICATION_FILTER = TextureMagnificationFilter.LINEAR;
/**
* This value is used as the default threshold for color-to-alpha if one is not provided
* during construction or by the imagery provider.
* @type {number}
* @default 0.004
*/
ImageryLayer.DEFAULT_APPLY_COLOR_TO_ALPHA_THRESHOLD = 0.004;
/**
* Create a new imagery layer from an asynchronous imagery provider. The layer will handle any asynchronous loads or errors, and begin rendering the imagery layer once ready.
*
* @param {Promise<ImageryProvider>} imageryProviderPromise A promise which resolves to a imagery provider
* @param {ImageryLayer.ConstructorOptions} options An object describing initialization options
* @returns {ImageryLayer} The created imagery layer.
*
* @example
* // Create a new base layer
* const viewer = new Cesium.Viewer("cesiumContainer", {
* baseLayer: Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
* });
*
* @example
* // Add a new transparent layer
* const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
* imageryLayer.alpha = 0.5;
* viewer.imageryLayers.add(imageryLayer);
*
* @example
* // Handle loading events
* const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
* viewer.imageryLayers.add(imageryLayer);
*
* imageryLayer.readyEvent.addEventListener(provider => {
* imageryLayer.provider.errorEvent.addEventListener(error => {
* alert(`Encountered an error while loading imagery tiles! ${error}`);
* });
* });
*
* imageryLayer.errorEvent.addEventListener(error => {
* alert(`Encountered an error while creating an imagery layer! ${error}`);
* });
*
* @see ImageryLayer.errorEvent
* @see ImageryLayer.readyEvent
* @see ImageryLayer.provider
* @see ImageryLayer.fromWorldImagery
*/
ImageryLayer.fromProviderAsync = function (imageryProviderPromise, options) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.object("imageryProviderPromise", imageryProviderPromise);
//>>includeEnd('debug');
const layer = new ImageryLayer(undefined, options);
handlePromise(layer, Promise.resolve(imageryProviderPromise));
return layer;
};
/**
* @typedef {ImageryLayer.ConstructorOptions} ImageryLayer.WorldImageryConstructorOptions
*
* Initialization options for ImageryLayer.fromWorldImagery
*
* @property {IonWorldImageryStyle} [options.style=IonWorldImageryStyle] The style of base imagery, only AERIAL, AERIAL_WITH_LABELS, and ROAD are currently supported.
*/
/**
* Create a new imagery layer for ion's default global base imagery layer, currently Bing Maps. The layer will handle any asynchronous loads or errors, and begin rendering the imagery layer once ready.
*
* @param {ImageryLayer.WorldImageryConstructorOptions} options An object describing initialization options
* @returns {ImageryLayer} The created imagery layer.
*
* * @example
* // Create a new base layer
* const viewer = new Cesium.Viewer("cesiumContainer", {
* baseLayer: Cesium.ImageryLayer.fromWorldImagery();
* });
*
* @example
* // Add a new transparent layer
* const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
* imageryLayer.alpha = 0.5;
* viewer.imageryLayers.add(imageryLayer);
*
* @example
* // Handle loading events
* const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
* viewer.imageryLayers.add(imageryLayer);
*
* imageryLayer.readyEvent.addEventListener(provider => {
* imageryLayer.provider.errorEvent.addEventListener(error => {
* alert(`Encountered an error while loading imagery tiles! ${error}`);
* });
* });
*
* imageryLayer.errorEvent.addEventListener(error => {
* alert(`Encountered an error while creating an imagery layer! ${error}`);
* });
*
* @see ImageryLayer.errorEvent
* @see ImageryLayer.readyEvent
* @see ImageryLayer.provider
*/
ImageryLayer.fromWorldImagery = function (options) {
options = defaultValue(options, defaultValue.EMPTY_OBJECT);
return ImageryLayer.fromProviderAsync(
createWorldImageryAsync({
style: options.style,
}),
options
);
};
/**
* Gets a value indicating whether this layer is the base layer in the
* {@link ImageryLayerCollection}. The base layer is the one that underlies all
* others. It is special in that it is treated as if it has global rectangle, even if
* it actually does not, by stretching the texels at the edges over the entire
* globe.
*
* @returns {boolean} true if this is the base layer; otherwise, false.
*/
ImageryLayer.prototype.isBaseLayer = function () {
return this._isBaseLayer;
};
/**
* Returns true if this object was destroyed; otherwise, false.
* <br /><br />
* If this object was destroyed, it should not be used; calling any function other than
* <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
*
* @returns {boolean} True if this object was destroyed; otherwise, false.
*
* @see ImageryLayer#destroy
*/
ImageryLayer.prototype.isDestroyed = function () {
return false;
};
/**
* Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
* release of WebGL resources, instead of relying on the garbage collector to destroy this object.
* <br /><br />
* Once an object is destroyed, it should not be used; calling any function other than
* <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
* assign the return value (<code>undefined</code>) to the object as done in the example.
*
* @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
*
*
* @example
* imageryLayer = imageryLayer && imageryLayer.destroy();
*
* @see ImageryLayer#isDestroyed
*/
ImageryLayer.prototype.destroy = function () {
return destroyObject(this);
};
const imageryBoundsScratch = new Rectangle();
const tileImageryBoundsScratch = new Rectangle();
const clippedRectangleScratch = new Rectangle();
const terrainRectangleScratch = new Rectangle();
/**
* Computes the intersection of this layer's rectangle with the imagery provider's availability rectangle,
* producing the overall bounds of imagery that can be produced by this layer.
*
* @returns {Rectangle} A rectangle which defines the overall bounds of imagery that can be produced by this layer.
*
* @example
* // Zoom to an imagery layer.
* const imageryRectangle = imageryLayer.getImageryRectangle();
* scene.camera.flyTo({
* destination: rectangle
* });
*
*/
ImageryLayer.prototype.getImageryRectangle = function () {
const imageryProvider = this._imageryProvider;
const rectangle = this._rectangle;
return Rectangle.intersection(imageryProvider.rectangle, rectangle);
};
/**
* Create skeletons for the imagery tiles that partially or completely overlap a given terrain
* tile.
*
* @private
*
* @param {Tile} tile The terrain tile.
* @param {TerrainProvider|undefined} terrainProvider The terrain provider associated with the terrain tile.
* @param {number} insertionPoint The position to insert new skeletons before in the tile's imagery list.
* @returns {boolean} true if this layer overlaps any portion of the terrain tile; otherwise, false.
*/
ImageryLayer.prototype._createTileImagerySkeletons = function (
tile,
terrainProvider,
insertionPoint
) {
const surfaceTile = tile.data;
if (
!defined(terrainProvider) ||
(defined(this._minimumTerrainLevel) &&
tile.level < this._minimumTerrainLevel)
) {
return false;
}
if (
defined(this._maximumTerrainLevel) &&
tile.level > this._maximumTerrainLevel
) {
return false;
}
if (!defined(insertionPoint)) {
insertionPoint = surfaceTile.imagery.length;
}
const imageryProvider = this._imageryProvider;
if (!this.ready) {
// The imagery provider is not ready, so we can't create skeletons, yet.
// Instead, add a placeholder so that we'll know to create
// the skeletons once the provider is ready.
this._skeletonPlaceholder.loadingImagery.addReference();
surfaceTile.imagery.splice(insertionPoint, 0, this._skeletonPlaceholder);
return true;
}
// Use Web Mercator for our texture coordinate computations if this imagery layer uses
// that projection and the terrain tile falls entirely inside the valid bounds of the
// projection.
const useWebMercatorT =
imageryProvider.tilingScheme.projection instanceof WebMercatorProjection &&
tile.rectangle.north < WebMercatorProjection.MaximumLatitude &&
tile.rectangle.south > -WebMercatorProjection.MaximumLatitude;
// Compute the rectangle of the imagery from this imageryProvider that overlaps
// the geometry tile. The ImageryProvider and ImageryLayer both have the
// opportunity to constrain the rectangle. The imagery TilingScheme's rectangle
// always fully contains the ImageryProvider's rectangle.
const imageryBounds = Rectangle.intersection(
imageryProvider.rectangle,
this._rectangle,
imageryBoundsScratch
);
let rectangle = Rectangle.intersection(
tile.rectangle,
imageryBounds,
tileImageryBoundsScratch
);
if (!defined(rectangle)) {
// There is no overlap between this terrain tile and this imagery
// provider. Unless this is the base layer, no skeletons need to be created.
// We stretch texels at the edge of the base layer over the entire globe.
if (!this.isBaseLayer()) {
return false;
}
const baseImageryRectangle = imageryBounds;
const baseTerrainRectangle = tile.rectangle;
rectangle = tileImageryBoundsScratch;
if (baseTerrainRectangle.south >= baseImageryRectangle.north) {
rectangle.north = rectangle.south = baseImageryRectangle.north;
} else if (baseTerrainRectangle.north <= baseImageryRectangle.south) {
rectangle.north = rectangle.south = baseImageryRectangle.south;
} else {
rectangle.south = Math.max(
baseTerrainRectangle.south,
baseImageryRectangle.south
);
rectangle.north = Math.min(
baseTerrainRectangle.north,
baseImageryRectangle.north
);
}
if (baseTerrainRectangle.west >= baseImageryRectangle.east) {
rectangle.west = rectangle.east = baseImageryRectangle.east;
} else if (baseTerrainRectangle.east <= baseImageryRectangle.west) {
rectangle.west = rectangle.east = baseImageryRectangle.west;
} else {
rectangle.west = Math.max(
baseTerrainRectangle.west,
baseImageryRectangle.west
);
rectangle.east = Math.min(
baseTerrainRectangle.east,
baseImageryRectangle.east
);
}
}
let latitudeClosestToEquator = 0.0;
if (rectangle.south > 0.0) {
latitudeClosestToEquator = rectangle.south;
} else if (rectangle.north < 0.0) {
latitudeClosestToEquator = rectangle.north;
}
// Compute the required level in the imagery tiling scheme.
// The errorRatio should really be imagerySSE / terrainSSE rather than this hard-coded value.
// But first we need configurable imagery SSE and we need the rendering to be able to handle more
// images attached to a terrain tile than there are available texture units. So that's for the future.
const errorRatio = 1.0;
const targetGeometricError =
errorRatio * terrainProvider.getLevelMaximumGeometricError(tile.level);
let imageryLevel = getLevelWithMaximumTexelSpacing(
this,
targetGeometricError,
latitudeClosestToEquator
);
imageryLevel = Math.max(0, imageryLevel);
const maximumLevel = imageryProvider.maximumLevel;
if (imageryLevel > maximumLevel) {
imageryLevel = maximumLevel;
}
if (defined(imageryProvider.minimumLevel)) {
const minimumLevel = imageryProvider.minimumLevel;
if (imageryLevel < minimumLevel) {
imageryLevel = minimumLevel;
}
}
const imageryTilingScheme = imageryProvider.tilingScheme;
const northwestTileCoordinates = imageryTilingScheme.positionToTileXY(
Rectangle.northwest(rectangle),
imageryLevel
);
const southeastTileCoordinates = imageryTilingScheme.positionToTileXY(
Rectangle.southeast(rectangle),
imageryLevel
);
// If the southeast corner of the rectangle lies very close to the north or west side
// of the southeast tile, we don't actually need the southernmost or easternmost
// tiles.
// Similarly, if the northwest corner of the rectangle lies very close to the south or east side
// of the northwest tile, we don't actually need the northernmost or westernmost tiles.
// We define "very close" as being within 1/512 of the width of the tile.
let veryCloseX = tile.rectangle.width / 512.0;
let veryCloseY = tile.rectangle.height / 512.0;
const northwestTileRectangle = imageryTilingScheme.tileXYToRectangle(
northwestTileCoordinates.x,
northwestTileCoordinates.y,
imageryLevel
);
if (
Math.abs(northwestTileRectangle.south - tile.rectangle.north) <
veryCloseY &&
northwestTileCoordinates.y < southeastTileCoordinates.y
) {
++northwestTileCoordinates.y;
}
if (
Math.abs(northwestTileRectangle.east - tile.rectangle.west) < veryCloseX &&
northwestTileCoordinates.x < southeastTileCoordinates.x
) {
++northwestTileCoordinates.x;
}
const southeastTileRectangle = imageryTilingScheme.tileXYToRectangle(
southeastTileCoordinates.x,
southeastTileCoordinates.y,
imageryLevel
);
if (
Math.abs(southeastTileRectangle.north - tile.rectangle.south) <
veryCloseY &&
southeastTileCoordinates.y > northwestTileCoordinates.y
) {
--southeastTileCoordinates.y;
}
if (
Math.abs(southeastTileRectangle.west - tile.rectangle.east) < veryCloseX &&
southeastTileCoordinates.x > northwestTileCoordinates.x
) {
--southeastTileCoordinates.x;
}
// Create TileImagery instances for each imagery tile overlapping this terrain tile.
// We need to do all texture coordinate computations in the imagery tile's tiling scheme.
const terrainRectangle = Rectangle.clone(
tile.rectangle,
terrainRectangleScratch
);
let imageryRectangle = imageryTilingScheme.tileXYToRectangle(
northwestTileCoordinates.x,
northwestTileCoordinates.y,
imageryLevel
);
let clippedImageryRectangle = Rectangle.intersection(
imageryRectangle,
imageryBounds,
clippedRectangleScratch
);
let imageryTileXYToRectangle;
if (useWebMercatorT) {
imageryTilingScheme.rectangleToNativeRectangle(
terrainRectangle,
terrainRectangle
);
imageryTilingScheme.rectangleToNativeRectangle(
imageryRectangle,
imageryRectangle
);
imageryTilingScheme.rectangleToNativeRectangle(
clippedImageryRectangle,
clippedImageryRectangle
);
imageryTilingScheme.rectangleToNativeRectangle(
imageryBounds,
imageryBounds
);
imageryTileXYToRectangle = imageryTilingScheme.tileXYToNativeRectangle.bind(
imageryTilingScheme
);
veryCloseX = terrainRectangle.width / 512.0;
veryCloseY = terrainRectangle.height / 512.0;
} else {
imageryTileXYToRectangle = imageryTilingScheme.tileXYToRectangle.bind(
imageryTilingScheme
);
}
let minU;
let maxU = 0.0;
let minV = 1.0;
let maxV;
// If this is the northern-most or western-most tile in the imagery tiling scheme,
// it may not start at the northern or western edge of the terrain tile.
// Calculate where it does start.
if (
!this.isBaseLayer() &&
Math.abs(clippedImageryRectangle.west - terrainRectangle.west) >= veryCloseX
) {
maxU = Math.min(
1.0,
(clippedImageryRectangle.west - terrainRectangle.west) /
terrainRectangle.width
);
}
if (
!this.isBaseLayer() &&
Math.abs(clippedImageryRectangle.north - terrainRectangle.north) >=
veryCloseY
) {
minV = Math.max(
0.0,
(clippedImageryRectangle.north - terrainRectangle.south) /
terrainRectangle.height
);
}
const initialMinV = minV;
for (
let i = northwestTileCoordinates.x;
i <= southeastTileCoordinates.x;
i++
) {
minU = maxU;
imageryRectangle = imageryTileXYToRectangle(
i,
northwestTileCoordinates.y,
imageryLevel
);
clippedImageryRectangle = Rectangle.simpleIntersection(
imageryRectangle,
imageryBounds,
clippedRectangleScratch
);
if (!defined(clippedImageryRectangle)) {
continue;
}
maxU = Math.min(
1.0,
(clippedImageryRectangle.east - terrainRectangle.west) /
terrainRectangle.width
);
// If this is the eastern-most imagery tile mapped to this terrain tile,