mars3d-cesium 1.125.0 → 1.125.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. package/Build/Cesium/Cesium.d.ts +931 -1448
  2. package/Build/Cesium/Cesium.js +15210 -15210
  3. package/Build/Cesium/README.md +13 -0
  4. package/Build/Cesium/Workers/{chunk-6IUI4MA7.js → chunk-2UZFBSSB.js} +2 -2
  5. package/Build/Cesium/Workers/{chunk-VKQRF7HL.js → chunk-3HHIRNOO.js} +2 -2
  6. package/Build/Cesium/Workers/{chunk-GQMIKH5H.js → chunk-46XGUA6R.js} +1 -1
  7. package/Build/Cesium/Workers/{chunk-OCHKFOPR.js → chunk-6NVYNBOU.js} +2 -2
  8. package/Build/Cesium/Workers/{chunk-BWLZ3QCO.js → chunk-773JEVMF.js} +2 -2
  9. package/Build/Cesium/Workers/{chunk-7SJVDNYB.js → chunk-77BVDWDZ.js} +2 -2
  10. package/Build/Cesium/Workers/{chunk-ASET7NRG.js → chunk-7LTNOHIS.js} +2 -2
  11. package/Build/Cesium/Workers/{chunk-RIB7EOON.js → chunk-A2ZU6XTS.js} +2 -2
  12. package/Build/Cesium/Workers/{chunk-2OOH46JS.js → chunk-AB6BXW2X.js} +2 -2
  13. package/Build/Cesium/Workers/chunk-AHXZX5AT.js +26 -0
  14. package/Build/Cesium/Workers/{chunk-Q5I7IT7P.js → chunk-ANEU72JU.js} +2 -2
  15. package/Build/Cesium/Workers/{chunk-F2Z6GE6G.js → chunk-AUHWAGVO.js} +2 -2
  16. package/Build/Cesium/Workers/{chunk-GXNTS2UA.js → chunk-BJOJ5NHC.js} +2 -2
  17. package/Build/Cesium/Workers/{chunk-6DQW6NRU.js → chunk-BPDEHBBZ.js} +2 -2
  18. package/Build/Cesium/Workers/{chunk-QL2MZ76D.js → chunk-BY4QQZVA.js} +3 -3
  19. package/Build/Cesium/Workers/{chunk-MJCITUHJ.js → chunk-C6J3BMVD.js} +2 -2
  20. package/Build/Cesium/Workers/{chunk-KEE27YTV.js → chunk-CBBLBV3O.js} +2 -2
  21. package/Build/Cesium/Workers/{chunk-F2G7OHSX.js → chunk-DJBXQ6UE.js} +2 -2
  22. package/Build/Cesium/Workers/{chunk-3AVCBMDN.js → chunk-F6YWKYMJ.js} +2 -2
  23. package/Build/Cesium/Workers/{chunk-QXGLAPJD.js → chunk-GFVUXNPF.js} +2 -2
  24. package/Build/Cesium/Workers/{chunk-S7KTIAXB.js → chunk-HDQQWVQZ.js} +2 -2
  25. package/Build/Cesium/Workers/{chunk-HO4GOHJF.js → chunk-IA263462.js} +1 -1
  26. package/Build/Cesium/Workers/{chunk-K6PUJAYT.js → chunk-IOALS3FH.js} +2 -2
  27. package/Build/Cesium/Workers/{chunk-QC5UETCI.js → chunk-ITLAYTGR.js} +2 -2
  28. package/Build/Cesium/Workers/{chunk-GQEXCWUU.js → chunk-IXVN2NOA.js} +2 -2
  29. package/Build/Cesium/Workers/{chunk-QW4E4LMT.js → chunk-JCY2C4IM.js} +2 -2
  30. package/Build/Cesium/Workers/{chunk-ABBJLCOR.js → chunk-JV2HHT7Z.js} +1 -1
  31. package/Build/Cesium/Workers/{chunk-SPTDAMKY.js → chunk-KKLYVGHK.js} +2 -2
  32. package/Build/Cesium/Workers/{chunk-O5TW6IGX.js → chunk-KNHPTALD.js} +2 -2
  33. package/Build/Cesium/Workers/{chunk-XFUY76FP.js → chunk-LUJM6ESA.js} +2 -2
  34. package/Build/Cesium/Workers/{chunk-2KYTGZVC.js → chunk-MBCMWSCP.js} +2 -2
  35. package/Build/Cesium/Workers/chunk-MKKB3G3L.js +28 -0
  36. package/Build/Cesium/Workers/{chunk-VZAG5RE4.js → chunk-NEKNC6WA.js} +2 -2
  37. package/Build/Cesium/Workers/{chunk-AMLZYJ2R.js → chunk-NX5OU6SB.js} +2 -2
  38. package/Build/Cesium/Workers/{chunk-YCDZI5IY.js → chunk-OR4LTELN.js} +1 -1
  39. package/Build/Cesium/Workers/{chunk-K5G4RKNZ.js → chunk-OV637V22.js} +2 -2
  40. package/Build/Cesium/Workers/{chunk-FL2EHGGP.js → chunk-OZ6FGR4J.js} +2 -2
  41. package/Build/Cesium/Workers/{chunk-CGLPPBJZ.js → chunk-PTLFKAXD.js} +2 -2
  42. package/Build/Cesium/Workers/{chunk-6S5JJ2VZ.js → chunk-QWLVE2AT.js} +2 -2
  43. package/Build/Cesium/Workers/{chunk-K44ZD4QY.js → chunk-RCJPU2DX.js} +2 -2
  44. package/Build/Cesium/Workers/{chunk-ALBASJU3.js → chunk-RL743EKS.js} +2 -2
  45. package/Build/Cesium/Workers/{chunk-OLNJDSMT.js → chunk-RZQL5F44.js} +2 -2
  46. package/Build/Cesium/Workers/{chunk-2XB4QIJ4.js → chunk-SKFJ2DRZ.js} +2 -2
  47. package/Build/Cesium/Workers/{chunk-C5UP27Q3.js → chunk-SNZK3GBW.js} +2 -2
  48. package/Build/Cesium/Workers/{chunk-EAYE7EWT.js → chunk-URZX3OSH.js} +2 -2
  49. package/Build/Cesium/Workers/{chunk-3Y2ILKM5.js → chunk-VTWUN3C4.js} +2 -2
  50. package/Build/Cesium/Workers/{chunk-KNABR2D4.js → chunk-W52PIE4Z.js} +2 -2
  51. package/Build/Cesium/Workers/{chunk-NOH5HXTJ.js → chunk-W6DYP6RP.js} +2 -2
  52. package/Build/Cesium/Workers/{chunk-JBY23FLT.js → chunk-XDY4CVDM.js} +2 -2
  53. package/Build/Cesium/Workers/{chunk-WJ6OY3E4.js → chunk-YMZY3BL5.js} +2 -2
  54. package/Build/Cesium/Workers/{chunk-ULSR43VM.js → chunk-Z7PETD2R.js} +2 -2
  55. package/Build/Cesium/Workers/{chunk-L2OFTTZJ.js → chunk-ZQPYQITL.js} +2 -2
  56. package/Build/Cesium/Workers/combineGeometry.js +2 -2
  57. package/Build/Cesium/Workers/createBoxGeometry.js +2 -2
  58. package/Build/Cesium/Workers/createBoxOutlineGeometry.js +2 -2
  59. package/Build/Cesium/Workers/createCircleGeometry.js +2 -2
  60. package/Build/Cesium/Workers/createCircleOutlineGeometry.js +2 -2
  61. package/Build/Cesium/Workers/createCoplanarPolygonGeometry.js +2 -2
  62. package/Build/Cesium/Workers/createCoplanarPolygonOutlineGeometry.js +2 -2
  63. package/Build/Cesium/Workers/createCorridorGeometry.js +2 -2
  64. package/Build/Cesium/Workers/createCorridorOutlineGeometry.js +2 -2
  65. package/Build/Cesium/Workers/createCylinderGeometry.js +2 -2
  66. package/Build/Cesium/Workers/createCylinderOutlineGeometry.js +2 -2
  67. package/Build/Cesium/Workers/createEllipseGeometry.js +2 -2
  68. package/Build/Cesium/Workers/createEllipseOutlineGeometry.js +2 -2
  69. package/Build/Cesium/Workers/createEllipsoidGeometry.js +2 -2
  70. package/Build/Cesium/Workers/createEllipsoidOutlineGeometry.js +2 -2
  71. package/Build/Cesium/Workers/createFrustumGeometry.js +2 -2
  72. package/Build/Cesium/Workers/createFrustumOutlineGeometry.js +2 -2
  73. package/Build/Cesium/Workers/createGeometry.js +2 -2
  74. package/Build/Cesium/Workers/createGroundPolylineGeometry.js +2 -2
  75. package/Build/Cesium/Workers/createPlaneGeometry.js +2 -2
  76. package/Build/Cesium/Workers/createPlaneOutlineGeometry.js +2 -2
  77. package/Build/Cesium/Workers/createPolygonGeometry.js +2 -2
  78. package/Build/Cesium/Workers/createPolygonOutlineGeometry.js +2 -2
  79. package/Build/Cesium/Workers/createPolylineGeometry.js +2 -2
  80. package/Build/Cesium/Workers/createPolylineVolumeGeometry.js +2 -2
  81. package/Build/Cesium/Workers/createPolylineVolumeOutlineGeometry.js +2 -2
  82. package/Build/Cesium/Workers/createRectangleGeometry.js +2 -2
  83. package/Build/Cesium/Workers/createRectangleOutlineGeometry.js +2 -2
  84. package/Build/Cesium/Workers/createSimplePolylineGeometry.js +2 -2
  85. package/Build/Cesium/Workers/createSphereGeometry.js +2 -2
  86. package/Build/Cesium/Workers/createSphereOutlineGeometry.js +2 -2
  87. package/Build/Cesium/Workers/createTaskProcessorWorker.js +2 -2
  88. package/Build/Cesium/Workers/createVectorTileClampedPolylines.js +2 -2
  89. package/Build/Cesium/Workers/createVectorTileGeometries.js +2 -2
  90. package/Build/Cesium/Workers/createVectorTilePoints.js +2 -2
  91. package/Build/Cesium/Workers/createVectorTilePolygons.js +2 -2
  92. package/Build/Cesium/Workers/createVectorTilePolylines.js +2 -2
  93. package/Build/Cesium/Workers/createVerticesFromGoogleEarthEnterpriseBuffer.js +2 -2
  94. package/Build/Cesium/Workers/createVerticesFromHeightmap.js +2 -2
  95. package/Build/Cesium/Workers/createVerticesFromQuantizedTerrainMesh.js +2 -2
  96. package/Build/Cesium/Workers/createWallGeometry.js +2 -2
  97. package/Build/Cesium/Workers/createWallOutlineGeometry.js +2 -2
  98. package/Build/Cesium/Workers/decodeDraco.js +2 -2
  99. package/Build/Cesium/Workers/decodeGoogleEarthEnterprisePacket.js +2 -2
  100. package/Build/Cesium/Workers/decodeI3S.js +2 -2
  101. package/Build/Cesium/Workers/transcodeKTX2.js +7 -7
  102. package/Build/Cesium/Workers/transferTypedArrayTest.js +1 -1
  103. package/Build/Cesium/Workers/upsampleQuantizedTerrainMesh.js +2 -2
  104. package/Build/Cesium/index.cjs +15235 -15235
  105. package/Build/Cesium/index.js +15204 -15204
  106. package/package.json +1 -1
  107. package/Build/Cesium/Workers/chunk-NPBBFQDL.js +0 -28
  108. package/Build/Cesium/Workers/chunk-S5OGNQLJ.js +0 -26
@@ -1304,7 +1304,7 @@ export class BoundingSphere {
1304
1304
  static projectTo2D(sphere: BoundingSphere, projection?: any, result?: BoundingSphere): BoundingSphere;
1305
1305
  /**
1306
1306
  * Determines whether or not a sphere is hidden from view by the occluder.
1307
- * @param sphere - The bounding sphere surrounding the occluded object.
1307
+ * @param sphere - The bounding sphere surrounding the occludee object.
1308
1308
  * @param occluder - The occluder.
1309
1309
  * @returns <code>true</code> if the sphere is not visible; otherwise <code>false</code>.
1310
1310
  */
@@ -3174,7 +3174,6 @@ export const Check: {
3174
3174
  };
3175
3175
  };
3176
3176
  };
3177
-
3178
3177
 
3179
3178
 
3180
3179
  /**
@@ -5473,9 +5472,7 @@ export function defaultValue(a: any, b: any): any;
5473
5472
  * @param value - The object.
5474
5473
  * @returns Returns true if the object is defined, returns false otherwise.
5475
5474
  */
5476
-
5477
- export function defined<Type>(value: Type): value is NonNullable<Type>;
5478
-
5475
+ export function defined<Type>(value: Type): value is NonNullable<Type>;
5479
5476
 
5480
5477
  /**
5481
5478
  * Destroys an object. Each of the object's functions, including functions in its prototype,
@@ -6250,7 +6247,7 @@ export class EllipsoidGeodesic {
6250
6247
  interpolateUsingFraction(fraction: number, result?: Cartographic): Cartographic;
6251
6248
  /**
6252
6249
  * Provides the location of a point at the indicated distance along the geodesic.
6253
- * @param distance - The distance from the initial point to the point of interest along the geodesic
6250
+ * @param distance - The distance from the inital point to the point of interest along the geodesic
6254
6251
  * @param [result] - The object in which to store the result.
6255
6252
  * @returns The location of the point along the geodesic.
6256
6253
  */
@@ -8013,27 +8010,6 @@ export class GoogleEarthEnterpriseTerrainProvider {
8013
8010
  loadTileDataAvailability(x: number, y: number, level: number): undefined;
8014
8011
  }
8015
8012
 
8016
- /**
8017
- * Provides geocoding through Google.
8018
- * @param options - Object with the following properties:
8019
- * @param options.key - An API key to use with the Google geocoding service
8020
- */
8021
- export class GoogleGeocoderService {
8022
- constructor(options: {
8023
- key: string;
8024
- });
8025
- /**
8026
- * Gets the credit to display after a geocode is performed. Typically this is used to credit
8027
- the geocoder service.
8028
- */
8029
- readonly credit: Credit | undefined;
8030
- /**
8031
- * Get a list of possible locations that match a search string.
8032
- * @param query - The query to be sent to the geocoder service
8033
- */
8034
- geocode(query: string): Promise<GeocoderService.Result[]>;
8035
- }
8036
-
8037
8013
  /**
8038
8014
  * Default settings for accessing the Google Maps API.
8039
8015
  <br/>
@@ -8992,49 +8968,24 @@ export namespace Ion {
8992
8968
  var defaultServer: string | Resource;
8993
8969
  }
8994
8970
 
8995
- /**
8996
- * Underlying geocoding services that can be used via Cesium ion.
8997
- */
8998
- export enum IonGeocodeProviderType {
8999
- /**
9000
- * Google geocoder, for use with Google data.
9001
- */
9002
- GOOGLE = "GOOGLE",
9003
- /**
9004
- * Bing geocoder, for use with Bing data.
9005
- */
9006
- BING = "BING",
9007
- /**
9008
- * Use the default geocoder as set on the server. Used when neither Bing or
9009
- Google data is used.
9010
- */
9011
- DEFAULT = "DEFAULT"
9012
- }
9013
-
9014
8971
  /**
9015
8972
  * Provides geocoding through Cesium ion.
9016
8973
  * @param options - Object with the following properties:
9017
8974
  * @param options.scene - The scene
9018
8975
  * @param [options.accessToken = Ion.defaultAccessToken] - The access token to use.
9019
8976
  * @param [options.server = Ion.defaultServer] - The resource to the Cesium ion API server.
9020
- * @param [options.geocodeProviderType = IonGeocodeProviderType.DEFAULT] - The geocoder the Cesium ion API server should use to fulfill this request.
9021
8977
  */
9022
8978
  export class IonGeocoderService {
9023
8979
  constructor(options: {
9024
8980
  scene: Scene;
9025
8981
  accessToken?: string;
9026
8982
  server?: string | Resource;
9027
- geocodeProviderType?: IonGeocodeProviderType;
9028
8983
  });
9029
8984
  /**
9030
8985
  * Gets the credit to display after a geocode is performed. Typically this is used to credit
9031
8986
  the geocoder service.
9032
8987
  */
9033
8988
  readonly credit: Credit | undefined;
9034
- /**
9035
- * The geocoding service that Cesium ion API server should use to fulfill geocding requests.
9036
- */
9037
- geocodeProviderType: IonGeocodeProviderType;
9038
8989
  /**
9039
8990
  * @param query - The query to be sent to the geocoder service
9040
8991
  * @param [type = GeocodeType.SEARCH] - The type of geocode to perform.
@@ -9148,37 +9099,6 @@ export namespace Iso8601 {
9148
9099
  const MAXIMUM_INTERVAL: TimeInterval;
9149
9100
  }
9150
9101
 
9151
- /**
9152
- * Default settings for accessing the iTwin platform.
9153
- */
9154
- export namespace ITwinPlatform {
9155
- /**
9156
- * Status states for a mesh-export export.
9157
- Valid values are: <code>NotStarted</code>, <code>InProgress</code>, <code>Complete</code>, <code>Invalid</code>
9158
- */
9159
- enum ExportStatus {
9160
- }
9161
- /**
9162
- * Types of mesh-export exports. CesiumJS only supports loading <code>3DTILES</code> type exports.
9163
- Valid values are: <code>IMODEL</code>, <code>CESIUM</code>, <code>3DTILES</code>
9164
- */
9165
- enum ExportType {
9166
- }
9167
- /**
9168
- * Types of Reality data. This is a partial list of types we know we can support
9169
- */
9170
- enum RealityDataType {
9171
- }
9172
- /**
9173
- * Gets or sets the default iTwin access token. This token should have the <code>itwin-platform</code> scope.
9174
- */
9175
- var defaultAccessToken: string | undefined;
9176
- /**
9177
- * Gets or sets the default iTwin API endpoint.
9178
- */
9179
- var apiEndpoint: string | Resource;
9180
- }
9181
-
9182
9102
  /**
9183
9103
  * Represents an astronomical Julian date, which is the number of days since noon on January 1, -4712 (4713 BC).
9184
9104
  For increased precision, this class stores the whole number part of the date and the seconds
@@ -12501,19 +12421,19 @@ export class OrthographicFrustum {
12501
12421
 
12502
12422
  /**
12503
12423
  * The viewing frustum is defined by 6 planes.
12504
- * Each plane is represented by a {@link Cartesian4} object, where the x, y, and z components
12505
- * define the unit vector normal to the plane, and the w component is the distance of the
12506
- * plane from the origin/camera position.
12424
+ Each plane is represented by a {@link Cartesian4} object, where the x, y, and z components
12425
+ define the unit vector normal to the plane, and the w component is the distance of the
12426
+ plane from the origin/camera position.
12507
12427
  * @example
12508
12428
  * const maxRadii = ellipsoid.maximumRadius;
12509
- *
12510
- * const frustum = new Cesium.OrthographicOffCenterFrustum();
12511
- * frustum.right = maxRadii * Cesium.Math.PI;
12512
- * frustum.left = -c.frustum.right;
12513
- * frustum.top = c.frustum.right * (canvas.clientHeight / canvas.clientWidth);
12514
- * frustum.bottom = -c.frustum.top;
12515
- * frustum.near = 0.01 * maxRadii;
12516
- * frustum.far = 50.0 * maxRadii;
12429
+
12430
+ const frustum = new Cesium.OrthographicOffCenterFrustum();
12431
+ frustum.right = maxRadii * Cesium.Math.PI;
12432
+ frustum.left = -c.frustum.right;
12433
+ frustum.top = c.frustum.right * (canvas.clientHeight / canvas.clientWidth);
12434
+ frustum.bottom = -c.frustum.top;
12435
+ frustum.near = 0.01 * maxRadii;
12436
+ frustum.far = 50.0 * maxRadii;
12517
12437
  * @param [options] - An object with the following properties:
12518
12438
  * @param [options.left] - The left clipping plane distance.
12519
12439
  * @param [options.right] - The right clipping plane distance.
@@ -12563,8 +12483,8 @@ export class OrthographicOffCenterFrustum {
12563
12483
  * Creates a culling volume for this frustum.
12564
12484
  * @example
12565
12485
  * // Check if a bounding volume intersects the frustum.
12566
- * const cullingVolume = frustum.computeCullingVolume(cameraPosition, cameraDirection, cameraUp);
12567
- * const intersect = cullingVolume.computeVisibility(boundingVolume);
12486
+ const cullingVolume = frustum.computeCullingVolume(cameraPosition, cameraDirection, cameraUp);
12487
+ const intersect = cullingVolume.computeVisibility(boundingVolume);
12568
12488
  * @param position - The eye position.
12569
12489
  * @param direction - The view direction.
12570
12490
  * @param up - The up direction.
@@ -12575,8 +12495,8 @@ export class OrthographicOffCenterFrustum {
12575
12495
  * Returns the pixel's width and height in meters.
12576
12496
  * @example
12577
12497
  * // Example 1
12578
- * // Get the width and height of a pixel.
12579
- * const pixelSize = camera.frustum.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, 0.0, scene.pixelRatio, new Cesium.Cartesian2());
12498
+ // Get the width and height of a pixel.
12499
+ const pixelSize = camera.frustum.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, 0.0, scene.pixelRatio, new Cesium.Cartesian2());
12580
12500
  * @param drawingBufferWidth - The width of the drawing buffer.
12581
12501
  * @param drawingBufferHeight - The height of the drawing buffer.
12582
12502
  * @param distance - The distance to the near plane in meters.
@@ -12593,15 +12513,15 @@ export class OrthographicOffCenterFrustum {
12593
12513
  clone(result?: OrthographicOffCenterFrustum): OrthographicOffCenterFrustum;
12594
12514
  /**
12595
12515
  * Compares the provided OrthographicOffCenterFrustum componentwise and returns
12596
- * <code>true</code> if they are equal, <code>false</code> otherwise.
12516
+ <code>true</code> if they are equal, <code>false</code> otherwise.
12597
12517
  * @param [other] - The right hand side OrthographicOffCenterFrustum.
12598
12518
  * @returns <code>true</code> if they are equal, <code>false</code> otherwise.
12599
12519
  */
12600
12520
  equals(other?: OrthographicOffCenterFrustum): boolean;
12601
12521
  /**
12602
12522
  * Compares the provided OrthographicOffCenterFrustum componentwise and returns
12603
- * <code>true</code> if they pass an absolute or relative tolerance test,
12604
- * <code>false</code> otherwise.
12523
+ <code>true</code> if they pass an absolute or relative tolerance test,
12524
+ <code>false</code> otherwise.
12605
12525
  * @param other - The right hand side OrthographicOffCenterFrustum.
12606
12526
  * @param relativeEpsilon - The relative epsilon tolerance to use for equality testing.
12607
12527
  * @param [absoluteEpsilon = relativeEpsilon] - The absolute epsilon tolerance to use for equality testing.
@@ -14741,6 +14661,11 @@ export class Rectangle {
14741
14661
  * @returns <code>true</code> if the Rectangles are within the provided epsilon, <code>false</code> otherwise.
14742
14662
  */
14743
14663
  equalsEpsilon(other?: Rectangle, epsilon?: number): boolean;
14664
+ /**
14665
+ * Checks a Rectangle's properties and throws if they are not in valid ranges.
14666
+ * @param rectangle - The rectangle to validate
14667
+ */
14668
+ static validate(rectangle: Rectangle): void;
14744
14669
  /**
14745
14670
  * Computes the southwest corner of a rectangle.
14746
14671
  * @param rectangle - The rectangle for which to find the corner
@@ -16219,7 +16144,7 @@ export namespace ScreenSpaceEventHandler {
16219
16144
 
16220
16145
  /**
16221
16146
  * Handles user input events. Custom functions can be added to be executed on
16222
- * when the user enters input.
16147
+ when the user enters input.
16223
16148
  * @param [element = document] - The element to add events to.
16224
16149
  */
16225
16150
  export class ScreenSpaceEventHandler {
@@ -16229,14 +16154,14 @@ export class ScreenSpaceEventHandler {
16229
16154
  * @param action - Function to be executed when the input event occurs.
16230
16155
  * @param type - The ScreenSpaceEventType of input event.
16231
16156
  * @param [modifier] - A KeyboardEventModifier key that is held when a <code>type</code>
16232
- * event occurs.
16157
+ event occurs.
16233
16158
  */
16234
16159
  setInputAction(action: ScreenSpaceEventHandler.PositionedEventCallback | ScreenSpaceEventHandler.MotionEventCallback | ScreenSpaceEventHandler.WheelEventCallback | ScreenSpaceEventHandler.TwoPointEventCallback | ScreenSpaceEventHandler.TwoPointMotionEventCallback, type: ScreenSpaceEventType, modifier?: KeyboardEventModifier): void;
16235
16160
  /**
16236
16161
  * Returns the function to be executed on an input event.
16237
16162
  * @param type - The ScreenSpaceEventType of input event.
16238
16163
  * @param [modifier] - A KeyboardEventModifier key that is held when a <code>type</code>
16239
- * event occurs.
16164
+ event occurs.
16240
16165
  * @returns The function to be executed on an input event.
16241
16166
  */
16242
16167
  getInputAction(type: ScreenSpaceEventType, modifier?: KeyboardEventModifier): ScreenSpaceEventHandler.PositionedEventCallback | ScreenSpaceEventHandler.MotionEventCallback | ScreenSpaceEventHandler.WheelEventCallback | ScreenSpaceEventHandler.TwoPointEventCallback | ScreenSpaceEventHandler.TwoPointMotionEventCallback;
@@ -16244,35 +16169,35 @@ export class ScreenSpaceEventHandler {
16244
16169
  * Removes the function to be executed on an input event.
16245
16170
  * @param type - The ScreenSpaceEventType of input event.
16246
16171
  * @param [modifier] - A KeyboardEventModifier key that is held when a <code>type</code>
16247
- * event occurs.
16172
+ event occurs.
16248
16173
  */
16249
16174
  removeInputAction(type: ScreenSpaceEventType, modifier?: KeyboardEventModifier): void;
16250
16175
  /**
16251
16176
  * Returns true if this object was destroyed; otherwise, false.
16252
- * <br /><br />
16253
- * If this object was destroyed, it should not be used; calling any function other than
16254
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
16177
+ <br /><br />
16178
+ If this object was destroyed, it should not be used; calling any function other than
16179
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
16255
16180
  * @returns <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
16256
16181
  */
16257
16182
  isDestroyed(): boolean;
16258
16183
  /**
16259
16184
  * Removes listeners held by this object.
16260
- * <br /><br />
16261
- * Once an object is destroyed, it should not be used; calling any function other than
16262
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
16263
- * assign the return value (<code>undefined</code>) to the object as done in the example.
16185
+ <br /><br />
16186
+ Once an object is destroyed, it should not be used; calling any function other than
16187
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
16188
+ assign the return value (<code>undefined</code>) to the object as done in the example.
16264
16189
  * @example
16265
16190
  * handler = handler && handler.destroy();
16266
16191
  */
16267
16192
  destroy(): void;
16268
16193
  /**
16269
16194
  * The amount of time, in milliseconds, that mouse events will be disabled after
16270
- * receiving any touch events, such that any emulated mouse events will be ignored.
16195
+ receiving any touch events, such that any emulated mouse events will be ignored.
16271
16196
  */
16272
16197
  static mouseEmulationIgnoreMilliseconds: number;
16273
16198
  /**
16274
16199
  * The amount of time, in milliseconds, before a touch on the screen becomes a
16275
- * touch and hold.
16200
+ touch and hold.
16276
16201
  */
16277
16202
  static touchHoldDelayMilliseconds: number;
16278
16203
  }
@@ -17674,34 +17599,6 @@ export enum TimeStandard {
17674
17599
  TAI = 1
17675
17600
  }
17676
17601
 
17677
- /**
17678
- * Constants for identifying well-known tracking reference frames.
17679
- */
17680
- export enum TrackingReferenceFrame {
17681
- /**
17682
- * Auto-detect algorithm. The reference frame used to track the Entity will
17683
- be automatically selected based on its trajectory: near-surface slow moving
17684
- objects will be tracked in the entity's local east-north-up reference
17685
- frame, while faster objects like satellites will use VVLH (Vehicle Velocity,
17686
- Local Horizontal).
17687
- */
17688
- AUTODETECT = 0,
17689
- /**
17690
- * The entity's local East-North-Up reference frame.
17691
- */
17692
- ENU = 1,
17693
- /**
17694
- * The entity's inertial reference frame. If entity has no defined orientation
17695
- property, it falls back to auto-detect algorithm.
17696
- */
17697
- INERTIAL = 2,
17698
- /**
17699
- * The entity's inertial reference frame with orientation fixed to its
17700
- {@link VelocityOrientationProperty}, ignoring its own orientation.
17701
- */
17702
- VELOCITY = 3
17703
- }
17704
-
17705
17602
  /**
17706
17603
  * Contains functions for transforming positions to various reference frames.
17707
17604
  */
@@ -21008,7 +20905,6 @@ export namespace Entity {
21008
20905
  * @property [name] - A human readable name to display to users. It does not have to be unique.
21009
20906
  * @property [availability] - The availability, if any, associated with this object.
21010
20907
  * @property [show] - A boolean value indicating if the entity and its children are displayed.
21011
- * @property [trackingReferenceFrame = TrackingReferenceFrame.AUTODETECT] - The reference frame used when this entity is being tracked. <br/> If <code>undefined</code>, reference frame is determined based on entity velocity: near-surface slow moving entities are tracked using the local east-north-up reference frame, whereas fast moving entities such as satellites are tracked using VVLH (Vehicle Velocity, Local Horizontal).
21012
20908
  * @property [description] - A string Property specifying an HTML description for this entity.
21013
20909
  * @property [position] - A Property specifying the entity position.
21014
20910
  * @property [orientation = Transforms.eastNorthUpToFixedFrame(position)] - A Property specifying the entity orientation in respect to Earth-fixed-Earth-centered (ECEF). If undefined, east-north-up at entity position is used.
@@ -21038,9 +20934,8 @@ export namespace Entity {
21038
20934
  name?: string;
21039
20935
  availability?: TimeIntervalCollection;
21040
20936
  show?: boolean;
21041
- trackingReferenceFrame?: TrackingReferenceFrame;
21042
20937
  description?: Property | string;
21043
- position?: PositionProperty | Cartesian3 | CallbackPositionProperty;
20938
+ position?: PositionProperty | Cartesian3 | CallbackProperty;
21044
20939
  orientation?: Property | Quaternion;
21045
20940
  viewFrom?: Property | Cartesian3;
21046
20941
  parent?: Entity;
@@ -21105,10 +21000,6 @@ export class Entity {
21105
21000
  the entity is only displayed if the parent entity's show property is also true.
21106
21001
  */
21107
21002
  show: boolean;
21108
- /**
21109
- * Gets or sets the entity's tracking reference frame.
21110
- */
21111
- trackingReferenceFrame: TrackingReferenceFrame;
21112
21003
  /**
21113
21004
  * Gets whether this entity is being displayed, taking into account
21114
21005
  the visibility of any ancestor entities.
@@ -21867,10 +21758,10 @@ export class GeometryVisualizer {
21867
21758
  constructor(scene: Scene, entityCollection: EntityCollection, primitives?: PrimitiveCollection, groundPrimitives?: PrimitiveCollection);
21868
21759
  /**
21869
21760
  * Updates all of the primitives created by this visualizer to match their
21870
- * Entity counterpart at the given time.
21761
+ Entity counterpart at the given time.
21871
21762
  * @param time - The time to update to.
21872
21763
  * @returns True if the visualizer successfully updated to the provided time,
21873
- * false if the visualizer is waiting for asynchronous primitives to be created.
21764
+ false if the visualizer is waiting for asynchronous primitives to be created.
21874
21765
  */
21875
21766
  update(time: JulianDate): boolean;
21876
21767
  /**
@@ -22820,7 +22711,6 @@ export namespace ModelGraphics {
22820
22711
  * @property [colorBlendMode = ColorBlendMode.HIGHLIGHT] - An enum Property specifying how the color blends with the model.
22821
22712
  * @property [colorBlendAmount = 0.5] - A numeric Property specifying the color strength when the <code>colorBlendMode</code> is <code>MIX</code>. A value of 0.0 results in the model's rendered color while a value of 1.0 results in a solid color, with any value in-between resulting in a mix of the two.
22822
22713
  * @property [imageBasedLightingFactor = new Cartesian2(1.0, 1.0)] - A property specifying the contribution from diffuse and specular image-based lighting.
22823
- * @property [environmentMapOptions] - The properties for managing dynamic environment maps on this entity.
22824
22714
  * @property [lightColor] - A property specifying the light color when shading the model. When <code>undefined</code> the scene's light color is used instead.
22825
22715
  * @property [distanceDisplayCondition] - A Property specifying at what distance from the camera that this model will be displayed.
22826
22716
  * @property [nodeTransformations] - An object, where keys are names of nodes, and values are {@link TranslationRotationScale} Properties describing the transformation to apply to that node. The transformation is applied after the node's existing transformation as specified in the glTF, and does not replace the node's existing transformation.
@@ -22846,9 +22736,6 @@ export namespace ModelGraphics {
22846
22736
  colorBlendMode?: Property | ColorBlendMode;
22847
22737
  colorBlendAmount?: Property | number;
22848
22738
  imageBasedLightingFactor?: Property | Cartesian2;
22849
- environmentMapOptions?: PropertyBag | {
22850
- [key: string]: any;
22851
- };
22852
22739
  lightColor?: Property | Color;
22853
22740
  distanceDisplayCondition?: Property | DistanceDisplayCondition;
22854
22741
  nodeTransformations?: PropertyBag | {
@@ -22956,10 +22843,6 @@ export class ModelGraphics {
22956
22843
  * A property specifying the {@link Cartesian2} used to scale the diffuse and specular image-based lighting contribution to the final color.
22957
22844
  */
22958
22845
  imageBasedLightingFactor: Property | undefined;
22959
- /**
22960
- * Gets or sets the {@link DynamicEnvironmentMapManager.ConstructorOptions} to apply to this model. This is represented as an {@link PropertyBag}.
22961
- */
22962
- environmentMapOptions: PropertyBag;
22963
22846
  /**
22964
22847
  * A property specifying the {@link Cartesian3} light color when shading the model. When <code>undefined</code> the scene's light color is used instead.
22965
22848
  */
@@ -24086,10 +23969,10 @@ export class PolylineVisualizer {
24086
23969
  constructor(scene: Scene, entityCollection: EntityCollection, primitives?: PrimitiveCollection, groundPrimitives?: PrimitiveCollection);
24087
23970
  /**
24088
23971
  * Updates all of the primitives created by this visualizer to match their
24089
- * Entity counterpart at the given time.
23972
+ Entity counterpart at the given time.
24090
23973
  * @param time - The time to update to.
24091
23974
  * @returns True if the visualizer successfully updated to the provided time,
24092
- * false if the visualizer is waiting for asynchronous primitives to be created.
23975
+ false if the visualizer is waiting for asynchronous primitives to be created.
24093
23976
  */
24094
23977
  update(time: JulianDate): boolean;
24095
23978
  /**
@@ -25050,12 +24933,6 @@ export class SampledProperty {
25050
24933
  * @param [derivativeValues] - An array where each item is the array of derivatives at the equivalent time index.
25051
24934
  */
25052
24935
  addSamples(times: JulianDate[], values: Packable[], derivativeValues?: any[][]): void;
25053
- /**
25054
- * Retrieves the time of the provided sample associated with the index. A negative index accesses the list of samples in reverse order.
25055
- * @param index - The index of samples list.
25056
- * @returns The JulianDate time of the sample, or undefined if failed.
25057
- */
25058
- getSample(index: number): JulianDate | undefined;
25059
24936
  /**
25060
24937
  * Adds samples as a single packed array where each new sample is represented as a date,
25061
24938
  followed by the packed representation of the corresponding value and derivatives.
@@ -26076,12 +25953,6 @@ export class Atmosphere {
26076
25953
  be used for dynamically lighting all atmosphere-related rendering effects.
26077
25954
  */
26078
25955
  dynamicLighting: DynamicAtmosphereLightingType;
26079
- /**
26080
- * Returns <code>true</code> if the atmosphere shader requires a color correct step.
26081
- * @param atmosphere - The atmosphere instance to check
26082
- * @returns true if the atmosphere shader requires a color correct step
26083
- */
26084
- static requiresColorCorrect(atmosphere: Atmosphere): boolean;
26085
25956
  }
26086
25957
 
26087
25958
  /**
@@ -28462,7 +28333,6 @@ export namespace Cesium3DTileset {
28462
28333
  * @property [pointCloudShading] - Options for constructing a {@link PointCloudShading} object to control point attenuation based on geometric error and lighting.
28463
28334
  * @property [lightColor] - The light color when shading models. When <code>undefined</code> the scene's light color is used instead.
28464
28335
  * @property [imageBasedLighting] - The properties for managing image-based lighting for this tileset.
28465
- * @property [environmentMapOptions] - The properties for managing dynamic environment maps on this tileset.
28466
28336
  * @property [backFaceCulling = true] - Whether to cull back-facing geometry. When true, back face culling is determined by the glTF material's doubleSided property; when false, back face culling is disabled.
28467
28337
  * @property [enableShowOutline = true] - Whether to enable outlines for models using the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set to false to avoid the additional processing of geometry at load time. When false, the showOutlines and outlineColor options are ignored.
28468
28338
  * @property [showOutline = true] - Whether to display the outline for models using the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. When true, outlines are displayed. When false, outlines are not displayed.
@@ -28527,7 +28397,6 @@ export namespace Cesium3DTileset {
28527
28397
  pointCloudShading?: any;
28528
28398
  lightColor?: Cartesian3;
28529
28399
  imageBasedLighting?: ImageBasedLighting;
28530
- environmentMapOptions?: DynamicEnvironmentMapManager.ConstructorOptions;
28531
28400
  backFaceCulling?: boolean;
28532
28401
  enableShowOutline?: boolean;
28533
28402
  showOutline?: boolean;
@@ -29256,14 +29125,6 @@ export class Cesium3DTileset {
29256
29125
  * The properties for managing image-based lighting on this tileset.
29257
29126
  */
29258
29127
  imageBasedLighting: ImageBasedLighting;
29259
- /**
29260
- * The properties for managing dynamic environment maps on this model. Affects lighting.
29261
- * @example
29262
- * // Change the ground color used for a tileset's environment map to a forest green
29263
- const environmentMapManager = tileset.environmentMapManager;
29264
- environmentMapManager.groundColor = Cesium.Color.fromCssColorString("#203b34");
29265
- */
29266
- readonly environmentMapManager: DynamicEnvironmentMapManager;
29267
29128
  /**
29268
29129
  * Indicates that only the tileset's vector tiles should be used for classification.
29269
29130
  */
@@ -31118,22 +30979,12 @@ export function createElevationBandMaterial(options: {
31118
30979
  }): Material;
31119
30980
 
31120
30981
  /**
31121
- * Creates a {@link Cesium3DTileset} instance for the Google Photorealistic 3D
31122
- Tiles tileset.
31123
-
31124
- Google Photorealistic 3D Tiles can only be used with the Google geocoder. To
31125
- confirm that you are aware of this restriction pass
31126
- `usingOnlyWithGoogleGeocoder: true` to the apiOptions. Otherwise a one time
31127
- warning will be displayed when this function is called.
30982
+ * Creates a {@link Cesium3DTileset} instance for the Google Photorealistic 3D Tiles tileset.
31128
30983
  * @example
31129
- * const viewer = new Cesium.Viewer("cesiumContainer", {
31130
- geocoder: Cesium.IonGeocodeProviderType.GOOGLE
31131
- });
30984
+ * const viewer = new Cesium.Viewer("cesiumContainer");
31132
30985
 
31133
30986
  try {
31134
- const tileset = await Cesium.createGooglePhotorealistic3DTileset({
31135
- onlyUsingWithGoogleGeocoder: true,
31136
- });
30987
+ const tileset = await Cesium.createGooglePhotorealistic3DTileset();
31137
30988
  viewer.scene.primitives.add(tileset));
31138
30989
  } catch (error) {
31139
30990
  console.log(`Error creating tileset: ${error}`);
@@ -31142,26 +30993,18 @@ try {
31142
30993
  * // Use your own Google Maps API key
31143
30994
  Cesium.GoogleMaps.defaultApiKey = "your-api-key";
31144
30995
 
31145
- const viewer = new Cesium.Viewer("cesiumContainer". {
31146
- geocoder: Cesium.IonGeocodeProviderType.GOOGLE
31147
- });
30996
+ const viewer = new Cesium.Viewer("cesiumContainer");
31148
30997
 
31149
30998
  try {
31150
- const tileset = await Cesium.createGooglePhotorealistic3DTileset({
31151
- onlyUsingWithGoogleGeocoder: true,
31152
- });
30999
+ const tileset = await Cesium.createGooglePhotorealistic3DTileset();
31153
31000
  viewer.scene.primitives.add(tileset));
31154
31001
  } catch (error) {
31155
31002
  console.log(`Error creating tileset: ${error}`);
31156
31003
  }
31157
- * @param [apiOptions.key = GoogleMaps.defaultApiKey] - Your API key to access Google Photorealistic 3D Tiles. See {@link https://developers.google.com/maps/documentation/javascript/get-api-key} for instructions on how to create your own key.
31158
- * @param [apiOptions.onlyUsingWithGoogleGeocoder] - Confirmation that this tileset will only be used with the Google geocoder.
31159
- * @param [tilesetOptions] - An object describing initialization options.
31004
+ * @param [key = GoogleMaps.defaultApiKey] - Your API key to access Google Photorealistic 3D Tiles. See {@link https://developers.google.com/maps/documentation/javascript/get-api-key} for instructions on how to create your own key.
31005
+ * @param [options] - An object describing initialization options.
31160
31006
  */
31161
- export function createGooglePhotorealistic3DTileset(apiOptions?: {
31162
- key?: string;
31163
- onlyUsingWithGoogleGeocoder?: true;
31164
- }, tilesetOptions?: Cesium3DTileset.ConstructorOptions): Promise<Cesium3DTileset>;
31007
+ export function createGooglePhotorealistic3DTileset(key?: string, options?: Cesium3DTileset.ConstructorOptions): Promise<Cesium3DTileset>;
31165
31008
 
31166
31009
  /**
31167
31010
  * Creates a {@link Cesium3DTileset} instance for the
@@ -31757,55 +31600,14 @@ export enum DepthFunction {
31757
31600
 
31758
31601
  /**
31759
31602
  * Returns the type that the given class property has in a GLSL shader.
31760
- *
31761
- * It returns the same string as `PropertyTextureProperty.prototype.getGlslType`
31762
- * for a property texture property with the given class property
31603
+
31604
+ It returns the same string as `PropertyTextureProperty.prototype.getGlslType`
31605
+ for a property texture property with the given class property
31763
31606
  * @param classProperty - The class property
31764
31607
  * @returns The GLSL shader type string for the property
31765
31608
  */
31766
31609
  export function getGlslType(classProperty: MetadataClassProperty): string;
31767
31610
 
31768
- /**
31769
- * Returns a shader statement that applies the inverse of the
31770
- * value transform to the given value, based on the given offset
31771
- * and scale.
31772
- * @param input - The input value
31773
- * @param offset - The offset
31774
- * @param scale - The scale
31775
- * @returns The statement
31776
- */
31777
- export function unapplyValueTransform(input: string, offset: string, scale: string): string;
31778
-
31779
- /**
31780
- * Returns a shader statement that applies the inverse of the
31781
- * normalization, based on the given component type
31782
- * @param input - The input value
31783
- * @param componentType - The component type
31784
- * @returns The statement
31785
- */
31786
- export function unnormalize(input: string, componentType: string): string;
31787
-
31788
- /**
31789
- * Creates a shader statement that returns the value of the specified
31790
- * property, normalized to the range [0, 1].
31791
- * @param classProperty - The class property
31792
- * @param metadataProperty - The metadata property, either
31793
- * a `PropertyTextureProperty` or a `PropertyAttributeProperty`
31794
- * @returns The string
31795
- */
31796
- export function getSourceValueStringScalar(classProperty: MetadataClassProperty, metadataProperty: any): string;
31797
-
31798
- /**
31799
- * Creates a shader statement that returns the value of the specified
31800
- * component of the given property, normalized to the range [0, 1].
31801
- * @param classProperty - The class property
31802
- * @param metadataProperty - The metadata property, either
31803
- * a `PropertyTextureProperty` or a `PropertyAttributeProperty`
31804
- * @param componentName - The name, in ["x", "y", "z", "w"]
31805
- * @returns The string
31806
- */
31807
- export function getSourceValueStringComponent(classProperty: MetadataClassProperty, metadataProperty: any, componentName: string): string;
31808
-
31809
31611
  /**
31810
31612
  * A light that gets emitted in a single direction from infinitely far away.
31811
31613
  * @param options - Object with the following properties:
@@ -31909,136 +31711,6 @@ export enum DynamicAtmosphereLightingType {
31909
31711
  SUNLIGHT = 2
31910
31712
  }
31911
31713
 
31912
- export namespace DynamicEnvironmentMapManager {
31913
- /**
31914
- * Options for the DynamicEnvironmentMapManager constructor
31915
- * @property [enabled = true] - If true, the environment map and related properties will continue to update.
31916
- * @property [mipmapLevels = 7] - The number of mipmap levels to generate for specular maps. More mipmap levels will produce a higher resolution specular reflection.
31917
- * @property [maximumSecondsDifference = 3600] - The maximum amount of elapsed seconds before a new environment map is created.
31918
- * @property [maximumPositionEpsilon = 1000] - The maximum difference in position before a new environment map is created, in meters. Small differences in position will not visibly affect results.
31919
- * @property [atmosphereScatteringIntensity = 2.0] - The intensity of the scattered light emitted from the atmosphere. This should be adjusted relative to the value of {@link Scene.light} intensity.
31920
- * @property [gamma = 1.0] - The gamma correction to apply to the range of light emitted from the environment. 1.0 uses the unmodified emitted light color.
31921
- * @property [brightness = 1.0] - The brightness of light emitted from the environment. 1.0 uses the unmodified emitted environment color. Less than 1.0 makes the light darker while greater than 1.0 makes it brighter.
31922
- * @property [saturation = 1.0] - The saturation of the light emitted from the environment. 1.0 uses the unmodified emitted environment color. Less than 1.0 reduces the saturation while greater than 1.0 increases it.
31923
- * @property [groundColor = DynamicEnvironmentMapManager.AVERAGE_EARTH_GROUND_COLOR] - Solid color used to represent the ground.
31924
- * @property [groundAlbedo = 0.31] - The percentage of light reflected from the ground. The average earth albedo is 0.31.
31925
- */
31926
- type ConstructorOptions = {
31927
- enabled?: boolean;
31928
- mipmapLevels?: number;
31929
- maximumSecondsDifference?: number;
31930
- maximumPositionEpsilon?: number;
31931
- atmosphereScatteringIntensity?: number;
31932
- gamma?: number;
31933
- brightness?: number;
31934
- saturation?: number;
31935
- groundColor?: Color;
31936
- groundAlbedo?: number;
31937
- };
31938
- }
31939
-
31940
- /**
31941
- * Generates an environment map at the given position based on scene's current lighting conditions. From this, it produces multiple levels of specular maps and spherical harmonic coefficients than can be used with {@link ImageBasedLighting} for models or tilesets.
31942
- * @example
31943
- * // Enable time-of-day environment mapping in a scene
31944
- scene.atmosphere.dynamicLighting = Cesium.DynamicAtmosphereLightingType.SUNLIGHT;
31945
-
31946
- // Decrease the directional lighting contribution
31947
- scene.light.intensity = 0.5
31948
-
31949
- // Increase the intensity of of the environment map lighting contribution
31950
- const environmentMapManager = tileset.environmentMapManager;
31951
- environmentMapManager.atmosphereScatteringIntensity = 3.0;
31952
- * @example
31953
- * // Change the ground color used for a model's environment map to a forest green
31954
- const environmentMapManager = model.environmentMapManager;
31955
- environmentMapManager.groundColor = Cesium.Color.fromCssColorString("#203b34");
31956
- * @param [options] - An object describing initialization options.
31957
- */
31958
- export class DynamicEnvironmentMapManager {
31959
- constructor(options?: DynamicEnvironmentMapManager.ConstructorOptions);
31960
- /**
31961
- * If true, the environment map and related properties will continue to update.
31962
- */
31963
- enabled: boolean;
31964
- /**
31965
- * The maximum amount of elapsed seconds before a new environment map is created.
31966
- */
31967
- maximumSecondsDifference: number;
31968
- /**
31969
- * The maximum difference in position before a new environment map is created, in meters. Small differences in position will not visibly affect results.
31970
- */
31971
- maximumPositionEpsilon: number;
31972
- /**
31973
- * The intensity of the scattered light emitted from the atmosphere. This should be adjusted relative to the value of {@link Scene.light} intensity.
31974
- */
31975
- atmosphereScatteringIntensity: number;
31976
- /**
31977
- * The gamma correction to apply to the range of light emitted from the environment. 1.0 uses the unmodified incoming light color.
31978
- */
31979
- gamma: number;
31980
- /**
31981
- * The brightness of light emitted from the environment. 1.0 uses the unmodified emitted environment color. Less than 1.0
31982
- makes the light darker while greater than 1.0 makes it brighter.
31983
- */
31984
- brightness: number;
31985
- /**
31986
- * The saturation of the light emitted from the environment. 1.0 uses the unmodified emitted environment color. Less than 1.0 reduces the
31987
- saturation while greater than 1.0 increases it.
31988
- */
31989
- saturation: number;
31990
- /**
31991
- * Solid color used to represent the ground.
31992
- */
31993
- groundColor: Color;
31994
- /**
31995
- * The percentage of light reflected from the ground. The average earth albedo is 0.31.
31996
- */
31997
- groundAlbedo: number;
31998
- /**
31999
- * The position around which the environment map is generated.
32000
- */
32001
- position: Cartesian3 | undefined;
32002
- /**
32003
- * Returns true if this object was destroyed; otherwise, false.
32004
- <br /><br />
32005
- If this object was destroyed, it should not be used; calling any function other than
32006
- <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
32007
- * @returns <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
32008
- */
32009
- isDestroyed(): boolean;
32010
- /**
32011
- * Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
32012
- release of WebGL resources, instead of relying on the garbage collector to destroy this object.
32013
- <br /><br />
32014
- Once an object is destroyed, it should not be used; calling any function other than
32015
- <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
32016
- assign the return value (<code>undefined</code>) to the object as done in the example.
32017
- * @example
32018
- * mapManager = mapManager && mapManager.destroy();
32019
- */
32020
- destroy(): void;
32021
- /**
32022
- * Returns <code>true</code> if dynamic updates are supported in the current WebGL rendering context.
32023
- Dynamic updates requires the EXT_color_buffer_float or EXT_color_buffer_half_float extension.
32024
- * @param scene - The object containing the rendering context
32025
- * @returns true if supported
32026
- */
32027
- static isDynamicUpdateSupported(scene: Scene): boolean;
32028
- /**
32029
- * Average hue of ground color on earth, a warm green-gray.
32030
- */
32031
- static readonly AVERAGE_EARTH_GROUND_COLOR: Color;
32032
- /**
32033
- * The default third order spherical harmonic coefficients used for the diffuse color of image-based lighting, a white ambient light with low intensity.
32034
- <p>
32035
- There are nine <code>Cartesian3</code> coefficients.
32036
- The order of the coefficients is: L<sub>0,0</sub>, L<sub>1,-1</sub>, L<sub>1,0</sub>, L<sub>1,1</sub>, L<sub>2,-2</sub>, L<sub>2,-1</sub>, L<sub>2,0</sub>, L<sub>2,1</sub>, L<sub>2,2</sub>
32037
- </p>
32038
- */
32039
- static readonly DEFAULT_SPHERICAL_HARMONIC_COEFFICIENTS: Cartesian3[];
32040
- }
32041
-
32042
31714
  /**
32043
31715
  * An appearance for geometry on the surface of the ellipsoid like {@link PolygonGeometry}
32044
31716
  and {@link RectangleGeometry}, which supports all materials like {@link MaterialAppearance}
@@ -32222,18 +31894,11 @@ export class Fog {
32222
31894
  constructor();
32223
31895
  /**
32224
31896
  * <code>true</code> if fog is enabled, <code>false</code> otherwise.
32225
- * @example
32226
- * // Disable fog in the scene
32227
- viewer.scene.fog.enabled = false;
32228
31897
  */
32229
31898
  enabled: boolean;
32230
31899
  /**
32231
31900
  * <code>true</code> if fog is renderable in shaders, <code>false</code> otherwise.
32232
31901
  This allows to benefits from optimized tile loading strategy based on fog density without the actual visual rendering.
32233
- * @example
32234
- * // Use fog culling but don't render it
32235
- viewer.scene.fog.enabled = true;
32236
- viewer.scene.fog.renderable = false;
32237
31902
  */
32238
31903
  renderable: boolean;
32239
31904
  /**
@@ -32242,27 +31907,8 @@ export class Fog {
32242
31907
  The more dense the fog is, the more aggressively the terrain is culled. For example, if the camera is a height of
32243
31908
  1000.0m above the ellipsoid, increasing the value to 3.0e-3 will cause many tiles close to the viewer be culled.
32244
31909
  Decreasing the value will push the fog further from the viewer, but decrease performance as more of the terrain is rendered.
32245
- * @example
32246
- * // Double the default fog density
32247
- viewer.scene.fog.density = 0.0012;
32248
31910
  */
32249
31911
  density: number;
32250
- /**
32251
- * A scalar used in the function to adjust density based on the height of the camera above the terrain.
32252
- */
32253
- heightScalar: number;
32254
- /**
32255
- * The maximum height fog is applied. If the camera is above this height fog will be disabled.
32256
- */
32257
- maxHeight: number;
32258
- /**
32259
- * A scalar that impacts the visual density of fog. This value does not impact the culling of terrain.
32260
- Use in combination with the {@link Fog.density} to make fog appear more or less dense.
32261
- * @example
32262
- * // Increase fog appearance effect
32263
- viewer.scene.fog.visualDensityScalar = 0.6;
32264
- */
32265
- visualDensityScalar: number;
32266
31912
  /**
32267
31913
  * A factor used to increase the screen space error of terrain tiles when they are partially in fog. The effect is to reduce
32268
31914
  the number of terrain tiles requested for rendering. If set to zero, the feature will be disabled. If the value is increased
@@ -32275,11 +31921,6 @@ export class Fog {
32275
31921
  the brightness at all.
32276
31922
  */
32277
31923
  minimumBrightness: number;
32278
- /**
32279
- * Exponent factor used in the function to adjust how density changes based on the height of the camera above the ellipsoid. Smaller values produce a more gradual transition as camera height increases.
32280
- Value must be greater than 0.
32281
- */
32282
- heightFalloff: number;
32283
31924
  }
32284
31925
 
32285
31926
  /**
@@ -34206,6 +33847,7 @@ If a model or tileset creates an instance of ImageBasedLighting, it will handle
34206
33847
  Otherwise, the application is responsible for calling destroy().
34207
33848
  </p>
34208
33849
  * @param [options.imageBasedLightingFactor = Cartesian2(1.0, 1.0)] - Scales diffuse and specular image-based lighting from the earth, sky, atmosphere and star skybox.
33850
+ * @param [options.luminanceAtZenith = 0.2] - The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map.
34209
33851
  * @param [options.sphericalHarmonicCoefficients] - The third order spherical harmonic coefficients used for the diffuse color of image-based lighting.
34210
33852
  * @param [options.specularEnvironmentMaps] - A URL to a KTX2 file that contains a cube map of the specular lighting and the convoluted specular mipmaps.
34211
33853
  */
@@ -34218,6 +33860,13 @@ export class ImageBasedLighting {
34218
33860
  disable those light sources.
34219
33861
  */
34220
33862
  imageBasedLightingFactor: Cartesian2;
33863
+ /**
33864
+ * The sun's luminance at the zenith in kilo candela per meter squared
33865
+ to use for this model's procedural environment map. This is used when
33866
+ {@link ImageBasedLighting#specularEnvironmentMaps} and {@link ImageBasedLighting#sphericalHarmonicCoefficients}
33867
+ are not defined.
33868
+ */
33869
+ luminanceAtZenith: number;
34221
33870
  /**
34222
33871
  * The third order spherical harmonic coefficients used for the diffuse color of image-based lighting. When <code>undefined</code>, a diffuse irradiance
34223
33872
  computed from the atmosphere color is used.
@@ -34251,81 +33900,81 @@ export namespace ImageryLayer {
34251
33900
  /**
34252
33901
  * Initialization options for the ImageryLayer constructor.
34253
33902
  * @property [rectangle = imageryProvider.rectangle] - The rectangle of the layer. This rectangle
34254
- * can limit the visible portion of the imagery provider.
33903
+ can limit the visible portion of the imagery provider.
34255
33904
  * @property [alpha = 1.0] - The alpha blending value of this layer, from 0.0 to 1.0.
34256
- * This can either be a simple number or a function with the signature
34257
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34258
- * current frame state, this layer, and the x, y, and level coordinates of the
34259
- * imagery tile for which the alpha is required, and it is expected to return
34260
- * the alpha value to use for the tile.
33905
+ This can either be a simple number or a function with the signature
33906
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
33907
+ current frame state, this layer, and the x, y, and level coordinates of the
33908
+ imagery tile for which the alpha is required, and it is expected to return
33909
+ the alpha value to use for the tile.
34261
33910
  * @property [nightAlpha = 1.0] - The alpha blending value of this layer on the night side of the globe, from 0.0 to 1.0.
34262
- * This can either be a simple number or a function with the signature
34263
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34264
- * current frame state, this layer, and the x, y, and level coordinates of the
34265
- * imagery tile for which the alpha is required, and it is expected to return
34266
- * the alpha value to use for the tile. This only takes effect when <code>enableLighting</code> is <code>true</code>.
33911
+ This can either be a simple number or a function with the signature
33912
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
33913
+ current frame state, this layer, and the x, y, and level coordinates of the
33914
+ imagery tile for which the alpha is required, and it is expected to return
33915
+ the alpha value to use for the tile. This only takes effect when <code>enableLighting</code> is <code>true</code>.
34267
33916
  * @property [dayAlpha = 1.0] - The alpha blending value of this layer on the day side of the globe, from 0.0 to 1.0.
34268
- * This can either be a simple number or a function with the signature
34269
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34270
- * current frame state, this layer, and the x, y, and level coordinates of the
34271
- * imagery tile for which the alpha is required, and it is expected to return
34272
- * the alpha value to use for the tile. This only takes effect when <code>enableLighting</code> is <code>true</code>.
33917
+ This can either be a simple number or a function with the signature
33918
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
33919
+ current frame state, this layer, and the x, y, and level coordinates of the
33920
+ imagery tile for which the alpha is required, and it is expected to return
33921
+ the alpha value to use for the tile. This only takes effect when <code>enableLighting</code> is <code>true</code>.
34273
33922
  * @property [brightness = 1.0] - The brightness of this layer. 1.0 uses the unmodified imagery
34274
- * color. Less than 1.0 makes the imagery darker while greater than 1.0 makes it brighter.
34275
- * This can either be a simple number or a function with the signature
34276
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34277
- * current frame state, this layer, and the x, y, and level coordinates of the
34278
- * imagery tile for which the brightness is required, and it is expected to return
34279
- * the brightness value to use for the tile. The function is executed for every
34280
- * frame and for every tile, so it must be fast.
33923
+ color. Less than 1.0 makes the imagery darker while greater than 1.0 makes it brighter.
33924
+ This can either be a simple number or a function with the signature
33925
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
33926
+ current frame state, this layer, and the x, y, and level coordinates of the
33927
+ imagery tile for which the brightness is required, and it is expected to return
33928
+ the brightness value to use for the tile. The function is executed for every
33929
+ frame and for every tile, so it must be fast.
34281
33930
  * @property [contrast = 1.0] - The contrast of this layer. 1.0 uses the unmodified imagery color.
34282
- * Less than 1.0 reduces the contrast while greater than 1.0 increases it.
34283
- * This can either be a simple number or a function with the signature
34284
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34285
- * current frame state, this layer, and the x, y, and level coordinates of the
34286
- * imagery tile for which the contrast is required, and it is expected to return
34287
- * the contrast value to use for the tile. The function is executed for every
34288
- * frame and for every tile, so it must be fast.
33931
+ Less than 1.0 reduces the contrast while greater than 1.0 increases it.
33932
+ This can either be a simple number or a function with the signature
33933
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
33934
+ current frame state, this layer, and the x, y, and level coordinates of the
33935
+ imagery tile for which the contrast is required, and it is expected to return
33936
+ the contrast value to use for the tile. The function is executed for every
33937
+ frame and for every tile, so it must be fast.
34289
33938
  * @property [hue = 0.0] - The hue of this layer. 0.0 uses the unmodified imagery color.
34290
- * This can either be a simple number or a function with the signature
34291
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34292
- * current frame state, this layer, and the x, y, and level coordinates
34293
- * of the imagery tile for which the hue is required, and it is expected to return
34294
- * the contrast value to use for the tile. The function is executed for every
34295
- * frame and for every tile, so it must be fast.
33939
+ This can either be a simple number or a function with the signature
33940
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
33941
+ current frame state, this layer, and the x, y, and level coordinates
33942
+ of the imagery tile for which the hue is required, and it is expected to return
33943
+ the contrast value to use for the tile. The function is executed for every
33944
+ frame and for every tile, so it must be fast.
34296
33945
  * @property [saturation = 1.0] - The saturation of this layer. 1.0 uses the unmodified imagery color.
34297
- * Less than 1.0 reduces the saturation while greater than 1.0 increases it.
34298
- * This can either be a simple number or a function with the signature
34299
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34300
- * current frame state, this layer, and the x, y, and level coordinates
34301
- * of the imagery tile for which the saturation is required, and it is expected to return
34302
- * the contrast value to use for the tile. The function is executed for every
34303
- * frame and for every tile, so it must be fast.
33946
+ Less than 1.0 reduces the saturation while greater than 1.0 increases it.
33947
+ This can either be a simple number or a function with the signature
33948
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
33949
+ current frame state, this layer, and the x, y, and level coordinates
33950
+ of the imagery tile for which the saturation is required, and it is expected to return
33951
+ the contrast value to use for the tile. The function is executed for every
33952
+ frame and for every tile, so it must be fast.
34304
33953
  * @property [gamma = 1.0] - The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color.
34305
- * This can either be a simple number or a function with the signature
34306
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34307
- * current frame state, this layer, and the x, y, and level coordinates of the
34308
- * imagery tile for which the gamma is required, and it is expected to return
34309
- * the gamma value to use for the tile. The function is executed for every
34310
- * frame and for every tile, so it must be fast.
33954
+ This can either be a simple number or a function with the signature
33955
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
33956
+ current frame state, this layer, and the x, y, and level coordinates of the
33957
+ imagery tile for which the gamma is required, and it is expected to return
33958
+ the gamma value to use for the tile. The function is executed for every
33959
+ frame and for every tile, so it must be fast.
34311
33960
  * @property [splitDirection = SplitDirection.NONE] - The {@link SplitDirection} split to apply to this layer.
34312
33961
  * @property [minificationFilter = TextureMinificationFilter.LINEAR] - The
34313
- * texture minification filter to apply to this layer. Possible values
34314
- * are <code>TextureMinificationFilter.LINEAR</code> and
34315
- * <code>TextureMinificationFilter.NEAREST</code>.
33962
+ texture minification filter to apply to this layer. Possible values
33963
+ are <code>TextureMinificationFilter.LINEAR</code> and
33964
+ <code>TextureMinificationFilter.NEAREST</code>.
34316
33965
  * @property [magnificationFilter = TextureMagnificationFilter.LINEAR] - The
34317
- * texture minification filter to apply to this layer. Possible values
34318
- * are <code>TextureMagnificationFilter.LINEAR</code> and
34319
- * <code>TextureMagnificationFilter.NEAREST</code>.
33966
+ texture minification filter to apply to this layer. Possible values
33967
+ are <code>TextureMagnificationFilter.LINEAR</code> and
33968
+ <code>TextureMagnificationFilter.NEAREST</code>.
34320
33969
  * @property [show = true] - True if the layer is shown; otherwise, false.
34321
33970
  * @property [maximumAnisotropy = maximum supported] - The maximum anisotropy level to use
34322
- * for texture filtering. If this parameter is not specified, the maximum anisotropy supported
34323
- * by the WebGL stack will be used. Larger values make the imagery look better in horizon
34324
- * views.
33971
+ for texture filtering. If this parameter is not specified, the maximum anisotropy supported
33972
+ by the WebGL stack will be used. Larger values make the imagery look better in horizon
33973
+ views.
34325
33974
  * @property [minimumTerrainLevel] - The minimum terrain level-of-detail at which to show this imagery layer,
34326
- * or undefined to show it at all levels. Level zero is the least-detailed level.
33975
+ or undefined to show it at all levels. Level zero is the least-detailed level.
34327
33976
  * @property [maximumTerrainLevel] - The maximum terrain level-of-detail at which to show this imagery layer,
34328
- * or undefined to show it at all levels. Level zero is the least-detailed level.
33977
+ or undefined to show it at all levels. Level zero is the least-detailed level.
34329
33978
  * @property [cutoutRectangle] - Cartographic rectangle for cutting out a portion of this ImageryLayer.
34330
33979
  * @property [colorToAlpha] - Color to be used as alpha.
34331
33980
  * @property [colorToAlphaThreshold = 0.004] - Threshold for color-to-alpha.
@@ -34360,22 +34009,22 @@ export namespace ImageryLayer {
34360
34009
 
34361
34010
  /**
34362
34011
  * An imagery layer that displays tiled image data from a single imagery provider
34363
- * on a {@link Globe}.
34012
+ on a {@link Globe}.
34364
34013
  * @example
34365
34014
  * // Add an OpenStreetMaps layer
34366
- * const imageryLayer = new Cesium.ImageryLayer(new Cesium.OpenStreetMapImageryProvider({
34367
- * url: "https://tile.openstreetmap.org/"
34368
- * }));
34369
- * scene.imageryLayers.add(imageryLayer);
34015
+ const imageryLayer = new Cesium.ImageryLayer(new Cesium.OpenStreetMapImageryProvider({
34016
+ url: "https://tile.openstreetmap.org/"
34017
+ }));
34018
+ scene.imageryLayers.add(imageryLayer);
34370
34019
  * @example
34371
34020
  * // Add Cesium ion's default world imagery layer
34372
- * const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
34373
- * scene.imageryLayers.add(imageryLayer);
34021
+ const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
34022
+ scene.imageryLayers.add(imageryLayer);
34374
34023
  * @example
34375
34024
  * // Add a new transparent layer from Cesium ion
34376
- * const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34377
- * imageryLayer.alpha = 0.5;
34378
- * scene.imageryLayers.add(imageryLayer);
34025
+ const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34026
+ imageryLayer.alpha = 0.5;
34027
+ scene.imageryLayers.add(imageryLayer);
34379
34028
  * @param [imageryProvider] - The imagery provider to use.
34380
34029
  * @param [options] - An object describing initialization options
34381
34030
  */
@@ -34383,27 +34032,27 @@ export class ImageryLayer {
34383
34032
  constructor(imageryProvider?: ImageryProvider, options?: ImageryLayer.ConstructorOptions);
34384
34033
  /**
34385
34034
  * The alpha blending value of this layer, with 0.0 representing fully transparent and
34386
- * 1.0 representing fully opaque.
34035
+ 1.0 representing fully opaque.
34387
34036
  */
34388
34037
  alpha: number;
34389
34038
  /**
34390
34039
  * The alpha blending value of this layer on the night side of the globe, with 0.0 representing fully transparent and
34391
- * 1.0 representing fully opaque. This only takes effect when {@link Globe#enableLighting} is <code>true</code>.
34040
+ 1.0 representing fully opaque. This only takes effect when {@link Globe#enableLighting} is <code>true</code>.
34392
34041
  */
34393
34042
  nightAlpha: number;
34394
34043
  /**
34395
34044
  * The alpha blending value of this layer on the day side of the globe, with 0.0 representing fully transparent and
34396
- * 1.0 representing fully opaque. This only takes effect when {@link Globe#enableLighting} is <code>true</code>.
34045
+ 1.0 representing fully opaque. This only takes effect when {@link Globe#enableLighting} is <code>true</code>.
34397
34046
  */
34398
34047
  dayAlpha: number;
34399
34048
  /**
34400
34049
  * The brightness of this layer. 1.0 uses the unmodified imagery color. Less than 1.0
34401
- * makes the imagery darker while greater than 1.0 makes it brighter.
34050
+ makes the imagery darker while greater than 1.0 makes it brighter.
34402
34051
  */
34403
34052
  brightness: number;
34404
34053
  /**
34405
34054
  * The contrast of this layer. 1.0 uses the unmodified imagery color. Less than 1.0 reduces
34406
- * the contrast while greater than 1.0 increases it.
34055
+ the contrast while greater than 1.0 increases it.
34407
34056
  */
34408
34057
  contrast: number;
34409
34058
  /**
@@ -34412,7 +34061,7 @@ export class ImageryLayer {
34412
34061
  hue: number;
34413
34062
  /**
34414
34063
  * The saturation of this layer. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the
34415
- * saturation while greater than 1.0 increases it.
34064
+ saturation while greater than 1.0 increases it.
34416
34065
  */
34417
34066
  saturation: number;
34418
34067
  /**
@@ -34425,20 +34074,20 @@ export class ImageryLayer {
34425
34074
  splitDirection: SplitDirection;
34426
34075
  /**
34427
34076
  * The {@link TextureMinificationFilter} to apply to this layer.
34428
- * Possible values are {@link TextureMinificationFilter.LINEAR} (the default)
34429
- * and {@link TextureMinificationFilter.NEAREST}.
34430
- *
34431
- * To take effect, this property must be set immediately after adding the imagery layer.
34432
- * Once a texture is loaded it won't be possible to change the texture filter used.
34077
+ Possible values are {@link TextureMinificationFilter.LINEAR} (the default)
34078
+ and {@link TextureMinificationFilter.NEAREST}.
34079
+
34080
+ To take effect, this property must be set immediately after adding the imagery layer.
34081
+ Once a texture is loaded it won't be possible to change the texture filter used.
34433
34082
  */
34434
34083
  minificationFilter: TextureMinificationFilter;
34435
34084
  /**
34436
34085
  * The {@link TextureMagnificationFilter} to apply to this layer.
34437
- * Possible values are {@link TextureMagnificationFilter.LINEAR} (the default)
34438
- * and {@link TextureMagnificationFilter.NEAREST}.
34439
- *
34440
- * To take effect, this property must be set immediately after adding the imagery layer.
34441
- * Once a texture is loaded it won't be possible to change the texture filter used.
34086
+ Possible values are {@link TextureMagnificationFilter.LINEAR} (the default)
34087
+ and {@link TextureMagnificationFilter.NEAREST}.
34088
+
34089
+ To take effect, this property must be set immediately after adding the imagery layer.
34090
+ Once a texture is loaded it won't be possible to change the texture filter used.
34442
34091
  */
34443
34092
  magnificationFilter: TextureMagnificationFilter;
34444
34093
  /**
@@ -34467,85 +34116,85 @@ export class ImageryLayer {
34467
34116
  readonly ready: boolean;
34468
34117
  /**
34469
34118
  * Gets an event that is raised when the imagery provider has been successfully created. Event listeners
34470
- * are passed the created instance of {@link ImageryProvider}.
34119
+ are passed the created instance of {@link ImageryProvider}.
34471
34120
  */
34472
34121
  readonly readyEvent: Event<ImageryLayer.ReadyEventCallback>;
34473
34122
  /**
34474
34123
  * Gets the rectangle of this layer. If this rectangle is smaller than the rectangle of the
34475
- * {@link ImageryProvider}, only a portion of the imagery provider is shown.
34124
+ {@link ImageryProvider}, only a portion of the imagery provider is shown.
34476
34125
  */
34477
34126
  readonly rectangle: Rectangle;
34478
34127
  /**
34479
34128
  * This value is used as the default brightness for the imagery layer if one is not provided during construction
34480
- * or by the imagery provider. This value does not modify the brightness of the imagery.
34129
+ or by the imagery provider. This value does not modify the brightness of the imagery.
34481
34130
  */
34482
34131
  static DEFAULT_BRIGHTNESS: number;
34483
34132
  /**
34484
34133
  * This value is used as the default contrast for the imagery layer if one is not provided during construction
34485
- * or by the imagery provider. This value does not modify the contrast of the imagery.
34134
+ or by the imagery provider. This value does not modify the contrast of the imagery.
34486
34135
  */
34487
34136
  static DEFAULT_CONTRAST: number;
34488
34137
  /**
34489
34138
  * This value is used as the default hue for the imagery layer if one is not provided during construction
34490
- * or by the imagery provider. This value does not modify the hue of the imagery.
34139
+ or by the imagery provider. This value does not modify the hue of the imagery.
34491
34140
  */
34492
34141
  static DEFAULT_HUE: number;
34493
34142
  /**
34494
34143
  * This value is used as the default saturation for the imagery layer if one is not provided during construction
34495
- * or by the imagery provider. This value does not modify the saturation of the imagery.
34144
+ or by the imagery provider. This value does not modify the saturation of the imagery.
34496
34145
  */
34497
34146
  static DEFAULT_SATURATION: number;
34498
34147
  /**
34499
34148
  * This value is used as the default gamma for the imagery layer if one is not provided during construction
34500
- * or by the imagery provider. This value does not modify the gamma of the imagery.
34149
+ or by the imagery provider. This value does not modify the gamma of the imagery.
34501
34150
  */
34502
34151
  static DEFAULT_GAMMA: number;
34503
34152
  /**
34504
34153
  * This value is used as the default split for the imagery layer if one is not provided during construction
34505
- * or by the imagery provider.
34154
+ or by the imagery provider.
34506
34155
  */
34507
34156
  static DEFAULT_SPLIT: SplitDirection;
34508
34157
  /**
34509
34158
  * This value is used as the default texture minification filter for the imagery layer if one is not provided
34510
- * during construction or by the imagery provider.
34159
+ during construction or by the imagery provider.
34511
34160
  */
34512
34161
  static DEFAULT_MINIFICATION_FILTER: TextureMinificationFilter;
34513
34162
  /**
34514
34163
  * This value is used as the default texture magnification filter for the imagery layer if one is not provided
34515
- * during construction or by the imagery provider.
34164
+ during construction or by the imagery provider.
34516
34165
  */
34517
34166
  static DEFAULT_MAGNIFICATION_FILTER: TextureMagnificationFilter;
34518
34167
  /**
34519
34168
  * This value is used as the default threshold for color-to-alpha if one is not provided
34520
- * during construction or by the imagery provider.
34169
+ during construction or by the imagery provider.
34521
34170
  */
34522
34171
  static DEFAULT_APPLY_COLOR_TO_ALPHA_THRESHOLD: number;
34523
34172
  /**
34524
34173
  * 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.
34525
34174
  * @example
34526
34175
  * // Create a new base layer
34527
- * const viewer = new Cesium.Viewer("cesiumContainer", {
34528
- * baseLayer: Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34529
- * });
34176
+ const viewer = new Cesium.Viewer("cesiumContainer", {
34177
+ baseLayer: Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34178
+ });
34530
34179
  * @example
34531
34180
  * // Add a new transparent layer
34532
- * const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34533
- * imageryLayer.alpha = 0.5;
34534
- * viewer.imageryLayers.add(imageryLayer);
34181
+ const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34182
+ imageryLayer.alpha = 0.5;
34183
+ viewer.imageryLayers.add(imageryLayer);
34535
34184
  * @example
34536
34185
  * // Handle loading events
34537
- * const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34538
- * viewer.imageryLayers.add(imageryLayer);
34539
- *
34540
- * imageryLayer.readyEvent.addEventListener(provider => {
34541
- * imageryLayer.provider.errorEvent.addEventListener(error => {
34542
- * alert(`Encountered an error while loading imagery tiles! ${error}`);
34543
- * });
34544
- * });
34545
- *
34546
- * imageryLayer.errorEvent.addEventListener(error => {
34547
- * alert(`Encountered an error while creating an imagery layer! ${error}`);
34548
- * });
34186
+ const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34187
+ viewer.imageryLayers.add(imageryLayer);
34188
+
34189
+ imageryLayer.readyEvent.addEventListener(provider => {
34190
+ imageryLayer.provider.errorEvent.addEventListener(error => {
34191
+ alert(`Encountered an error while loading imagery tiles! ${error}`);
34192
+ });
34193
+ });
34194
+
34195
+ imageryLayer.errorEvent.addEventListener(error => {
34196
+ alert(`Encountered an error while creating an imagery layer! ${error}`);
34197
+ });
34549
34198
  * @param imageryProviderPromise - A promise which resolves to a imagery provider
34550
34199
  * @param options - An object describing initialization options
34551
34200
  * @returns The created imagery layer.
@@ -34555,70 +34204,70 @@ export class ImageryLayer {
34555
34204
  * 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.
34556
34205
  * @example
34557
34206
  * // Add a new transparent layer
34558
- * const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
34559
- * imageryLayer.alpha = 0.5;
34560
- * viewer.imageryLayers.add(imageryLayer);
34207
+ const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
34208
+ imageryLayer.alpha = 0.5;
34209
+ viewer.imageryLayers.add(imageryLayer);
34561
34210
  * @example
34562
34211
  * // Handle loading events
34563
- * const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
34564
- * viewer.imageryLayers.add(imageryLayer);
34565
- *
34566
- * imageryLayer.readyEvent.addEventListener(provider => {
34567
- * imageryLayer.provider.errorEvent.addEventListener(error => {
34568
- * alert(`Encountered an error while loading imagery tiles! ${error}`);
34569
- * });
34570
- * });
34571
- *
34572
- * imageryLayer.errorEvent.addEventListener(error => {
34573
- * alert(`Encountered an error while creating an imagery layer! ${error}`);
34574
- * });
34212
+ const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
34213
+ viewer.imageryLayers.add(imageryLayer);
34214
+
34215
+ imageryLayer.readyEvent.addEventListener(provider => {
34216
+ imageryLayer.provider.errorEvent.addEventListener(error => {
34217
+ alert(`Encountered an error while loading imagery tiles! ${error}`);
34218
+ });
34219
+ });
34220
+
34221
+ imageryLayer.errorEvent.addEventListener(error => {
34222
+ alert(`Encountered an error while creating an imagery layer! ${error}`);
34223
+ });
34575
34224
  * @param options - An object describing initialization options
34576
34225
  * @returns The created imagery layer.
34577
- *
34578
- * * @example
34579
- * // Create a new base layer
34580
- * const viewer = new Cesium.Viewer("cesiumContainer", {
34581
- * baseLayer: Cesium.ImageryLayer.fromWorldImagery();
34582
- * });
34226
+
34227
+ * @example
34228
+ // Create a new base layer
34229
+ const viewer = new Cesium.Viewer("cesiumContainer", {
34230
+ baseLayer: Cesium.ImageryLayer.fromWorldImagery();
34231
+ });
34583
34232
  */
34584
34233
  static fromWorldImagery(options: ImageryLayer.WorldImageryConstructorOptions): ImageryLayer;
34585
34234
  /**
34586
34235
  * Gets a value indicating whether this layer is the base layer in the
34587
- * {@link ImageryLayerCollection}. The base layer is the one that underlies all
34588
- * others. It is special in that it is treated as if it has global rectangle, even if
34589
- * it actually does not, by stretching the texels at the edges over the entire
34590
- * globe.
34236
+ {@link ImageryLayerCollection}. The base layer is the one that underlies all
34237
+ others. It is special in that it is treated as if it has global rectangle, even if
34238
+ it actually does not, by stretching the texels at the edges over the entire
34239
+ globe.
34591
34240
  * @returns true if this is the base layer; otherwise, false.
34592
34241
  */
34593
34242
  isBaseLayer(): boolean;
34594
34243
  /**
34595
34244
  * Returns true if this object was destroyed; otherwise, false.
34596
- * <br /><br />
34597
- * If this object was destroyed, it should not be used; calling any function other than
34598
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
34245
+ <br /><br />
34246
+ If this object was destroyed, it should not be used; calling any function other than
34247
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
34599
34248
  * @returns True if this object was destroyed; otherwise, false.
34600
34249
  */
34601
34250
  isDestroyed(): boolean;
34602
34251
  /**
34603
34252
  * Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
34604
- * release of WebGL resources, instead of relying on the garbage collector to destroy this object.
34605
- * <br /><br />
34606
- * Once an object is destroyed, it should not be used; calling any function other than
34607
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
34608
- * assign the return value (<code>undefined</code>) to the object as done in the example.
34253
+ release of WebGL resources, instead of relying on the garbage collector to destroy this object.
34254
+ <br /><br />
34255
+ Once an object is destroyed, it should not be used; calling any function other than
34256
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
34257
+ assign the return value (<code>undefined</code>) to the object as done in the example.
34609
34258
  * @example
34610
34259
  * imageryLayer = imageryLayer && imageryLayer.destroy();
34611
34260
  */
34612
34261
  destroy(): void;
34613
34262
  /**
34614
34263
  * Computes the intersection of this layer's rectangle with the imagery provider's availability rectangle,
34615
- * producing the overall bounds of imagery that can be produced by this layer.
34264
+ producing the overall bounds of imagery that can be produced by this layer.
34616
34265
  * @example
34617
34266
  * // Zoom to an imagery layer.
34618
- * const imageryRectangle = imageryLayer.getImageryRectangle();
34619
- * scene.camera.flyTo({
34620
- * destination: rectangle
34621
- * });
34267
+ const imageryRectangle = imageryLayer.getImageryRectangle();
34268
+ scene.camera.flyTo({
34269
+ destination: rectangle
34270
+ });
34622
34271
  * @returns A rectangle which defines the overall bounds of imagery that can be produced by this layer.
34623
34272
  */
34624
34273
  getImageryRectangle(): Rectangle;
@@ -34631,24 +34280,24 @@ export class ImageryLayerCollection {
34631
34280
  constructor();
34632
34281
  /**
34633
34282
  * An event that is raised when a layer is added to the collection. Event handlers are passed the layer that
34634
- * was added and the index at which it was added.
34283
+ was added and the index at which it was added.
34635
34284
  */
34636
34285
  layerAdded: Event;
34637
34286
  /**
34638
34287
  * An event that is raised when a layer is removed from the collection. Event handlers are passed the layer that
34639
- * was removed and the index from which it was removed.
34288
+ was removed and the index from which it was removed.
34640
34289
  */
34641
34290
  layerRemoved: Event;
34642
34291
  /**
34643
34292
  * An event that is raised when a layer changes position in the collection. Event handlers are passed the layer that
34644
- * was moved, its new index after the move, and its old index prior to the move.
34293
+ was moved, its new index after the move, and its old index prior to the move.
34645
34294
  */
34646
34295
  layerMoved: Event;
34647
34296
  /**
34648
34297
  * An event that is raised when a layer is shown or hidden by setting the
34649
- * {@link ImageryLayer#show} property. Event handlers are passed a reference to this layer,
34650
- * the index of the layer in the collection, and a flag that is true if the layer is now
34651
- * shown or false if it is now hidden.
34298
+ {@link ImageryLayer#show} property. Event handlers are passed a reference to this layer,
34299
+ the index of the layer in the collection, and a flag that is true if the layer is now
34300
+ shown or false if it is now hidden.
34652
34301
  */
34653
34302
  layerShownOrHidden: Event;
34654
34303
  /**
@@ -34659,27 +34308,27 @@ export class ImageryLayerCollection {
34659
34308
  * Adds a layer to the collection.
34660
34309
  * @example
34661
34310
  * const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
34662
- * scene.imageryLayers.add(imageryLayer);
34311
+ scene.imageryLayers.add(imageryLayer);
34663
34312
  * @example
34664
34313
  * const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34665
- * scene.imageryLayers.add(imageryLayer);
34314
+ scene.imageryLayers.add(imageryLayer);
34666
34315
  * @param layer - the layer to add.
34667
34316
  * @param [index] - the index to add the layer at. If omitted, the layer will
34668
- * be added on top of all existing layers.
34317
+ be added on top of all existing layers.
34669
34318
  */
34670
34319
  add(layer: ImageryLayer, index?: number): void;
34671
34320
  /**
34672
34321
  * Creates a new layer using the given ImageryProvider and adds it to the collection.
34673
34322
  * @example
34674
34323
  * try {
34675
- * const provider = await Cesium.IonImageryProvider.fromAssetId(3812);
34676
- * scene.imageryLayers.addImageryProvider(provider);
34677
- * } catch (error) {
34678
- * console.log(`There was an error creating the imagery layer. ${error}`)
34679
- * }
34324
+ const provider = await Cesium.IonImageryProvider.fromAssetId(3812);
34325
+ scene.imageryLayers.addImageryProvider(provider);
34326
+ } catch (error) {
34327
+ console.log(`There was an error creating the imagery layer. ${error}`)
34328
+ }
34680
34329
  * @param imageryProvider - the imagery provider to create a new layer for.
34681
34330
  * @param [index] - the index to add the layer at. If omitted, the layer will
34682
- * added on top of all existing layers.
34331
+ added on top of all existing layers.
34683
34332
  * @returns The newly created layer.
34684
34333
  */
34685
34334
  addImageryProvider(imageryProvider: ImageryProvider, index?: number): ImageryLayer;
@@ -34688,7 +34337,7 @@ export class ImageryLayerCollection {
34688
34337
  * @param layer - The layer to remove.
34689
34338
  * @param [destroy = true] - whether to destroy the layers in addition to removing them.
34690
34339
  * @returns true if the layer was in the collection and was removed,
34691
- * false if the layer was not in the collection.
34340
+ false if the layer was not in the collection.
34692
34341
  */
34693
34342
  remove(layer: ImageryLayer, destroy?: boolean): boolean;
34694
34343
  /**
@@ -34736,57 +34385,57 @@ export class ImageryLayerCollection {
34736
34385
  lowerToBottom(layer: ImageryLayer): void;
34737
34386
  /**
34738
34387
  * Determines the imagery layers that are intersected by a pick ray. To compute a pick ray from a
34739
- * location on the screen, use {@link Camera.getPickRay}.
34388
+ location on the screen, use {@link Camera.getPickRay}.
34740
34389
  * @param ray - The ray to test for intersection.
34741
34390
  * @param scene - The scene.
34742
34391
  * @returns An array that includes all of
34743
- * the layers that are intersected by a given pick ray. Undefined if
34744
- * no layers are selected.
34392
+ the layers that are intersected by a given pick ray. Undefined if
34393
+ no layers are selected.
34745
34394
  */
34746
34395
  pickImageryLayers(ray: Ray, scene: Scene): ImageryLayer[] | undefined;
34747
34396
  /**
34748
34397
  * Asynchronously determines the imagery layer features that are intersected by a pick ray. The intersected imagery
34749
- * layer features are found by invoking {@link ImageryProvider#pickFeatures} for each imagery layer tile intersected
34750
- * by the pick ray. To compute a pick ray from a location on the screen, use {@link Camera.getPickRay}.
34398
+ layer features are found by invoking {@link ImageryProvider#pickFeatures} for each imagery layer tile intersected
34399
+ by the pick ray. To compute a pick ray from a location on the screen, use {@link Camera.getPickRay}.
34751
34400
  * @example
34752
34401
  * const pickRay = viewer.camera.getPickRay(windowPosition);
34753
- * const featuresPromise = viewer.imageryLayers.pickImageryLayerFeatures(pickRay, viewer.scene);
34754
- * if (!Cesium.defined(featuresPromise)) {
34755
- * console.log('No features picked.');
34756
- * } else {
34757
- * Promise.resolve(featuresPromise).then(function(features) {
34758
- * // This function is called asynchronously when the list if picked features is available.
34759
- * console.log(`Number of features: ${features.length}`);
34760
- * if (features.length > 0) {
34761
- * console.log(`First feature name: ${features[0].name}`);
34762
- * }
34763
- * });
34764
- * }
34402
+ const featuresPromise = viewer.imageryLayers.pickImageryLayerFeatures(pickRay, viewer.scene);
34403
+ if (!Cesium.defined(featuresPromise)) {
34404
+ console.log('No features picked.');
34405
+ } else {
34406
+ Promise.resolve(featuresPromise).then(function(features) {
34407
+ // This function is called asynchronously when the list if picked features is available.
34408
+ console.log(`Number of features: ${features.length}`);
34409
+ if (features.length > 0) {
34410
+ console.log(`First feature name: ${features[0].name}`);
34411
+ }
34412
+ });
34413
+ }
34765
34414
  * @param ray - The ray to test for intersection.
34766
34415
  * @param scene - The scene.
34767
34416
  * @returns A promise that resolves to an array of features intersected by the pick ray.
34768
- * If it can be quickly determined that no features are intersected (for example,
34769
- * because no active imagery providers support {@link ImageryProvider#pickFeatures}
34770
- * or because the pick ray does not intersect the surface), this function will
34771
- * return undefined.
34417
+ If it can be quickly determined that no features are intersected (for example,
34418
+ because no active imagery providers support {@link ImageryProvider#pickFeatures}
34419
+ or because the pick ray does not intersect the surface), this function will
34420
+ return undefined.
34772
34421
  */
34773
34422
  pickImageryLayerFeatures(ray: Ray, scene: Scene): Promise<ImageryLayerFeatureInfo[]> | undefined;
34774
34423
  /**
34775
34424
  * Returns true if this object was destroyed; otherwise, false.
34776
- * <br /><br />
34777
- * If this object was destroyed, it should not be used; calling any function other than
34778
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
34425
+ <br /><br />
34426
+ If this object was destroyed, it should not be used; calling any function other than
34427
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
34779
34428
  * @returns true if this object was destroyed; otherwise, false.
34780
34429
  */
34781
34430
  isDestroyed(): boolean;
34782
34431
  /**
34783
34432
  * Destroys the WebGL resources held by all layers in this collection. Explicitly destroying this
34784
- * object allows for deterministic release of WebGL resources, instead of relying on the garbage
34785
- * collector.
34786
- * <br /><br />
34787
- * Once this object is destroyed, it should not be used; calling any function other than
34788
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
34789
- * assign the return value (<code>undefined</code>) to the object as done in the example.
34433
+ object allows for deterministic release of WebGL resources, instead of relying on the garbage
34434
+ collector.
34435
+ <br /><br />
34436
+ Once this object is destroyed, it should not be used; calling any function other than
34437
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
34438
+ assign the return value (<code>undefined</code>) to the object as done in the example.
34790
34439
  * @example
34791
34440
  * layerCollection = layerCollection && layerCollection.destroy();
34792
34441
  */
@@ -35097,52 +34746,6 @@ export enum IonWorldImageryStyle {
35097
34746
  ROAD = 4
35098
34747
  }
35099
34748
 
35100
- /**
35101
- * Methods for loading iTwin platform data into CesiumJS
35102
- */
35103
- export namespace ITwinData {
35104
- /**
35105
- * Create a {@link Cesium3DTileset} for the given iModel id using iTwin's Mesh Export API.
35106
-
35107
- If there is not a completed export available for the given iModel id, the returned promise will resolve to <code>undefined</code>.
35108
- We recommend waiting 10-20 seconds and trying to load the tileset again.
35109
- If all exports are Invalid this will throw an error.
35110
- * @example
35111
- * const tileset = await Cesium.ITwinData.createTilesetFromIModelId(iModelId);
35112
- if (Cesium.defined(tileset)) {
35113
- viewer.scene.primitives.add(tileset);
35114
- }
35115
- * @param iModelId - The id of the iModel to load
35116
- * @param [options] - Object containing options to pass to the internally created {@link Cesium3DTileset}.
35117
- * @returns A promise that will resolve to the created 3D tileset or <code>undefined</code> if there is no completed export for the given iModel id
35118
- */
35119
- function createTilesetFromIModelId(iModelId: string, options?: Cesium3DTileset.ConstructorOptions): Promise<Cesium3DTileset | undefined>;
35120
- /**
35121
- * Create a tileset for the specified reality data id. This function only works
35122
- with 3D Tiles meshes and point clouds.
35123
-
35124
- If the <code>type</code> or <code>rootDocument</code> are not provided this function
35125
- will first request the full metadata for the specified reality data to fill these values.
35126
- * @param iTwinId - The id of the iTwin to load data from
35127
- * @param realityDataId - The id of the reality data to load
35128
- * @param [type] - The type of this reality data
35129
- * @param [rootDocument] - The path of the root document for this reality data
35130
- */
35131
- function createTilesetForRealityDataId(iTwinId: string, realityDataId: string, type?: ITwinPlatform.RealityDataType, rootDocument?: string): Promise<Cesium3DTileset>;
35132
- /**
35133
- * Create a data source of the correct type for the specified reality data id.
35134
- This function only works for KML and GeoJSON type data.
35135
-
35136
- If the <code>type</code> or <code>rootDocument</code> are not provided this function
35137
- will first request the full metadata for the specified reality data to fill these values.
35138
- * @param iTwinId - The id of the iTwin to load data from
35139
- * @param realityDataId - The id of the reality data to load
35140
- * @param [type] - The type of this reality data
35141
- * @param [rootDocument] - The path of the root document for this reality data
35142
- */
35143
- function createDataSourceForRealityDataId(iTwinId: string, realityDataId: string, type?: ITwinPlatform.RealityDataType, rootDocument?: string): Promise<GeoJsonDataSource | KmlDataSource>;
35144
- }
35145
-
35146
34749
  export namespace Label {
35147
34750
  /**
35148
34751
  * Initialization options for the Label constructor
@@ -35975,216 +35578,216 @@ export enum MapMode2D {
35975
35578
 
35976
35579
  /**
35977
35580
  * A Material defines surface appearance through a combination of diffuse, specular,
35978
- * normal, emission, and alpha components. These values are specified using a
35979
- * JSON schema called Fabric which gets parsed and assembled into glsl shader code
35980
- * behind-the-scenes. Check out the {@link https://github.com/CesiumGS/cesium/wiki/Fabric|wiki page}
35981
- * for more details on Fabric.
35982
- * <br /><br />
35983
- * <style type="text/css">
35984
- * #materialDescriptions code {
35985
- * font-weight: normal;
35986
- * font-family: Consolas, 'Lucida Console', Monaco, monospace;
35987
- * color: #A35A00;
35988
- * }
35989
- * #materialDescriptions ul, #materialDescriptions ul ul {
35990
- * list-style-type: none;
35991
- * }
35992
- * #materialDescriptions ul ul {
35993
- * margin-bottom: 10px;
35994
- * }
35995
- * #materialDescriptions ul ul li {
35996
- * font-weight: normal;
35997
- * color: #000000;
35998
- * text-indent: -2em;
35999
- * margin-left: 2em;
36000
- * }
36001
- * #materialDescriptions ul li {
36002
- * font-weight: bold;
36003
- * color: #0053CF;
36004
- * }
36005
- * </style>
36006
- *
36007
- * Base material types and their uniforms:
36008
- * <div id='materialDescriptions'>
36009
- * <ul>
36010
- * <li>Color</li>
36011
- * <ul>
36012
- * <li><code>color</code>: rgba color object.</li>
36013
- * </ul>
36014
- * <li>Image</li>
36015
- * <ul>
36016
- * <li><code>image</code>: path to image.</li>
36017
- * <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36018
- * </ul>
36019
- * <li>DiffuseMap</li>
36020
- * <ul>
36021
- * <li><code>image</code>: path to image.</li>
36022
- * <li><code>channels</code>: Three character string containing any combination of r, g, b, and a for selecting the desired image channels.</li>
36023
- * <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36024
- * </ul>
36025
- * <li>AlphaMap</li>
36026
- * <ul>
36027
- * <li><code>image</code>: path to image.</li>
36028
- * <li><code>channel</code>: One character string containing r, g, b, or a for selecting the desired image channel. </li>
36029
- * <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36030
- * </ul>
36031
- * <li>SpecularMap</li>
36032
- * <ul>
36033
- * <li><code>image</code>: path to image.</li>
36034
- * <li><code>channel</code>: One character string containing r, g, b, or a for selecting the desired image channel. </li>
36035
- * <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36036
- * </ul>
36037
- * <li>EmissionMap</li>
36038
- * <ul>
36039
- * <li><code>image</code>: path to image.</li>
36040
- * <li><code>channels</code>: Three character string containing any combination of r, g, b, and a for selecting the desired image channels. </li>
36041
- * <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36042
- * </ul>
36043
- * <li>BumpMap</li>
36044
- * <ul>
36045
- * <li><code>image</code>: path to image.</li>
36046
- * <li><code>channel</code>: One character string containing r, g, b, or a for selecting the desired image channel. </li>
36047
- * <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36048
- * <li><code>strength</code>: Bump strength value between 0.0 and 1.0 where 0.0 is small bumps and 1.0 is large bumps.</li>
36049
- * </ul>
36050
- * <li>NormalMap</li>
36051
- * <ul>
36052
- * <li><code>image</code>: path to image.</li>
36053
- * <li><code>channels</code>: Three character string containing any combination of r, g, b, and a for selecting the desired image channels. </li>
36054
- * <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36055
- * <li><code>strength</code>: Bump strength value between 0.0 and 1.0 where 0.0 is small bumps and 1.0 is large bumps.</li>
36056
- * </ul>
36057
- * <li>Grid</li>
36058
- * <ul>
36059
- * <li><code>color</code>: rgba color object for the whole material.</li>
36060
- * <li><code>cellAlpha</code>: Alpha value for the cells between grid lines. This will be combined with color.alpha.</li>
36061
- * <li><code>lineCount</code>: Object with x and y values specifying the number of columns and rows respectively.</li>
36062
- * <li><code>lineThickness</code>: Object with x and y values specifying the thickness of grid lines (in pixels where available).</li>
36063
- * <li><code>lineOffset</code>: Object with x and y values specifying the offset of grid lines (range is 0 to 1).</li>
36064
- * </ul>
36065
- * <li>Stripe</li>
36066
- * <ul>
36067
- * <li><code>horizontal</code>: Boolean that determines if the stripes are horizontal or vertical.</li>
36068
- * <li><code>evenColor</code>: rgba color object for the stripe's first color.</li>
36069
- * <li><code>oddColor</code>: rgba color object for the stripe's second color.</li>
36070
- * <li><code>offset</code>: Number that controls at which point into the pattern to begin drawing; with 0.0 being the beginning of the even color, 1.0 the beginning of the odd color, 2.0 being the even color again, and any multiple or fractional values being in between.</li>
36071
- * <li><code>repeat</code>: Number that controls the total number of stripes, half light and half dark.</li>
36072
- * </ul>
36073
- * <li>Checkerboard</li>
36074
- * <ul>
36075
- * <li><code>lightColor</code>: rgba color object for the checkerboard's light alternating color.</li>
36076
- * <li><code>darkColor</code>: rgba color object for the checkerboard's dark alternating color.</li>
36077
- * <li><code>repeat</code>: Object with x and y values specifying the number of columns and rows respectively.</li>
36078
- * </ul>
36079
- * <li>Dot</li>
36080
- * <ul>
36081
- * <li><code>lightColor</code>: rgba color object for the dot color.</li>
36082
- * <li><code>darkColor</code>: rgba color object for the background color.</li>
36083
- * <li><code>repeat</code>: Object with x and y values specifying the number of columns and rows of dots respectively.</li>
36084
- * </ul>
36085
- * <li>Water</li>
36086
- * <ul>
36087
- * <li><code>baseWaterColor</code>: rgba color object base color of the water.</li>
36088
- * <li><code>blendColor</code>: rgba color object used when blending from water to non-water areas.</li>
36089
- * <li><code>specularMap</code>: Single channel texture used to indicate areas of water.</li>
36090
- * <li><code>normalMap</code>: Normal map for water normal perturbation.</li>
36091
- * <li><code>frequency</code>: Number that controls the number of waves.</li>
36092
- * <li><code>animationSpeed</code>: Number that controls the animations speed of the water.</li>
36093
- * <li><code>amplitude</code>: Number that controls the amplitude of water waves.</li>
36094
- * <li><code>specularIntensity</code>: Number that controls the intensity of specular reflections.</li>
36095
- * </ul>
36096
- * <li>RimLighting</li>
36097
- * <ul>
36098
- * <li><code>color</code>: diffuse color and alpha.</li>
36099
- * <li><code>rimColor</code>: diffuse color and alpha of the rim.</li>
36100
- * <li><code>width</code>: Number that determines the rim's width.</li>
36101
- * </ul>
36102
- * <li>Fade</li>
36103
- * <ul>
36104
- * <li><code>fadeInColor</code>: diffuse color and alpha at <code>time</code></li>
36105
- * <li><code>fadeOutColor</code>: diffuse color and alpha at <code>maximumDistance</code> from <code>time</code></li>
36106
- * <li><code>maximumDistance</code>: Number between 0.0 and 1.0 where the <code>fadeInColor</code> becomes the <code>fadeOutColor</code>. A value of 0.0 gives the entire material a color of <code>fadeOutColor</code> and a value of 1.0 gives the the entire material a color of <code>fadeInColor</code></li>
36107
- * <li><code>repeat</code>: true if the fade should wrap around the texture coodinates.</li>
36108
- * <li><code>fadeDirection</code>: Object with x and y values specifying if the fade should be in the x and y directions.</li>
36109
- * <li><code>time</code>: Object with x and y values between 0.0 and 1.0 of the <code>fadeInColor</code> position</li>
36110
- * </ul>
36111
- * <li>PolylineArrow</li>
36112
- * <ul>
36113
- * <li><code>color</code>: diffuse color and alpha.</li>
36114
- * </ul>
36115
- * <li>PolylineDash</li>
36116
- * <ul>
36117
- * <li><code>color</code>: color for the line.</li>
36118
- * <li><code>gapColor</code>: color for the gaps in the line.</li>
36119
- * <li><code>dashLength</code>: Dash length in pixels.</li>
36120
- * <li><code>dashPattern</code>: The 16 bit stipple pattern for the line..</li>
36121
- * </ul>
36122
- * <li>PolylineGlow</li>
36123
- * <ul>
36124
- * <li><code>color</code>: color and maximum alpha for the glow on the line.</li>
36125
- * <li><code>glowPower</code>: strength of the glow, as a percentage of the total line width (less than 1.0).</li>
36126
- * <li><code>taperPower</code>: strength of the tapering effect, as a percentage of the total line length. If 1.0 or higher, no taper effect is used.</li>
36127
- * </ul>
36128
- * <li>PolylineOutline</li>
36129
- * <ul>
36130
- * <li><code>color</code>: diffuse color and alpha for the interior of the line.</li>
36131
- * <li><code>outlineColor</code>: diffuse color and alpha for the outline.</li>
36132
- * <li><code>outlineWidth</code>: width of the outline in pixels.</li>
36133
- * </ul>
36134
- * <li>ElevationContour</li>
36135
- * <ul>
36136
- * <li><code>color</code>: color and alpha for the contour line.</li>
36137
- * <li><code>spacing</code>: spacing for contour lines in meters.</li>
36138
- * <li><code>width</code>: Number specifying the width of the grid lines in pixels.</li>
36139
- * </ul>
36140
- * <li>ElevationRamp</li>
36141
- * <ul>
36142
- * <li><code>image</code>: color ramp image to use for coloring the terrain.</li>
36143
- * <li><code>minimumHeight</code>: minimum height for the ramp.</li>
36144
- * <li><code>maximumHeight</code>: maximum height for the ramp.</li>
36145
- * </ul>
36146
- * <li>SlopeRamp</li>
36147
- * <ul>
36148
- * <li><code>image</code>: color ramp image to use for coloring the terrain by slope.</li>
36149
- * </ul>
36150
- * <li>AspectRamp</li>
36151
- * <ul>
36152
- * <li><code>image</code>: color ramp image to use for color the terrain by aspect.</li>
36153
- * </ul>
36154
- * <li>ElevationBand</li>
36155
- * <ul>
36156
- * <li><code>heights</code>: image of heights sorted from lowest to highest.</li>
36157
- * <li><code>colors</code>: image of colors at the corresponding heights.</li>
36158
- * </ul>
36159
- * <li>WaterMask</li>
36160
- * <ul>
36161
- * <li><code>waterColor</code>: diffuse color and alpha for the areas covered by water.</li>
36162
- * <li><code>landColor</code>: diffuse color and alpha for the areas covered by land.</li>
36163
- * </ul>
36164
- * </ul>
36165
- * </ul>
36166
- * </div>
35581
+ normal, emission, and alpha components. These values are specified using a
35582
+ JSON schema called Fabric which gets parsed and assembled into glsl shader code
35583
+ behind-the-scenes. Check out the {@link https://github.com/CesiumGS/cesium/wiki/Fabric|wiki page}
35584
+ for more details on Fabric.
35585
+ <br /><br />
35586
+ <style type="text/css">
35587
+ #materialDescriptions code {
35588
+ font-weight: normal;
35589
+ font-family: Consolas, 'Lucida Console', Monaco, monospace;
35590
+ color: #A35A00;
35591
+ }
35592
+ #materialDescriptions ul, #materialDescriptions ul ul {
35593
+ list-style-type: none;
35594
+ }
35595
+ #materialDescriptions ul ul {
35596
+ margin-bottom: 10px;
35597
+ }
35598
+ #materialDescriptions ul ul li {
35599
+ font-weight: normal;
35600
+ color: #000000;
35601
+ text-indent: -2em;
35602
+ margin-left: 2em;
35603
+ }
35604
+ #materialDescriptions ul li {
35605
+ font-weight: bold;
35606
+ color: #0053CF;
35607
+ }
35608
+ </style>
35609
+
35610
+ Base material types and their uniforms:
35611
+ <div id='materialDescriptions'>
35612
+ <ul>
35613
+ <li>Color</li>
35614
+ <ul>
35615
+ <li><code>color</code>: rgba color object.</li>
35616
+ </ul>
35617
+ <li>Image</li>
35618
+ <ul>
35619
+ <li><code>image</code>: path to image.</li>
35620
+ <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
35621
+ </ul>
35622
+ <li>DiffuseMap</li>
35623
+ <ul>
35624
+ <li><code>image</code>: path to image.</li>
35625
+ <li><code>channels</code>: Three character string containing any combination of r, g, b, and a for selecting the desired image channels.</li>
35626
+ <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
35627
+ </ul>
35628
+ <li>AlphaMap</li>
35629
+ <ul>
35630
+ <li><code>image</code>: path to image.</li>
35631
+ <li><code>channel</code>: One character string containing r, g, b, or a for selecting the desired image channel. </li>
35632
+ <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
35633
+ </ul>
35634
+ <li>SpecularMap</li>
35635
+ <ul>
35636
+ <li><code>image</code>: path to image.</li>
35637
+ <li><code>channel</code>: One character string containing r, g, b, or a for selecting the desired image channel. </li>
35638
+ <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
35639
+ </ul>
35640
+ <li>EmissionMap</li>
35641
+ <ul>
35642
+ <li><code>image</code>: path to image.</li>
35643
+ <li><code>channels</code>: Three character string containing any combination of r, g, b, and a for selecting the desired image channels. </li>
35644
+ <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
35645
+ </ul>
35646
+ <li>BumpMap</li>
35647
+ <ul>
35648
+ <li><code>image</code>: path to image.</li>
35649
+ <li><code>channel</code>: One character string containing r, g, b, or a for selecting the desired image channel. </li>
35650
+ <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
35651
+ <li><code>strength</code>: Bump strength value between 0.0 and 1.0 where 0.0 is small bumps and 1.0 is large bumps.</li>
35652
+ </ul>
35653
+ <li>NormalMap</li>
35654
+ <ul>
35655
+ <li><code>image</code>: path to image.</li>
35656
+ <li><code>channels</code>: Three character string containing any combination of r, g, b, and a for selecting the desired image channels. </li>
35657
+ <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
35658
+ <li><code>strength</code>: Bump strength value between 0.0 and 1.0 where 0.0 is small bumps and 1.0 is large bumps.</li>
35659
+ </ul>
35660
+ <li>Grid</li>
35661
+ <ul>
35662
+ <li><code>color</code>: rgba color object for the whole material.</li>
35663
+ <li><code>cellAlpha</code>: Alpha value for the cells between grid lines. This will be combined with color.alpha.</li>
35664
+ <li><code>lineCount</code>: Object with x and y values specifying the number of columns and rows respectively.</li>
35665
+ <li><code>lineThickness</code>: Object with x and y values specifying the thickness of grid lines (in pixels where available).</li>
35666
+ <li><code>lineOffset</code>: Object with x and y values specifying the offset of grid lines (range is 0 to 1).</li>
35667
+ </ul>
35668
+ <li>Stripe</li>
35669
+ <ul>
35670
+ <li><code>horizontal</code>: Boolean that determines if the stripes are horizontal or vertical.</li>
35671
+ <li><code>evenColor</code>: rgba color object for the stripe's first color.</li>
35672
+ <li><code>oddColor</code>: rgba color object for the stripe's second color.</li>
35673
+ <li><code>offset</code>: Number that controls at which point into the pattern to begin drawing; with 0.0 being the beginning of the even color, 1.0 the beginning of the odd color, 2.0 being the even color again, and any multiple or fractional values being in between.</li>
35674
+ <li><code>repeat</code>: Number that controls the total number of stripes, half light and half dark.</li>
35675
+ </ul>
35676
+ <li>Checkerboard</li>
35677
+ <ul>
35678
+ <li><code>lightColor</code>: rgba color object for the checkerboard's light alternating color.</li>
35679
+ <li><code>darkColor</code>: rgba color object for the checkerboard's dark alternating color.</li>
35680
+ <li><code>repeat</code>: Object with x and y values specifying the number of columns and rows respectively.</li>
35681
+ </ul>
35682
+ <li>Dot</li>
35683
+ <ul>
35684
+ <li><code>lightColor</code>: rgba color object for the dot color.</li>
35685
+ <li><code>darkColor</code>: rgba color object for the background color.</li>
35686
+ <li><code>repeat</code>: Object with x and y values specifying the number of columns and rows of dots respectively.</li>
35687
+ </ul>
35688
+ <li>Water</li>
35689
+ <ul>
35690
+ <li><code>baseWaterColor</code>: rgba color object base color of the water.</li>
35691
+ <li><code>blendColor</code>: rgba color object used when blending from water to non-water areas.</li>
35692
+ <li><code>specularMap</code>: Single channel texture used to indicate areas of water.</li>
35693
+ <li><code>normalMap</code>: Normal map for water normal perturbation.</li>
35694
+ <li><code>frequency</code>: Number that controls the number of waves.</li>
35695
+ <li><code>animationSpeed</code>: Number that controls the animations speed of the water.</li>
35696
+ <li><code>amplitude</code>: Number that controls the amplitude of water waves.</li>
35697
+ <li><code>specularIntensity</code>: Number that controls the intensity of specular reflections.</li>
35698
+ </ul>
35699
+ <li>RimLighting</li>
35700
+ <ul>
35701
+ <li><code>color</code>: diffuse color and alpha.</li>
35702
+ <li><code>rimColor</code>: diffuse color and alpha of the rim.</li>
35703
+ <li><code>width</code>: Number that determines the rim's width.</li>
35704
+ </ul>
35705
+ <li>Fade</li>
35706
+ <ul>
35707
+ <li><code>fadeInColor</code>: diffuse color and alpha at <code>time</code></li>
35708
+ <li><code>fadeOutColor</code>: diffuse color and alpha at <code>maximumDistance</code> from <code>time</code></li>
35709
+ <li><code>maximumDistance</code>: Number between 0.0 and 1.0 where the <code>fadeInColor</code> becomes the <code>fadeOutColor</code>. A value of 0.0 gives the entire material a color of <code>fadeOutColor</code> and a value of 1.0 gives the the entire material a color of <code>fadeInColor</code></li>
35710
+ <li><code>repeat</code>: true if the fade should wrap around the texture coodinates.</li>
35711
+ <li><code>fadeDirection</code>: Object with x and y values specifying if the fade should be in the x and y directions.</li>
35712
+ <li><code>time</code>: Object with x and y values between 0.0 and 1.0 of the <code>fadeInColor</code> position</li>
35713
+ </ul>
35714
+ <li>PolylineArrow</li>
35715
+ <ul>
35716
+ <li><code>color</code>: diffuse color and alpha.</li>
35717
+ </ul>
35718
+ <li>PolylineDash</li>
35719
+ <ul>
35720
+ <li><code>color</code>: color for the line.</li>
35721
+ <li><code>gapColor</code>: color for the gaps in the line.</li>
35722
+ <li><code>dashLength</code>: Dash length in pixels.</li>
35723
+ <li><code>dashPattern</code>: The 16 bit stipple pattern for the line..</li>
35724
+ </ul>
35725
+ <li>PolylineGlow</li>
35726
+ <ul>
35727
+ <li><code>color</code>: color and maximum alpha for the glow on the line.</li>
35728
+ <li><code>glowPower</code>: strength of the glow, as a percentage of the total line width (less than 1.0).</li>
35729
+ <li><code>taperPower</code>: strength of the tapering effect, as a percentage of the total line length. If 1.0 or higher, no taper effect is used.</li>
35730
+ </ul>
35731
+ <li>PolylineOutline</li>
35732
+ <ul>
35733
+ <li><code>color</code>: diffuse color and alpha for the interior of the line.</li>
35734
+ <li><code>outlineColor</code>: diffuse color and alpha for the outline.</li>
35735
+ <li><code>outlineWidth</code>: width of the outline in pixels.</li>
35736
+ </ul>
35737
+ <li>ElevationContour</li>
35738
+ <ul>
35739
+ <li><code>color</code>: color and alpha for the contour line.</li>
35740
+ <li><code>spacing</code>: spacing for contour lines in meters.</li>
35741
+ <li><code>width</code>: Number specifying the width of the grid lines in pixels.</li>
35742
+ </ul>
35743
+ <li>ElevationRamp</li>
35744
+ <ul>
35745
+ <li><code>image</code>: color ramp image to use for coloring the terrain.</li>
35746
+ <li><code>minimumHeight</code>: minimum height for the ramp.</li>
35747
+ <li><code>maximumHeight</code>: maximum height for the ramp.</li>
35748
+ </ul>
35749
+ <li>SlopeRamp</li>
35750
+ <ul>
35751
+ <li><code>image</code>: color ramp image to use for coloring the terrain by slope.</li>
35752
+ </ul>
35753
+ <li>AspectRamp</li>
35754
+ <ul>
35755
+ <li><code>image</code>: color ramp image to use for color the terrain by aspect.</li>
35756
+ </ul>
35757
+ <li>ElevationBand</li>
35758
+ <ul>
35759
+ <li><code>heights</code>: image of heights sorted from lowest to highest.</li>
35760
+ <li><code>colors</code>: image of colors at the corresponding heights.</li>
35761
+ </ul>
35762
+ <li>WaterMask</li>
35763
+ <ul>
35764
+ <li><code>waterColor</code>: diffuse color and alpha for the areas covered by water.</li>
35765
+ <li><code>landColor</code>: diffuse color and alpha for the areas covered by land.</li>
35766
+ </ul>
35767
+ </ul>
35768
+ </ul>
35769
+ </div>
36167
35770
  * @example
36168
35771
  * // Create a color material with fromType:
36169
- * polygon.material = Cesium.Material.fromType('Color');
36170
- * polygon.material.uniforms.color = new Cesium.Color(1.0, 1.0, 0.0, 1.0);
36171
- *
36172
- * // Create the default material:
36173
- * polygon.material = new Cesium.Material();
36174
- *
36175
- * // Create a color material with full Fabric notation:
36176
- * polygon.material = new Cesium.Material({
36177
- * fabric: {
36178
- * type: 'Color',
36179
- * uniforms: {
36180
- * color: new Cesium.Color(1.0, 1.0, 0.0, 1.0)
36181
- * }
36182
- * }
36183
- * });
35772
+ polygon.material = Cesium.Material.fromType('Color');
35773
+ polygon.material.uniforms.color = new Cesium.Color(1.0, 1.0, 0.0, 1.0);
35774
+
35775
+ // Create the default material:
35776
+ polygon.material = new Cesium.Material();
35777
+
35778
+ // Create a color material with full Fabric notation:
35779
+ polygon.material = new Cesium.Material({
35780
+ fabric: {
35781
+ type: 'Color',
35782
+ uniforms: {
35783
+ color: new Cesium.Color(1.0, 1.0, 0.0, 1.0)
35784
+ }
35785
+ }
35786
+ });
36184
35787
  * @param [options] - Object with the following properties:
36185
35788
  * @param [options.strict = false] - Throws errors for issues that would normally be ignored, including unused uniforms or materials.
36186
35789
  * @param [options.translucent = true] - When <code>true</code> or a function that returns <code>true</code>, the geometry
36187
- * with this material is expected to appear translucent.
35790
+ with this material is expected to appear translucent.
36188
35791
  * @param [options.minificationFilter = TextureMinificationFilter.LINEAR] - The {@link TextureMinificationFilter} to apply to this material's textures.
36189
35792
  * @param [options.magnificationFilter = TextureMagnificationFilter.LINEAR] - The {@link TextureMagnificationFilter} to apply to this material's textures.
36190
35793
  * @param options.fabric - The fabric JSON used to generate the material.
@@ -36215,17 +35818,17 @@ export class Material {
36215
35818
  uniforms: any;
36216
35819
  /**
36217
35820
  * When <code>true</code> or a function that returns <code>true</code>,
36218
- * the geometry is expected to appear translucent.
35821
+ the geometry is expected to appear translucent.
36219
35822
  */
36220
35823
  translucent: boolean | ((...params: any[]) => any);
36221
35824
  /**
36222
35825
  * Creates a new material using an existing material type.
36223
- * <br /><br />
36224
- * Shorthand for: new Material({fabric : {type : type}});
35826
+ <br /><br />
35827
+ Shorthand for: new Material({fabric : {type : type}});
36225
35828
  * @example
36226
35829
  * const material = Cesium.Material.fromType('Color', {
36227
- * color: new Cesium.Color(1.0, 0.0, 0.0, 1.0)
36228
- * });
35830
+ color: new Cesium.Color(1.0, 0.0, 0.0, 1.0)
35831
+ });
36229
35832
  * @param type - The base material type.
36230
35833
  * @param [uniforms] - Overrides for the default uniforms.
36231
35834
  * @returns New material object.
@@ -36238,19 +35841,19 @@ export class Material {
36238
35841
  isTranslucent(): boolean;
36239
35842
  /**
36240
35843
  * Returns true if this object was destroyed; otherwise, false.
36241
- * <br /><br />
36242
- * If this object was destroyed, it should not be used; calling any function other than
36243
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
35844
+ <br /><br />
35845
+ If this object was destroyed, it should not be used; calling any function other than
35846
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
36244
35847
  * @returns True if this object was destroyed; otherwise, false.
36245
35848
  */
36246
35849
  isDestroyed(): boolean;
36247
35850
  /**
36248
35851
  * Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
36249
- * release of WebGL resources, instead of relying on the garbage collector to destroy this object.
36250
- * <br /><br />
36251
- * Once an object is destroyed, it should not be used; calling any function other than
36252
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
36253
- * assign the return value (<code>undefined</code>) to the object as done in the example.
35852
+ release of WebGL resources, instead of relying on the garbage collector to destroy this object.
35853
+ <br /><br />
35854
+ Once an object is destroyed, it should not be used; calling any function other than
35855
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
35856
+ assign the return value (<code>undefined</code>) to the object as done in the example.
36254
35857
  * @example
36255
35858
  * material = material && material.destroy();
36256
35859
  */
@@ -36689,18 +36292,10 @@ export class MetadataClassProperty {
36689
36292
  readonly semantic: string;
36690
36293
  /**
36691
36294
  * The offset to be added to property values as part of the value transform.
36692
-
36693
- This is always defined, even when `hasValueTransform` is `false`. If
36694
- the class property JSON itself did not define it, then it will be
36695
- initialized to the default value.
36696
36295
  */
36697
36296
  readonly offset: number | number[] | number[][];
36698
36297
  /**
36699
36298
  * The scale to be multiplied to property values as part of the value transform.
36700
-
36701
- This is always defined, even when `hasValueTransform` is `false`. If
36702
- the class property JSON itself did not define it, then it will be
36703
- initialized to the default value.
36704
36299
  */
36705
36300
  readonly scale: number | number[] | number[][];
36706
36301
  /**
@@ -36923,26 +36518,6 @@ export class MetadataSchema {
36923
36518
  readonly extensions: any;
36924
36519
  }
36925
36520
 
36926
- /**
36927
- * An instance of a metadata value.<br>
36928
- <br>
36929
- This can be one of the following types:
36930
- <ul>
36931
- <li><code>number</code> for type <code>SCALAR</code> and numeric component types except for <code>INT64</code> or <code>UINT64</code></li>
36932
- <li><code>bigint</code> for type <code>SCALAR</code> and component type <code>INT64</code> or <code>UINT64</code></li>
36933
- <li><code>string</code> for type <code>STRING</code> or <code>ENUM</code></li>
36934
- <li><code>boolean</code> for type <code>BOOLEAN</code></li>
36935
- <li><code>Cartesian2</code> for type <code>VEC2</code></li>
36936
- <li><code>Cartesian3</code> for type <code>VEC3</code></li>
36937
- <li><code>Cartesian4</code> for type <code>VEC4</code></li>
36938
- <li><code>Matrix2</code> for type <code>MAT2</code></li>
36939
- <li><code>Matrix3</code> for type <code>MAT3</code></li>
36940
- <li><code>Matrix4</code> for type <code>MAT4</code></li>
36941
- <li>Arrays of these types when the metadata value is an array</li>
36942
- </ul>
36943
- */
36944
- export type MetadataValue = number | bigint | string | boolean | Cartesian2 | Cartesian3 | Cartesian4 | Matrix2 | Matrix3 | Matrix4 | number[] | bigint[] | string[] | boolean[] | Cartesian2[] | Cartesian3[] | Cartesian4[] | Matrix2[] | Matrix3[] | Matrix4[];
36945
-
36946
36521
  /**
36947
36522
  * An enum of metadata types. These metadata types are containers containing
36948
36523
  one or more components of type {@link MetadataComponentType}
@@ -37710,7 +37285,7 @@ export class Model {
37710
37285
  */
37711
37286
  enableVerticalExaggeration: boolean;
37712
37287
  /**
37713
- * The directional light color when shading the model. When <code>undefined</code> the scene's light color is used instead.
37288
+ * The light color when shading the model. When <code>undefined</code> the scene's light color is used instead.
37714
37289
  <p>
37715
37290
  Disabling additional light sources by setting
37716
37291
  <code>model.imageBasedLighting.imageBasedLightingFactor = new Cartesian2(0.0, 0.0)</code>
@@ -37722,14 +37297,6 @@ export class Model {
37722
37297
  * The properties for managing image-based lighting on this model.
37723
37298
  */
37724
37299
  imageBasedLighting: ImageBasedLighting;
37725
- /**
37726
- * The properties for managing dynamic environment maps on this model. Affects lighting.
37727
- * @example
37728
- * // Change the ground color used for a model's environment map to a forest green
37729
- const environmentMapManager = model.environmentMapManager;
37730
- environmentMapManager.groundColor = Cesium.Color.fromCssColorString("#203b34");
37731
- */
37732
- readonly environmentMapManager: DynamicEnvironmentMapManager;
37733
37300
  /**
37734
37301
  * Whether to cull back-facing geometry. When true, back face culling is
37735
37302
  determined by the material's doubleSided property; when false, back face
@@ -37825,7 +37392,7 @@ export class Model {
37825
37392
 
37826
37393
  The given name may be the name of a glTF extension, like `"EXT_example_extension"`.
37827
37394
  If the specified extension was present in the root of the underlying glTF asset,
37828
- and a loader for the specified extension has processed the extension data, then
37395
+ and a loder for the specified extension has processed the extension data, then
37829
37396
  this will return the model representation of the extension.
37830
37397
  * @param extensionName - The name of the extension
37831
37398
  * @returns The object, or `undefined`
@@ -37969,7 +37536,6 @@ export class Model {
37969
37536
  * @param [options.clippingPolygons] - The {@link ClippingPolygonCollection} used to selectively disable rendering the model.
37970
37537
  * @param [options.lightColor] - The light color when shading the model. When <code>undefined</code> the scene's light color is used instead.
37971
37538
  * @param [options.imageBasedLighting] - The properties for managing image-based lighting on this model.
37972
- * @param [options.environmentMapOptions] - The properties for managing dynamic environment maps on this model.
37973
37539
  * @param [options.backFaceCulling = true] - Whether to cull back-facing geometry. When true, back face culling is determined by the material's doubleSided property; when false, back face culling is disabled. Back faces are not culled if the model's color is translucent.
37974
37540
  * @param [options.credit] - A credit for the data source, which is displayed on the canvas.
37975
37541
  * @param [options.showCreditsOnScreen = false] - Whether to display the credits of this model on screen.
@@ -38023,7 +37589,6 @@ export class Model {
38023
37589
  clippingPolygons?: ClippingPolygonCollection;
38024
37590
  lightColor?: Cartesian3;
38025
37591
  imageBasedLighting?: ImageBasedLighting;
38026
- environmentMapOptions?: DynamicEnvironmentMapManager.ConstructorOptions;
38027
37592
  backFaceCulling?: boolean;
38028
37593
  credit?: Credit | string;
38029
37594
  showCreditsOnScreen?: boolean;
@@ -39259,19 +38824,10 @@ export var className: string;
39259
38824
  export var propertyName: string;
39260
38825
 
39261
38826
  /**
39262
- * The the `MetadataClassProperty` that is described by this
39263
- structure, as obtained from the `MetadataSchema`
38827
+ * The optional ID of the metadata schema
39264
38828
  */
39265
38829
  export var classProperty: MetadataClassProperty;
39266
38830
 
39267
- /**
39268
- * The `PropertyTextureProperty` or `PropertyAttributeProperty` that
39269
- is described by this structure, as obtained from the property texture
39270
- or property attribute of the `StructuralMetadata` that matches the
39271
- class name and property name.
39272
- */
39273
- export var metadataProperty: any;
39274
-
39275
38831
  /**
39276
38832
  * Compute the rectangle that describes the part of the drawing buffer
39277
38833
  that is relevant for picking.
@@ -40265,20 +39821,32 @@ export class PostProcessStageCollection {
40265
39821
  surface receives light and regardless of the light's position.
40266
39822
  </p>
40267
39823
  <p>
40268
- The uniforms have the following properties:
39824
+ The uniforms have the following properties: <code>intensity</code>, <code>bias</code>, <code>lengthCap</code>,
39825
+ <code>stepSize</code>, <code>frustumLength</code>, <code>ambientOcclusionOnly</code>,
39826
+ <code>delta</code>, <code>sigma</code>, and <code>blurStepSize</code>.
39827
+ </p>
40269
39828
  <ul>
40270
39829
  <li><code>intensity</code> is a scalar value used to lighten or darken the shadows exponentially. Higher values make the shadows darker. The default value is <code>3.0</code>.</li>
39830
+
40271
39831
  <li><code>bias</code> is a scalar value representing an angle in radians. If the dot product between the normal of the sample and the vector to the camera is less than this value,
40272
39832
  sampling stops in the current direction. This is used to remove shadows from near planar edges. The default value is <code>0.1</code>.</li>
39833
+
40273
39834
  <li><code>lengthCap</code> is a scalar value representing a length in meters. If the distance from the current sample to first sample is greater than this value,
40274
39835
  sampling stops in the current direction. The default value is <code>0.26</code>.</li>
40275
- <li><code>directionCount</code> is the number of directions along which the ray marching will search for occluders. The default value is <code>8</code>.</li>
40276
- <li><code>stepCount</code> is the number of steps the ray marching will take along each direction. The default value is <code>32</code>.</li>
40277
- <li><code>randomTexture</code> is a texture where the red channel is a random value in [0.0, 1.0]. The default value is <code>undefined</code>. This texture needs to be set.</li>
39836
+
39837
+ <li><code>stepSize</code> is a scalar value indicating the distance to the next texel sample in the current direction. The default value is <code>1.95</code>.</li>
39838
+
39839
+ <li><code>frustumLength</code> is a scalar value in meters. If the current fragment has a distance from the camera greater than this value, ambient occlusion is not computed for the fragment.
39840
+ The default value is <code>1000.0</code>.</li>
39841
+
40278
39842
  <li><code>ambientOcclusionOnly</code> is a boolean value. When <code>true</code>, only the shadows generated are written to the output. When <code>false</code>, the input texture is modulated
40279
39843
  with the ambient occlusion. This is a useful debug option for seeing the effects of changing the uniform values. The default value is <code>false</code>.</li>
40280
39844
  </ul>
40281
39845
  <p>
39846
+ <code>delta</code>, <code>sigma</code>, and <code>blurStepSize</code> are the same properties as {@link PostProcessStageLibrary#createBlurStage}.
39847
+ The blur is applied to the shadows generated from the image to make them smoother.
39848
+ </p>
39849
+ <p>
40282
39850
  When enabled, this stage will execute before all others.
40283
39851
  </p>
40284
39852
  */
@@ -40675,88 +40243,88 @@ export enum PostProcessStageSampleMode {
40675
40243
 
40676
40244
  /**
40677
40245
  * A primitive represents geometry in the {@link Scene}. The geometry can be from a single {@link GeometryInstance}
40678
- * as shown in example 1 below, or from an array of instances, even if the geometry is from different
40679
- * geometry types, e.g., an {@link RectangleGeometry} and an {@link EllipsoidGeometry} as shown in Code Example 2.
40680
- * <p>
40681
- * A primitive combines geometry instances with an {@link Appearance} that describes the full shading, including
40682
- * {@link Material} and {@link RenderState}. Roughly, the geometry instance defines the structure and placement,
40683
- * and the appearance defines the visual characteristics. Decoupling geometry and appearance allows us to mix
40684
- * and match most of them and add a new geometry or appearance independently of each other.
40685
- * </p>
40686
- * <p>
40687
- * Combining multiple instances into one primitive is called batching, and significantly improves performance for static data.
40688
- * Instances can be individually picked; {@link Scene#pick} returns their {@link GeometryInstance#id}. Using
40689
- * per-instance appearances like {@link PerInstanceColorAppearance}, each instance can also have a unique color.
40690
- * </p>
40691
- * <p>
40692
- * {@link Geometry} can either be created and batched on a web worker or the main thread. The first two examples
40693
- * show geometry that will be created on a web worker by using the descriptions of the geometry. The third example
40694
- * shows how to create the geometry on the main thread by explicitly calling the <code>createGeometry</code> method.
40695
- * </p>
40246
+ as shown in example 1 below, or from an array of instances, even if the geometry is from different
40247
+ geometry types, e.g., an {@link RectangleGeometry} and an {@link EllipsoidGeometry} as shown in Code Example 2.
40248
+ <p>
40249
+ A primitive combines geometry instances with an {@link Appearance} that describes the full shading, including
40250
+ {@link Material} and {@link RenderState}. Roughly, the geometry instance defines the structure and placement,
40251
+ and the appearance defines the visual characteristics. Decoupling geometry and appearance allows us to mix
40252
+ and match most of them and add a new geometry or appearance independently of each other.
40253
+ </p>
40254
+ <p>
40255
+ Combining multiple instances into one primitive is called batching, and significantly improves performance for static data.
40256
+ Instances can be individually picked; {@link Scene#pick} returns their {@link GeometryInstance#id}. Using
40257
+ per-instance appearances like {@link PerInstanceColorAppearance}, each instance can also have a unique color.
40258
+ </p>
40259
+ <p>
40260
+ {@link Geometry} can either be created and batched on a web worker or the main thread. The first two examples
40261
+ show geometry that will be created on a web worker by using the descriptions of the geometry. The third example
40262
+ shows how to create the geometry on the main thread by explicitly calling the <code>createGeometry</code> method.
40263
+ </p>
40696
40264
  * @example
40697
40265
  * // 1. Draw a translucent ellipse on the surface with a checkerboard pattern
40698
- * const instance = new Cesium.GeometryInstance({
40699
- * geometry : new Cesium.EllipseGeometry({
40700
- * center : Cesium.Cartesian3.fromDegrees(-100.0, 20.0),
40701
- * semiMinorAxis : 500000.0,
40702
- * semiMajorAxis : 1000000.0,
40703
- * rotation : Cesium.Math.PI_OVER_FOUR,
40704
- * vertexFormat : Cesium.VertexFormat.POSITION_AND_ST
40705
- * }),
40706
- * id : 'object returned when this instance is picked and to get/set per-instance attributes'
40707
- * });
40708
- * scene.primitives.add(new Cesium.Primitive({
40709
- * geometryInstances : instance,
40710
- * appearance : new Cesium.EllipsoidSurfaceAppearance({
40711
- * material : Cesium.Material.fromType('Checkerboard')
40712
- * })
40713
- * }));
40266
+ const instance = new Cesium.GeometryInstance({
40267
+ geometry : new Cesium.EllipseGeometry({
40268
+ center : Cesium.Cartesian3.fromDegrees(-100.0, 20.0),
40269
+ semiMinorAxis : 500000.0,
40270
+ semiMajorAxis : 1000000.0,
40271
+ rotation : Cesium.Math.PI_OVER_FOUR,
40272
+ vertexFormat : Cesium.VertexFormat.POSITION_AND_ST
40273
+ }),
40274
+ id : 'object returned when this instance is picked and to get/set per-instance attributes'
40275
+ });
40276
+ scene.primitives.add(new Cesium.Primitive({
40277
+ geometryInstances : instance,
40278
+ appearance : new Cesium.EllipsoidSurfaceAppearance({
40279
+ material : Cesium.Material.fromType('Checkerboard')
40280
+ })
40281
+ }));
40714
40282
  * @example
40715
40283
  * // 2. Draw different instances each with a unique color
40716
- * const rectangleInstance = new Cesium.GeometryInstance({
40717
- * geometry : new Cesium.RectangleGeometry({
40718
- * rectangle : Cesium.Rectangle.fromDegrees(-140.0, 30.0, -100.0, 40.0),
40719
- * vertexFormat : Cesium.PerInstanceColorAppearance.VERTEX_FORMAT
40720
- * }),
40721
- * id : 'rectangle',
40722
- * attributes : {
40723
- * color : new Cesium.ColorGeometryInstanceAttribute(0.0, 1.0, 1.0, 0.5)
40724
- * }
40725
- * });
40726
- * const ellipsoidInstance = new Cesium.GeometryInstance({
40727
- * geometry : new Cesium.EllipsoidGeometry({
40728
- * radii : new Cesium.Cartesian3(500000.0, 500000.0, 1000000.0),
40729
- * vertexFormat : Cesium.VertexFormat.POSITION_AND_NORMAL
40730
- * }),
40731
- * modelMatrix : Cesium.Matrix4.multiplyByTranslation(Cesium.Transforms.eastNorthUpToFixedFrame(
40732
- * Cesium.Cartesian3.fromDegrees(-95.59777, 40.03883)), new Cesium.Cartesian3(0.0, 0.0, 500000.0), new Cesium.Matrix4()),
40733
- * id : 'ellipsoid',
40734
- * attributes : {
40735
- * color : Cesium.ColorGeometryInstanceAttribute.fromColor(Cesium.Color.AQUA)
40736
- * }
40737
- * });
40738
- * scene.primitives.add(new Cesium.Primitive({
40739
- * geometryInstances : [rectangleInstance, ellipsoidInstance],
40740
- * appearance : new Cesium.PerInstanceColorAppearance()
40741
- * }));
40284
+ const rectangleInstance = new Cesium.GeometryInstance({
40285
+ geometry : new Cesium.RectangleGeometry({
40286
+ rectangle : Cesium.Rectangle.fromDegrees(-140.0, 30.0, -100.0, 40.0),
40287
+ vertexFormat : Cesium.PerInstanceColorAppearance.VERTEX_FORMAT
40288
+ }),
40289
+ id : 'rectangle',
40290
+ attributes : {
40291
+ color : new Cesium.ColorGeometryInstanceAttribute(0.0, 1.0, 1.0, 0.5)
40292
+ }
40293
+ });
40294
+ const ellipsoidInstance = new Cesium.GeometryInstance({
40295
+ geometry : new Cesium.EllipsoidGeometry({
40296
+ radii : new Cesium.Cartesian3(500000.0, 500000.0, 1000000.0),
40297
+ vertexFormat : Cesium.VertexFormat.POSITION_AND_NORMAL
40298
+ }),
40299
+ modelMatrix : Cesium.Matrix4.multiplyByTranslation(Cesium.Transforms.eastNorthUpToFixedFrame(
40300
+ Cesium.Cartesian3.fromDegrees(-95.59777, 40.03883)), new Cesium.Cartesian3(0.0, 0.0, 500000.0), new Cesium.Matrix4()),
40301
+ id : 'ellipsoid',
40302
+ attributes : {
40303
+ color : Cesium.ColorGeometryInstanceAttribute.fromColor(Cesium.Color.AQUA)
40304
+ }
40305
+ });
40306
+ scene.primitives.add(new Cesium.Primitive({
40307
+ geometryInstances : [rectangleInstance, ellipsoidInstance],
40308
+ appearance : new Cesium.PerInstanceColorAppearance()
40309
+ }));
40742
40310
  * @example
40743
40311
  * // 3. Create the geometry on the main thread.
40744
- * scene.primitives.add(new Cesium.Primitive({
40745
- * geometryInstances : new Cesium.GeometryInstance({
40746
- * geometry : Cesium.EllipsoidGeometry.createGeometry(new Cesium.EllipsoidGeometry({
40747
- * radii : new Cesium.Cartesian3(500000.0, 500000.0, 1000000.0),
40748
- * vertexFormat : Cesium.VertexFormat.POSITION_AND_NORMAL
40749
- * })),
40750
- * modelMatrix : Cesium.Matrix4.multiplyByTranslation(Cesium.Transforms.eastNorthUpToFixedFrame(
40751
- * Cesium.Cartesian3.fromDegrees(-95.59777, 40.03883)), new Cesium.Cartesian3(0.0, 0.0, 500000.0), new Cesium.Matrix4()),
40752
- * id : 'ellipsoid',
40753
- * attributes : {
40754
- * color : Cesium.ColorGeometryInstanceAttribute.fromColor(Cesium.Color.AQUA)
40755
- * }
40756
- * }),
40757
- * appearance : new Cesium.PerInstanceColorAppearance(),
40758
- * asynchronous : false
40759
- * }));
40312
+ scene.primitives.add(new Cesium.Primitive({
40313
+ geometryInstances : new Cesium.GeometryInstance({
40314
+ geometry : Cesium.EllipsoidGeometry.createGeometry(new Cesium.EllipsoidGeometry({
40315
+ radii : new Cesium.Cartesian3(500000.0, 500000.0, 1000000.0),
40316
+ vertexFormat : Cesium.VertexFormat.POSITION_AND_NORMAL
40317
+ })),
40318
+ modelMatrix : Cesium.Matrix4.multiplyByTranslation(Cesium.Transforms.eastNorthUpToFixedFrame(
40319
+ Cesium.Cartesian3.fromDegrees(-95.59777, 40.03883)), new Cesium.Cartesian3(0.0, 0.0, 500000.0), new Cesium.Matrix4()),
40320
+ id : 'ellipsoid',
40321
+ attributes : {
40322
+ color : Cesium.ColorGeometryInstanceAttribute.fromColor(Cesium.Color.AQUA)
40323
+ }
40324
+ }),
40325
+ appearance : new Cesium.PerInstanceColorAppearance(),
40326
+ asynchronous : false
40327
+ }));
40760
40328
  * @param [options] - Object with the following properties:
40761
40329
  * @param [options.geometryInstances] - The geometry instances - or a single geometry instance - to render.
40762
40330
  * @param [options.appearance] - The appearance used to render the primitive.
@@ -40792,67 +40360,67 @@ export class Primitive {
40792
40360
  });
40793
40361
  /**
40794
40362
  * The geometry instances rendered with this primitive. This may
40795
- * be <code>undefined</code> if <code>options.releaseGeometryInstances</code>
40796
- * is <code>true</code> when the primitive is constructed.
40797
- * <p>
40798
- * Changing this property after the primitive is rendered has no effect.
40799
- * </p>
40363
+ be <code>undefined</code> if <code>options.releaseGeometryInstances</code>
40364
+ is <code>true</code> when the primitive is constructed.
40365
+ <p>
40366
+ Changing this property after the primitive is rendered has no effect.
40367
+ </p>
40800
40368
  */
40801
40369
  readonly geometryInstances: GeometryInstance[] | GeometryInstance;
40802
40370
  /**
40803
40371
  * The {@link Appearance} used to shade this primitive. Each geometry
40804
- * instance is shaded with the same appearance. Some appearances, like
40805
- * {@link PerInstanceColorAppearance} allow giving each instance unique
40806
- * properties.
40372
+ instance is shaded with the same appearance. Some appearances, like
40373
+ {@link PerInstanceColorAppearance} allow giving each instance unique
40374
+ properties.
40807
40375
  */
40808
40376
  appearance: Appearance;
40809
40377
  /**
40810
40378
  * The {@link Appearance} used to shade this primitive when it fails the depth test. Each geometry
40811
- * instance is shaded with the same appearance. Some appearances, like
40812
- * {@link PerInstanceColorAppearance} allow giving each instance unique
40813
- * properties.
40814
- *
40815
- * <p>
40816
- * When using an appearance that requires a color attribute, like PerInstanceColorAppearance,
40817
- * add a depthFailColor per-instance attribute instead.
40818
- * </p>
40819
- *
40820
- * <p>
40821
- * Requires the EXT_frag_depth WebGL extension to render properly. If the extension is not supported,
40822
- * there may be artifacts.
40823
- * </p>
40379
+ instance is shaded with the same appearance. Some appearances, like
40380
+ {@link PerInstanceColorAppearance} allow giving each instance unique
40381
+ properties.
40382
+
40383
+ <p>
40384
+ When using an appearance that requires a color attribute, like PerInstanceColorAppearance,
40385
+ add a depthFailColor per-instance attribute instead.
40386
+ </p>
40387
+
40388
+ <p>
40389
+ Requires the EXT_frag_depth WebGL extension to render properly. If the extension is not supported,
40390
+ there may be artifacts.
40391
+ </p>
40824
40392
  */
40825
40393
  depthFailAppearance: Appearance;
40826
40394
  /**
40827
40395
  * The 4x4 transformation matrix that transforms the primitive (all geometry instances) from model to world coordinates.
40828
- * When this is the identity matrix, the primitive is drawn in world coordinates, i.e., Earth's WGS84 coordinates.
40829
- * Local reference frames can be used by providing a different transformation matrix, like that returned
40830
- * by {@link Transforms.eastNorthUpToFixedFrame}.
40831
- *
40832
- * <p>
40833
- * This property is only supported in 3D mode.
40834
- * </p>
40396
+ When this is the identity matrix, the primitive is drawn in world coordinates, i.e., Earth's WGS84 coordinates.
40397
+ Local reference frames can be used by providing a different transformation matrix, like that returned
40398
+ by {@link Transforms.eastNorthUpToFixedFrame}.
40399
+
40400
+ <p>
40401
+ This property is only supported in 3D mode.
40402
+ </p>
40835
40403
  * @example
40836
40404
  * const origin = Cesium.Cartesian3.fromDegrees(-95.0, 40.0, 200000.0);
40837
- * p.modelMatrix = Cesium.Transforms.eastNorthUpToFixedFrame(origin);
40405
+ p.modelMatrix = Cesium.Transforms.eastNorthUpToFixedFrame(origin);
40838
40406
  */
40839
40407
  modelMatrix: Matrix4;
40840
40408
  /**
40841
40409
  * Determines if the primitive will be shown. This affects all geometry
40842
- * instances in the primitive.
40410
+ instances in the primitive.
40843
40411
  */
40844
40412
  show: boolean;
40845
40413
  /**
40846
40414
  * When <code>true</code>, the renderer frustum culls and horizon culls the primitive's commands
40847
- * based on their bounding volume. Set this to <code>false</code> for a small performance gain
40848
- * if you are manually culling the primitive.
40415
+ based on their bounding volume. Set this to <code>false</code> for a small performance gain
40416
+ if you are manually culling the primitive.
40849
40417
  */
40850
40418
  cull: boolean;
40851
40419
  /**
40852
40420
  * This property is for debugging only; it is not for production use nor is it optimized.
40853
- * <p>
40854
- * Draws the bounding sphere for each draw command in the primitive.
40855
- * </p>
40421
+ <p>
40422
+ Draws the bounding sphere for each draw command in the primitive.
40423
+ </p>
40856
40424
  */
40857
40425
  debugShowBoundingVolume: boolean;
40858
40426
  /**
@@ -40885,60 +40453,60 @@ export class Primitive {
40885
40453
  readonly compressVertices: boolean;
40886
40454
  /**
40887
40455
  * Determines if the primitive is complete and ready to render. If this property is
40888
- * true, the primitive will be rendered the next time that {@link Primitive#update}
40889
- * is called.
40456
+ true, the primitive will be rendered the next time that {@link Primitive#update}
40457
+ is called.
40890
40458
  * @example
40891
40459
  * // Wait for a primitive to become ready before accessing attributes
40892
- * const removeListener = scene.postRender.addEventListener(() => {
40893
- * if (!frustumPrimitive.ready) {
40894
- * return;
40895
- * }
40896
- *
40897
- * const attributes = primitive.getGeometryInstanceAttributes('an id');
40898
- * attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA);
40899
- *
40900
- * removeListener();
40901
- * });
40460
+ const removeListener = scene.postRender.addEventListener(() => {
40461
+ if (!frustumPrimitive.ready) {
40462
+ return;
40463
+ }
40464
+
40465
+ const attributes = primitive.getGeometryInstanceAttributes('an id');
40466
+ attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA);
40467
+
40468
+ removeListener();
40469
+ });
40902
40470
  */
40903
40471
  readonly ready: boolean;
40904
40472
  /**
40905
40473
  * Called when {@link Viewer} or {@link CesiumWidget} render the scene to
40906
- * get the draw commands needed to render this primitive.
40907
- * <p>
40908
- * Do not call this function directly. This is documented just to
40909
- * list the exceptions that may be propagated when the scene is rendered:
40910
- * </p>
40474
+ get the draw commands needed to render this primitive.
40475
+ <p>
40476
+ Do not call this function directly. This is documented just to
40477
+ list the exceptions that may be propagated when the scene is rendered:
40478
+ </p>
40911
40479
  */
40912
40480
  update(): void;
40913
40481
  /**
40914
40482
  * Returns the modifiable per-instance attributes for a {@link GeometryInstance}.
40915
40483
  * @example
40916
40484
  * const attributes = primitive.getGeometryInstanceAttributes('an id');
40917
- * attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA);
40918
- * attributes.show = Cesium.ShowGeometryInstanceAttribute.toValue(true);
40919
- * attributes.distanceDisplayCondition = Cesium.DistanceDisplayConditionGeometryInstanceAttribute.toValue(100.0, 10000.0);
40920
- * attributes.offset = Cesium.OffsetGeometryInstanceAttribute.toValue(Cartesian3.IDENTITY);
40485
+ attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA);
40486
+ attributes.show = Cesium.ShowGeometryInstanceAttribute.toValue(true);
40487
+ attributes.distanceDisplayCondition = Cesium.DistanceDisplayConditionGeometryInstanceAttribute.toValue(100.0, 10000.0);
40488
+ attributes.offset = Cesium.OffsetGeometryInstanceAttribute.toValue(Cartesian3.IDENTITY);
40921
40489
  * @param id - The id of the {@link GeometryInstance}.
40922
40490
  * @returns The typed array in the attribute's format or undefined if the is no instance with id.
40923
40491
  */
40924
40492
  getGeometryInstanceAttributes(id: any): any;
40925
40493
  /**
40926
40494
  * Returns true if this object was destroyed; otherwise, false.
40927
- * <p>
40928
- * If this object was destroyed, it should not be used; calling any function other than
40929
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
40930
- * </p>
40495
+ <p>
40496
+ If this object was destroyed, it should not be used; calling any function other than
40497
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
40498
+ </p>
40931
40499
  * @returns <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
40932
40500
  */
40933
40501
  isDestroyed(): boolean;
40934
40502
  /**
40935
40503
  * Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
40936
- * release of WebGL resources, instead of relying on the garbage collector to destroy this object.
40937
- * <p>
40938
- * Once an object is destroyed, it should not be used; calling any function other than
40939
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
40940
- * assign the return value (<code>undefined</code>) to the object as done in the example.
40941
- * </p>
40504
+ release of WebGL resources, instead of relying on the garbage collector to destroy this object.
40505
+ <p>
40506
+ Once an object is destroyed, it should not be used; calling any function other than
40507
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
40508
+ assign the return value (<code>undefined</code>) to the object as done in the example.
40509
+ </p>
40942
40510
  * @example
40943
40511
  * e = e && e.destroy();
40944
40512
  */
@@ -41101,15 +40669,15 @@ export class PrimitiveCollection {
41101
40669
 
41102
40670
  /**
41103
40671
  * The container for all 3D graphical objects and state in a Cesium virtual scene. Generally,
41104
- * a scene is not created directly; instead, it is implicitly created by {@link CesiumWidget}.
40672
+ a scene is not created directly; instead, it is implicitly created by {@link CesiumWidget}.
41105
40673
  * @example
41106
40674
  * // Create scene without anisotropic texture filtering
41107
- * const scene = new Cesium.Scene({
41108
- * canvas : canvas,
41109
- * contextOptions : {
41110
- * allowTextureFilterAnisotropic : false
41111
- * }
41112
- * });
40675
+ const scene = new Cesium.Scene({
40676
+ canvas : canvas,
40677
+ contextOptions : {
40678
+ allowTextureFilterAnisotropic : false
40679
+ }
40680
+ });
41113
40681
  * @param options - Object with the following properties:
41114
40682
  * @param options.canvas - The HTML canvas element to create the scene for.
41115
40683
  * @param [options.contextOptions] - Context and WebGL creation properties.
@@ -41145,14 +40713,14 @@ export class Scene {
41145
40713
  });
41146
40714
  /**
41147
40715
  * Exceptions occurring in <code>render</code> are always caught in order to raise the
41148
- * <code>renderError</code> event. If this property is true, the error is rethrown
41149
- * after the event is raised. If this property is false, the <code>render</code> function
41150
- * returns normally after raising the event.
40716
+ <code>renderError</code> event. If this property is true, the error is rethrown
40717
+ after the event is raised. If this property is false, the <code>render</code> function
40718
+ returns normally after raising the event.
41151
40719
  */
41152
40720
  rethrowRenderErrors: boolean;
41153
40721
  /**
41154
40722
  * Determines whether or not to instantly complete the
41155
- * scene transition animation on user input.
40723
+ scene transition animation on user input.
41156
40724
  */
41157
40725
  completeMorphOnUserInput: boolean;
41158
40726
  /**
@@ -41189,106 +40757,106 @@ export class Scene {
41189
40757
  backgroundColor: Color;
41190
40758
  /**
41191
40759
  * The current morph transition time between 2D/Columbus View and 3D,
41192
- * with 0.0 being 2D or Columbus View and 1.0 being 3D.
40760
+ with 0.0 being 2D or Columbus View and 1.0 being 3D.
41193
40761
  */
41194
40762
  morphTime: number;
41195
40763
  /**
41196
40764
  * The far-to-near ratio of the multi-frustum when using a normal depth buffer.
41197
- * <p>
41198
- * This value is used to create the near and far values for each frustum of the multi-frustum. It is only used
41199
- * when {@link Scene#logarithmicDepthBuffer} is <code>false</code>. When <code>logarithmicDepthBuffer</code> is
41200
- * <code>true</code>, use {@link Scene#logarithmicDepthFarToNearRatio}.
41201
- * </p>
40765
+ <p>
40766
+ This value is used to create the near and far values for each frustum of the multi-frustum. It is only used
40767
+ when {@link Scene#logarithmicDepthBuffer} is <code>false</code>. When <code>logarithmicDepthBuffer</code> is
40768
+ <code>true</code>, use {@link Scene#logarithmicDepthFarToNearRatio}.
40769
+ </p>
41202
40770
  */
41203
40771
  farToNearRatio: number;
41204
40772
  /**
41205
40773
  * The far-to-near ratio of the multi-frustum when using a logarithmic depth buffer.
41206
- * <p>
41207
- * This value is used to create the near and far values for each frustum of the multi-frustum. It is only used
41208
- * when {@link Scene#logarithmicDepthBuffer} is <code>true</code>. When <code>logarithmicDepthBuffer</code> is
41209
- * <code>false</code>, use {@link Scene#farToNearRatio}.
41210
- * </p>
40774
+ <p>
40775
+ This value is used to create the near and far values for each frustum of the multi-frustum. It is only used
40776
+ when {@link Scene#logarithmicDepthBuffer} is <code>true</code>. When <code>logarithmicDepthBuffer</code> is
40777
+ <code>false</code>, use {@link Scene#farToNearRatio}.
40778
+ </p>
41211
40779
  */
41212
40780
  logarithmicDepthFarToNearRatio: number;
41213
40781
  /**
41214
40782
  * Determines the uniform depth size in meters of each frustum of the multifrustum in 2D. If a primitive or model close
41215
- * to the surface shows z-fighting, decreasing this will eliminate the artifact, but decrease performance. On the
41216
- * other hand, increasing this will increase performance but may cause z-fighting among primitives close to the surface.
40783
+ to the surface shows z-fighting, decreasing this will eliminate the artifact, but decrease performance. On the
40784
+ other hand, increasing this will increase performance but may cause z-fighting among primitives close to the surface.
41217
40785
  */
41218
40786
  nearToFarDistance2D: number;
41219
40787
  /**
41220
40788
  * The vertical exaggeration of the scene.
41221
- * When set to 1.0, no exaggeration is applied.
40789
+ When set to 1.0, no exaggeration is applied.
41222
40790
  */
41223
40791
  verticalExaggeration: number;
41224
40792
  /**
41225
40793
  * The reference height for vertical exaggeration of the scene.
41226
- * When set to 0.0, the exaggeration is applied relative to the ellipsoid surface.
40794
+ When set to 0.0, the exaggeration is applied relative to the ellipsoid surface.
41227
40795
  */
41228
40796
  verticalExaggerationRelativeHeight: number;
41229
40797
  /**
41230
40798
  * This property is for debugging only; it is not for production use.
41231
- * <p>
41232
- * A function that determines what commands are executed. As shown in the examples below,
41233
- * the function receives the command's <code>owner</code> as an argument, and returns a boolean indicating if the
41234
- * command should be executed.
41235
- * </p>
41236
- * <p>
41237
- * The default is <code>undefined</code>, indicating that all commands are executed.
41238
- * </p>
40799
+ <p>
40800
+ A function that determines what commands are executed. As shown in the examples below,
40801
+ the function receives the command's <code>owner</code> as an argument, and returns a boolean indicating if the
40802
+ command should be executed.
40803
+ </p>
40804
+ <p>
40805
+ The default is <code>undefined</code>, indicating that all commands are executed.
40806
+ </p>
41239
40807
  * @example
41240
40808
  * // Do not execute any commands.
41241
- * scene.debugCommandFilter = function(command) {
41242
- * return false;
41243
- * };
41244
- *
41245
- * // Execute only the billboard's commands. That is, only draw the billboard.
41246
- * const billboards = new Cesium.BillboardCollection();
41247
- * scene.debugCommandFilter = function(command) {
41248
- * return command.owner === billboards;
41249
- * };
40809
+ scene.debugCommandFilter = function(command) {
40810
+ return false;
40811
+ };
40812
+
40813
+ // Execute only the billboard's commands. That is, only draw the billboard.
40814
+ const billboards = new Cesium.BillboardCollection();
40815
+ scene.debugCommandFilter = function(command) {
40816
+ return command.owner === billboards;
40817
+ };
41250
40818
  */
41251
40819
  debugCommandFilter: (...params: any[]) => any;
41252
40820
  /**
41253
40821
  * This property is for debugging only; it is not for production use.
41254
- * <p>
41255
- * When <code>true</code>, commands are randomly shaded. This is useful
41256
- * for performance analysis to see what parts of a scene or model are
41257
- * command-dense and could benefit from batching.
41258
- * </p>
40822
+ <p>
40823
+ When <code>true</code>, commands are randomly shaded. This is useful
40824
+ for performance analysis to see what parts of a scene or model are
40825
+ command-dense and could benefit from batching.
40826
+ </p>
41259
40827
  */
41260
40828
  debugShowCommands: boolean;
41261
40829
  /**
41262
40830
  * This property is for debugging only; it is not for production use.
41263
- * <p>
41264
- * When <code>true</code>, commands are shaded based on the frustums they
41265
- * overlap. Commands in the closest frustum are tinted red, commands in
41266
- * the next closest are green, and commands in the farthest frustum are
41267
- * blue. If a command overlaps more than one frustum, the color components
41268
- * are combined, e.g., a command overlapping the first two frustums is tinted
41269
- * yellow.
41270
- * </p>
40831
+ <p>
40832
+ When <code>true</code>, commands are shaded based on the frustums they
40833
+ overlap. Commands in the closest frustum are tinted red, commands in
40834
+ the next closest are green, and commands in the farthest frustum are
40835
+ blue. If a command overlaps more than one frustum, the color components
40836
+ are combined, e.g., a command overlapping the first two frustums is tinted
40837
+ yellow.
40838
+ </p>
41271
40839
  */
41272
40840
  debugShowFrustums: boolean;
41273
40841
  /**
41274
40842
  * This property is for debugging only; it is not for production use.
41275
- * <p>
41276
- * Displays frames per second and time between frames.
41277
- * </p>
40843
+ <p>
40844
+ Displays frames per second and time between frames.
40845
+ </p>
41278
40846
  */
41279
40847
  debugShowFramesPerSecond: boolean;
41280
40848
  /**
41281
40849
  * This property is for debugging only; it is not for production use.
41282
- * <p>
41283
- * Indicates which frustum will have depth information displayed.
41284
- * </p>
40850
+ <p>
40851
+ Indicates which frustum will have depth information displayed.
40852
+ </p>
41285
40853
  */
41286
40854
  debugShowDepthFrustum: number;
41287
40855
  /**
41288
40856
  * This property is for debugging only; it is not for production use.
41289
- * <p>
41290
- * When <code>true</code>, draws outlines to show the boundaries of the camera frustums
41291
- * </p>
40857
+ <p>
40858
+ When <code>true</code>, draws outlines to show the boundaries of the camera frustums
40859
+ </p>
41292
40860
  */
41293
40861
  debugShowFrustumPlanes: boolean;
41294
40862
  /**
@@ -41297,33 +40865,33 @@ export class Scene {
41297
40865
  useDepthPicking: boolean;
41298
40866
  /**
41299
40867
  * When <code>true</code>, enables picking translucent geometry using the depth buffer. Note that {@link Scene#useDepthPicking} must also be true for enabling this to work.
41300
- *
41301
- * <p>
41302
- * There is a decrease in performance when enabled. There are extra draw calls to write depth for
41303
- * translucent geometry.
41304
- * </p>
40868
+
40869
+ <p>
40870
+ There is a decrease in performance when enabled. There are extra draw calls to write depth for
40871
+ translucent geometry.
40872
+ </p>
41305
40873
  * @example
41306
40874
  * // picking the position of a translucent primitive
41307
- * viewer.screenSpaceEventHandler.setInputAction(function onLeftClick(movement) {
41308
- * const pickedFeature = viewer.scene.pick(movement.position);
41309
- * if (!Cesium.defined(pickedFeature)) {
41310
- * // nothing picked
41311
- * return;
41312
- * }
41313
- * const worldPosition = viewer.scene.pickPosition(movement.position);
41314
- * }, Cesium.ScreenSpaceEventType.LEFT_CLICK);
40875
+ viewer.screenSpaceEventHandler.setInputAction(function onLeftClick(movement) {
40876
+ const pickedFeature = viewer.scene.pick(movement.position);
40877
+ if (!Cesium.defined(pickedFeature)) {
40878
+ // nothing picked
40879
+ return;
40880
+ }
40881
+ const worldPosition = viewer.scene.pickPosition(movement.position);
40882
+ }, Cesium.ScreenSpaceEventType.LEFT_CLICK);
41315
40883
  */
41316
40884
  pickTranslucentDepth: boolean;
41317
40885
  /**
41318
40886
  * Settings for atmosphere lighting effects affecting 3D Tiles and model rendering. This is not to be confused with
41319
- * {@link Scene#skyAtmosphere} which is responsible for rendering the sky.
40887
+ {@link Scene#skyAtmosphere} which is responsible for rendering the sky.
41320
40888
  */
41321
40889
  atmosphere: Atmosphere;
41322
40890
  /**
41323
40891
  * Blends the atmosphere to geometry far from the camera for horizon views. Allows for additional
41324
- * performance improvements by rendering less geometry and dispatching less terrain requests.
41325
- *
41326
- * Disbaled by default if an ellipsoid other than WGS84 is used.
40892
+ performance improvements by rendering less geometry and dispatching less terrain requests.
40893
+
40894
+ Disbaled by default if an ellipsoid other than WGS84 is used.
41327
40895
  */
41328
40896
  fog: Fog;
41329
40897
  /**
@@ -41332,13 +40900,13 @@ export class Scene {
41332
40900
  shadowMap: ShadowMap;
41333
40901
  /**
41334
40902
  * When <code>false</code>, 3D Tiles will render normally. When <code>true</code>, classified 3D Tile geometry will render normally and
41335
- * unclassified 3D Tile geometry will render with the color multiplied by {@link Scene#invertClassificationColor}.
40903
+ unclassified 3D Tile geometry will render with the color multiplied by {@link Scene#invertClassificationColor}.
41336
40904
  */
41337
40905
  invertClassification: boolean;
41338
40906
  /**
41339
40907
  * The highlight color of unclassified 3D Tile geometry when {@link Scene#invertClassification} is <code>true</code>.
41340
- * <p>When the color's alpha is less than 1.0, the unclassified portions of the 3D Tiles will not blend correctly with the classified positions of the 3D Tiles.</p>
41341
- * <p>Also, when the color's alpha is less than 1.0, the WEBGL_depth_texture and EXT_frag_depth WebGL extensions must be supported.</p>
40908
+ <p>When the color's alpha is less than 1.0, the unclassified portions of the 3D Tiles will not blend correctly with the classified positions of the 3D Tiles.</p>
40909
+ <p>Also, when the color's alpha is less than 1.0, the WEBGL_depth_texture and EXT_frag_depth WebGL extensions must be supported.</p>
41342
40910
  */
41343
40911
  invertClassificationColor: Color;
41344
40912
  /**
@@ -41355,18 +40923,18 @@ export class Scene {
41355
40923
  postProcessStages: PostProcessStageCollection;
41356
40924
  /**
41357
40925
  * When <code>true</code>, rendering a frame will only occur when needed as determined by changes within the scene.
41358
- * Enabling improves performance of the application, but requires using {@link Scene#requestRender}
41359
- * to render a new frame explicitly in this mode. This will be necessary in many cases after making changes
41360
- * to the scene in other parts of the API.
40926
+ Enabling improves performance of the application, but requires using {@link Scene#requestRender}
40927
+ to render a new frame explicitly in this mode. This will be necessary in many cases after making changes
40928
+ to the scene in other parts of the API.
41361
40929
  */
41362
40930
  requestRenderMode: boolean;
41363
40931
  /**
41364
40932
  * If {@link Scene#requestRenderMode} is <code>true</code>, this value defines the maximum change in
41365
- * simulation time allowed before a render is requested. Lower values increase the number of frames rendered
41366
- * and higher values decrease the number of frames rendered. If <code>undefined</code>, changes to
41367
- * the simulation time will never request a render.
41368
- * This value impacts the rate of rendering for changes in the scene like lighting, entity property updates,
41369
- * and animations.
40933
+ simulation time allowed before a render is requested. Lower values increase the number of frames rendered
40934
+ and higher values decrease the number of frames rendered. If <code>undefined</code>, changes to
40935
+ the simulation time will never request a render.
40936
+ This value impacts the rate of rendering for changes in the scene like lighting, entity property updates,
40937
+ and animations.
41370
40938
  */
41371
40939
  maximumRenderTimeChange: number;
41372
40940
  /**
@@ -41383,7 +40951,7 @@ export class Scene {
41383
40951
  light: Light;
41384
40952
  /**
41385
40953
  * Use this to set the default value for {@link Scene#logarithmicDepthBuffer} in newly constructed Scenes
41386
- * This property relies on fragmentDepth being supported.
40954
+ This property relies on fragmentDepth being supported.
41387
40955
  */
41388
40956
  static defaultLogDepthBuffer: any;
41389
40957
  /**
@@ -41468,48 +41036,48 @@ export class Scene {
41468
41036
  readonly terrainProviderChanged: Event;
41469
41037
  /**
41470
41038
  * Gets the event that will be raised before the scene is updated or rendered. Subscribers to the event
41471
- * receive the Scene instance as the first parameter and the current time as the second parameter.
41039
+ receive the Scene instance as the first parameter and the current time as the second parameter.
41472
41040
  */
41473
41041
  readonly preUpdate: Event;
41474
41042
  /**
41475
41043
  * Gets the event that will be raised immediately after the scene is updated and before the scene is rendered.
41476
- * Subscribers to the event receive the Scene instance as the first parameter and the current time as the second
41477
- * parameter.
41044
+ Subscribers to the event receive the Scene instance as the first parameter and the current time as the second
41045
+ parameter.
41478
41046
  */
41479
41047
  readonly postUpdate: Event;
41480
41048
  /**
41481
41049
  * Gets the event that will be raised when an error is thrown inside the <code>render</code> function.
41482
- * The Scene instance and the thrown error are the only two parameters passed to the event handler.
41483
- * By default, errors are not rethrown after this event is raised, but that can be changed by setting
41484
- * the <code>rethrowRenderErrors</code> property.
41050
+ The Scene instance and the thrown error are the only two parameters passed to the event handler.
41051
+ By default, errors are not rethrown after this event is raised, but that can be changed by setting
41052
+ the <code>rethrowRenderErrors</code> property.
41485
41053
  */
41486
41054
  readonly renderError: Event;
41487
41055
  /**
41488
41056
  * Gets the event that will be raised after the scene is updated and immediately before the scene is rendered.
41489
- * Subscribers to the event receive the Scene instance as the first parameter and the current time as the second
41490
- * parameter.
41057
+ Subscribers to the event receive the Scene instance as the first parameter and the current time as the second
41058
+ parameter.
41491
41059
  */
41492
41060
  readonly preRender: Event;
41493
41061
  /**
41494
41062
  * Gets the event that will be raised immediately after the scene is rendered. Subscribers to the event
41495
- * receive the Scene instance as the first parameter and the current time as the second parameter.
41063
+ receive the Scene instance as the first parameter and the current time as the second parameter.
41496
41064
  */
41497
41065
  readonly postRender: Event;
41498
41066
  /**
41499
41067
  * Gets the simulation time when the scene was last rendered. Returns undefined if the scene has not yet been
41500
- * rendered.
41068
+ rendered.
41501
41069
  */
41502
41070
  readonly lastRenderTime: JulianDate;
41503
41071
  /**
41504
41072
  * This property is for debugging only; it is not for production use.
41505
- * <p>
41506
- * When {@link Scene.debugShowFrustums} is <code>true</code>, this contains
41507
- * properties with statistics about the number of command execute per frustum.
41508
- * <code>totalCommands</code> is the total number of commands executed, ignoring
41509
- * overlap. <code>commandsInFrustums</code> is an array with the number of times
41510
- * commands are executed redundantly, e.g., how many commands overlap two or
41511
- * three frustums.
41512
- * </p>
41073
+ <p>
41074
+ When {@link Scene.debugShowFrustums} is <code>true</code>, this contains
41075
+ properties with statistics about the number of command execute per frustum.
41076
+ <code>totalCommands</code> is the total number of commands executed, ignoring
41077
+ overlap. <code>commandsInFrustums</code> is an array with the number of times
41078
+ commands are executed redundantly, e.g., how many commands overlap two or
41079
+ three frustums.
41080
+ </p>
41513
41081
  */
41514
41082
  readonly debugFrustumStatistics: any;
41515
41083
  /**
@@ -41518,8 +41086,8 @@ export class Scene {
41518
41086
  readonly scene3DOnly: boolean;
41519
41087
  /**
41520
41088
  * Gets whether or not the scene has order independent translucency enabled.
41521
- * Note that this only reflects the original construction option, and there are
41522
- * other factors that could prevent OIT from functioning on a given system configuration.
41089
+ Note that this only reflects the original construction option, and there are
41090
+ other factors that could prevent OIT from functioning on a given system configuration.
41523
41091
  */
41524
41092
  readonly orderIndependentTranslucency: boolean;
41525
41093
  /**
@@ -41532,7 +41100,7 @@ export class Scene {
41532
41100
  mode: SceneMode;
41533
41101
  /**
41534
41102
  * When <code>true</code>, splits the scene into two viewports with steroscopic views for the left and right eyes.
41535
- * Used for cardboard and WebVR.
41103
+ Used for cardboard and WebVR.
41536
41104
  */
41537
41105
  useWebVR: boolean;
41538
41106
  /**
@@ -41545,14 +41113,14 @@ export class Scene {
41545
41113
  splitPosition: number;
41546
41114
  /**
41547
41115
  * The distance from the camera at which to disable the depth test of billboards, labels and points
41548
- * to, for example, prevent clipping against terrain. When set to zero, the depth test should always
41549
- * be applied. When less than zero, the depth test should never be applied. Setting the disableDepthTestDistance
41550
- * property of a billboard, label or point will override this value.
41116
+ to, for example, prevent clipping against terrain. When set to zero, the depth test should always
41117
+ be applied. When less than zero, the depth test should never be applied. Setting the disableDepthTestDistance
41118
+ property of a billboard, label or point will override this value.
41551
41119
  */
41552
41120
  minimumDisableDepthTestDistance: number;
41553
41121
  /**
41554
41122
  * Whether or not to use a logarithmic depth buffer. Enabling this option will allow for less frustums in the multi-frustum,
41555
- * increasing performance. This property relies on fragmentDepth being supported.
41123
+ increasing performance. This property relies on fragmentDepth being supported.
41556
41124
  */
41557
41125
  logarithmicDepthBuffer: boolean;
41558
41126
  /**
@@ -41587,30 +41155,30 @@ export class Scene {
41587
41155
  getCompressedTextureFormatSupported(format: string): boolean;
41588
41156
  /**
41589
41157
  * Update and render the scene. It is usually not necessary to call this function
41590
- * directly because {@link CesiumWidget} will do it automatically.
41158
+ directly because {@link CesiumWidget} will do it automatically.
41591
41159
  * @param [time] - The simulation time at which to render.
41592
41160
  */
41593
41161
  render(time?: JulianDate): void;
41594
41162
  /**
41595
41163
  * Requests a new rendered frame when {@link Scene#requestRenderMode} is set to <code>true</code>.
41596
- * The render rate will not exceed the {@link CesiumWidget#targetFrameRate}.
41164
+ The render rate will not exceed the {@link CesiumWidget#targetFrameRate}.
41597
41165
  */
41598
41166
  requestRender(): void;
41599
41167
  /**
41600
41168
  * Returns an object with a `primitive` property that contains the first (top) primitive in the scene
41601
- * at a particular window coordinate or undefined if nothing is at the location. Other properties may
41602
- * potentially be set depending on the type of primitive and may be used to further identify the picked object.
41603
- * <p>
41604
- * When a feature of a 3D Tiles tileset is picked, <code>pick</code> returns a {@link Cesium3DTileFeature} object.
41605
- * </p>
41169
+ at a particular window coordinate or undefined if nothing is at the location. Other properties may
41170
+ potentially be set depending on the type of primitive and may be used to further identify the picked object.
41171
+ <p>
41172
+ When a feature of a 3D Tiles tileset is picked, <code>pick</code> returns a {@link Cesium3DTileFeature} object.
41173
+ </p>
41606
41174
  * @example
41607
41175
  * // On mouse over, color the feature yellow.
41608
- * handler.setInputAction(function(movement) {
41609
- * const feature = scene.pick(movement.endPosition);
41610
- * if (feature instanceof Cesium.Cesium3DTileFeature) {
41611
- * feature.color = Cesium.Color.YELLOW;
41612
- * }
41613
- * }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
41176
+ handler.setInputAction(function(movement) {
41177
+ const feature = scene.pick(movement.endPosition);
41178
+ if (feature instanceof Cesium.Cesium3DTileFeature) {
41179
+ feature.color = Cesium.Color.YELLOW;
41180
+ }
41181
+ }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
41614
41182
  * @param windowPosition - Window coordinates to perform picking on.
41615
41183
  * @param [width = 3] - Width of the pick rectangle.
41616
41184
  * @param [height = 3] - Height of the pick rectangle.
@@ -41619,15 +41187,15 @@ export class Scene {
41619
41187
  pick(windowPosition: Cartesian2, width?: number, height?: number): any;
41620
41188
  /**
41621
41189
  * Returns a {@link VoxelCell} for the voxel sample rendered at a particular window coordinate,
41622
- * or undefined if no voxel is rendered at that position.
41190
+ or undefined if no voxel is rendered at that position.
41623
41191
  * @example
41624
41192
  * On left click, report the value of the "color" property at that voxel sample.
41625
- * handler.setInputAction(function(movement) {
41626
- * const voxelCell = scene.pickVoxel(movement.position);
41627
- * if (defined(voxelCell)) {
41628
- * console.log(voxelCell.getProperty("color"));
41629
- * }
41630
- * }, Cesium.ScreenSpaceEventType.LEFT_CLICK);
41193
+ handler.setInputAction(function(movement) {
41194
+ const voxelCell = scene.pickVoxel(movement.position);
41195
+ if (defined(voxelCell)) {
41196
+ console.log(voxelCell.getProperty("color"));
41197
+ }
41198
+ }, Cesium.ScreenSpaceEventType.LEFT_CLICK);
41631
41199
  * @param windowPosition - Window coordinates to perform picking on.
41632
41200
  * @param [width = 3] - Width of the pick rectangle.
41633
41201
  * @param [height = 3] - Height of the pick rectangle.
@@ -41638,34 +41206,33 @@ export class Scene {
41638
41206
  * Pick a metadata value at the given window position.
41639
41207
  * @param windowPosition - Window coordinates to perform picking on.
41640
41208
  * @param schemaId - The ID of the metadata schema to pick values
41641
- * from. If this is `undefined`, then it will pick the values from the object
41642
- * that match the given class- and property name, regardless of the schema ID.
41209
+ from. If this is `undefined`, then it will pick the values from the object
41210
+ that match the given class- and property name, regardless of the schema ID.
41643
41211
  * @param className - The name of the metadata class to pick
41644
- * values from
41212
+ values from
41645
41213
  * @param propertyName - The name of the metadata property to pick
41646
- * values from
41647
- * @returns The metadata value, or `undefined` when
41648
- * no matching metadata was found at the given position
41214
+ values from
41215
+ * @returns The metadata value
41649
41216
  */
41650
- pickMetadata(windowPosition: Cartesian2, schemaId: string | undefined, className: string, propertyName: string): MetadataValue | undefined;
41217
+ pickMetadata(windowPosition: Cartesian2, schemaId: string | undefined, className: string, propertyName: string): any;
41651
41218
  /**
41652
41219
  * Pick the schema of the metadata of the object at the given position
41653
41220
  * @param windowPosition - Window coordinates to perform picking on.
41654
41221
  * @returns The metadata schema, or `undefined` if there is no object with
41655
- * associated metadata at the given position.
41222
+ associated metadata at the given position.
41656
41223
  */
41657
41224
  pickMetadataSchema(windowPosition: Cartesian2): MetadataSchema;
41658
41225
  /**
41659
41226
  * Returns the cartesian position reconstructed from the depth buffer and window position.
41660
- * <p>
41661
- * The position reconstructed from the depth buffer in 2D may be slightly different from those
41662
- * reconstructed in 3D and Columbus view. This is caused by the difference in the distribution
41663
- * of depth values of perspective and orthographic projection.
41664
- * </p>
41665
- * <p>
41666
- * Set {@link Scene#pickTranslucentDepth} to <code>true</code> to include the depth of
41667
- * translucent primitives; otherwise, this essentially picks through translucent primitives.
41668
- * </p>
41227
+ <p>
41228
+ The position reconstructed from the depth buffer in 2D may be slightly different from those
41229
+ reconstructed in 3D and Columbus view. This is caused by the difference in the distribution
41230
+ of depth values of perspective and orthographic projection.
41231
+ </p>
41232
+ <p>
41233
+ Set {@link Scene#pickTranslucentDepth} to <code>true</code> to include the depth of
41234
+ translucent primitives; otherwise, this essentially picks through translucent primitives.
41235
+ </p>
41669
41236
  * @param windowPosition - Window coordinates to perform picking on.
41670
41237
  * @param [result] - The object on which to restore the result.
41671
41238
  * @returns The cartesian position.
@@ -41673,9 +41240,9 @@ export class Scene {
41673
41240
  pickPosition(windowPosition: Cartesian2, result?: Cartesian3): Cartesian3;
41674
41241
  /**
41675
41242
  * Returns a list of objects, each containing a `primitive` property, for all primitives at
41676
- * a particular window coordinate position. Other properties may also be set depending on the
41677
- * type of primitive and may be used to further identify the picked object. The primitives in
41678
- * the list are ordered by their visual order in the scene (front to back).
41243
+ a particular window coordinate position. Other properties may also be set depending on the
41244
+ type of primitive and may be used to further identify the picked object. The primitives in
41245
+ the list are ordered by their visual order in the scene (front to back).
41679
41246
  * @example
41680
41247
  * const pickedObjects = scene.drillPick(new Cesium.Cartesian2(100.0, 200.0));
41681
41248
  * @param windowPosition - Window coordinates to perform picking on.
@@ -41687,16 +41254,16 @@ export class Scene {
41687
41254
  drillPick(windowPosition: Cartesian2, limit?: number, width?: number, height?: number): any[];
41688
41255
  /**
41689
41256
  * Returns the height of scene geometry at the given cartographic position or <code>undefined</code> if there was no
41690
- * scene geometry to sample height from. The height of the input position is ignored. May be used to clamp objects to
41691
- * the globe, 3D Tiles, or primitives in the scene.
41692
- * <p>
41693
- * This function only samples height from globe tiles and 3D Tiles that are rendered in the current view. Samples height
41694
- * from all other primitives regardless of their visibility.
41695
- * </p>
41257
+ scene geometry to sample height from. The height of the input position is ignored. May be used to clamp objects to
41258
+ the globe, 3D Tiles, or primitives in the scene.
41259
+ <p>
41260
+ This function only samples height from globe tiles and 3D Tiles that are rendered in the current view. Samples height
41261
+ from all other primitives regardless of their visibility.
41262
+ </p>
41696
41263
  * @example
41697
41264
  * const position = new Cesium.Cartographic(-1.31968, 0.698874);
41698
- * const height = viewer.scene.sampleHeight(position);
41699
- * console.log(height);
41265
+ const height = viewer.scene.sampleHeight(position);
41266
+ console.log(height);
41700
41267
  * @param position - The cartographic position to sample height from.
41701
41268
  * @param [objectsToExclude] - A list of primitives, entities, or 3D Tiles features to not sample height from.
41702
41269
  * @param [width = 0.1] - Width of the intersection volume in meters.
@@ -41705,16 +41272,16 @@ export class Scene {
41705
41272
  sampleHeight(position: Cartographic, objectsToExclude?: object[], width?: number): number;
41706
41273
  /**
41707
41274
  * Clamps the given cartesian position to the scene geometry along the geodetic surface normal. Returns the
41708
- * clamped position or <code>undefined</code> if there was no scene geometry to clamp to. May be used to clamp
41709
- * objects to the globe, 3D Tiles, or primitives in the scene.
41710
- * <p>
41711
- * This function only clamps to globe tiles and 3D Tiles that are rendered in the current view. Clamps to
41712
- * all other primitives regardless of their visibility.
41713
- * </p>
41275
+ clamped position or <code>undefined</code> if there was no scene geometry to clamp to. May be used to clamp
41276
+ objects to the globe, 3D Tiles, or primitives in the scene.
41277
+ <p>
41278
+ This function only clamps to globe tiles and 3D Tiles that are rendered in the current view. Clamps to
41279
+ all other primitives regardless of their visibility.
41280
+ </p>
41714
41281
  * @example
41715
41282
  * // Clamp an entity to the underlying scene geometry
41716
- * const position = entity.position.getValue(Cesium.JulianDate.now());
41717
- * entity.position = viewer.scene.clampToHeight(position);
41283
+ const position = entity.position.getValue(Cesium.JulianDate.now());
41284
+ entity.position = viewer.scene.clampToHeight(position);
41718
41285
  * @param cartesian - The cartesian position.
41719
41286
  * @param [objectsToExclude] - A list of primitives, entities, or 3D Tiles features to not clamp to.
41720
41287
  * @param [width = 0.1] - Width of the intersection volume in meters.
@@ -41724,20 +41291,20 @@ export class Scene {
41724
41291
  clampToHeight(cartesian: Cartesian3, objectsToExclude?: object[], width?: number, result?: Cartesian3): Cartesian3;
41725
41292
  /**
41726
41293
  * Initiates an asynchronous {@link Scene#sampleHeight} query for an array of {@link Cartographic} positions
41727
- * using the maximum level of detail for 3D Tilesets in the scene. The height of the input positions is ignored.
41728
- * Returns a promise that is resolved when the query completes. Each point height is modified in place.
41729
- * If a height cannot be determined because no geometry can be sampled at that location, or another error occurs,
41730
- * the height is set to undefined.
41294
+ using the maximum level of detail for 3D Tilesets in the scene. The height of the input positions is ignored.
41295
+ Returns a promise that is resolved when the query completes. Each point height is modified in place.
41296
+ If a height cannot be determined because no geometry can be sampled at that location, or another error occurs,
41297
+ the height is set to undefined.
41731
41298
  * @example
41732
41299
  * const positions = [
41733
- * new Cesium.Cartographic(-1.31968, 0.69887),
41734
- * new Cesium.Cartographic(-1.10489, 0.83923)
41735
- * ];
41736
- * const promise = viewer.scene.sampleHeightMostDetailed(positions);
41737
- * promise.then(function(updatedPosition) {
41738
- * // positions[0].height and positions[1].height have been updated.
41739
- * // updatedPositions is just a reference to positions.
41740
- * }
41300
+ new Cesium.Cartographic(-1.31968, 0.69887),
41301
+ new Cesium.Cartographic(-1.10489, 0.83923)
41302
+ ];
41303
+ const promise = viewer.scene.sampleHeightMostDetailed(positions);
41304
+ promise.then(function(updatedPosition) {
41305
+ // positions[0].height and positions[1].height have been updated.
41306
+ // updatedPositions is just a reference to positions.
41307
+ }
41741
41308
  * @param positions - The cartographic positions to update with sampled heights.
41742
41309
  * @param [objectsToExclude] - A list of primitives, entities, or 3D Tiles features to not sample height from.
41743
41310
  * @param [width = 0.1] - Width of the intersection volume in meters.
@@ -41746,19 +41313,19 @@ export class Scene {
41746
41313
  sampleHeightMostDetailed(positions: Cartographic[], objectsToExclude?: object[], width?: number): Promise<Cartographic[]>;
41747
41314
  /**
41748
41315
  * Initiates an asynchronous {@link Scene#clampToHeight} query for an array of {@link Cartesian3} positions
41749
- * using the maximum level of detail for 3D Tilesets in the scene. Returns a promise that is resolved when
41750
- * the query completes. Each position is modified in place. If a position cannot be clamped because no geometry
41751
- * can be sampled at that location, or another error occurs, the element in the array is set to undefined.
41316
+ using the maximum level of detail for 3D Tilesets in the scene. Returns a promise that is resolved when
41317
+ the query completes. Each position is modified in place. If a position cannot be clamped because no geometry
41318
+ can be sampled at that location, or another error occurs, the element in the array is set to undefined.
41752
41319
  * @example
41753
41320
  * const cartesians = [
41754
- * entities[0].position.getValue(Cesium.JulianDate.now()),
41755
- * entities[1].position.getValue(Cesium.JulianDate.now())
41756
- * ];
41757
- * const promise = viewer.scene.clampToHeightMostDetailed(cartesians);
41758
- * promise.then(function(updatedCartesians) {
41759
- * entities[0].position = updatedCartesians[0];
41760
- * entities[1].position = updatedCartesians[1];
41761
- * }
41321
+ entities[0].position.getValue(Cesium.JulianDate.now()),
41322
+ entities[1].position.getValue(Cesium.JulianDate.now())
41323
+ ];
41324
+ const promise = viewer.scene.clampToHeightMostDetailed(cartesians);
41325
+ promise.then(function(updatedCartesians) {
41326
+ entities[0].position = updatedCartesians[0];
41327
+ entities[1].position = updatedCartesians[1];
41328
+ }
41762
41329
  * @param cartesians - The cartesian positions to update with clamped positions.
41763
41330
  * @param [objectsToExclude] - A list of primitives, entities, or 3D Tiles features to not clamp to.
41764
41331
  * @param [width = 0.1] - Width of the intersection volume in meters.
@@ -41767,15 +41334,15 @@ export class Scene {
41767
41334
  clampToHeightMostDetailed(cartesians: Cartesian3[], objectsToExclude?: object[], width?: number): Promise<Cartesian3[]>;
41768
41335
  /**
41769
41336
  * Transforms a position in cartesian coordinates to canvas coordinates. This is commonly used to place an
41770
- * HTML element at the same screen position as an object in the scene.
41337
+ HTML element at the same screen position as an object in the scene.
41771
41338
  * @example
41772
41339
  * // Output the canvas position of longitude/latitude (0, 0) every time the mouse moves.
41773
- * const scene = widget.scene;
41774
- * const position = Cesium.Cartesian3.fromDegrees(0.0, 0.0);
41775
- * const handler = new Cesium.ScreenSpaceEventHandler(scene.canvas);
41776
- * handler.setInputAction(function(movement) {
41777
- * console.log(scene.cartesianToCanvasCoordinates(position));
41778
- * }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
41340
+ const scene = widget.scene;
41341
+ const position = Cesium.Cartesian3.fromDegrees(0.0, 0.0);
41342
+ const handler = new Cesium.ScreenSpaceEventHandler(scene.canvas);
41343
+ handler.setInputAction(function(movement) {
41344
+ console.log(scene.cartesianToCanvasCoordinates(position));
41345
+ }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
41779
41346
  * @param position - The position in cartesian coordinates.
41780
41347
  * @param [result] - An optional object to return the input position transformed to canvas coordinates.
41781
41348
  * @returns The modified result parameter or a new Cartesian2 instance if one was not provided. This may be <code>undefined</code> if the input position is near the center of the ellipsoid.
@@ -41804,34 +41371,34 @@ export class Scene {
41804
41371
  * Update the terrain providing surface geometry for the globe.
41805
41372
  * @example
41806
41373
  * // Use Cesium World Terrain
41807
- * scene.setTerrain(Cesium.Terrain.fromWorldTerrain());
41374
+ scene.setTerrain(Cesium.Terrain.fromWorldTerrain());
41808
41375
  * @example
41809
41376
  * // Use a custom terrain provider
41810
- * const terrain = new Cesium.Terrain(Cesium.CesiumTerrainProvider.fromUrl("https://myTestTerrain.com"));
41811
- * scene.setTerrain(terrain);
41812
- *
41813
- * terrain.errorEvent.addEventListener(error => {
41814
- * alert(`Encountered an error while creating terrain! ${error}`);
41815
- * });
41377
+ const terrain = new Cesium.Terrain(Cesium.CesiumTerrainProvider.fromUrl("https://myTestTerrain.com"));
41378
+ scene.setTerrain(terrain);
41379
+
41380
+ terrain.errorEvent.addEventListener(error => {
41381
+ alert(`Encountered an error while creating terrain! ${error}`);
41382
+ });
41816
41383
  * @param terrain - The terrain provider async helper
41817
41384
  * @returns terrain The terrain provider async helper
41818
41385
  */
41819
41386
  setTerrain(terrain: Terrain): Terrain;
41820
41387
  /**
41821
41388
  * Returns true if this object was destroyed; otherwise, false.
41822
- * <br /><br />
41823
- * If this object was destroyed, it should not be used; calling any function other than
41824
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
41389
+ <br /><br />
41390
+ If this object was destroyed, it should not be used; calling any function other than
41391
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
41825
41392
  * @returns <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
41826
41393
  */
41827
41394
  isDestroyed(): boolean;
41828
41395
  /**
41829
41396
  * Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
41830
- * release of WebGL resources, instead of relying on the garbage collector to destroy this object.
41831
- * <br /><br />
41832
- * Once an object is destroyed, it should not be used; calling any function other than
41833
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
41834
- * assign the return value (<code>undefined</code>) to the object as done in the example.
41397
+ release of WebGL resources, instead of relying on the garbage collector to destroy this object.
41398
+ <br /><br />
41399
+ Once an object is destroyed, it should not be used; calling any function other than
41400
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
41401
+ assign the return value (<code>undefined</code>) to the object as done in the example.
41835
41402
  * @example
41836
41403
  * scene = scene && scene.destroy();
41837
41404
  */
@@ -41840,11 +41407,11 @@ export class Scene {
41840
41407
 
41841
41408
  /**
41842
41409
  * Determine how translucent surfaces will be handled.
41843
- *
41844
- * When OIT is enabled, then this will delegate to OIT.executeCommands.
41845
- * Otherwise, it will just be executeTranslucentCommandsBackToFront
41846
- * for render passes, or executeTranslucentCommandsFrontToBack for
41847
- * other passes.
41410
+
41411
+ When OIT is enabled, then this will delegate to OIT.executeCommands.
41412
+ Otherwise, it will just be executeTranslucentCommandsBackToFront
41413
+ for render passes, or executeTranslucentCommandsFrontToBack for
41414
+ other passes.
41848
41415
  * @param scene - The scene.
41849
41416
  * @returns A function to execute translucent commands.
41850
41417
  */
@@ -42105,13 +41672,13 @@ export enum SensorVolumePortionToDisplay {
42105
41672
 
42106
41673
  /**
42107
41674
  * <div class="notice">
42108
- * Use {@link Viewer#shadowMap} to get the scene's shadow map. Do not construct this directly.
42109
- * </div>
42110
- *
42111
- * <p>
42112
- * The normalOffset bias pushes the shadows forward slightly, and may be disabled
42113
- * for applications that require ultra precise shadows.
42114
- * </p>
41675
+ Use {@link Viewer#shadowMap} to get the scene's shadow map. Do not construct this directly.
41676
+ </div>
41677
+
41678
+ <p>
41679
+ The normalOffset bias pushes the shadows forward slightly, and may be disabled
41680
+ for applications that require ultra precise shadows.
41681
+ </p>
42115
41682
  */
42116
41683
  export class ShadowMap {
42117
41684
  constructor();
@@ -43370,13 +42937,13 @@ const positron = new Cesium.UrlTemplateImageryProvider({
43370
42937
  });
43371
42938
  // Access a Web Map Service (WMS) server.
43372
42939
  const wms = new Cesium.UrlTemplateImageryProvider({
43373
- url : 'https://services.ga.gov.au/gis/services/NM_Hydrology_and_Marine_Points/MapServer/WMSServer?' +
43374
- 'tiled=true&transparent=true&format=image%2Fpng&exceptions=application%2Fvnd.ogc.se_xml&' +
43375
- 'styles=&service=WMS&version=1.3.0&request=GetMap&' +
43376
- 'layers=Bores&crs=EPSG%3A3857&' +
42940
+ url : 'https://programs.communications.gov.au/geoserver/ows?tiled=true&' +
42941
+ 'transparent=true&format=image%2Fpng&exceptions=application%2Fvnd.ogc.se_xml&' +
42942
+ 'styles=&service=WMS&version=1.1.1&request=GetMap&' +
42943
+ 'layers=public%3AMyBroadband_Availability&srs=EPSG%3A3857&' +
43377
42944
  'bbox={westProjected}%2C{southProjected}%2C{eastProjected}%2C{northProjected}&' +
43378
42945
  'width=256&height=256',
43379
- rectangle : Cesium.Rectangle.fromDegrees(95.0, -55.0, 170.0, -1.0) // From GetCapabilities EX_GeographicBoundingBox
42946
+ rectangle : Cesium.Rectangle.fromDegrees(96.799393, -43.598214999057824, 153.63925700000001, -9.2159219997013)
43380
42947
  });
43381
42948
  // Using custom tags in your template url.
43382
42949
  const custom = new Cesium.UrlTemplateImageryProvider({
@@ -43985,31 +43552,31 @@ export namespace WebMapServiceImageryProvider {
43985
43552
  * @property [parameters = WebMapServiceImageryProvider.DefaultParameters] - Additional parameters to pass to the WMS server in the GetMap URL.
43986
43553
  * @property [getFeatureInfoParameters = WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters] - Additional parameters to pass to the WMS server in the GetFeatureInfo URL.
43987
43554
  * @property [enablePickFeatures = true] - If true, {@link WebMapServiceImageryProvider#pickFeatures} will invoke
43988
- * the GetFeatureInfo operation on the WMS server and return the features included in the response. If false,
43989
- * {@link WebMapServiceImageryProvider#pickFeatures} will immediately return undefined (indicating no pickable features)
43990
- * without communicating with the server. Set this property to false if you know your WMS server does not support
43991
- * GetFeatureInfo or if you don't want this provider's features to be pickable. Note that this can be dynamically
43992
- * overridden by modifying the WebMapServiceImageryProvider#enablePickFeatures property.
43555
+ the GetFeatureInfo operation on the WMS server and return the features included in the response. If false,
43556
+ {@link WebMapServiceImageryProvider#pickFeatures} will immediately return undefined (indicating no pickable features)
43557
+ without communicating with the server. Set this property to false if you know your WMS server does not support
43558
+ GetFeatureInfo or if you don't want this provider's features to be pickable. Note that this can be dynamically
43559
+ overridden by modifying the WebMapServiceImageryProvider#enablePickFeatures property.
43993
43560
  * @property [getFeatureInfoFormats = WebMapServiceImageryProvider.DefaultGetFeatureInfoFormats] - The formats
43994
- * in which to try WMS GetFeatureInfo requests.
43561
+ in which to try WMS GetFeatureInfo requests.
43995
43562
  * @property [rectangle = Rectangle.MAX_VALUE] - The rectangle of the layer.
43996
43563
  * @property [tilingScheme = new GeographicTilingScheme()] - The tiling scheme to use to divide the world into tiles.
43997
43564
  * @property [ellipsoid] - The ellipsoid. If the tilingScheme is specified,
43998
- * this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither
43999
- * parameter is specified, the WGS84 ellipsoid is used.
43565
+ this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither
43566
+ parameter is specified, the WGS84 ellipsoid is used.
44000
43567
  * @property [tileWidth = 256] - The width of each tile in pixels.
44001
43568
  * @property [tileHeight = 256] - The height of each tile in pixels.
44002
43569
  * @property [minimumLevel = 0] - The minimum level-of-detail supported by the imagery provider. Take care when
44003
- * specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is
44004
- * likely to result in rendering problems.
43570
+ specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is
43571
+ likely to result in rendering problems.
44005
43572
  * @property [maximumLevel] - The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
44006
- * If not specified, there is no limit.
43573
+ If not specified, there is no limit.
44007
43574
  * @property [crs] - CRS specification, for use with WMS specification >= 1.3.0.
44008
43575
  * @property [srs] - SRS specification, for use with WMS specification 1.1.0 or 1.1.1
44009
43576
  * @property [credit] - A credit for the data source, which is displayed on the canvas.
44010
43577
  * @property [subdomains = 'abc'] - The subdomains to use for the <code>{s}</code> placeholder in the URL template.
44011
- * If this parameter is a single string, each character in the string is a subdomain. If it is
44012
- * an array, each element in the array is a subdomain.
43578
+ If this parameter is a single string, each character in the string is a subdomain. If it is
43579
+ an array, each element in the array is a subdomain.
44013
43580
  * @property [clock] - A Clock instance that is used when determining the value for the time dimension. Required when `times` is specified.
44014
43581
  * @property [times] - TimeIntervalCollection with its data property being an object containing time dynamic dimension and their values.
44015
43582
  * @property [getFeatureInfoUrl] - The getFeatureInfo URL of the WMS service. If the property is not defined then we use the property value of url.
@@ -44042,12 +43609,12 @@ export namespace WebMapServiceImageryProvider {
44042
43609
  * Provides tiled imagery hosted by a Web Map Service (WMS) server.
44043
43610
  * @example
44044
43611
  * const provider = new Cesium.WebMapServiceImageryProvider({
44045
- * url : 'https://sampleserver1.arcgisonline.com/ArcGIS/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer/WMSServer',
44046
- * layers : '0',
44047
- * proxy: new Cesium.DefaultProxy('/proxy/')
44048
- * });
44049
- * const imageryLayer = new Cesium.ImageryLayer(provider);
44050
- * viewer.imageryLayers.add(imageryLayer);
43612
+ url : 'https://sampleserver1.arcgisonline.com/ArcGIS/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer/WMSServer',
43613
+ layers : '0',
43614
+ proxy: new Cesium.DefaultProxy('/proxy/')
43615
+ });
43616
+ const imageryLayer = new Cesium.ImageryLayer(provider);
43617
+ viewer.imageryLayers.add(imageryLayer);
44051
43618
  * @param options - Object describing initialization options
44052
43619
  */
44053
43620
  export class WebMapServiceImageryProvider {
@@ -44090,35 +43657,35 @@ export class WebMapServiceImageryProvider {
44090
43657
  readonly rectangle: Rectangle;
44091
43658
  /**
44092
43659
  * Gets the tile discard policy. If not undefined, the discard policy is responsible
44093
- * for filtering out "missing" tiles via its shouldDiscardImage function. If this function
44094
- * returns undefined, no tiles are filtered.
43660
+ for filtering out "missing" tiles via its shouldDiscardImage function. If this function
43661
+ returns undefined, no tiles are filtered.
44095
43662
  */
44096
43663
  readonly tileDiscardPolicy: TileDiscardPolicy;
44097
43664
  /**
44098
43665
  * Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing
44099
- * to the event, you will be notified of the error and can potentially recover from it. Event listeners
44100
- * are passed an instance of {@link TileProviderError}.
43666
+ to the event, you will be notified of the error and can potentially recover from it. Event listeners
43667
+ are passed an instance of {@link TileProviderError}.
44101
43668
  */
44102
43669
  readonly errorEvent: Event;
44103
43670
  /**
44104
43671
  * Gets the credit to display when this imagery provider is active. Typically this is used to credit
44105
- * the source of the imagery.
43672
+ the source of the imagery.
44106
43673
  */
44107
43674
  readonly credit: Credit;
44108
43675
  /**
44109
43676
  * Gets a value indicating whether or not the images provided by this imagery provider
44110
- * include an alpha channel. If this property is false, an alpha channel, if present, will
44111
- * be ignored. If this property is true, any images without an alpha channel will be treated
44112
- * as if their alpha is 1.0 everywhere. When this property is false, memory usage
44113
- * and texture upload time are reduced.
43677
+ include an alpha channel. If this property is false, an alpha channel, if present, will
43678
+ be ignored. If this property is true, any images without an alpha channel will be treated
43679
+ as if their alpha is 1.0 everywhere. When this property is false, memory usage
43680
+ and texture upload time are reduced.
44114
43681
  */
44115
43682
  readonly hasAlphaChannel: boolean;
44116
43683
  /**
44117
43684
  * Gets or sets a value indicating whether feature picking is enabled. If true, {@link WebMapServiceImageryProvider#pickFeatures} will
44118
- * invoke the <code>GetFeatureInfo</code> service on the WMS server and attempt to interpret the features included in the response. If false,
44119
- * {@link WebMapServiceImageryProvider#pickFeatures} will immediately return undefined (indicating no pickable
44120
- * features) without communicating with the server. Set this property to false if you know your data
44121
- * source does not support picking features or if you don't want this provider's features to be pickable.
43685
+ invoke the <code>GetFeatureInfo</code> service on the WMS server and attempt to interpret the features included in the response. If false,
43686
+ {@link WebMapServiceImageryProvider#pickFeatures} will immediately return undefined (indicating no pickable
43687
+ features) without communicating with the server. Set this property to false if you know your data
43688
+ source does not support picking features or if you don't want this provider's features to be pickable.
44122
43689
  */
44123
43690
  enablePickFeatures: boolean;
44124
43691
  /**
@@ -44127,8 +43694,8 @@ export class WebMapServiceImageryProvider {
44127
43694
  clock: Clock;
44128
43695
  /**
44129
43696
  * Gets or sets a time interval collection that is used to get time dynamic parameters. The data of each
44130
- * TimeInterval is an object containing the keys and values of the properties that are used during
44131
- * tile requests.
43697
+ TimeInterval is an object containing the keys and values of the properties that are used during
43698
+ tile requests.
44132
43699
  */
44133
43700
  times: TimeIntervalCollection;
44134
43701
  /**
@@ -44150,36 +43717,36 @@ export class WebMapServiceImageryProvider {
44150
43717
  * @param level - The tile level.
44151
43718
  * @param [request] - The request object. Intended for internal use only.
44152
43719
  * @returns A promise for the image that will resolve when the image is available, or
44153
- * undefined if there are too many active requests to the server, and the request should be retried later.
43720
+ undefined if there are too many active requests to the server, and the request should be retried later.
44154
43721
  */
44155
43722
  requestImage(x: number, y: number, level: number, request?: Request): Promise<ImageryTypes> | undefined;
44156
43723
  /**
44157
43724
  * Asynchronously determines what features, if any, are located at a given longitude and latitude within
44158
- * a tile.
43725
+ a tile.
44159
43726
  * @param x - The tile X coordinate.
44160
43727
  * @param y - The tile Y coordinate.
44161
43728
  * @param level - The tile level.
44162
43729
  * @param longitude - The longitude at which to pick features.
44163
43730
  * @param latitude - The latitude at which to pick features.
44164
43731
  * @returns A promise for the picked features that will resolve when the asynchronous
44165
- * picking completes. The resolved value is an array of {@link ImageryLayerFeatureInfo}
44166
- * instances. The array may be empty if no features are found at the given location.
43732
+ picking completes. The resolved value is an array of {@link ImageryLayerFeatureInfo}
43733
+ instances. The array may be empty if no features are found at the given location.
44167
43734
  */
44168
43735
  pickFeatures(x: number, y: number, level: number, longitude: number, latitude: number): Promise<ImageryLayerFeatureInfo[]> | undefined;
44169
43736
  /**
44170
43737
  * The default parameters to include in the WMS URL to obtain images. The values are as follows:
44171
- * service=WMS
44172
- * version=1.1.1
44173
- * request=GetMap
44174
- * styles=
44175
- * format=image/jpeg
43738
+ service=WMS
43739
+ version=1.1.1
43740
+ request=GetMap
43741
+ styles=
43742
+ format=image/jpeg
44176
43743
  */
44177
43744
  static readonly DefaultParameters: any;
44178
43745
  /**
44179
43746
  * The default parameters to include in the WMS URL to get feature information. The values are as follows:
44180
- * service=WMS
44181
- * version=1.1.1
44182
- * request=GetFeatureInfo
43747
+ service=WMS
43748
+ version=1.1.1
43749
+ request=GetFeatureInfo
44183
43750
  */
44184
43751
  static readonly GetFeatureInfoDefaultParameters: any;
44185
43752
  }
@@ -44420,7 +43987,6 @@ const widget2 = new Cesium.CesiumWidget("cesiumContainer", {
44420
43987
  * @param container - The DOM element or ID that will contain the widget.
44421
43988
  * @param [options] - Object with the following properties:
44422
43989
  * @param [options.clock = new Clock()] - The clock to use to control current time.
44423
- * @param [options.shouldAnimate = false] - <code>true</code> if the clock should attempt to advance simulation time by default, <code>false</code> otherwise.
44424
43990
  * @param [options.ellipsoid = Ellipsoid.default] - The default ellipsoid.
44425
43991
  * @param [options.baseLayer = ImageryLayer.fromWorldImagery()] - The bottommost imagery layer applied to the globe. If set to <code>false</code>, no imagery provider will be added.
44426
43992
  * @param [options.terrainProvider = new EllipsoidTerrainProvider(options.ellipsoid)] - The terrain provider.
@@ -44436,17 +44002,14 @@ const widget2 = new Cesium.CesiumWidget("cesiumContainer", {
44436
44002
  * @param [options.useBrowserRecommendedResolution = true] - If true, render at the browser's recommended resolution and ignore <code>window.devicePixelRatio</code>.
44437
44003
  * @param [options.targetFrameRate] - The target frame rate when using the default render loop.
44438
44004
  * @param [options.showRenderLoopErrors = true] - If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs.
44439
- * @param [options.automaticallyTrackDataSourceClocks = true] - If true, this widget will automatically track the clock settings of newly added DataSources, updating if the DataSource's clock changes. Set this to false if you want to configure the clock independently.
44440
44005
  * @param [options.contextOptions] - Context and WebGL creation properties passed to {@link Scene}.
44441
44006
  * @param [options.creditContainer] - The DOM element or ID that will contain the {@link CreditDisplay}. If not specified, the credits are added
44442
44007
  to the bottom of the widget itself.
44443
44008
  * @param [options.creditViewport] - The DOM element or ID that will contain the credit pop up created by the {@link CreditDisplay}. If not specified, it will appear over the widget itself.
44444
- * @param [options.dataSources = new DataSourceCollection()] - The collection of data sources visualized by the widget. If this parameter is provided,
44445
- the instance is assumed to be owned by the caller and will not be destroyed when the widget is destroyed.
44446
44009
  * @param [options.shadows = false] - Determines if shadows are cast by light sources.
44447
44010
  * @param [options.terrainShadows = ShadowMode.RECEIVE_ONLY] - Determines if the terrain casts or receives shadows from light sources.
44448
44011
  * @param [options.mapMode2D = MapMode2D.INFINITE_SCROLL] - Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
44449
- * @param [options.blurActiveElementOnCanvasFocus = true] - If true, the active element will blur when the widget's canvas is clicked. Setting this to false is useful for cases when the canvas is clicked only for retrieving position or an entity data without actually meaning to set the canvas to be the active element.
44012
+ * @param [options.blurActiveElementOnCanvasFocus = true] - If true, the active element will blur when the viewer's canvas is clicked. Setting this to false is useful for cases when the canvas is clicked only for retrieving position or an entity data without actually meaning to set the canvas to be the active element.
44450
44013
  * @param [options.requestRenderMode = false] - If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application, but requires using {@link Scene#requestRender} to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}.
44451
44014
  * @param [options.maximumRenderTimeChange = 0.0] - If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}.
44452
44015
  * @param [options.msaaSamples = 4] - If provided, this value controls the rate of multisample antialiasing. Typical multisampling rates are 2, 4, and sometimes 8 samples per pixel. Higher sampling rates of MSAA may impact performance in exchange for improved visual quality. This value only applies to WebGL2 contexts that support multisample render targets. Set to 1 to disable MSAA.
@@ -44454,7 +44017,6 @@ const widget2 = new Cesium.CesiumWidget("cesiumContainer", {
44454
44017
  export class CesiumWidget {
44455
44018
  constructor(container: Element | string, options?: {
44456
44019
  clock?: Clock;
44457
- shouldAnimate?: boolean;
44458
44020
  ellipsoid?: Ellipsoid;
44459
44021
  baseLayer?: ImageryLayer | false;
44460
44022
  terrainProvider?: TerrainProvider;
@@ -44470,11 +44032,9 @@ export class CesiumWidget {
44470
44032
  useBrowserRecommendedResolution?: boolean;
44471
44033
  targetFrameRate?: number;
44472
44034
  showRenderLoopErrors?: boolean;
44473
- automaticallyTrackDataSourceClocks?: boolean;
44474
44035
  contextOptions?: ContextOptions;
44475
44036
  creditContainer?: Element | string;
44476
44037
  creditViewport?: Element | string;
44477
- dataSources?: DataSourceCollection;
44478
44038
  shadows?: boolean;
44479
44039
  terrainShadows?: ShadowMode;
44480
44040
  mapMode2D?: MapMode2D;
@@ -44515,19 +44075,6 @@ export class CesiumWidget {
44515
44075
  * Manages the list of credits to display on screen and in the lightbox.
44516
44076
  */
44517
44077
  creditDisplay: CreditDisplay;
44518
- /**
44519
- * Gets the display used for {@link DataSource} visualization.
44520
- */
44521
- readonly dataSourceDisplay: DataSourceDisplay;
44522
- /**
44523
- * Gets the collection of entities not tied to a particular data source.
44524
- This is a shortcut to [dataSourceDisplay.defaultDataSource.entities]{@link CesiumWidget#dataSourceDisplay}.
44525
- */
44526
- readonly entities: EntityCollection;
44527
- /**
44528
- * Gets the set of {@link DataSource} instances to be visualized.
44529
- */
44530
- readonly dataSources: DataSourceCollection;
44531
44078
  /**
44532
44079
  * Gets the camera.
44533
44080
  */
@@ -44581,25 +44128,6 @@ export class CesiumWidget {
44581
44128
  this flag is true or false.
44582
44129
  */
44583
44130
  useBrowserRecommendedResolution: boolean;
44584
- /**
44585
- * Gets or sets whether or not data sources can temporarily pause
44586
- animation in order to avoid showing an incomplete picture to the user.
44587
- For example, if asynchronous primitives are being processed in the
44588
- background, the clock will not advance until the geometry is ready.
44589
- */
44590
- allowDataSourcesToSuspendAnimation: boolean;
44591
- /**
44592
- * Gets or sets the Entity instance currently being tracked by the camera.
44593
- */
44594
- trackedEntity: Entity | undefined;
44595
- /**
44596
- * Gets the event that is raised when the tracked entity changes.
44597
- */
44598
- readonly trackedEntityChanged: Event;
44599
- /**
44600
- * Gets or sets the data source to track with the widget's clock.
44601
- */
44602
- clockTrackedDataSource: DataSource;
44603
44131
  /**
44604
44132
  * Show an error panel to the user containing a title and a longer error message,
44605
44133
  which can be dismissed using an OK button. This panel is displayed automatically
@@ -44630,51 +44158,6 @@ export class CesiumWidget {
44630
44158
  unless <code>useDefaultRenderLoop</code> is set to false;
44631
44159
  */
44632
44160
  render(): void;
44633
- /**
44634
- * Asynchronously sets the camera to view the provided entity, entities, or data source.
44635
- If the data source is still in the process of loading or the visualization is otherwise still loading,
44636
- this method waits for the data to be ready before performing the zoom.
44637
-
44638
- <p>The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere.
44639
- The heading and the pitch angles are defined in the local east-north-up reference frame.
44640
- The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch
44641
- angles are above the plane. Negative pitch angles are below the plane. The range is the distance from the center. If the range is
44642
- zero, a range will be computed such that the whole bounding sphere is visible.</p>
44643
-
44644
- <p>In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the
44645
- target will be the range. The heading will be determined from the offset. If the heading cannot be
44646
- determined from the offset, the heading will be north.</p>
44647
- * @param target - The entity, array of entities, entity collection, data source, Cesium3DTileset, point cloud, or imagery layer to view. You can also pass a promise that resolves to one of the previously mentioned types.
44648
- * @param [offset] - The offset from the center of the entity in the local east-north-up reference frame.
44649
- * @returns A Promise that resolves to true if the zoom was successful or false if the target is not currently visualized in the scene or the zoom was cancelled.
44650
- */
44651
- zoomTo(target: Entity | Entity[] | EntityCollection | DataSource | ImageryLayer | Cesium3DTileset | TimeDynamicPointCloud | Promise<Entity | Entity[] | EntityCollection | DataSource | ImageryLayer | Cesium3DTileset | TimeDynamicPointCloud | VoxelPrimitive>, offset?: HeadingPitchRange): Promise<boolean>;
44652
- /**
44653
- * Flies the camera to the provided entity, entities, or data source.
44654
- If the data source is still in the process of loading or the visualization is otherwise still loading,
44655
- this method waits for the data to be ready before performing the flight.
44656
-
44657
- <p>The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere.
44658
- The heading and the pitch angles are defined in the local east-north-up reference frame.
44659
- The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch
44660
- angles are above the plane. Negative pitch angles are below the plane. The range is the distance from the center. If the range is
44661
- zero, a range will be computed such that the whole bounding sphere is visible.</p>
44662
-
44663
- <p>In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the
44664
- target will be the range. The heading will be determined from the offset. If the heading cannot be
44665
- determined from the offset, the heading will be north.</p>
44666
- * @param target - The entity, array of entities, entity collection, data source, Cesium3DTileset, point cloud, or imagery layer to view. You can also pass a promise that resolves to one of the previously mentioned types.
44667
- * @param [options] - Object with the following properties:
44668
- * @param [options.duration = 3.0] - The duration of the flight in seconds.
44669
- * @param [options.maximumHeight] - The maximum height at the peak of the flight.
44670
- * @param [options.offset] - The offset from the target in the local east-north-up reference frame centered at the target.
44671
- * @returns A Promise that resolves to true if the flight was successful or false if the target is not currently visualized in the scene or the flight was cancelled. //TODO: Cleanup entity mentions
44672
- */
44673
- flyTo(target: Entity | Entity[] | EntityCollection | DataSource | ImageryLayer | Cesium3DTileset | TimeDynamicPointCloud | Promise<Entity | Entity[] | EntityCollection | DataSource | ImageryLayer | Cesium3DTileset | TimeDynamicPointCloud | VoxelPrimitive>, options?: {
44674
- duration?: number;
44675
- maximumHeight?: number;
44676
- offset?: HeadingPitchRange;
44677
- }): Promise<boolean>;
44678
44161
  }
44679
44162
 
44680
44163
  /**
@@ -44979,12 +44462,12 @@ export class BaseLayerPickerViewModel {
44979
44462
  });
44980
44463
  /**
44981
44464
  * Gets or sets an array of ProviderViewModel instances available for imagery selection.
44982
- * This property is observable.
44465
+ This property is observable.
44983
44466
  */
44984
44467
  imageryProviderViewModels: ProviderViewModel[];
44985
44468
  /**
44986
44469
  * Gets or sets an array of ProviderViewModel instances available for terrain selection.
44987
- * This property is observable.
44470
+ This property is observable.
44988
44471
  */
44989
44472
  terrainProviderViewModels: ProviderViewModel[];
44990
44473
  /**
@@ -45025,7 +44508,7 @@ export class BaseLayerPickerViewModel {
45025
44508
  * @param options.iconUrl - An icon representing the layer.
45026
44509
  * @param [options.category] - A category for the layer.
45027
44510
  * @param options.creationFunction - A function or Command
45028
- * that creates one or more providers which will be added to the globe when this item is selected.
44511
+ that creates one or more providers which will be added to the globe when this item is selected.
45029
44512
  */
45030
44513
  export class ProviderViewModel {
45031
44514
  constructor(options: {
@@ -45049,7 +44532,7 @@ export class ProviderViewModel {
45049
44532
  iconUrl: string;
45050
44533
  /**
45051
44534
  * Gets the Command that creates one or more providers which will be added to
45052
- * the globe when this item is selected.
44535
+ the globe when this item is selected.
45053
44536
  */
45054
44537
  readonly creationCommand: Command;
45055
44538
  /**
@@ -46610,7 +46093,7 @@ export namespace Viewer {
46610
46093
  * @property [baseLayerPicker = true] - If set to false, the BaseLayerPicker widget will not be created.
46611
46094
  * @property [fullscreenButton = true] - If set to false, the FullscreenButton widget will not be created.
46612
46095
  * @property [vrButton = false] - If set to true, the VRButton widget will be created.
46613
- * @property [geocoder = IonGeocodeProviderType.DEFAULT] - The geocoding service or services to use when searching with the Geocoder widget. If set to false, the Geocoder widget will not be created.
46096
+ * @property [geocoder = true] - If set to false, the Geocoder widget will not be created.
46614
46097
  * @property [homeButton = true] - If set to false, the HomeButton widget will not be created.
46615
46098
  * @property [infoBox = true] - If set to false, the InfoBox widget will not be created.
46616
46099
  * @property [sceneModePicker = true] - If set to false, the SceneModePicker widget will not be created.
@@ -46625,7 +46108,7 @@ export namespace Viewer {
46625
46108
  * @property [imageryProviderViewModels = createDefaultImageryProviderViewModels()] - The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if `baseLayerPicker` is set to true.
46626
46109
  * @property [selectedTerrainProviderViewModel] - The view model for the current base terrain layer, if not supplied the first available base layer is used. This value is only valid if `baseLayerPicker` is set to true.
46627
46110
  * @property [terrainProviderViewModels = createDefaultTerrainProviderViewModels()] - The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if `baseLayerPicker` is set to true.
46628
- * @property [baseLayer = ImageryLayer.fromWorldImagery()] - The bottommost imagery layer applied to the globe. If set to <code>false</code>, no imagery provider will be added. This value is only valid if `baseLayerPicker` is set to false. Cannot be used when `globe` is set to false.
46111
+ * @property [baseLayer = ImageryLayer.fromWorldImagery()] - The bottommost imagery layer applied to the globe. If set to <code>false</code>, no imagery provider will be added. This value is only valid if `baseLayerPicker` is set to false.
46629
46112
  * @property [ellipsoid = Ellipsoid.default] - The default ellipsoid.
46630
46113
  * @property [terrainProvider = new EllipsoidTerrainProvider()] - The terrain provider to use
46631
46114
  * @property [terrain] - A terrain object which handles asynchronous terrain provider. Can only specify if options.terrainProvider is undefined.
@@ -46661,7 +46144,7 @@ export namespace Viewer {
46661
46144
  baseLayerPicker?: boolean;
46662
46145
  fullscreenButton?: boolean;
46663
46146
  vrButton?: boolean;
46664
- geocoder?: boolean | IonGeocodeProviderType | GeocoderService[];
46147
+ geocoder?: boolean | GeocoderService[];
46665
46148
  homeButton?: boolean;
46666
46149
  infoBox?: boolean;
46667
46150
  sceneModePicker?: boolean;