mars3d-cesium 1.125.2 → 1.126.0

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 (107) hide show
  1. package/Build/Cesium/Cesium.d.ts +881 -250
  2. package/Build/Cesium/Cesium.js +14682 -14682
  3. package/Build/Cesium/Workers/{chunk-BY4QQZVA.js → chunk-2BKICBC5.js} +2 -2
  4. package/Build/Cesium/Workers/{chunk-W6DYP6RP.js → chunk-2IY2PMDX.js} +2 -2
  5. package/Build/Cesium/Workers/{chunk-CBBLBV3O.js → chunk-2MV4QGBJ.js} +2 -2
  6. package/Build/Cesium/Workers/{chunk-YMZY3BL5.js → chunk-474CNST4.js} +2 -2
  7. package/Build/Cesium/Workers/{chunk-77BVDWDZ.js → chunk-47AW3P5I.js} +2 -2
  8. package/Build/Cesium/Workers/{chunk-OV637V22.js → chunk-67MO77KC.js} +2 -2
  9. package/Build/Cesium/Workers/{chunk-46XGUA6R.js → chunk-6FWZFHMY.js} +1 -1
  10. package/Build/Cesium/Workers/{chunk-PTLFKAXD.js → chunk-BXEFB5QN.js} +2 -2
  11. package/Build/Cesium/Workers/{chunk-IA263462.js → chunk-CFAKZFXW.js} +1 -1
  12. package/Build/Cesium/Workers/{chunk-QWLVE2AT.js → chunk-DLYIYR7T.js} +2 -2
  13. package/Build/Cesium/Workers/{chunk-3HHIRNOO.js → chunk-DOWKCYUQ.js} +2 -2
  14. package/Build/Cesium/Workers/{chunk-XDY4CVDM.js → chunk-E3P4NHT2.js} +2 -2
  15. package/Build/Cesium/Workers/{chunk-MBCMWSCP.js → chunk-EKL26VPS.js} +2 -2
  16. package/Build/Cesium/Workers/{chunk-NEKNC6WA.js → chunk-EONOAY5M.js} +2 -2
  17. package/Build/Cesium/Workers/{chunk-ITLAYTGR.js → chunk-EV3DRMRT.js} +2 -2
  18. package/Build/Cesium/Workers/{chunk-URZX3OSH.js → chunk-F74K45DP.js} +2 -2
  19. package/Build/Cesium/Workers/{chunk-RCJPU2DX.js → chunk-FEOOKXKB.js} +2 -2
  20. package/Build/Cesium/Workers/{chunk-6NVYNBOU.js → chunk-FLO5JSWX.js} +2 -2
  21. package/Build/Cesium/Workers/{chunk-GFVUXNPF.js → chunk-GEQRLQHN.js} +2 -2
  22. package/Build/Cesium/Workers/{chunk-IXVN2NOA.js → chunk-GLPLIC24.js} +2 -2
  23. package/Build/Cesium/Workers/{chunk-A2ZU6XTS.js → chunk-GVZNTIFU.js} +2 -2
  24. package/Build/Cesium/Workers/{chunk-Z7PETD2R.js → chunk-HHDJU2SX.js} +2 -2
  25. package/Build/Cesium/Workers/{chunk-KNHPTALD.js → chunk-IFFLNNY4.js} +2 -2
  26. package/Build/Cesium/Workers/{chunk-AUHWAGVO.js → chunk-IPHUJSDE.js} +2 -2
  27. package/Build/Cesium/Workers/{chunk-LUJM6ESA.js → chunk-IX4H4MBI.js} +2 -2
  28. package/Build/Cesium/Workers/{chunk-BPDEHBBZ.js → chunk-JPVCPBBF.js} +2 -2
  29. package/Build/Cesium/Workers/{chunk-DJBXQ6UE.js → chunk-JRH3D44M.js} +2 -2
  30. package/Build/Cesium/Workers/{chunk-HDQQWVQZ.js → chunk-KQWXYTBQ.js} +2 -2
  31. package/Build/Cesium/Workers/{chunk-773JEVMF.js → chunk-L2QH3JGT.js} +2 -2
  32. package/Build/Cesium/Workers/{chunk-AB6BXW2X.js → chunk-L4GCE7O5.js} +2 -2
  33. package/Build/Cesium/Workers/{chunk-RL743EKS.js → chunk-N6RVY6RL.js} +2 -2
  34. package/Build/Cesium/Workers/{chunk-W52PIE4Z.js → chunk-NTLPSXWP.js} +2 -2
  35. package/Build/Cesium/Workers/{chunk-OR4LTELN.js → chunk-OHXLSTW7.js} +1 -1
  36. package/Build/Cesium/Workers/{chunk-SKFJ2DRZ.js → chunk-PILVCHTC.js} +2 -2
  37. package/Build/Cesium/Workers/{chunk-IOALS3FH.js → chunk-PUKD5R4H.js} +2 -2
  38. package/Build/Cesium/Workers/{chunk-ZQPYQITL.js → chunk-Q33MRHTT.js} +2 -2
  39. package/Build/Cesium/Workers/{chunk-SNZK3GBW.js → chunk-R76S47YN.js} +2 -2
  40. package/Build/Cesium/Workers/{chunk-MKKB3G3L.js → chunk-RQLD6HXJ.js} +2 -2
  41. package/Build/Cesium/Workers/{chunk-OZ6FGR4J.js → chunk-SSFSJT6Y.js} +1 -1
  42. package/Build/Cesium/Workers/{chunk-C6J3BMVD.js → chunk-T7AA3C7O.js} +2 -2
  43. package/Build/Cesium/Workers/{chunk-JV2HHT7Z.js → chunk-TVO4OWQK.js} +1 -1
  44. package/Build/Cesium/Workers/{chunk-7LTNOHIS.js → chunk-UC5TZEJC.js} +2 -2
  45. package/Build/Cesium/Workers/{chunk-BJOJ5NHC.js → chunk-UGIYEMNI.js} +2 -2
  46. package/Build/Cesium/Workers/{chunk-VTWUN3C4.js → chunk-UWBWKTZT.js} +2 -2
  47. package/Build/Cesium/Workers/{chunk-JCY2C4IM.js → chunk-V6SOMRY5.js} +2 -2
  48. package/Build/Cesium/Workers/{chunk-NX5OU6SB.js → chunk-VRPOC73U.js} +2 -2
  49. package/Build/Cesium/Workers/{chunk-ANEU72JU.js → chunk-VSYGE4HP.js} +2 -2
  50. package/Build/Cesium/Workers/{chunk-F6YWKYMJ.js → chunk-XMKYRXGO.js} +2 -2
  51. package/Build/Cesium/Workers/{chunk-RZQL5F44.js → chunk-YINCJM5O.js} +2 -2
  52. package/Build/Cesium/Workers/{chunk-KKLYVGHK.js → chunk-YLL5EZ4L.js} +2 -2
  53. package/Build/Cesium/Workers/{chunk-AHXZX5AT.js → chunk-ZFEWPYXN.js} +2 -2
  54. package/Build/Cesium/Workers/{chunk-2UZFBSSB.js → chunk-ZZKDRMOO.js} +2 -2
  55. package/Build/Cesium/Workers/combineGeometry.js +2 -2
  56. package/Build/Cesium/Workers/createBoxGeometry.js +2 -2
  57. package/Build/Cesium/Workers/createBoxOutlineGeometry.js +2 -2
  58. package/Build/Cesium/Workers/createCircleGeometry.js +2 -2
  59. package/Build/Cesium/Workers/createCircleOutlineGeometry.js +2 -2
  60. package/Build/Cesium/Workers/createCoplanarPolygonGeometry.js +2 -2
  61. package/Build/Cesium/Workers/createCoplanarPolygonOutlineGeometry.js +2 -2
  62. package/Build/Cesium/Workers/createCorridorGeometry.js +2 -2
  63. package/Build/Cesium/Workers/createCorridorOutlineGeometry.js +2 -2
  64. package/Build/Cesium/Workers/createCylinderGeometry.js +2 -2
  65. package/Build/Cesium/Workers/createCylinderOutlineGeometry.js +2 -2
  66. package/Build/Cesium/Workers/createEllipseGeometry.js +2 -2
  67. package/Build/Cesium/Workers/createEllipseOutlineGeometry.js +2 -2
  68. package/Build/Cesium/Workers/createEllipsoidGeometry.js +2 -2
  69. package/Build/Cesium/Workers/createEllipsoidOutlineGeometry.js +2 -2
  70. package/Build/Cesium/Workers/createFrustumGeometry.js +2 -2
  71. package/Build/Cesium/Workers/createFrustumOutlineGeometry.js +2 -2
  72. package/Build/Cesium/Workers/createGeometry.js +2 -2
  73. package/Build/Cesium/Workers/createGroundPolylineGeometry.js +2 -2
  74. package/Build/Cesium/Workers/createPlaneGeometry.js +2 -2
  75. package/Build/Cesium/Workers/createPlaneOutlineGeometry.js +2 -2
  76. package/Build/Cesium/Workers/createPolygonGeometry.js +2 -2
  77. package/Build/Cesium/Workers/createPolygonOutlineGeometry.js +2 -2
  78. package/Build/Cesium/Workers/createPolylineGeometry.js +2 -2
  79. package/Build/Cesium/Workers/createPolylineVolumeGeometry.js +2 -2
  80. package/Build/Cesium/Workers/createPolylineVolumeOutlineGeometry.js +2 -2
  81. package/Build/Cesium/Workers/createRectangleGeometry.js +2 -2
  82. package/Build/Cesium/Workers/createRectangleOutlineGeometry.js +2 -2
  83. package/Build/Cesium/Workers/createSimplePolylineGeometry.js +2 -2
  84. package/Build/Cesium/Workers/createSphereGeometry.js +2 -2
  85. package/Build/Cesium/Workers/createSphereOutlineGeometry.js +2 -2
  86. package/Build/Cesium/Workers/createTaskProcessorWorker.js +2 -2
  87. package/Build/Cesium/Workers/createVectorTileClampedPolylines.js +2 -2
  88. package/Build/Cesium/Workers/createVectorTileGeometries.js +2 -2
  89. package/Build/Cesium/Workers/createVectorTilePoints.js +2 -2
  90. package/Build/Cesium/Workers/createVectorTilePolygons.js +2 -2
  91. package/Build/Cesium/Workers/createVectorTilePolylines.js +2 -2
  92. package/Build/Cesium/Workers/createVerticesFromGoogleEarthEnterpriseBuffer.js +2 -2
  93. package/Build/Cesium/Workers/createVerticesFromHeightmap.js +2 -2
  94. package/Build/Cesium/Workers/createVerticesFromQuantizedTerrainMesh.js +2 -2
  95. package/Build/Cesium/Workers/createWallGeometry.js +2 -2
  96. package/Build/Cesium/Workers/createWallOutlineGeometry.js +2 -2
  97. package/Build/Cesium/Workers/decodeDraco.js +2 -2
  98. package/Build/Cesium/Workers/decodeGoogleEarthEnterprisePacket.js +2 -2
  99. package/Build/Cesium/Workers/decodeI3S.js +2 -2
  100. package/Build/Cesium/Workers/transcodeKTX2.js +2 -2
  101. package/Build/Cesium/Workers/transferTypedArrayTest.js +1 -1
  102. package/Build/Cesium/Workers/upsampleQuantizedTerrainMesh.js +2 -2
  103. package/Build/Cesium/index.cjs +14681 -14681
  104. package/Build/Cesium/index.js +14676 -14676
  105. package/README.md +141 -141
  106. package/package.json +1 -1
  107. package/Build/Cesium/README.md +0 -13
@@ -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 occludee object.
1307
+ * @param sphere - The bounding sphere surrounding the occluded 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,6 +3174,7 @@ export const Check: {
3174
3174
  };
3175
3175
  };
3176
3176
  };
3177
+
3177
3178
 
3178
3179
 
3179
3180
  /**
@@ -3625,11 +3626,11 @@ export class Color {
3625
3626
  static clone(color: Color, result?: Color): Color;
3626
3627
  /**
3627
3628
  * Returns true if the first Color equals the second color.
3628
- * @param left - The first Color to compare for equality.
3629
- * @param right - The second Color to compare for equality.
3629
+ * @param [left] - The first Color to compare for equality.
3630
+ * @param [right] - The second Color to compare for equality.
3630
3631
  * @returns <code>true</code> if the Colors are equal; otherwise, <code>false</code>.
3631
3632
  */
3632
- static equals(left: Color, right: Color): boolean;
3633
+ static equals(left?: Color, right?: Color): boolean;
3633
3634
  /**
3634
3635
  * Returns a duplicate of a Color instance.
3635
3636
  * @param [result] - The object to store the result in, if undefined a new instance will be created.
@@ -3638,10 +3639,10 @@ export class Color {
3638
3639
  clone(result?: Color): Color;
3639
3640
  /**
3640
3641
  * Returns true if this Color equals other.
3641
- * @param other - The Color to compare for equality.
3642
+ * @param [other] - The Color to compare for equality.
3642
3643
  * @returns <code>true</code> if the Colors are equal; otherwise, <code>false</code>.
3643
3644
  */
3644
- equals(other: Color): boolean;
3645
+ equals(other?: Color): boolean;
3645
3646
  /**
3646
3647
  * Returns <code>true</code> if this Color equals other componentwise within the specified epsilon.
3647
3648
  * @param other - The Color to compare for equality.
@@ -5134,17 +5135,17 @@ export class Credit {
5134
5135
  readonly element: HTMLElement;
5135
5136
  /**
5136
5137
  * Returns true if the credits are equal
5137
- * @param left - The first credit
5138
- * @param right - The second credit
5138
+ * @param [left] - The first credit
5139
+ * @param [right] - The second credit
5139
5140
  * @returns <code>true</code> if left and right are equal, <code>false</code> otherwise.
5140
5141
  */
5141
- static equals(left: Credit, right: Credit): boolean;
5142
+ static equals(left?: Credit, right?: Credit): boolean;
5142
5143
  /**
5143
5144
  * Returns true if the credits are equal
5144
- * @param credit - The credit to compare to.
5145
+ * @param [credit] - The credit to compare to.
5145
5146
  * @returns <code>true</code> if left and right are equal, <code>false</code> otherwise.
5146
5147
  */
5147
- equals(credit: Credit): boolean;
5148
+ equals(credit?: Credit): boolean;
5148
5149
  /**
5149
5150
  * Duplicates a Credit instance.
5150
5151
  * @param [credit] - The Credit to duplicate.
@@ -5472,7 +5473,9 @@ export function defaultValue(a: any, b: any): any;
5472
5473
  * @param value - The object.
5473
5474
  * @returns Returns true if the object is defined, returns false otherwise.
5474
5475
  */
5475
- export function defined<Type>(value: Type): value is NonNullable<Type>;
5476
+
5477
+ export function defined<Type>(value: Type): value is NonNullable<Type>;
5478
+
5476
5479
 
5477
5480
  /**
5478
5481
  * Destroys an object. Each of the object's functions, including functions in its prototype,
@@ -5563,11 +5566,11 @@ export class DistanceDisplayCondition {
5563
5566
  static unpack(array: number[], startingIndex?: number, result?: DistanceDisplayCondition): DistanceDisplayCondition;
5564
5567
  /**
5565
5568
  * Determines if two distance display conditions are equal.
5566
- * @param left - A distance display condition.
5567
- * @param right - Another distance display condition.
5569
+ * @param [left] - A distance display condition.
5570
+ * @param [right] - Another distance display condition.
5568
5571
  * @returns Whether the two distance display conditions are equal.
5569
5572
  */
5570
- static equals(left: DistanceDisplayCondition, right: DistanceDisplayCondition): boolean;
5573
+ static equals(left?: DistanceDisplayCondition, right?: DistanceDisplayCondition): boolean;
5571
5574
  /**
5572
5575
  * Duplicates a distance display condition instance.
5573
5576
  * @param [value] - The distance display condition to duplicate.
@@ -5583,10 +5586,10 @@ export class DistanceDisplayCondition {
5583
5586
  clone(result?: DistanceDisplayCondition): DistanceDisplayCondition;
5584
5587
  /**
5585
5588
  * Determines if this distance display condition is equal to another.
5586
- * @param other - Another distance display condition.
5589
+ * @param [other] - Another distance display condition.
5587
5590
  * @returns Whether this distance display condition is equal to the other.
5588
5591
  */
5589
- equals(other: DistanceDisplayCondition): boolean;
5592
+ equals(other?: DistanceDisplayCondition): boolean;
5590
5593
  }
5591
5594
 
5592
5595
  /**
@@ -6247,7 +6250,7 @@ export class EllipsoidGeodesic {
6247
6250
  interpolateUsingFraction(fraction: number, result?: Cartographic): Cartographic;
6248
6251
  /**
6249
6252
  * Provides the location of a point at the indicated distance along the geodesic.
6250
- * @param distance - The distance from the inital point to the point of interest along the geodesic
6253
+ * @param distance - The distance from the initial point to the point of interest along the geodesic
6251
6254
  * @param [result] - The object in which to store the result.
6252
6255
  * @returns The location of the point along the geodesic.
6253
6256
  */
@@ -8010,6 +8013,27 @@ export class GoogleEarthEnterpriseTerrainProvider {
8010
8013
  loadTileDataAvailability(x: number, y: number, level: number): undefined;
8011
8014
  }
8012
8015
 
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
+
8013
8037
  /**
8014
8038
  * Default settings for accessing the Google Maps API.
8015
8039
  <br/>
@@ -8952,10 +8976,10 @@ export class Interval {
8952
8976
 
8953
8977
  /**
8954
8978
  * Default settings for accessing the Cesium ion API.
8955
-
8956
- An ion access token is only required if you are using any ion related APIs.
8957
- A default access token is provided for evaluation purposes only.
8958
- Sign up for a free ion account and get your own access token at {@link https://cesium.com}
8979
+ *
8980
+ * An ion access token is only required if you are using any ion related APIs.
8981
+ * A default access token is provided for evaluation purposes only.
8982
+ * Sign up for a free ion account and get your own access token at {@link https://cesium.com}
8959
8983
  */
8960
8984
  export namespace Ion {
8961
8985
  /**
@@ -8968,24 +8992,49 @@ export namespace Ion {
8968
8992
  var defaultServer: string | Resource;
8969
8993
  }
8970
8994
 
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
+
8971
9014
  /**
8972
9015
  * Provides geocoding through Cesium ion.
8973
9016
  * @param options - Object with the following properties:
8974
9017
  * @param options.scene - The scene
8975
9018
  * @param [options.accessToken = Ion.defaultAccessToken] - The access token to use.
8976
9019
  * @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.
8977
9021
  */
8978
9022
  export class IonGeocoderService {
8979
9023
  constructor(options: {
8980
9024
  scene: Scene;
8981
9025
  accessToken?: string;
8982
9026
  server?: string | Resource;
9027
+ geocodeProviderType?: IonGeocodeProviderType;
8983
9028
  });
8984
9029
  /**
8985
9030
  * Gets the credit to display after a geocode is performed. Typically this is used to credit
8986
9031
  the geocoder service.
8987
9032
  */
8988
9033
  readonly credit: Credit | undefined;
9034
+ /**
9035
+ * The geocoding service that Cesium ion API server should use to fulfill geocding requests.
9036
+ */
9037
+ geocodeProviderType: IonGeocodeProviderType;
8989
9038
  /**
8990
9039
  * @param query - The query to be sent to the geocoder service
8991
9040
  * @param [type = GeocodeType.SEARCH] - The type of geocode to perform.
@@ -9099,6 +9148,37 @@ export namespace Iso8601 {
9099
9148
  const MAXIMUM_INTERVAL: TimeInterval;
9100
9149
  }
9101
9150
 
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
+
9102
9182
  /**
9103
9183
  * Represents an astronomical Julian date, which is the number of days since noon on January 1, -4712 (4713 BC).
9104
9184
  For increased precision, this class stores the whole number part of the date and the seconds
@@ -12284,11 +12364,11 @@ export class OrientedBoundingBox {
12284
12364
  /**
12285
12365
  * Compares the provided OrientedBoundingBox componentwise and returns
12286
12366
  <code>true</code> if they are equal, <code>false</code> otherwise.
12287
- * @param left - The first OrientedBoundingBox.
12288
- * @param right - The second OrientedBoundingBox.
12367
+ * @param [left] - The first OrientedBoundingBox.
12368
+ * @param [right] - The second OrientedBoundingBox.
12289
12369
  * @returns <code>true</code> if left and right are equal, <code>false</code> otherwise.
12290
12370
  */
12291
- static equals(left: OrientedBoundingBox, right: OrientedBoundingBox): boolean;
12371
+ static equals(left?: OrientedBoundingBox, right?: OrientedBoundingBox): boolean;
12292
12372
  /**
12293
12373
  * Duplicates this OrientedBoundingBox instance.
12294
12374
  * @param [result] - The object onto which to store the result.
@@ -14661,11 +14741,6 @@ export class Rectangle {
14661
14741
  * @returns <code>true</code> if the Rectangles are within the provided epsilon, <code>false</code> otherwise.
14662
14742
  */
14663
14743
  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;
14669
14744
  /**
14670
14745
  * Computes the southwest corner of a rectangle.
14671
14746
  * @param rectangle - The rectangle for which to find the corner
@@ -16540,11 +16615,11 @@ export class Spherical {
16540
16615
  static normalize(spherical: Spherical, result?: Spherical): Spherical;
16541
16616
  /**
16542
16617
  * Returns true if the first spherical is equal to the second spherical, false otherwise.
16543
- * @param left - The first Spherical to be compared.
16544
- * @param right - The second Spherical to be compared.
16618
+ * @param [left] - The first Spherical to be compared.
16619
+ * @param [right] - The second Spherical to be compared.
16545
16620
  * @returns true if the first spherical is equal to the second spherical, false otherwise.
16546
16621
  */
16547
- static equals(left: Spherical, right: Spherical): boolean;
16622
+ static equals(left?: Spherical, right?: Spherical): boolean;
16548
16623
  /**
16549
16624
  * Returns true if the first spherical is within the provided epsilon of the second spherical, false otherwise.
16550
16625
  * @param left - The first Spherical to be compared.
@@ -16555,10 +16630,10 @@ export class Spherical {
16555
16630
  static equalsEpsilon(left: Spherical, right: Spherical, epsilon?: number): boolean;
16556
16631
  /**
16557
16632
  * Returns true if this spherical is equal to the provided spherical, false otherwise.
16558
- * @param other - The Spherical to be compared.
16633
+ * @param [other] - The Spherical to be compared.
16559
16634
  * @returns true if this spherical is equal to the provided spherical, false otherwise.
16560
16635
  */
16561
- equals(other: Spherical): boolean;
16636
+ equals(other?: Spherical): boolean;
16562
16637
  /**
16563
16638
  * Creates a duplicate of this Spherical.
16564
16639
  * @param [result] - The object to store the result into, if undefined a new instance will be created.
@@ -17599,6 +17674,34 @@ export enum TimeStandard {
17599
17674
  TAI = 1
17600
17675
  }
17601
17676
 
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
+
17602
17705
  /**
17603
17706
  * Contains functions for transforming positions to various reference frames.
17604
17707
  */
@@ -18661,7 +18764,6 @@ If text is blank, returns undefined.
18661
18764
  * @param text - The text to write.
18662
18765
  * @param [options] - Object with the following properties:
18663
18766
  * @param [options.font = '10px sans-serif'] - The CSS font to use.
18664
- * @param [options.textBaseline = 'bottom'] - The baseline of the text.
18665
18767
  * @param [options.fill = true] - Whether to fill the text.
18666
18768
  * @param [options.stroke = false] - Whether to stroke the text.
18667
18769
  * @param [options.fillColor = Color.WHITE] - The fill color.
@@ -18675,7 +18777,6 @@ If text is blank, returns undefined.
18675
18777
  */
18676
18778
  export function writeTextToCanvas(text: string, options?: {
18677
18779
  font?: string;
18678
- textBaseline?: string;
18679
18780
  fill?: boolean;
18680
18781
  stroke?: boolean;
18681
18782
  fillColor?: Color;
@@ -18941,6 +19042,21 @@ export class BillboardVisualizer {
18941
19042
  destroy(): void;
18942
19043
  }
18943
19044
 
19045
+ /**
19046
+ * The BoundingSphere has been computed.
19047
+ */
19048
+ export const DONE = 0;
19049
+
19050
+ /**
19051
+ * The BoundingSphere is still being computed.
19052
+ */
19053
+ export const PENDING = 1;
19054
+
19055
+ /**
19056
+ * The BoundingSphere does not exist.
19057
+ */
19058
+ export const FAILED = 2;
19059
+
18944
19060
  /**
18945
19061
  * A {@link GeometryUpdater} for boxes.
18946
19062
  Clients do not normally create this class directly, but instead rely on {@link DataSourceDisplay}.
@@ -20338,10 +20454,10 @@ export class DataSourceClock {
20338
20454
  clone(result?: DataSourceClock): DataSourceClock;
20339
20455
  /**
20340
20456
  * Returns true if this DataSourceClock is equivalent to the other
20341
- * @param other - The other DataSourceClock to compare to.
20457
+ * @param [other] - The other DataSourceClock to compare to.
20342
20458
  * @returns <code>true</code> if the DataSourceClocks are equal; otherwise, <code>false</code>.
20343
20459
  */
20344
- equals(other: DataSourceClock): boolean;
20460
+ equals(other?: DataSourceClock): boolean;
20345
20461
  /**
20346
20462
  * Assigns each unassigned property on this object to the value
20347
20463
  of the same property on the provided source object.
@@ -20905,6 +21021,7 @@ export namespace Entity {
20905
21021
  * @property [name] - A human readable name to display to users. It does not have to be unique.
20906
21022
  * @property [availability] - The availability, if any, associated with this object.
20907
21023
  * @property [show] - A boolean value indicating if the entity and its children are displayed.
21024
+ * @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).
20908
21025
  * @property [description] - A string Property specifying an HTML description for this entity.
20909
21026
  * @property [position] - A Property specifying the entity position.
20910
21027
  * @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.
@@ -20934,8 +21051,9 @@ export namespace Entity {
20934
21051
  name?: string;
20935
21052
  availability?: TimeIntervalCollection;
20936
21053
  show?: boolean;
21054
+ trackingReferenceFrame?: TrackingReferenceFrame;
20937
21055
  description?: Property | string;
20938
- position?: PositionProperty | Cartesian3 | CallbackProperty;
21056
+ position?: PositionProperty | Cartesian3 | CallbackPositionProperty;
20939
21057
  orientation?: Property | Quaternion;
20940
21058
  viewFrom?: Property | Cartesian3;
20941
21059
  parent?: Entity;
@@ -21000,6 +21118,10 @@ export class Entity {
21000
21118
  the entity is only displayed if the parent entity's show property is also true.
21001
21119
  */
21002
21120
  show: boolean;
21121
+ /**
21122
+ * Gets or sets the entity's tracking reference frame.
21123
+ */
21124
+ trackingReferenceFrame: TrackingReferenceFrame;
21003
21125
  /**
21004
21126
  * Gets whether this entity is being displayed, taking into account
21005
21127
  the visibility of any ancestor entities.
@@ -22711,6 +22833,7 @@ export namespace ModelGraphics {
22711
22833
  * @property [colorBlendMode = ColorBlendMode.HIGHLIGHT] - An enum Property specifying how the color blends with the model.
22712
22834
  * @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.
22713
22835
  * @property [imageBasedLightingFactor = new Cartesian2(1.0, 1.0)] - A property specifying the contribution from diffuse and specular image-based lighting.
22836
+ * @property [environmentMapOptions] - The properties for managing dynamic environment maps on this entity.
22714
22837
  * @property [lightColor] - A property specifying the light color when shading the model. When <code>undefined</code> the scene's light color is used instead.
22715
22838
  * @property [distanceDisplayCondition] - A Property specifying at what distance from the camera that this model will be displayed.
22716
22839
  * @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.
@@ -22736,6 +22859,9 @@ export namespace ModelGraphics {
22736
22859
  colorBlendMode?: Property | ColorBlendMode;
22737
22860
  colorBlendAmount?: Property | number;
22738
22861
  imageBasedLightingFactor?: Property | Cartesian2;
22862
+ environmentMapOptions?: PropertyBag | {
22863
+ [key: string]: any;
22864
+ };
22739
22865
  lightColor?: Property | Color;
22740
22866
  distanceDisplayCondition?: Property | DistanceDisplayCondition;
22741
22867
  nodeTransformations?: PropertyBag | {
@@ -22843,6 +22969,10 @@ export class ModelGraphics {
22843
22969
  * A property specifying the {@link Cartesian2} used to scale the diffuse and specular image-based lighting contribution to the final color.
22844
22970
  */
22845
22971
  imageBasedLightingFactor: Property | undefined;
22972
+ /**
22973
+ * Gets or sets the {@link DynamicEnvironmentMapManager.ConstructorOptions} to apply to this model. This is represented as an {@link PropertyBag}.
22974
+ */
22975
+ environmentMapOptions: PropertyBag;
22846
22976
  /**
22847
22977
  * A property specifying the {@link Cartesian3} light color when shading the model. When <code>undefined</code> the scene's light color is used instead.
22848
22978
  */
@@ -24933,6 +25063,12 @@ export class SampledProperty {
24933
25063
  * @param [derivativeValues] - An array where each item is the array of derivatives at the equivalent time index.
24934
25064
  */
24935
25065
  addSamples(times: JulianDate[], values: Packable[], derivativeValues?: any[][]): void;
25066
+ /**
25067
+ * Retrieves the time of the provided sample associated with the index. A negative index accesses the list of samples in reverse order.
25068
+ * @param index - The index of samples list.
25069
+ * @returns The JulianDate time of the sample, or undefined if failed.
25070
+ */
25071
+ getSample(index: number): JulianDate | undefined;
24936
25072
  /**
24937
25073
  * Adds samples as a single packed array where each new sample is represented as a date,
24938
25074
  followed by the packed representation of the corresponding value and derivatives.
@@ -25854,11 +25990,11 @@ export class ArcGisMapServerImageryProvider {
25854
25990
 
25855
25991
  /**
25856
25992
  * Default options for accessing the ArcGIS image tile service.
25857
-
25858
- An ArcGIS access token is required to access ArcGIS image tile layers.
25859
- A default token is provided for evaluation purposes only.
25860
- To obtain an access token, go to {@link https://developers.arcgis.com} and create a free account.
25861
- More info can be found in the {@link https://developers.arcgis.com/documentation/mapping-apis-and-services/security/ | ArcGIS developer guide}.
25993
+ *
25994
+ * An ArcGIS access token is required to access ArcGIS image tile layers.
25995
+ * A default token is provided for evaluation purposes only.
25996
+ * To obtain an access token, go to {@link https://developers.arcgis.com} and create a free account.
25997
+ * More info can be found in the {@link https://developers.arcgis.com/documentation/mapping-apis-and-services/security/ | ArcGIS developer guide}.
25862
25998
  */
25863
25999
  export namespace ArcGisMapService {
25864
26000
  /**
@@ -25953,6 +26089,12 @@ export class Atmosphere {
25953
26089
  be used for dynamically lighting all atmosphere-related rendering effects.
25954
26090
  */
25955
26091
  dynamicLighting: DynamicAtmosphereLightingType;
26092
+ /**
26093
+ * Returns <code>true</code> if the atmosphere shader requires a color correct step.
26094
+ * @param atmosphere - The atmosphere instance to check
26095
+ * @returns true if the atmosphere shader requires a color correct step
26096
+ */
26097
+ static requiresColorCorrect(atmosphere: Atmosphere): boolean;
25956
26098
  }
25957
26099
 
25958
26100
  /**
@@ -26349,10 +26491,10 @@ export class Billboard {
26349
26491
  /**
26350
26492
  * Determines if this billboard equals another billboard. Billboards are equal if all their properties
26351
26493
  are equal. Billboards in different collections can be equal.
26352
- * @param other - The billboard to compare for equality.
26494
+ * @param [other] - The billboard to compare for equality.
26353
26495
  * @returns <code>true</code> if the billboards are equal; otherwise, <code>false</code>.
26354
26496
  */
26355
- equals(other: Billboard): boolean;
26497
+ equals(other?: Billboard): boolean;
26356
26498
  }
26357
26499
 
26358
26500
  /**
@@ -27712,10 +27854,10 @@ export enum CameraEventType {
27712
27854
 
27713
27855
  /**
27714
27856
  * A tile in a {@link Cesium3DTileset}. When a tile is first created, its content is not loaded;
27715
- the content is loaded on-demand when needed based on the view.
27716
- <p>
27717
- Do not construct this directly, instead access tiles through {@link Cesium3DTileset#tileVisible}.
27718
- </p>
27857
+ * the content is loaded on-demand when needed based on the view.
27858
+ * <p>
27859
+ * Do not construct this directly, instead access tiles through {@link Cesium3DTileset#tileVisible}.
27860
+ * </p>
27719
27861
  * @param tileset - The tileset
27720
27862
  * @param baseResource - The base resource for the tileset
27721
27863
  * @param header - The JSON header for the tile
@@ -27733,7 +27875,7 @@ export class Cesium3DTile {
27733
27875
  readonly computedTransform: Matrix4;
27734
27876
  /**
27735
27877
  * The error, in meters, introduced if this tile is rendered and its children are not.
27736
- This is used to compute screen space error, i.e., the error measured in pixels.
27878
+ * This is used to compute screen space error, i.e., the error measured in pixels.
27737
27879
  */
27738
27880
  readonly geometricError: number;
27739
27881
  /**
@@ -27742,11 +27884,11 @@ export class Cesium3DTile {
27742
27884
  readonly children: Cesium3DTile[];
27743
27885
  /**
27744
27886
  * This tile's parent or <code>undefined</code> if this tile is the root.
27745
- <p>
27746
- When a tile's content points to an external tileset JSON file, the external tileset's
27747
- root tile's parent is not <code>undefined</code>; instead, the parent references
27748
- the tile (with its content pointing to an external tileset JSON file) as if the two tilesets were merged.
27749
- </p>
27887
+ * <p>
27888
+ * When a tile's content points to an external tileset JSON file, the external tileset's
27889
+ * root tile's parent is not <code>undefined</code>; instead, the parent references
27890
+ * the tile (with its content pointing to an external tileset JSON file) as if the two tilesets were merged.
27891
+ * </p>
27750
27892
  */
27751
27893
  readonly parent: Cesium3DTile;
27752
27894
  /**
@@ -27763,7 +27905,7 @@ export class Cesium3DTile {
27763
27905
  readonly tileset: Cesium3DTileset;
27764
27906
  /**
27765
27907
  * The tile's content. This represents the actual tile's payload,
27766
- not the content's metadata in the tileset JSON file.
27908
+ * not the content's metadata in the tileset JSON file.
27767
27909
  */
27768
27910
  readonly content: Cesium3DTileContent;
27769
27911
  /**
@@ -27772,7 +27914,7 @@ export class Cesium3DTile {
27772
27914
  readonly boundingSphere: BoundingSphere;
27773
27915
  /**
27774
27916
  * Returns the <code>extras</code> property in the tileset JSON for this tile, which contains application specific metadata.
27775
- Returns <code>undefined</code> if <code>extras</code> does not exist.
27917
+ * Returns <code>undefined</code> if <code>extras</code> does not exist.
27776
27918
  */
27777
27919
  readonly extras: any;
27778
27920
  /**
@@ -28333,6 +28475,7 @@ export namespace Cesium3DTileset {
28333
28475
  * @property [pointCloudShading] - Options for constructing a {@link PointCloudShading} object to control point attenuation based on geometric error and lighting.
28334
28476
  * @property [lightColor] - The light color when shading models. When <code>undefined</code> the scene's light color is used instead.
28335
28477
  * @property [imageBasedLighting] - The properties for managing image-based lighting for this tileset.
28478
+ * @property [environmentMapOptions] - The properties for managing dynamic environment maps on this tileset.
28336
28479
  * @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.
28337
28480
  * @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.
28338
28481
  * @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.
@@ -28397,6 +28540,7 @@ export namespace Cesium3DTileset {
28397
28540
  pointCloudShading?: any;
28398
28541
  lightColor?: Cartesian3;
28399
28542
  imageBasedLighting?: ImageBasedLighting;
28543
+ environmentMapOptions?: DynamicEnvironmentMapManager.ConstructorOptions;
28400
28544
  backFaceCulling?: boolean;
28401
28545
  enableShowOutline?: boolean;
28402
28546
  showOutline?: boolean;
@@ -29125,6 +29269,14 @@ export class Cesium3DTileset {
29125
29269
  * The properties for managing image-based lighting on this tileset.
29126
29270
  */
29127
29271
  imageBasedLighting: ImageBasedLighting;
29272
+ /**
29273
+ * The properties for managing dynamic environment maps on this model. Affects lighting.
29274
+ * @example
29275
+ * // Change the ground color used for a tileset's environment map to a forest green
29276
+ const environmentMapManager = tileset.environmentMapManager;
29277
+ environmentMapManager.groundColor = Cesium.Color.fromCssColorString("#203b34");
29278
+ */
29279
+ readonly environmentMapManager: DynamicEnvironmentMapManager;
29128
29280
  /**
29129
29281
  * Indicates that only the tileset's vector tiles should be used for classification.
29130
29282
  */
@@ -29964,12 +30116,12 @@ export class Cesium3DTileStyle {
29964
30116
 
29965
30117
  /**
29966
30118
  * A {@link VoxelProvider} that fetches voxel data from a 3D Tiles tileset.
29967
- <p>
29968
- Implements the {@link VoxelProvider} interface.
29969
- </p>
29970
- <div class="notice">
29971
- This object is normally not instantiated directly, use {@link Cesium3DTilesVoxelProvider.fromUrl}.
29972
- </div>
30119
+ * <p>
30120
+ * Implements the {@link VoxelProvider} interface.
30121
+ * </p>
30122
+ * <div class="notice">
30123
+ * This object is normally not instantiated directly, use {@link Cesium3DTilesVoxelProvider.fromUrl}.
30124
+ * </div>
29973
30125
  * @param options - Object with the following properties:
29974
30126
  */
29975
30127
  export class Cesium3DTilesVoxelProvider extends VoxelProvider {
@@ -29990,69 +30142,69 @@ export class Cesium3DTilesVoxelProvider extends VoxelProvider {
29990
30142
  readonly shapeTransform: Matrix4 | undefined;
29991
30143
  /**
29992
30144
  * Gets the {@link VoxelShapeType}
29993
- This should not be called before {@link VoxelProvider#ready} returns true.
30145
+ * This should not be called before {@link VoxelProvider#ready} returns true.
29994
30146
  */
29995
30147
  readonly shape: VoxelShapeType;
29996
30148
  /**
29997
30149
  * Gets the minimum bounds.
29998
- If undefined, the shape's default minimum bounds will be used instead.
29999
- This should not be called before {@link VoxelProvider#ready} returns true.
30150
+ * If undefined, the shape's default minimum bounds will be used instead.
30151
+ * This should not be called before {@link VoxelProvider#ready} returns true.
30000
30152
  */
30001
30153
  readonly minBounds: Cartesian3 | undefined;
30002
30154
  /**
30003
30155
  * Gets the maximum bounds.
30004
- If undefined, the shape's default maximum bounds will be used instead.
30005
- This should not be called before {@link VoxelProvider#ready} returns true.
30156
+ * If undefined, the shape's default maximum bounds will be used instead.
30157
+ * This should not be called before {@link VoxelProvider#ready} returns true.
30006
30158
  */
30007
30159
  readonly maxBounds: Cartesian3 | undefined;
30008
30160
  /**
30009
30161
  * Gets the number of voxels per dimension of a tile. This is the same for all tiles in the dataset.
30010
- This should not be called before {@link VoxelProvider#ready} returns true.
30162
+ * This should not be called before {@link VoxelProvider#ready} returns true.
30011
30163
  */
30012
30164
  readonly dimensions: Cartesian3;
30013
30165
  /**
30014
30166
  * Gets the number of padding voxels before the tile. This improves rendering quality when sampling the edge of a tile, but it increases memory usage.
30015
- This should not be called before {@link VoxelProvider#ready} returns true.
30167
+ * This should not be called before {@link VoxelProvider#ready} returns true.
30016
30168
  */
30017
30169
  readonly paddingBefore: Cartesian3 | undefined;
30018
30170
  /**
30019
30171
  * Gets the number of padding voxels after the tile. This improves rendering quality when sampling the edge of a tile, but it increases memory usage.
30020
- This should not be called before {@link VoxelProvider#ready} returns true.
30172
+ * This should not be called before {@link VoxelProvider#ready} returns true.
30021
30173
  */
30022
30174
  readonly paddingAfter: Cartesian3 | undefined;
30023
30175
  /**
30024
30176
  * Gets the metadata names.
30025
- This should not be called before {@link VoxelProvider#ready} returns true.
30177
+ * This should not be called before {@link VoxelProvider#ready} returns true.
30026
30178
  */
30027
30179
  readonly names: string[];
30028
30180
  /**
30029
30181
  * Gets the metadata types.
30030
- This should not be called before {@link VoxelProvider#ready} returns true.
30182
+ * This should not be called before {@link VoxelProvider#ready} returns true.
30031
30183
  */
30032
30184
  readonly types: MetadataType[];
30033
30185
  /**
30034
30186
  * Gets the metadata component types.
30035
- This should not be called before {@link VoxelProvider#ready} returns true.
30187
+ * This should not be called before {@link VoxelProvider#ready} returns true.
30036
30188
  */
30037
30189
  readonly componentTypes: MetadataComponentType[];
30038
30190
  /**
30039
30191
  * Gets the metadata minimum values.
30040
- This should not be called before {@link VoxelProvider#ready} returns true.
30192
+ * This should not be called before {@link VoxelProvider#ready} returns true.
30041
30193
  */
30042
30194
  readonly minimumValues: number[][] | undefined;
30043
30195
  /**
30044
30196
  * Gets the metadata maximum values.
30045
- This should not be called before {@link VoxelProvider#ready} returns true.
30197
+ * This should not be called before {@link VoxelProvider#ready} returns true.
30046
30198
  */
30047
30199
  readonly maximumValues: number[][] | undefined;
30048
30200
  /**
30049
30201
  * The maximum number of tiles that exist for this provider. This value is used as a hint to the voxel renderer to allocate an appropriate amount of GPU memory. If this value is not known it can be undefined.
30050
- This should not be called before {@link VoxelProvider#ready} returns true.
30202
+ * This should not be called before {@link VoxelProvider#ready} returns true.
30051
30203
  */
30052
30204
  readonly maximumTileCount: number | undefined;
30053
30205
  /**
30054
30206
  * Requests the data for a given tile. The data is a flattened 3D array ordered by X, then Y, then Z.
30055
- This function should not be called before {@link VoxelProvider#ready} returns true.
30207
+ * This function should not be called before {@link VoxelProvider#ready} returns true.
30056
30208
  * @param [options] - Object with the following properties:
30057
30209
  * @param [options.tileLevel = 0] - The tile's level.
30058
30210
  * @param [options.tileX = 0] - The tile's X coordinate.
@@ -30510,7 +30662,7 @@ export class ClippingPolygon {
30510
30662
  * @param right - The second polygon.
30511
30663
  * @returns <code>true</code> if left and right are equal, <code>false</code> otherwise.
30512
30664
  */
30513
- static equals(left: Plane, right: Plane): boolean;
30665
+ static equals(left: ClippingPolygon, right: ClippingPolygon): boolean;
30514
30666
  /**
30515
30667
  * Computes a cartographic rectangle which encloses the polygon defined by the list of positions, including cases over the international date line and the poles.
30516
30668
  * @param [result] - An object in which to store the result.
@@ -30979,32 +31131,50 @@ export function createElevationBandMaterial(options: {
30979
31131
  }): Material;
30980
31132
 
30981
31133
  /**
30982
- * Creates a {@link Cesium3DTileset} instance for the Google Photorealistic 3D Tiles tileset.
31134
+ * Creates a {@link Cesium3DTileset} instance for the Google Photorealistic 3D
31135
+ * Tiles tileset.
31136
+ *
31137
+ * Google Photorealistic 3D Tiles can only be used with the Google geocoder. To
31138
+ * confirm that you are aware of this restriction pass
31139
+ * `usingOnlyWithGoogleGeocoder: true` to the apiOptions. Otherwise a one time
31140
+ * warning will be displayed when this function is called.
30983
31141
  * @example
30984
- * const viewer = new Cesium.Viewer("cesiumContainer");
30985
-
30986
- try {
30987
- const tileset = await Cesium.createGooglePhotorealistic3DTileset();
30988
- viewer.scene.primitives.add(tileset));
30989
- } catch (error) {
30990
- console.log(`Error creating tileset: ${error}`);
30991
- }
31142
+ * const viewer = new Cesium.Viewer("cesiumContainer", {
31143
+ * geocoder: Cesium.IonGeocodeProviderType.GOOGLE
31144
+ * });
31145
+ *
31146
+ * try {
31147
+ * const tileset = await Cesium.createGooglePhotorealistic3DTileset({
31148
+ * onlyUsingWithGoogleGeocoder: true,
31149
+ * });
31150
+ * viewer.scene.primitives.add(tileset));
31151
+ * } catch (error) {
31152
+ * console.log(`Error creating tileset: ${error}`);
31153
+ * }
30992
31154
  * @example
30993
31155
  * // Use your own Google Maps API key
30994
- Cesium.GoogleMaps.defaultApiKey = "your-api-key";
30995
-
30996
- const viewer = new Cesium.Viewer("cesiumContainer");
30997
-
30998
- try {
30999
- const tileset = await Cesium.createGooglePhotorealistic3DTileset();
31000
- viewer.scene.primitives.add(tileset));
31001
- } catch (error) {
31002
- console.log(`Error creating tileset: ${error}`);
31003
- }
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.
31006
- */
31007
- export function createGooglePhotorealistic3DTileset(key?: string, options?: Cesium3DTileset.ConstructorOptions): Promise<Cesium3DTileset>;
31156
+ * Cesium.GoogleMaps.defaultApiKey = "your-api-key";
31157
+ *
31158
+ * const viewer = new Cesium.Viewer("cesiumContainer". {
31159
+ * geocoder: Cesium.IonGeocodeProviderType.GOOGLE
31160
+ * });
31161
+ *
31162
+ * try {
31163
+ * const tileset = await Cesium.createGooglePhotorealistic3DTileset({
31164
+ * onlyUsingWithGoogleGeocoder: true,
31165
+ * });
31166
+ * viewer.scene.primitives.add(tileset));
31167
+ * } catch (error) {
31168
+ * console.log(`Error creating tileset: ${error}`);
31169
+ * }
31170
+ * @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.
31171
+ * @param [apiOptions.onlyUsingWithGoogleGeocoder] - Confirmation that this tileset will only be used with the Google geocoder.
31172
+ * @param [tilesetOptions] - An object describing initialization options.
31173
+ */
31174
+ export function createGooglePhotorealistic3DTileset(apiOptions?: {
31175
+ key?: string;
31176
+ onlyUsingWithGoogleGeocoder?: true;
31177
+ }, tilesetOptions?: Cesium3DTileset.ConstructorOptions): Promise<Cesium3DTileset>;
31008
31178
 
31009
31179
  /**
31010
31180
  * Creates a {@link Cesium3DTileset} instance for the
@@ -31608,6 +31778,47 @@ for a property texture property with the given class property
31608
31778
  */
31609
31779
  export function getGlslType(classProperty: MetadataClassProperty): string;
31610
31780
 
31781
+ /**
31782
+ * Returns a shader statement that applies the inverse of the
31783
+ value transform to the given value, based on the given offset
31784
+ and scale.
31785
+ * @param input - The input value
31786
+ * @param offset - The offset
31787
+ * @param scale - The scale
31788
+ * @returns The statement
31789
+ */
31790
+ export function unapplyValueTransform(input: string, offset: string, scale: string): string;
31791
+
31792
+ /**
31793
+ * Returns a shader statement that applies the inverse of the
31794
+ normalization, based on the given component type
31795
+ * @param input - The input value
31796
+ * @param componentType - The component type
31797
+ * @returns The statement
31798
+ */
31799
+ export function unnormalize(input: string, componentType: string): string;
31800
+
31801
+ /**
31802
+ * Creates a shader statement that returns the value of the specified
31803
+ property, normalized to the range [0, 1].
31804
+ * @param classProperty - The class property
31805
+ * @param metadataProperty - The metadata property, either
31806
+ a `PropertyTextureProperty` or a `PropertyAttributeProperty`
31807
+ * @returns The string
31808
+ */
31809
+ export function getSourceValueStringScalar(classProperty: MetadataClassProperty, metadataProperty: any): string;
31810
+
31811
+ /**
31812
+ * Creates a shader statement that returns the value of the specified
31813
+ component of the given property, normalized to the range [0, 1].
31814
+ * @param classProperty - The class property
31815
+ * @param metadataProperty - The metadata property, either
31816
+ a `PropertyTextureProperty` or a `PropertyAttributeProperty`
31817
+ * @param componentName - The name, in ["x", "y", "z", "w"]
31818
+ * @returns The string
31819
+ */
31820
+ export function getSourceValueStringComponent(classProperty: MetadataClassProperty, metadataProperty: any, componentName: string): string;
31821
+
31611
31822
  /**
31612
31823
  * A light that gets emitted in a single direction from infinitely far away.
31613
31824
  * @param options - Object with the following properties:
@@ -31711,6 +31922,136 @@ export enum DynamicAtmosphereLightingType {
31711
31922
  SUNLIGHT = 2
31712
31923
  }
31713
31924
 
31925
+ export namespace DynamicEnvironmentMapManager {
31926
+ /**
31927
+ * Options for the DynamicEnvironmentMapManager constructor
31928
+ * @property [enabled = true] - If true, the environment map and related properties will continue to update.
31929
+ * @property [mipmapLevels = 7] - The number of mipmap levels to generate for specular maps. More mipmap levels will produce a higher resolution specular reflection.
31930
+ * @property [maximumSecondsDifference = 3600] - The maximum amount of elapsed seconds before a new environment map is created.
31931
+ * @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.
31932
+ * @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.
31933
+ * @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.
31934
+ * @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.
31935
+ * @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.
31936
+ * @property [groundColor = DynamicEnvironmentMapManager.AVERAGE_EARTH_GROUND_COLOR] - Solid color used to represent the ground.
31937
+ * @property [groundAlbedo = 0.31] - The percentage of light reflected from the ground. The average earth albedo is 0.31.
31938
+ */
31939
+ type ConstructorOptions = {
31940
+ enabled?: boolean;
31941
+ mipmapLevels?: number;
31942
+ maximumSecondsDifference?: number;
31943
+ maximumPositionEpsilon?: number;
31944
+ atmosphereScatteringIntensity?: number;
31945
+ gamma?: number;
31946
+ brightness?: number;
31947
+ saturation?: number;
31948
+ groundColor?: Color;
31949
+ groundAlbedo?: number;
31950
+ };
31951
+ }
31952
+
31953
+ /**
31954
+ * 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.
31955
+ * @example
31956
+ * // Enable time-of-day environment mapping in a scene
31957
+ scene.atmosphere.dynamicLighting = Cesium.DynamicAtmosphereLightingType.SUNLIGHT;
31958
+
31959
+ // Decrease the directional lighting contribution
31960
+ scene.light.intensity = 0.5
31961
+
31962
+ // Increase the intensity of of the environment map lighting contribution
31963
+ const environmentMapManager = tileset.environmentMapManager;
31964
+ environmentMapManager.atmosphereScatteringIntensity = 3.0;
31965
+ * @example
31966
+ * // Change the ground color used for a model's environment map to a forest green
31967
+ const environmentMapManager = model.environmentMapManager;
31968
+ environmentMapManager.groundColor = Cesium.Color.fromCssColorString("#203b34");
31969
+ * @param [options] - An object describing initialization options.
31970
+ */
31971
+ export class DynamicEnvironmentMapManager {
31972
+ constructor(options?: DynamicEnvironmentMapManager.ConstructorOptions);
31973
+ /**
31974
+ * If true, the environment map and related properties will continue to update.
31975
+ */
31976
+ enabled: boolean;
31977
+ /**
31978
+ * The maximum amount of elapsed seconds before a new environment map is created.
31979
+ */
31980
+ maximumSecondsDifference: number;
31981
+ /**
31982
+ * The maximum difference in position before a new environment map is created, in meters. Small differences in position will not visibly affect results.
31983
+ */
31984
+ maximumPositionEpsilon: number;
31985
+ /**
31986
+ * The intensity of the scattered light emitted from the atmosphere. This should be adjusted relative to the value of {@link Scene.light} intensity.
31987
+ */
31988
+ atmosphereScatteringIntensity: number;
31989
+ /**
31990
+ * The gamma correction to apply to the range of light emitted from the environment. 1.0 uses the unmodified incoming light color.
31991
+ */
31992
+ gamma: number;
31993
+ /**
31994
+ * The brightness of light emitted from the environment. 1.0 uses the unmodified emitted environment color. Less than 1.0
31995
+ makes the light darker while greater than 1.0 makes it brighter.
31996
+ */
31997
+ brightness: number;
31998
+ /**
31999
+ * The saturation of the light emitted from the environment. 1.0 uses the unmodified emitted environment color. Less than 1.0 reduces the
32000
+ saturation while greater than 1.0 increases it.
32001
+ */
32002
+ saturation: number;
32003
+ /**
32004
+ * Solid color used to represent the ground.
32005
+ */
32006
+ groundColor: Color;
32007
+ /**
32008
+ * The percentage of light reflected from the ground. The average earth albedo is 0.31.
32009
+ */
32010
+ groundAlbedo: number;
32011
+ /**
32012
+ * The position around which the environment map is generated.
32013
+ */
32014
+ position: Cartesian3 | undefined;
32015
+ /**
32016
+ * Returns true if this object was destroyed; otherwise, false.
32017
+ <br /><br />
32018
+ If this object was destroyed, it should not be used; calling any function other than
32019
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
32020
+ * @returns <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
32021
+ */
32022
+ isDestroyed(): boolean;
32023
+ /**
32024
+ * Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
32025
+ release of WebGL resources, instead of relying on the garbage collector to destroy this object.
32026
+ <br /><br />
32027
+ Once an object is destroyed, it should not be used; calling any function other than
32028
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
32029
+ assign the return value (<code>undefined</code>) to the object as done in the example.
32030
+ * @example
32031
+ * mapManager = mapManager && mapManager.destroy();
32032
+ */
32033
+ destroy(): void;
32034
+ /**
32035
+ * Returns <code>true</code> if dynamic updates are supported in the current WebGL rendering context.
32036
+ Dynamic updates requires the EXT_color_buffer_float or EXT_color_buffer_half_float extension.
32037
+ * @param scene - The object containing the rendering context
32038
+ * @returns true if supported
32039
+ */
32040
+ static isDynamicUpdateSupported(scene: Scene): boolean;
32041
+ /**
32042
+ * Average hue of ground color on earth, a warm green-gray.
32043
+ */
32044
+ static readonly AVERAGE_EARTH_GROUND_COLOR: Color;
32045
+ /**
32046
+ * The default third order spherical harmonic coefficients used for the diffuse color of image-based lighting, a white ambient light with low intensity.
32047
+ <p>
32048
+ There are nine <code>Cartesian3</code> coefficients.
32049
+ 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>
32050
+ </p>
32051
+ */
32052
+ static readonly DEFAULT_SPHERICAL_HARMONIC_COEFFICIENTS: Cartesian3[];
32053
+ }
32054
+
31714
32055
  /**
31715
32056
  * An appearance for geometry on the surface of the ellipsoid like {@link PolygonGeometry}
31716
32057
  and {@link RectangleGeometry}, which supports all materials like {@link MaterialAppearance}
@@ -31894,11 +32235,18 @@ export class Fog {
31894
32235
  constructor();
31895
32236
  /**
31896
32237
  * <code>true</code> if fog is enabled, <code>false</code> otherwise.
32238
+ * @example
32239
+ * // Disable fog in the scene
32240
+ viewer.scene.fog.enabled = false;
31897
32241
  */
31898
32242
  enabled: boolean;
31899
32243
  /**
31900
32244
  * <code>true</code> if fog is renderable in shaders, <code>false</code> otherwise.
31901
32245
  This allows to benefits from optimized tile loading strategy based on fog density without the actual visual rendering.
32246
+ * @example
32247
+ * // Use fog culling but don't render it
32248
+ viewer.scene.fog.enabled = true;
32249
+ viewer.scene.fog.renderable = false;
31902
32250
  */
31903
32251
  renderable: boolean;
31904
32252
  /**
@@ -31907,8 +32255,27 @@ export class Fog {
31907
32255
  The more dense the fog is, the more aggressively the terrain is culled. For example, if the camera is a height of
31908
32256
  1000.0m above the ellipsoid, increasing the value to 3.0e-3 will cause many tiles close to the viewer be culled.
31909
32257
  Decreasing the value will push the fog further from the viewer, but decrease performance as more of the terrain is rendered.
32258
+ * @example
32259
+ * // Double the default fog density
32260
+ viewer.scene.fog.density = 0.0012;
31910
32261
  */
31911
32262
  density: number;
32263
+ /**
32264
+ * A scalar used in the function to adjust density based on the height of the camera above the terrain.
32265
+ */
32266
+ heightScalar: number;
32267
+ /**
32268
+ * The maximum height fog is applied. If the camera is above this height fog will be disabled.
32269
+ */
32270
+ maxHeight: number;
32271
+ /**
32272
+ * A scalar that impacts the visual density of fog. This value does not impact the culling of terrain.
32273
+ Use in combination with the {@link Fog.density} to make fog appear more or less dense.
32274
+ * @example
32275
+ * // Increase fog appearance effect
32276
+ viewer.scene.fog.visualDensityScalar = 0.6;
32277
+ */
32278
+ visualDensityScalar: number;
31912
32279
  /**
31913
32280
  * A factor used to increase the screen space error of terrain tiles when they are partially in fog. The effect is to reduce
31914
32281
  the number of terrain tiles requested for rendering. If set to zero, the feature will be disabled. If the value is increased
@@ -31921,6 +32288,11 @@ export class Fog {
31921
32288
  the brightness at all.
31922
32289
  */
31923
32290
  minimumBrightness: number;
32291
+ /**
32292
+ * 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.
32293
+ Value must be greater than 0.
32294
+ */
32295
+ heightFalloff: number;
31924
32296
  }
31925
32297
 
31926
32298
  /**
@@ -33847,7 +34219,6 @@ If a model or tileset creates an instance of ImageBasedLighting, it will handle
33847
34219
  Otherwise, the application is responsible for calling destroy().
33848
34220
  </p>
33849
34221
  * @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.
33851
34222
  * @param [options.sphericalHarmonicCoefficients] - The third order spherical harmonic coefficients used for the diffuse color of image-based lighting.
33852
34223
  * @param [options.specularEnvironmentMaps] - A URL to a KTX2 file that contains a cube map of the specular lighting and the convoluted specular mipmaps.
33853
34224
  */
@@ -33860,13 +34231,6 @@ export class ImageBasedLighting {
33860
34231
  disable those light sources.
33861
34232
  */
33862
34233
  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;
33870
34234
  /**
33871
34235
  * The third order spherical harmonic coefficients used for the diffuse color of image-based lighting. When <code>undefined</code>, a diffuse irradiance
33872
34236
  computed from the atmosphere color is used.
@@ -34196,10 +34560,10 @@ export class ImageryLayer {
34196
34560
  alert(`Encountered an error while creating an imagery layer! ${error}`);
34197
34561
  });
34198
34562
  * @param imageryProviderPromise - A promise which resolves to a imagery provider
34199
- * @param options - An object describing initialization options
34563
+ * @param [options] - An object describing initialization options
34200
34564
  * @returns The created imagery layer.
34201
34565
  */
34202
- static fromProviderAsync(imageryProviderPromise: Promise<ImageryProvider>, options: ImageryLayer.ConstructorOptions): ImageryLayer;
34566
+ static fromProviderAsync(imageryProviderPromise: Promise<ImageryProvider>, options?: ImageryLayer.ConstructorOptions): ImageryLayer;
34203
34567
  /**
34204
34568
  * 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.
34205
34569
  * @example
@@ -34746,6 +35110,59 @@ export enum IonWorldImageryStyle {
34746
35110
  ROAD = 4
34747
35111
  }
34748
35112
 
35113
+ /**
35114
+ * Methods for loading iTwin platform data into CesiumJS
35115
+ */
35116
+ export namespace ITwinData {
35117
+ /**
35118
+ * Create a {@link Cesium3DTileset} for the given iModel id using iTwin's Mesh Export API.
35119
+ *
35120
+ * If there is not a completed export available for the given iModel id, the returned promise will resolve to <code>undefined</code>.
35121
+ * We recommend waiting 10-20 seconds and trying to load the tileset again.
35122
+ * If all exports are Invalid this will throw an error.
35123
+ * @example
35124
+ * const tileset = await Cesium.ITwinData.createTilesetFromIModelId(iModelId);
35125
+ * if (Cesium.defined(tileset)) {
35126
+ * viewer.scene.primitives.add(tileset);
35127
+ * }
35128
+ * @param iModelId - The id of the iModel to load
35129
+ * @param [options] - Object containing options to pass to the internally created {@link Cesium3DTileset}.
35130
+ * @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
35131
+ */
35132
+ function createTilesetFromIModelId(iModelId: string, options?: Cesium3DTileset.ConstructorOptions): Promise<Cesium3DTileset | undefined>;
35133
+ /**
35134
+ * Create a tileset for the specified reality data id. This function only works
35135
+ * with 3D Tiles meshes and point clouds.
35136
+ *
35137
+ * If the <code>type</code> or <code>rootDocument</code> are not provided this function
35138
+ * will first request the full metadata for the specified reality data to fill these values.
35139
+ * @param iTwinId - The id of the iTwin to load data from
35140
+ * @param realityDataId - The id of the reality data to load
35141
+ * @param [type] - The type of this reality data
35142
+ * @param [rootDocument] - The path of the root document for this reality data
35143
+ */
35144
+ function createTilesetForRealityDataId(iTwinId: string, realityDataId: string, type?: ITwinPlatform.RealityDataType, rootDocument?: string): Promise<Cesium3DTileset>;
35145
+ /**
35146
+ * Create a data source of the correct type for the specified reality data id.
35147
+ * This function only works for KML and GeoJSON type data.
35148
+ *
35149
+ * If the <code>type</code> or <code>rootDocument</code> are not provided this function
35150
+ * will first request the full metadata for the specified reality data to fill these values.
35151
+ * @param iTwinId - The id of the iTwin to load data from
35152
+ * @param realityDataId - The id of the reality data to load
35153
+ * @param [type] - The type of this reality data
35154
+ * @param [rootDocument] - The path of the root document for this reality data
35155
+ */
35156
+ function createDataSourceForRealityDataId(iTwinId: string, realityDataId: string, type?: ITwinPlatform.RealityDataType, rootDocument?: string): Promise<GeoJsonDataSource | KmlDataSource>;
35157
+ /**
35158
+ * Load data from the Geospatial Features API as GeoJSON.
35159
+ * @param iTwinId - The id of the iTwin to load data from
35160
+ * @param collectionId - The id of the data collection to load
35161
+ * @param [limit = 10000] - number of items per page, must be between 1 and 10,000 inclusive
35162
+ */
35163
+ function loadGeospatialFeatures(iTwinId: string, collectionId: string, limit?: number): Promise<GeoJsonDataSource>;
35164
+ }
35165
+
34749
35166
  export namespace Label {
34750
35167
  /**
34751
35168
  * Initialization options for the Label constructor
@@ -35027,10 +35444,10 @@ export class Label {
35027
35444
  /**
35028
35445
  * Determines if this label equals another label. Labels are equal if all their properties
35029
35446
  are equal. Labels in different collections can be equal.
35030
- * @param other - The label to compare for equality.
35447
+ * @param [other] - The label to compare for equality.
35031
35448
  * @returns <code>true</code> if the labels are equal; otherwise, <code>false</code>.
35032
35449
  */
35033
- equals(other: Label): boolean;
35450
+ equals(other?: Label): boolean;
35034
35451
  /**
35035
35452
  * Returns true if this object was destroyed; otherwise, false.
35036
35453
  <br /><br />
@@ -36292,10 +36709,18 @@ export class MetadataClassProperty {
36292
36709
  readonly semantic: string;
36293
36710
  /**
36294
36711
  * The offset to be added to property values as part of the value transform.
36712
+
36713
+ This is always defined, even when `hasValueTransform` is `false`. If
36714
+ the class property JSON itself did not define it, then it will be
36715
+ initialized to the default value.
36295
36716
  */
36296
36717
  readonly offset: number | number[] | number[][];
36297
36718
  /**
36298
36719
  * The scale to be multiplied to property values as part of the value transform.
36720
+
36721
+ This is always defined, even when `hasValueTransform` is `false`. If
36722
+ the class property JSON itself did not define it, then it will be
36723
+ initialized to the default value.
36299
36724
  */
36300
36725
  readonly scale: number | number[] | number[][];
36301
36726
  /**
@@ -36518,6 +36943,26 @@ export class MetadataSchema {
36518
36943
  readonly extensions: any;
36519
36944
  }
36520
36945
 
36946
+ /**
36947
+ * An instance of a metadata value.<br>
36948
+ <br>
36949
+ This can be one of the following types:
36950
+ <ul>
36951
+ <li><code>number</code> for type <code>SCALAR</code> and numeric component types except for <code>INT64</code> or <code>UINT64</code></li>
36952
+ <li><code>bigint</code> for type <code>SCALAR</code> and component type <code>INT64</code> or <code>UINT64</code></li>
36953
+ <li><code>string</code> for type <code>STRING</code> or <code>ENUM</code></li>
36954
+ <li><code>boolean</code> for type <code>BOOLEAN</code></li>
36955
+ <li><code>Cartesian2</code> for type <code>VEC2</code></li>
36956
+ <li><code>Cartesian3</code> for type <code>VEC3</code></li>
36957
+ <li><code>Cartesian4</code> for type <code>VEC4</code></li>
36958
+ <li><code>Matrix2</code> for type <code>MAT2</code></li>
36959
+ <li><code>Matrix3</code> for type <code>MAT3</code></li>
36960
+ <li><code>Matrix4</code> for type <code>MAT4</code></li>
36961
+ <li>Arrays of these types when the metadata value is an array</li>
36962
+ </ul>
36963
+ */
36964
+ export type MetadataValue = number | bigint | string | boolean | Cartesian2 | Cartesian3 | Cartesian4 | Matrix2 | Matrix3 | Matrix4 | number[] | bigint[] | string[] | boolean[] | Cartesian2[] | Cartesian3[] | Cartesian4[] | Matrix2[] | Matrix3[] | Matrix4[];
36965
+
36521
36966
  /**
36522
36967
  * An enum of metadata types. These metadata types are containers containing
36523
36968
  one or more components of type {@link MetadataComponentType}
@@ -37285,7 +37730,7 @@ export class Model {
37285
37730
  */
37286
37731
  enableVerticalExaggeration: boolean;
37287
37732
  /**
37288
- * The light color when shading the model. When <code>undefined</code> the scene's light color is used instead.
37733
+ * The directional light color when shading the model. When <code>undefined</code> the scene's light color is used instead.
37289
37734
  <p>
37290
37735
  Disabling additional light sources by setting
37291
37736
  <code>model.imageBasedLighting.imageBasedLightingFactor = new Cartesian2(0.0, 0.0)</code>
@@ -37297,6 +37742,14 @@ export class Model {
37297
37742
  * The properties for managing image-based lighting on this model.
37298
37743
  */
37299
37744
  imageBasedLighting: ImageBasedLighting;
37745
+ /**
37746
+ * The properties for managing dynamic environment maps on this model. Affects lighting.
37747
+ * @example
37748
+ * // Change the ground color used for a model's environment map to a forest green
37749
+ const environmentMapManager = model.environmentMapManager;
37750
+ environmentMapManager.groundColor = Cesium.Color.fromCssColorString("#203b34");
37751
+ */
37752
+ readonly environmentMapManager: DynamicEnvironmentMapManager;
37300
37753
  /**
37301
37754
  * Whether to cull back-facing geometry. When true, back face culling is
37302
37755
  determined by the material's doubleSided property; when false, back face
@@ -37392,7 +37845,7 @@ export class Model {
37392
37845
 
37393
37846
  The given name may be the name of a glTF extension, like `"EXT_example_extension"`.
37394
37847
  If the specified extension was present in the root of the underlying glTF asset,
37395
- and a loder for the specified extension has processed the extension data, then
37848
+ and a loader for the specified extension has processed the extension data, then
37396
37849
  this will return the model representation of the extension.
37397
37850
  * @param extensionName - The name of the extension
37398
37851
  * @returns The object, or `undefined`
@@ -37536,6 +37989,7 @@ export class Model {
37536
37989
  * @param [options.clippingPolygons] - The {@link ClippingPolygonCollection} used to selectively disable rendering the model.
37537
37990
  * @param [options.lightColor] - The light color when shading the model. When <code>undefined</code> the scene's light color is used instead.
37538
37991
  * @param [options.imageBasedLighting] - The properties for managing image-based lighting on this model.
37992
+ * @param [options.environmentMapOptions] - The properties for managing dynamic environment maps on this model.
37539
37993
  * @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.
37540
37994
  * @param [options.credit] - A credit for the data source, which is displayed on the canvas.
37541
37995
  * @param [options.showCreditsOnScreen = false] - Whether to display the credits of this model on screen.
@@ -37589,6 +38043,7 @@ export class Model {
37589
38043
  clippingPolygons?: ClippingPolygonCollection;
37590
38044
  lightColor?: Cartesian3;
37591
38045
  imageBasedLighting?: ImageBasedLighting;
38046
+ environmentMapOptions?: DynamicEnvironmentMapManager.ConstructorOptions;
37592
38047
  backFaceCulling?: boolean;
37593
38048
  credit?: Credit | string;
37594
38049
  showCreditsOnScreen?: boolean;
@@ -38824,10 +39279,19 @@ export var className: string;
38824
39279
  export var propertyName: string;
38825
39280
 
38826
39281
  /**
38827
- * The optional ID of the metadata schema
39282
+ * The the `MetadataClassProperty` that is described by this
39283
+ structure, as obtained from the `MetadataSchema`
38828
39284
  */
38829
39285
  export var classProperty: MetadataClassProperty;
38830
39286
 
39287
+ /**
39288
+ * The `PropertyTextureProperty` or `PropertyAttributeProperty` that
39289
+ is described by this structure, as obtained from the property texture
39290
+ or property attribute of the `StructuralMetadata` that matches the
39291
+ class name and property name.
39292
+ */
39293
+ export var metadataProperty: any;
39294
+
38831
39295
  /**
38832
39296
  * Compute the rectangle that describes the part of the drawing buffer
38833
39297
  that is relevant for picking.
@@ -39045,10 +39509,10 @@ export class PointPrimitive {
39045
39509
  /**
39046
39510
  * Determines if this point equals another point. Points are equal if all their properties
39047
39511
  are equal. Points in different collections can be equal.
39048
- * @param other - The point to compare for equality.
39512
+ * @param [other] - The point to compare for equality.
39049
39513
  * @returns <code>true</code> if the points are equal; otherwise, <code>false</code>.
39050
39514
  */
39051
- equals(other: PointPrimitive): boolean;
39515
+ equals(other?: PointPrimitive): boolean;
39052
39516
  }
39053
39517
 
39054
39518
  /**
@@ -39821,32 +40285,20 @@ export class PostProcessStageCollection {
39821
40285
  surface receives light and regardless of the light's position.
39822
40286
  </p>
39823
40287
  <p>
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>
40288
+ The uniforms have the following properties:
39828
40289
  <ul>
39829
40290
  <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
-
39831
40291
  <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,
39832
40292
  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
-
39834
40293
  <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,
39835
40294
  sampling stops in the current direction. The default value is <code>0.26</code>.</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
-
40295
+ <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>
40296
+ <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>
40297
+ <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>
39842
40298
  <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
39843
40299
  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>
39844
40300
  </ul>
39845
40301
  <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>
39850
40302
  When enabled, this stage will execute before all others.
39851
40303
  </p>
39852
40304
  */
@@ -41212,9 +41664,10 @@ export class Scene {
41212
41664
  values from
41213
41665
  * @param propertyName - The name of the metadata property to pick
41214
41666
  values from
41215
- * @returns The metadata value
41667
+ * @returns The metadata value, or `undefined` when
41668
+ no matching metadata was found at the given position
41216
41669
  */
41217
- pickMetadata(windowPosition: Cartesian2, schemaId: string | undefined, className: string, propertyName: string): any;
41670
+ pickMetadata(windowPosition: Cartesian2, schemaId: string | undefined, className: string, propertyName: string): MetadataValue | undefined;
41218
41671
  /**
41219
41672
  * Pick the schema of the metadata of the object at the given position
41220
41673
  * @param windowPosition - Window coordinates to perform picking on.
@@ -41446,14 +41899,14 @@ export enum SceneMode {
41446
41899
  export namespace SceneTransforms {
41447
41900
  /**
41448
41901
  * Transforms a position in world (WGS84 or alternative ellipsoid) coordinates to window coordinates. This is commonly used to place an
41449
- HTML element at the same screen position as an object in the scene.
41902
+ * HTML element at the same screen position as an object in the scene.
41450
41903
  * @example
41451
41904
  * // Output the window position of longitude/latitude (0, 0) every time the mouse moves.
41452
- const position = Cesium.Cartesian3.fromDegrees(0.0, 0.0);
41453
- const handler = new Cesium.ScreenSpaceEventHandler(scene.canvas);
41454
- handler.setInputAction(function(movement) {
41455
- console.log(Cesium.SceneTransforms.worldToWindowCoordinates(scene, position));
41456
- }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
41905
+ * const position = Cesium.Cartesian3.fromDegrees(0.0, 0.0);
41906
+ * const handler = new Cesium.ScreenSpaceEventHandler(scene.canvas);
41907
+ * handler.setInputAction(function(movement) {
41908
+ * console.log(Cesium.SceneTransforms.worldToWindowCoordinates(scene, position));
41909
+ * }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
41457
41910
  * @param scene - The scene.
41458
41911
  * @param position - The position in world (WGS84 or alternative ellipsoid) coordinates.
41459
41912
  * @param [result] - An optional object to return the input position transformed to window coordinates.
@@ -41462,14 +41915,14 @@ export namespace SceneTransforms {
41462
41915
  function worldToWindowCoordinates(scene: Scene, position: Cartesian3, result?: Cartesian2): Cartesian2 | undefined;
41463
41916
  /**
41464
41917
  * Transforms a position in world coordinates to drawing buffer coordinates. This may produce different
41465
- results from SceneTransforms.worldToWindowCoordinates when the browser zoom is not 100%, or on high-DPI displays.
41918
+ * results from SceneTransforms.worldToWindowCoordinates when the browser zoom is not 100%, or on high-DPI displays.
41466
41919
  * @example
41467
41920
  * // Output the window position of longitude/latitude (0, 0) every time the mouse moves.
41468
- const position = Cesium.Cartesian3.fromDegrees(0.0, 0.0);
41469
- const handler = new Cesium.ScreenSpaceEventHandler(scene.canvas);
41470
- handler.setInputAction(function(movement) {
41471
- console.log(Cesium.SceneTransforms.worldToDrawingBufferCoordinates(scene, position));
41472
- }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
41921
+ * const position = Cesium.Cartesian3.fromDegrees(0.0, 0.0);
41922
+ * const handler = new Cesium.ScreenSpaceEventHandler(scene.canvas);
41923
+ * handler.setInputAction(function(movement) {
41924
+ * console.log(Cesium.SceneTransforms.worldToDrawingBufferCoordinates(scene, position));
41925
+ * }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
41473
41926
  * @param scene - The scene.
41474
41927
  * @param position - The position in world (WGS84 or alternative ellipsoid) coordinates.
41475
41928
  * @param [result] - An optional object to return the input position transformed to window coordinates.
@@ -42937,13 +43390,13 @@ const positron = new Cesium.UrlTemplateImageryProvider({
42937
43390
  });
42938
43391
  // Access a Web Map Service (WMS) server.
42939
43392
  const wms = new Cesium.UrlTemplateImageryProvider({
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&' +
43393
+ url : 'https://services.ga.gov.au/gis/services/NM_Hydrology_and_Marine_Points/MapServer/WMSServer?' +
43394
+ 'tiled=true&transparent=true&format=image%2Fpng&exceptions=application%2Fvnd.ogc.se_xml&' +
43395
+ 'styles=&service=WMS&version=1.3.0&request=GetMap&' +
43396
+ 'layers=Bores&crs=EPSG%3A3857&' +
42944
43397
  'bbox={westProjected}%2C{southProjected}%2C{eastProjected}%2C{northProjected}&' +
42945
43398
  'width=256&height=256',
42946
- rectangle : Cesium.Rectangle.fromDegrees(96.799393, -43.598214999057824, 153.63925700000001, -9.2159219997013)
43399
+ rectangle : Cesium.Rectangle.fromDegrees(95.0, -55.0, 170.0, -1.0) // From GetCapabilities EX_GeographicBoundingBox
42947
43400
  });
42948
43401
  // Using custom tags in your template url.
42949
43402
  const custom = new Cesium.UrlTemplateImageryProvider({
@@ -43287,6 +43740,95 @@ export class VoxelPrimitive {
43287
43740
  customShader?: CustomShader;
43288
43741
  clock?: Clock;
43289
43742
  });
43743
+ /**
43744
+ * The number of levels of detail containing available tiles in the tileset.
43745
+ */
43746
+ readonly availableLevels: number | undefined;
43747
+ /**
43748
+ * The event fired to indicate that a tile's content was loaded.
43749
+ * <p>
43750
+ * This event is fired during the tileset traversal while the frame is being rendered
43751
+ * so that updates to the tile take effect in the same frame. Do not create or modify
43752
+ * Cesium entities or primitives during the event listener.
43753
+ * </p>
43754
+ * @example
43755
+ * voxelPrimitive.tileLoad.addEventListener(function() {
43756
+ * console.log('A tile was loaded.');
43757
+ * });
43758
+ */
43759
+ tileLoad: Event;
43760
+ /**
43761
+ * This event fires once for each visible tile in a frame.
43762
+ * <p>
43763
+ * This event is fired during the traversal while the frame is being rendered.
43764
+ * @example
43765
+ * voxelPrimitive.tileVisible.addEventListener(function() {
43766
+ * console.log('A tile is visible.');
43767
+ * });
43768
+ */
43769
+ tileVisible: Event;
43770
+ /**
43771
+ * The event fired to indicate that a tile's content failed to load.
43772
+ * @example
43773
+ * voxelPrimitive.tileFailed.addEventListener(function() {
43774
+ * console.log('An error occurred loading tile.');
43775
+ * });
43776
+ */
43777
+ tileFailed: Event;
43778
+ /**
43779
+ * The event fired to indicate that a tile's content was unloaded.
43780
+ * @example
43781
+ * voxelPrimitive.tileUnload.addEventListener(function() {
43782
+ * console.log('A tile was unloaded from the cache.');
43783
+ * });
43784
+ */
43785
+ tileUnload: Event;
43786
+ /**
43787
+ * The event fired to indicate progress of loading new tiles. This event is fired when a new tile
43788
+ * is requested, when a requested tile is finished downloading, and when a downloaded tile has been
43789
+ * processed and is ready to render.
43790
+ * <p>
43791
+ * The number of pending tile requests, <code>numberOfPendingRequests</code>, and number of tiles
43792
+ * processing, <code>numberOfTilesProcessing</code> are passed to the event listener.
43793
+ * </p>
43794
+ * <p>
43795
+ * This event is fired at the end of the frame after the scene is rendered.
43796
+ * </p>
43797
+ * @example
43798
+ * voxelPrimitive.loadProgress.addEventListener(function(numberOfPendingRequests, numberOfTilesProcessing) {
43799
+ * if ((numberOfPendingRequests === 0) && (numberOfTilesProcessing === 0)) {
43800
+ * console.log('Finished loading');
43801
+ * return;
43802
+ * }
43803
+ *
43804
+ * console.log(`Loading: requests: ${numberOfPendingRequests}, processing: ${numberOfTilesProcessing}`);
43805
+ * });
43806
+ */
43807
+ loadProgress: Event;
43808
+ /**
43809
+ * The event fired to indicate that all tiles that meet the screen space error this frame are loaded. The voxel
43810
+ * primitive is completely loaded for this view.
43811
+ * <p>
43812
+ * This event is fired at the end of the frame after the scene is rendered.
43813
+ * </p>
43814
+ * @example
43815
+ * voxelPrimitive.allTilesLoaded.addEventListener(function() {
43816
+ * console.log('All tiles are loaded');
43817
+ * });
43818
+ */
43819
+ allTilesLoaded: Event;
43820
+ /**
43821
+ * The event fired to indicate that all tiles that meet the screen space error this frame are loaded. This event
43822
+ * is fired once when all tiles in the initial view are loaded.
43823
+ * <p>
43824
+ * This event is fired at the end of the frame after the scene is rendered.
43825
+ * </p>
43826
+ * @example
43827
+ * voxelPrimitive.initialTilesLoaded.addEventListener(function() {
43828
+ * console.log('Initial tiles are loaded');
43829
+ * });
43830
+ */
43831
+ initialTilesLoaded: Event;
43290
43832
  /**
43291
43833
  * Gets a value indicating whether or not the primitive is ready for use.
43292
43834
  */
@@ -43345,35 +43887,35 @@ export class VoxelPrimitive {
43345
43887
  nearestSampling: boolean;
43346
43888
  /**
43347
43889
  * Gets or sets the screen space error in pixels. If the screen space size
43348
- of a voxel is greater than the screen space error, the tile is subdivided.
43349
- Lower screen space error corresponds with higher detail rendering, but could
43350
- result in worse performance and higher memory consumption.
43890
+ * of a voxel is greater than the screen space error, the tile is subdivided.
43891
+ * Lower screen space error corresponds with higher detail rendering, but could
43892
+ * result in worse performance and higher memory consumption.
43351
43893
  */
43352
43894
  screenSpaceError: number;
43353
43895
  /**
43354
43896
  * Gets or sets the step size multiplier used during raymarching.
43355
- The lower the value, the higher the rendering quality, but
43356
- also the worse the performance.
43897
+ * The lower the value, the higher the rendering quality, but
43898
+ * also the worse the performance.
43357
43899
  */
43358
43900
  stepSize: number;
43359
43901
  /**
43360
43902
  * Gets or sets the minimum bounds in the shape's local coordinate system.
43361
- Voxel data is stretched or squashed to fit the bounds.
43903
+ * Voxel data is stretched or squashed to fit the bounds.
43362
43904
  */
43363
43905
  minBounds: Cartesian3;
43364
43906
  /**
43365
43907
  * Gets or sets the maximum bounds in the shape's local coordinate system.
43366
- Voxel data is stretched or squashed to fit the bounds.
43908
+ * Voxel data is stretched or squashed to fit the bounds.
43367
43909
  */
43368
43910
  maxBounds: Cartesian3;
43369
43911
  /**
43370
43912
  * Gets or sets the minimum clipping location in the shape's local coordinate system.
43371
- Any voxel content outside the range is clipped.
43913
+ * Any voxel content outside the range is clipped.
43372
43914
  */
43373
43915
  minClippingBounds: Cartesian3;
43374
43916
  /**
43375
43917
  * Gets or sets the maximum clipping location in the shape's local coordinate system.
43376
- Any voxel content outside the range is clipped.
43918
+ * Any voxel content outside the range is clipped.
43377
43919
  */
43378
43920
  maxClippingBounds: Cartesian3;
43379
43921
  /**
@@ -43390,19 +43932,19 @@ export class VoxelPrimitive {
43390
43932
  readonly customShaderCompilationEvent: Event;
43391
43933
  /**
43392
43934
  * Returns true if this object was destroyed; otherwise, false.
43393
- <br /><br />
43394
- If this object was destroyed, it should not be used; calling any function other than
43395
- <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
43935
+ * <br /><br />
43936
+ * If this object was destroyed, it should not be used; calling any function other than
43937
+ * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
43396
43938
  * @returns <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
43397
43939
  */
43398
43940
  isDestroyed(): boolean;
43399
43941
  /**
43400
43942
  * Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
43401
- release of WebGL resources, instead of relying on the garbage collector to destroy this object.
43402
- <br /><br />
43403
- Once an object is destroyed, it should not be used; calling any function other than
43404
- <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
43405
- assign the return value (<code>undefined</code>) to the object as done in the example.
43943
+ * release of WebGL resources, instead of relying on the garbage collector to destroy this object.
43944
+ * <br /><br />
43945
+ * Once an object is destroyed, it should not be used; calling any function other than
43946
+ * <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
43947
+ * assign the return value (<code>undefined</code>) to the object as done in the example.
43406
43948
  * @example
43407
43949
  * voxelPrimitive = voxelPrimitive && voxelPrimitive.destroy();
43408
43950
  */
@@ -43411,7 +43953,7 @@ export class VoxelPrimitive {
43411
43953
 
43412
43954
  /**
43413
43955
  * Provides voxel data. Intended to be used with {@link VoxelPrimitive}.
43414
- This type describes an interface and is not intended to be instantiated directly.
43956
+ * This type describes an interface and is not intended to be instantiated directly.
43415
43957
  */
43416
43958
  export class VoxelProvider {
43417
43959
  constructor();
@@ -43425,69 +43967,69 @@ export class VoxelProvider {
43425
43967
  readonly shapeTransform: Matrix4 | undefined;
43426
43968
  /**
43427
43969
  * Gets the {@link VoxelShapeType}
43428
- This should not be called before {@link VoxelProvider#ready} returns true.
43970
+ * This should not be called before {@link VoxelProvider#ready} returns true.
43429
43971
  */
43430
43972
  readonly shape: VoxelShapeType;
43431
43973
  /**
43432
43974
  * Gets the minimum bounds.
43433
- If undefined, the shape's default minimum bounds will be used instead.
43434
- This should not be called before {@link VoxelProvider#ready} returns true.
43975
+ * If undefined, the shape's default minimum bounds will be used instead.
43976
+ * This should not be called before {@link VoxelProvider#ready} returns true.
43435
43977
  */
43436
43978
  readonly minBounds: Cartesian3 | undefined;
43437
43979
  /**
43438
43980
  * Gets the maximum bounds.
43439
- If undefined, the shape's default maximum bounds will be used instead.
43440
- This should not be called before {@link VoxelProvider#ready} returns true.
43981
+ * If undefined, the shape's default maximum bounds will be used instead.
43982
+ * This should not be called before {@link VoxelProvider#ready} returns true.
43441
43983
  */
43442
43984
  readonly maxBounds: Cartesian3 | undefined;
43443
43985
  /**
43444
43986
  * Gets the number of voxels per dimension of a tile. This is the same for all tiles in the dataset.
43445
- This should not be called before {@link VoxelProvider#ready} returns true.
43987
+ * This should not be called before {@link VoxelProvider#ready} returns true.
43446
43988
  */
43447
43989
  readonly dimensions: Cartesian3;
43448
43990
  /**
43449
43991
  * Gets the number of padding voxels before the tile. This improves rendering quality when sampling the edge of a tile, but it increases memory usage.
43450
- This should not be called before {@link VoxelProvider#ready} returns true.
43992
+ * This should not be called before {@link VoxelProvider#ready} returns true.
43451
43993
  */
43452
43994
  readonly paddingBefore: Cartesian3 | undefined;
43453
43995
  /**
43454
43996
  * Gets the number of padding voxels after the tile. This improves rendering quality when sampling the edge of a tile, but it increases memory usage.
43455
- This should not be called before {@link VoxelProvider#ready} returns true.
43997
+ * This should not be called before {@link VoxelProvider#ready} returns true.
43456
43998
  */
43457
43999
  readonly paddingAfter: Cartesian3 | undefined;
43458
44000
  /**
43459
44001
  * Gets the metadata names.
43460
- This should not be called before {@link VoxelProvider#ready} returns true.
44002
+ * This should not be called before {@link VoxelProvider#ready} returns true.
43461
44003
  */
43462
44004
  readonly names: string[];
43463
44005
  /**
43464
44006
  * Gets the metadata types.
43465
- This should not be called before {@link VoxelProvider#ready} returns true.
44007
+ * This should not be called before {@link VoxelProvider#ready} returns true.
43466
44008
  */
43467
44009
  readonly types: MetadataType[];
43468
44010
  /**
43469
44011
  * Gets the metadata component types.
43470
- This should not be called before {@link VoxelProvider#ready} returns true.
44012
+ * This should not be called before {@link VoxelProvider#ready} returns true.
43471
44013
  */
43472
44014
  readonly componentTypes: MetadataComponentType[];
43473
44015
  /**
43474
44016
  * Gets the metadata minimum values.
43475
- This should not be called before {@link VoxelProvider#ready} returns true.
44017
+ * This should not be called before {@link VoxelProvider#ready} returns true.
43476
44018
  */
43477
44019
  readonly minimumValues: number[][] | undefined;
43478
44020
  /**
43479
44021
  * Gets the metadata maximum values.
43480
- This should not be called before {@link VoxelProvider#ready} returns true.
44022
+ * This should not be called before {@link VoxelProvider#ready} returns true.
43481
44023
  */
43482
44024
  readonly maximumValues: number[][] | undefined;
43483
44025
  /**
43484
44026
  * The maximum number of tiles that exist for this provider. This value is used as a hint to the voxel renderer to allocate an appropriate amount of GPU memory. If this value is not known it can be undefined.
43485
- This should not be called before {@link VoxelProvider#ready} returns true.
44027
+ * This should not be called before {@link VoxelProvider#ready} returns true.
43486
44028
  */
43487
44029
  readonly maximumTileCount: number | undefined;
43488
44030
  /**
43489
44031
  * Requests the data for a given tile. The data is a flattened 3D array ordered by X, then Y, then Z.
43490
- This function should not be called before {@link VoxelProvider#ready} returns true.
44032
+ * This function should not be called before {@link VoxelProvider#ready} returns true.
43491
44033
  * @param [options] - Object with the following properties:
43492
44034
  * @param [options.tileLevel = 0] - The tile's level.
43493
44035
  * @param [options.tileX = 0] - The tile's X coordinate.
@@ -43503,6 +44045,11 @@ export class VoxelProvider {
43503
44045
  }): Promise<any[][]> | undefined;
43504
44046
  }
43505
44047
 
44048
+ /**
44049
+ * The number of levels of detail containing available tiles in the tileset.
44050
+ */
44051
+ export const availableLevels: number | undefined;
44052
+
43506
44053
  export const shaderUniforms: {
43507
44054
  [key: string]: any;
43508
44055
  };
@@ -43772,8 +44319,8 @@ export namespace WebMapTileServiceImageryProvider {
43772
44319
  * @property [ellipsoid] - The ellipsoid. If not specified, the WGS84 ellipsoid is used.
43773
44320
  * @property [credit] - A credit for the data source, which is displayed on the canvas.
43774
44321
  * @property [subdomains = 'abc'] - The subdomains to use for the <code>{s}</code> placeholder in the URL template.
43775
- If this parameter is a single string, each character in the string is a subdomain. If it is
43776
- an array, each element in the array is a subdomain.
44322
+ * If this parameter is a single string, each character in the string is a subdomain. If it is
44323
+ * an array, each element in the array is a subdomain.
43777
44324
  */
43778
44325
  type ConstructorOptions = {
43779
44326
  url: Resource | string;
@@ -43799,54 +44346,54 @@ export namespace WebMapTileServiceImageryProvider {
43799
44346
 
43800
44347
  /**
43801
44348
  * Provides tiled imagery served by {@link http://www.opengeospatial.org/standards/wmts|WMTS 1.0.0} compliant servers.
43802
- This provider supports HTTP KVP-encoded and RESTful GetTile requests, but does not yet support the SOAP encoding.
44349
+ * This provider supports HTTP KVP-encoded and RESTful GetTile requests, but does not yet support the SOAP encoding.
43803
44350
  * @example
43804
44351
  * // Example 1. USGS shaded relief tiles (KVP)
43805
- const shadedRelief1 = new Cesium.WebMapTileServiceImageryProvider({
43806
- url : 'http://basemap.nationalmap.gov/arcgis/rest/services/USGSShadedReliefOnly/MapServer/WMTS',
43807
- layer : 'USGSShadedReliefOnly',
43808
- style : 'default',
43809
- format : 'image/jpeg',
43810
- tileMatrixSetID : 'default028mm',
43811
- // tileMatrixLabels : ['default028mm:0', 'default028mm:1', 'default028mm:2' ...],
43812
- maximumLevel: 19,
43813
- credit : new Cesium.Credit('U. S. Geological Survey')
43814
- });
43815
- viewer.imageryLayers.addImageryProvider(shadedRelief1);
44352
+ * const shadedRelief1 = new Cesium.WebMapTileServiceImageryProvider({
44353
+ * url : 'https://basemap.nationalmap.gov/arcgis/rest/services/USGSShadedReliefOnly/MapServer/WMTS',
44354
+ * layer : 'USGSShadedReliefOnly',
44355
+ * style : 'default',
44356
+ * format : 'image/jpeg',
44357
+ * tileMatrixSetID : 'default028mm',
44358
+ * // tileMatrixLabels : ['default028mm:0', 'default028mm:1', 'default028mm:2' ...],
44359
+ * maximumLevel: 19,
44360
+ * credit : new Cesium.Credit('U. S. Geological Survey')
44361
+ * });
44362
+ * viewer.imageryLayers.addImageryProvider(shadedRelief1);
43816
44363
  * @example
43817
44364
  * // Example 2. USGS shaded relief tiles (RESTful)
43818
- const shadedRelief2 = new Cesium.WebMapTileServiceImageryProvider({
43819
- url : 'http://basemap.nationalmap.gov/arcgis/rest/services/USGSShadedReliefOnly/MapServer/WMTS/tile/1.0.0/USGSShadedReliefOnly/{Style}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.jpg',
43820
- layer : 'USGSShadedReliefOnly',
43821
- style : 'default',
43822
- format : 'image/jpeg',
43823
- tileMatrixSetID : 'default028mm',
43824
- maximumLevel: 19,
43825
- credit : new Cesium.Credit('U. S. Geological Survey')
43826
- });
43827
- viewer.imageryLayers.addImageryProvider(shadedRelief2);
44365
+ * const shadedRelief2 = new Cesium.WebMapTileServiceImageryProvider({
44366
+ * url : 'https://basemap.nationalmap.gov/arcgis/rest/services/USGSShadedReliefOnly/MapServer/WMTS/tile/1.0.0/USGSShadedReliefOnly/{Style}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.jpg',
44367
+ * layer : 'USGSShadedReliefOnly',
44368
+ * style : 'default',
44369
+ * format : 'image/jpeg',
44370
+ * tileMatrixSetID : 'default028mm',
44371
+ * maximumLevel: 19,
44372
+ * credit : new Cesium.Credit('U. S. Geological Survey')
44373
+ * });
44374
+ * viewer.imageryLayers.addImageryProvider(shadedRelief2);
43828
44375
  * @example
43829
44376
  * // Example 3. NASA time dynamic weather data (RESTful)
43830
- const times = Cesium.TimeIntervalCollection.fromIso8601({
43831
- iso8601: '2015-07-30/2017-06-16/P1D',
43832
- dataCallback: function dataCallback(interval, index) {
43833
- return {
43834
- Time: Cesium.JulianDate.toIso8601(interval.start)
43835
- };
43836
- }
43837
- });
43838
- const weather = new Cesium.WebMapTileServiceImageryProvider({
43839
- url : 'https://gibs.earthdata.nasa.gov/wmts/epsg4326/best/AMSR2_Snow_Water_Equivalent/default/{Time}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.png',
43840
- layer : 'AMSR2_Snow_Water_Equivalent',
43841
- style : 'default',
43842
- tileMatrixSetID : '2km',
43843
- maximumLevel : 5,
43844
- format : 'image/png',
43845
- clock: clock,
43846
- times: times,
43847
- credit : new Cesium.Credit('NASA Global Imagery Browse Services for EOSDIS')
43848
- });
43849
- viewer.imageryLayers.addImageryProvider(weather);
44377
+ * const times = Cesium.TimeIntervalCollection.fromIso8601({
44378
+ * iso8601: '2015-07-30/2017-06-16/P1D',
44379
+ * dataCallback: function dataCallback(interval, index) {
44380
+ * return {
44381
+ * Time: Cesium.JulianDate.toIso8601(interval.start)
44382
+ * };
44383
+ * }
44384
+ * });
44385
+ * const weather = new Cesium.WebMapTileServiceImageryProvider({
44386
+ * url : 'https://gibs.earthdata.nasa.gov/wmts/epsg4326/best/AMSR2_Snow_Water_Equivalent/default/{Time}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.png',
44387
+ * layer : 'AMSR2_Snow_Water_Equivalent',
44388
+ * style : 'default',
44389
+ * tileMatrixSetID : '2km',
44390
+ * maximumLevel : 5,
44391
+ * format : 'image/png',
44392
+ * clock: clock,
44393
+ * times: times,
44394
+ * credit : new Cesium.Credit('NASA Global Imagery Browse Services for EOSDIS')
44395
+ * });
44396
+ * viewer.imageryLayers.addImageryProvider(weather);
43850
44397
  * @param options - Object describing initialization options
43851
44398
  */
43852
44399
  export class WebMapTileServiceImageryProvider {
@@ -43885,14 +44432,14 @@ export class WebMapTileServiceImageryProvider {
43885
44432
  readonly rectangle: Rectangle;
43886
44433
  /**
43887
44434
  * Gets the tile discard policy. If not undefined, the discard policy is responsible
43888
- for filtering out "missing" tiles via its shouldDiscardImage function. If this function
43889
- returns undefined, no tiles are filtered.
44435
+ * for filtering out "missing" tiles via its shouldDiscardImage function. If this function
44436
+ * returns undefined, no tiles are filtered.
43890
44437
  */
43891
44438
  readonly tileDiscardPolicy: TileDiscardPolicy;
43892
44439
  /**
43893
44440
  * Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing
43894
- to the event, you will be notified of the error and can potentially recover from it. Event listeners
43895
- are passed an instance of {@link TileProviderError}.
44441
+ * to the event, you will be notified of the error and can potentially recover from it. Event listeners
44442
+ * are passed an instance of {@link TileProviderError}.
43896
44443
  */
43897
44444
  readonly errorEvent: Event;
43898
44445
  /**
@@ -43901,15 +44448,15 @@ export class WebMapTileServiceImageryProvider {
43901
44448
  readonly format: string;
43902
44449
  /**
43903
44450
  * Gets the credit to display when this imagery provider is active. Typically this is used to credit
43904
- the source of the imagery.
44451
+ * the source of the imagery.
43905
44452
  */
43906
44453
  readonly credit: Credit;
43907
44454
  /**
43908
44455
  * Gets a value indicating whether or not the images provided by this imagery provider
43909
- include an alpha channel. If this property is false, an alpha channel, if present, will
43910
- be ignored. If this property is true, any images without an alpha channel will be treated
43911
- as if their alpha is 1.0 everywhere. When this property is false, memory usage
43912
- and texture upload time are reduced.
44456
+ * include an alpha channel. If this property is false, an alpha channel, if present, will
44457
+ * be ignored. If this property is true, any images without an alpha channel will be treated
44458
+ * as if their alpha is 1.0 everywhere. When this property is false, memory usage
44459
+ * and texture upload time are reduced.
43913
44460
  */
43914
44461
  readonly hasAlphaChannel: boolean;
43915
44462
  /**
@@ -43918,8 +44465,8 @@ export class WebMapTileServiceImageryProvider {
43918
44465
  clock: Clock;
43919
44466
  /**
43920
44467
  * Gets or sets a time interval collection that is used to get time dynamic parameters. The data of each
43921
- TimeInterval is an object containing the keys and values of the properties that are used during
43922
- tile requests.
44468
+ * TimeInterval is an object containing the keys and values of the properties that are used during
44469
+ * tile requests.
43923
44470
  */
43924
44471
  times: TimeIntervalCollection;
43925
44472
  /**
@@ -43941,12 +44488,12 @@ export class WebMapTileServiceImageryProvider {
43941
44488
  * @param level - The tile level.
43942
44489
  * @param [request] - The request object. Intended for internal use only.
43943
44490
  * @returns A promise for the image that will resolve when the image is available, or
43944
- undefined if there are too many active requests to the server, and the request should be retried later.
44491
+ * undefined if there are too many active requests to the server, and the request should be retried later.
43945
44492
  */
43946
44493
  requestImage(x: number, y: number, level: number, request?: Request): Promise<ImageryTypes> | undefined;
43947
44494
  /**
43948
44495
  * Picking features is not currently supported by this imagery provider, so this function simply returns
43949
- undefined.
44496
+ * undefined.
43950
44497
  * @param x - The tile X coordinate.
43951
44498
  * @param y - The tile Y coordinate.
43952
44499
  * @param level - The tile level.
@@ -43987,6 +44534,7 @@ const widget2 = new Cesium.CesiumWidget("cesiumContainer", {
43987
44534
  * @param container - The DOM element or ID that will contain the widget.
43988
44535
  * @param [options] - Object with the following properties:
43989
44536
  * @param [options.clock = new Clock()] - The clock to use to control current time.
44537
+ * @param [options.shouldAnimate = false] - <code>true</code> if the clock should attempt to advance simulation time by default, <code>false</code> otherwise.
43990
44538
  * @param [options.ellipsoid = Ellipsoid.default] - The default ellipsoid.
43991
44539
  * @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.
43992
44540
  * @param [options.terrainProvider = new EllipsoidTerrainProvider(options.ellipsoid)] - The terrain provider.
@@ -44002,14 +44550,17 @@ const widget2 = new Cesium.CesiumWidget("cesiumContainer", {
44002
44550
  * @param [options.useBrowserRecommendedResolution = true] - If true, render at the browser's recommended resolution and ignore <code>window.devicePixelRatio</code>.
44003
44551
  * @param [options.targetFrameRate] - The target frame rate when using the default render loop.
44004
44552
  * @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.
44553
+ * @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.
44005
44554
  * @param [options.contextOptions] - Context and WebGL creation properties passed to {@link Scene}.
44006
44555
  * @param [options.creditContainer] - The DOM element or ID that will contain the {@link CreditDisplay}. If not specified, the credits are added
44007
44556
  to the bottom of the widget itself.
44008
44557
  * @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.
44558
+ * @param [options.dataSources = new DataSourceCollection()] - The collection of data sources visualized by the widget. If this parameter is provided,
44559
+ the instance is assumed to be owned by the caller and will not be destroyed when the widget is destroyed.
44009
44560
  * @param [options.shadows = false] - Determines if shadows are cast by light sources.
44010
44561
  * @param [options.terrainShadows = ShadowMode.RECEIVE_ONLY] - Determines if the terrain casts or receives shadows from light sources.
44011
44562
  * @param [options.mapMode2D = MapMode2D.INFINITE_SCROLL] - Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
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.
44563
+ * @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.
44013
44564
  * @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}.
44014
44565
  * @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}.
44015
44566
  * @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.
@@ -44017,6 +44568,7 @@ const widget2 = new Cesium.CesiumWidget("cesiumContainer", {
44017
44568
  export class CesiumWidget {
44018
44569
  constructor(container: Element | string, options?: {
44019
44570
  clock?: Clock;
44571
+ shouldAnimate?: boolean;
44020
44572
  ellipsoid?: Ellipsoid;
44021
44573
  baseLayer?: ImageryLayer | false;
44022
44574
  terrainProvider?: TerrainProvider;
@@ -44032,9 +44584,11 @@ export class CesiumWidget {
44032
44584
  useBrowserRecommendedResolution?: boolean;
44033
44585
  targetFrameRate?: number;
44034
44586
  showRenderLoopErrors?: boolean;
44587
+ automaticallyTrackDataSourceClocks?: boolean;
44035
44588
  contextOptions?: ContextOptions;
44036
44589
  creditContainer?: Element | string;
44037
44590
  creditViewport?: Element | string;
44591
+ dataSources?: DataSourceCollection;
44038
44592
  shadows?: boolean;
44039
44593
  terrainShadows?: ShadowMode;
44040
44594
  mapMode2D?: MapMode2D;
@@ -44075,6 +44629,19 @@ export class CesiumWidget {
44075
44629
  * Manages the list of credits to display on screen and in the lightbox.
44076
44630
  */
44077
44631
  creditDisplay: CreditDisplay;
44632
+ /**
44633
+ * Gets the display used for {@link DataSource} visualization.
44634
+ */
44635
+ readonly dataSourceDisplay: DataSourceDisplay;
44636
+ /**
44637
+ * Gets the collection of entities not tied to a particular data source.
44638
+ This is a shortcut to [dataSourceDisplay.defaultDataSource.entities]{@link CesiumWidget#dataSourceDisplay}.
44639
+ */
44640
+ readonly entities: EntityCollection;
44641
+ /**
44642
+ * Gets the set of {@link DataSource} instances to be visualized.
44643
+ */
44644
+ readonly dataSources: DataSourceCollection;
44078
44645
  /**
44079
44646
  * Gets the camera.
44080
44647
  */
@@ -44128,6 +44695,25 @@ export class CesiumWidget {
44128
44695
  this flag is true or false.
44129
44696
  */
44130
44697
  useBrowserRecommendedResolution: boolean;
44698
+ /**
44699
+ * Gets or sets whether or not data sources can temporarily pause
44700
+ animation in order to avoid showing an incomplete picture to the user.
44701
+ For example, if asynchronous primitives are being processed in the
44702
+ background, the clock will not advance until the geometry is ready.
44703
+ */
44704
+ allowDataSourcesToSuspendAnimation: boolean;
44705
+ /**
44706
+ * Gets or sets the Entity instance currently being tracked by the camera.
44707
+ */
44708
+ trackedEntity: Entity | undefined;
44709
+ /**
44710
+ * Gets the event that is raised when the tracked entity changes.
44711
+ */
44712
+ readonly trackedEntityChanged: Event;
44713
+ /**
44714
+ * Gets or sets the data source to track with the widget's clock.
44715
+ */
44716
+ clockTrackedDataSource: DataSource;
44131
44717
  /**
44132
44718
  * Show an error panel to the user containing a title and a longer error message,
44133
44719
  which can be dismissed using an OK button. This panel is displayed automatically
@@ -44158,6 +44744,51 @@ export class CesiumWidget {
44158
44744
  unless <code>useDefaultRenderLoop</code> is set to false;
44159
44745
  */
44160
44746
  render(): void;
44747
+ /**
44748
+ * Asynchronously sets the camera to view the provided entity, entities, or data source.
44749
+ If the data source is still in the process of loading or the visualization is otherwise still loading,
44750
+ this method waits for the data to be ready before performing the zoom.
44751
+
44752
+ <p>The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere.
44753
+ The heading and the pitch angles are defined in the local east-north-up reference frame.
44754
+ The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch
44755
+ angles are above the plane. Negative pitch angles are below the plane. The range is the distance from the center. If the range is
44756
+ zero, a range will be computed such that the whole bounding sphere is visible.</p>
44757
+
44758
+ <p>In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the
44759
+ target will be the range. The heading will be determined from the offset. If the heading cannot be
44760
+ determined from the offset, the heading will be north.</p>
44761
+ * @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.
44762
+ * @param [offset] - The offset from the center of the entity in the local east-north-up reference frame.
44763
+ * @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.
44764
+ */
44765
+ zoomTo(target: Entity | Entity[] | EntityCollection | DataSource | ImageryLayer | Cesium3DTileset | TimeDynamicPointCloud | Promise<Entity | Entity[] | EntityCollection | DataSource | ImageryLayer | Cesium3DTileset | TimeDynamicPointCloud | VoxelPrimitive>, offset?: HeadingPitchRange): Promise<boolean>;
44766
+ /**
44767
+ * Flies the camera to the provided entity, entities, or data source.
44768
+ If the data source is still in the process of loading or the visualization is otherwise still loading,
44769
+ this method waits for the data to be ready before performing the flight.
44770
+
44771
+ <p>The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere.
44772
+ The heading and the pitch angles are defined in the local east-north-up reference frame.
44773
+ The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch
44774
+ angles are above the plane. Negative pitch angles are below the plane. The range is the distance from the center. If the range is
44775
+ zero, a range will be computed such that the whole bounding sphere is visible.</p>
44776
+
44777
+ <p>In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the
44778
+ target will be the range. The heading will be determined from the offset. If the heading cannot be
44779
+ determined from the offset, the heading will be north.</p>
44780
+ * @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.
44781
+ * @param [options] - Object with the following properties:
44782
+ * @param [options.duration = 3.0] - The duration of the flight in seconds.
44783
+ * @param [options.maximumHeight] - The maximum height at the peak of the flight.
44784
+ * @param [options.offset] - The offset from the target in the local east-north-up reference frame centered at the target.
44785
+ * @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
44786
+ */
44787
+ flyTo(target: Entity | Entity[] | EntityCollection | DataSource | ImageryLayer | Cesium3DTileset | TimeDynamicPointCloud | Promise<Entity | Entity[] | EntityCollection | DataSource | ImageryLayer | Cesium3DTileset | TimeDynamicPointCloud | VoxelPrimitive>, options?: {
44788
+ duration?: number;
44789
+ maximumHeight?: number;
44790
+ offset?: HeadingPitchRange;
44791
+ }): Promise<boolean>;
44161
44792
  }
44162
44793
 
44163
44794
  /**
@@ -46093,7 +46724,7 @@ export namespace Viewer {
46093
46724
  * @property [baseLayerPicker = true] - If set to false, the BaseLayerPicker widget will not be created.
46094
46725
  * @property [fullscreenButton = true] - If set to false, the FullscreenButton widget will not be created.
46095
46726
  * @property [vrButton = false] - If set to true, the VRButton widget will be created.
46096
- * @property [geocoder = true] - If set to false, the Geocoder widget will not be created.
46727
+ * @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.
46097
46728
  * @property [homeButton = true] - If set to false, the HomeButton widget will not be created.
46098
46729
  * @property [infoBox = true] - If set to false, the InfoBox widget will not be created.
46099
46730
  * @property [sceneModePicker = true] - If set to false, the SceneModePicker widget will not be created.
@@ -46108,7 +46739,7 @@ export namespace Viewer {
46108
46739
  * @property [imageryProviderViewModels = createDefaultImageryProviderViewModels()] - The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if `baseLayerPicker` is set to true.
46109
46740
  * @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.
46110
46741
  * @property [terrainProviderViewModels = createDefaultTerrainProviderViewModels()] - The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if `baseLayerPicker` is set to true.
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.
46742
+ * @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.
46112
46743
  * @property [ellipsoid = Ellipsoid.default] - The default ellipsoid.
46113
46744
  * @property [terrainProvider = new EllipsoidTerrainProvider()] - The terrain provider to use
46114
46745
  * @property [terrain] - A terrain object which handles asynchronous terrain provider. Can only specify if options.terrainProvider is undefined.
@@ -46144,7 +46775,7 @@ export namespace Viewer {
46144
46775
  baseLayerPicker?: boolean;
46145
46776
  fullscreenButton?: boolean;
46146
46777
  vrButton?: boolean;
46147
- geocoder?: boolean | GeocoderService[];
46778
+ geocoder?: boolean | IonGeocodeProviderType | GeocoderService[];
46148
46779
  homeButton?: boolean;
46149
46780
  infoBox?: boolean;
46150
46781
  sceneModePicker?: boolean;