mars3d-cesium 1.124.0 → 1.125.1

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 (109) hide show
  1. package/Build/Cesium/Cesium.d.ts +963 -926
  2. package/Build/Cesium/Cesium.js +4270 -4270
  3. package/Build/Cesium/ThirdParty/draco_decoder.wasm +0 -0
  4. package/Build/Cesium/Workers/{chunk-EXYLABM3.js → chunk-2UKB643G.js} +2 -2
  5. package/Build/Cesium/Workers/{chunk-SXINKIB2.js → chunk-33SMWJ4M.js} +2 -2
  6. package/Build/Cesium/Workers/{chunk-5CZH3YOM.js → chunk-3Q7HFAXM.js} +2 -2
  7. package/Build/Cesium/Workers/chunk-4WBCASTJ.js +66 -0
  8. package/Build/Cesium/Workers/{chunk-S4WTTFQO.js → chunk-5BN4XL45.js} +2 -2
  9. package/Build/Cesium/Workers/{chunk-G6BZKWWN.js → chunk-7ECYEMF7.js} +2 -2
  10. package/Build/Cesium/Workers/{chunk-ADZK2JLO.js → chunk-A73BOSSA.js} +2 -2
  11. package/Build/Cesium/Workers/{chunk-CJFJKB5V.js → chunk-BACU57HL.js} +2 -2
  12. package/Build/Cesium/Workers/{chunk-QIZB5B47.js → chunk-BDYXP2QF.js} +2 -2
  13. package/Build/Cesium/Workers/{chunk-72NMS5KE.js → chunk-BGZOHHAB.js} +2 -2
  14. package/Build/Cesium/Workers/{chunk-T7AQS7YI.js → chunk-BJXRSRRV.js} +2 -2
  15. package/Build/Cesium/Workers/{chunk-SP2S5UZD.js → chunk-BYZQXU6M.js} +2 -2
  16. package/Build/Cesium/Workers/{chunk-BMKF5JTH.js → chunk-DY27RKVJ.js} +2 -2
  17. package/Build/Cesium/Workers/{chunk-E2XIHPTZ.js → chunk-E5YZ6SQH.js} +2 -2
  18. package/Build/Cesium/Workers/{chunk-TP5B32RY.js → chunk-F7XJNQKG.js} +1 -1
  19. package/Build/Cesium/Workers/{chunk-6IQVYEBD.js → chunk-FK7TFZU5.js} +2 -2
  20. package/Build/Cesium/Workers/{chunk-4BGNE6LH.js → chunk-GBVHGTZ7.js} +2 -2
  21. package/Build/Cesium/Workers/{chunk-I66MFRXO.js → chunk-GOLTSWYP.js} +2 -2
  22. package/Build/Cesium/Workers/{chunk-QT33UL57.js → chunk-IIOJRYGY.js} +2 -2
  23. package/Build/Cesium/Workers/{chunk-GP5GXDAP.js → chunk-IMHDULPO.js} +2 -2
  24. package/Build/Cesium/Workers/{chunk-NIXFT7ZT.js → chunk-IMJXI5NR.js} +2 -2
  25. package/Build/Cesium/Workers/{chunk-DW4EQ6YI.js → chunk-J2SHZBIV.js} +2 -2
  26. package/Build/Cesium/Workers/{chunk-44LKXGXW.js → chunk-JUFKA5CT.js} +2 -2
  27. package/Build/Cesium/Workers/{chunk-HWH6BBH6.js → chunk-KENZMGVN.js} +2 -2
  28. package/Build/Cesium/Workers/{chunk-SM4U4WO5.js → chunk-L7XKP4E4.js} +2 -2
  29. package/Build/Cesium/Workers/{chunk-J27DO7RZ.js → chunk-LZZDW4YT.js} +2 -2
  30. package/Build/Cesium/Workers/{chunk-ULZ2QSU5.js → chunk-MAF47YKU.js} +2 -2
  31. package/Build/Cesium/Workers/{chunk-GVFM5H7M.js → chunk-NKNGJ3TE.js} +2 -2
  32. package/Build/Cesium/Workers/{chunk-LKADYPHQ.js → chunk-NQTLURKO.js} +2 -2
  33. package/Build/Cesium/Workers/chunk-NUEQ7ML6.js +28 -0
  34. package/Build/Cesium/Workers/{chunk-67ZE4UMX.js → chunk-OJHKQU2O.js} +2 -2
  35. package/Build/Cesium/Workers/{chunk-LWGQRCCJ.js → chunk-PA425TYW.js} +2 -2
  36. package/Build/Cesium/Workers/{chunk-BRDKDER4.js → chunk-PSCDC4OD.js} +1 -1
  37. package/Build/Cesium/Workers/{chunk-JLMPKQO4.js → chunk-RWO7U3U4.js} +2 -2
  38. package/Build/Cesium/Workers/{chunk-OX5CTLXY.js → chunk-SRRLOWNQ.js} +1 -1
  39. package/Build/Cesium/Workers/{chunk-JHG5JGLM.js → chunk-SSIRCWZX.js} +2 -2
  40. package/Build/Cesium/Workers/{chunk-TZGYF5KJ.js → chunk-SVQATCHF.js} +2 -2
  41. package/Build/Cesium/Workers/{chunk-A3VS2OZ2.js → chunk-T3LZJ5CN.js} +2 -2
  42. package/Build/Cesium/Workers/{chunk-D76R4V7H.js → chunk-T65UROT7.js} +2 -2
  43. package/Build/Cesium/Workers/{chunk-GCVZZUCS.js → chunk-TCPL2UQQ.js} +2 -2
  44. package/Build/Cesium/Workers/{chunk-RPAJTIFB.js → chunk-UC366W63.js} +2 -2
  45. package/Build/Cesium/Workers/{chunk-4ALHVD6K.js → chunk-UNQYLG6A.js} +2 -2
  46. package/Build/Cesium/Workers/{chunk-64YODNAO.js → chunk-VFICESPF.js} +2 -2
  47. package/Build/Cesium/Workers/{chunk-6DFUP66D.js → chunk-W3BTOZDI.js} +1 -1
  48. package/Build/Cesium/Workers/{chunk-HPB3ARQJ.js → chunk-W3DF3VH7.js} +2 -2
  49. package/Build/Cesium/Workers/{chunk-4ULMZV5R.js → chunk-WCLG5YTZ.js} +2 -2
  50. package/Build/Cesium/Workers/{chunk-OWPC6DLM.js → chunk-WPXKYLM3.js} +2 -2
  51. package/Build/Cesium/Workers/{chunk-JKCZ5NAK.js → chunk-XLXM5IN5.js} +2 -2
  52. package/Build/Cesium/Workers/{chunk-M2TWLQFJ.js → chunk-Y5OPU7UI.js} +2 -2
  53. package/Build/Cesium/Workers/{chunk-AVHFP6LX.js → chunk-YTKG3EFI.js} +2 -2
  54. package/Build/Cesium/Workers/{chunk-GNTVNTUY.js → chunk-ZJVGBDEL.js} +2 -2
  55. package/Build/Cesium/Workers/{chunk-46LYVLGL.js → chunk-ZMSSQLR2.js} +2 -2
  56. package/Build/Cesium/Workers/combineGeometry.js +2 -2
  57. package/Build/Cesium/Workers/createBoxGeometry.js +2 -2
  58. package/Build/Cesium/Workers/createBoxOutlineGeometry.js +2 -2
  59. package/Build/Cesium/Workers/createCircleGeometry.js +2 -2
  60. package/Build/Cesium/Workers/createCircleOutlineGeometry.js +2 -2
  61. package/Build/Cesium/Workers/createCoplanarPolygonGeometry.js +2 -2
  62. package/Build/Cesium/Workers/createCoplanarPolygonOutlineGeometry.js +2 -2
  63. package/Build/Cesium/Workers/createCorridorGeometry.js +2 -2
  64. package/Build/Cesium/Workers/createCorridorOutlineGeometry.js +2 -2
  65. package/Build/Cesium/Workers/createCylinderGeometry.js +2 -2
  66. package/Build/Cesium/Workers/createCylinderOutlineGeometry.js +2 -2
  67. package/Build/Cesium/Workers/createEllipseGeometry.js +2 -2
  68. package/Build/Cesium/Workers/createEllipseOutlineGeometry.js +2 -2
  69. package/Build/Cesium/Workers/createEllipsoidGeometry.js +2 -2
  70. package/Build/Cesium/Workers/createEllipsoidOutlineGeometry.js +2 -2
  71. package/Build/Cesium/Workers/createFrustumGeometry.js +2 -2
  72. package/Build/Cesium/Workers/createFrustumOutlineGeometry.js +2 -2
  73. package/Build/Cesium/Workers/createGeometry.js +2 -2
  74. package/Build/Cesium/Workers/createGroundPolylineGeometry.js +2 -2
  75. package/Build/Cesium/Workers/createPlaneGeometry.js +2 -2
  76. package/Build/Cesium/Workers/createPlaneOutlineGeometry.js +2 -2
  77. package/Build/Cesium/Workers/createPolygonGeometry.js +2 -2
  78. package/Build/Cesium/Workers/createPolygonOutlineGeometry.js +2 -2
  79. package/Build/Cesium/Workers/createPolylineGeometry.js +2 -2
  80. package/Build/Cesium/Workers/createPolylineVolumeGeometry.js +2 -2
  81. package/Build/Cesium/Workers/createPolylineVolumeOutlineGeometry.js +2 -2
  82. package/Build/Cesium/Workers/createRectangleGeometry.js +2 -2
  83. package/Build/Cesium/Workers/createRectangleOutlineGeometry.js +2 -2
  84. package/Build/Cesium/Workers/createSimplePolylineGeometry.js +2 -2
  85. package/Build/Cesium/Workers/createSphereGeometry.js +2 -2
  86. package/Build/Cesium/Workers/createSphereOutlineGeometry.js +2 -2
  87. package/Build/Cesium/Workers/createTaskProcessorWorker.js +2 -2
  88. package/Build/Cesium/Workers/createVectorTileClampedPolylines.js +2 -2
  89. package/Build/Cesium/Workers/createVectorTileGeometries.js +2 -2
  90. package/Build/Cesium/Workers/createVectorTilePoints.js +2 -2
  91. package/Build/Cesium/Workers/createVectorTilePolygons.js +2 -2
  92. package/Build/Cesium/Workers/createVectorTilePolylines.js +2 -2
  93. package/Build/Cesium/Workers/createVerticesFromGoogleEarthEnterpriseBuffer.js +2 -2
  94. package/Build/Cesium/Workers/createVerticesFromHeightmap.js +2 -2
  95. package/Build/Cesium/Workers/createVerticesFromQuantizedTerrainMesh.js +2 -2
  96. package/Build/Cesium/Workers/createWallGeometry.js +2 -2
  97. package/Build/Cesium/Workers/createWallOutlineGeometry.js +2 -2
  98. package/Build/Cesium/Workers/decodeDraco.js +2 -2
  99. package/Build/Cesium/Workers/decodeGoogleEarthEnterprisePacket.js +2 -2
  100. package/Build/Cesium/Workers/decodeI3S.js +2 -2
  101. package/Build/Cesium/Workers/transcodeKTX2.js +2 -2
  102. package/Build/Cesium/Workers/transferTypedArrayTest.js +1 -1
  103. package/Build/Cesium/Workers/upsampleQuantizedTerrainMesh.js +2 -2
  104. package/Build/Cesium/index.cjs +4293 -4293
  105. package/Build/Cesium/index.js +4281 -4281
  106. package/README.md +141 -141
  107. package/package.json +1 -1
  108. package/Build/Cesium/Workers/chunk-2K72IAMD.js +0 -66
  109. package/Build/Cesium/Workers/chunk-YEUI4ZO2.js +0 -28
@@ -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
  /**
@@ -9162,7 +9165,7 @@ export namespace ITwinPlatform {
9162
9165
  enum ExportType {
9163
9166
  }
9164
9167
  /**
9165
- * Types of Reality data
9168
+ * Types of Reality data. This is a partial list of types we know we can support
9166
9169
  */
9167
9170
  enum RealityDataType {
9168
9171
  }
@@ -12361,11 +12364,11 @@ export class OrientedBoundingBox {
12361
12364
  /**
12362
12365
  * Compares the provided OrientedBoundingBox componentwise and returns
12363
12366
  <code>true</code> if they are equal, <code>false</code> otherwise.
12364
- * @param left - The first OrientedBoundingBox.
12365
- * @param right - The second OrientedBoundingBox.
12367
+ * @param [left] - The first OrientedBoundingBox.
12368
+ * @param [right] - The second OrientedBoundingBox.
12366
12369
  * @returns <code>true</code> if left and right are equal, <code>false</code> otherwise.
12367
12370
  */
12368
- static equals(left: OrientedBoundingBox, right: OrientedBoundingBox): boolean;
12371
+ static equals(left?: OrientedBoundingBox, right?: OrientedBoundingBox): boolean;
12369
12372
  /**
12370
12373
  * Duplicates this OrientedBoundingBox instance.
12371
12374
  * @param [result] - The object onto which to store the result.
@@ -12498,19 +12501,19 @@ export class OrthographicFrustum {
12498
12501
 
12499
12502
  /**
12500
12503
  * The viewing frustum is defined by 6 planes.
12501
- * Each plane is represented by a {@link Cartesian4} object, where the x, y, and z components
12502
- * define the unit vector normal to the plane, and the w component is the distance of the
12503
- * plane from the origin/camera position.
12504
+ Each plane is represented by a {@link Cartesian4} object, where the x, y, and z components
12505
+ define the unit vector normal to the plane, and the w component is the distance of the
12506
+ plane from the origin/camera position.
12504
12507
  * @example
12505
12508
  * const maxRadii = ellipsoid.maximumRadius;
12506
- *
12507
- * const frustum = new Cesium.OrthographicOffCenterFrustum();
12508
- * frustum.right = maxRadii * Cesium.Math.PI;
12509
- * frustum.left = -c.frustum.right;
12510
- * frustum.top = c.frustum.right * (canvas.clientHeight / canvas.clientWidth);
12511
- * frustum.bottom = -c.frustum.top;
12512
- * frustum.near = 0.01 * maxRadii;
12513
- * frustum.far = 50.0 * maxRadii;
12509
+
12510
+ const frustum = new Cesium.OrthographicOffCenterFrustum();
12511
+ frustum.right = maxRadii * Cesium.Math.PI;
12512
+ frustum.left = -c.frustum.right;
12513
+ frustum.top = c.frustum.right * (canvas.clientHeight / canvas.clientWidth);
12514
+ frustum.bottom = -c.frustum.top;
12515
+ frustum.near = 0.01 * maxRadii;
12516
+ frustum.far = 50.0 * maxRadii;
12514
12517
  * @param [options] - An object with the following properties:
12515
12518
  * @param [options.left] - The left clipping plane distance.
12516
12519
  * @param [options.right] - The right clipping plane distance.
@@ -12560,8 +12563,8 @@ export class OrthographicOffCenterFrustum {
12560
12563
  * Creates a culling volume for this frustum.
12561
12564
  * @example
12562
12565
  * // Check if a bounding volume intersects the frustum.
12563
- * const cullingVolume = frustum.computeCullingVolume(cameraPosition, cameraDirection, cameraUp);
12564
- * const intersect = cullingVolume.computeVisibility(boundingVolume);
12566
+ const cullingVolume = frustum.computeCullingVolume(cameraPosition, cameraDirection, cameraUp);
12567
+ const intersect = cullingVolume.computeVisibility(boundingVolume);
12565
12568
  * @param position - The eye position.
12566
12569
  * @param direction - The view direction.
12567
12570
  * @param up - The up direction.
@@ -12572,8 +12575,8 @@ export class OrthographicOffCenterFrustum {
12572
12575
  * Returns the pixel's width and height in meters.
12573
12576
  * @example
12574
12577
  * // Example 1
12575
- * // Get the width and height of a pixel.
12576
- * const pixelSize = camera.frustum.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, 0.0, scene.pixelRatio, new Cesium.Cartesian2());
12578
+ // Get the width and height of a pixel.
12579
+ const pixelSize = camera.frustum.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, 0.0, scene.pixelRatio, new Cesium.Cartesian2());
12577
12580
  * @param drawingBufferWidth - The width of the drawing buffer.
12578
12581
  * @param drawingBufferHeight - The height of the drawing buffer.
12579
12582
  * @param distance - The distance to the near plane in meters.
@@ -12590,15 +12593,15 @@ export class OrthographicOffCenterFrustum {
12590
12593
  clone(result?: OrthographicOffCenterFrustum): OrthographicOffCenterFrustum;
12591
12594
  /**
12592
12595
  * Compares the provided OrthographicOffCenterFrustum componentwise and returns
12593
- * <code>true</code> if they are equal, <code>false</code> otherwise.
12596
+ <code>true</code> if they are equal, <code>false</code> otherwise.
12594
12597
  * @param [other] - The right hand side OrthographicOffCenterFrustum.
12595
12598
  * @returns <code>true</code> if they are equal, <code>false</code> otherwise.
12596
12599
  */
12597
12600
  equals(other?: OrthographicOffCenterFrustum): boolean;
12598
12601
  /**
12599
12602
  * Compares the provided OrthographicOffCenterFrustum componentwise and returns
12600
- * <code>true</code> if they pass an absolute or relative tolerance test,
12601
- * <code>false</code> otherwise.
12603
+ <code>true</code> if they pass an absolute or relative tolerance test,
12604
+ <code>false</code> otherwise.
12602
12605
  * @param other - The right hand side OrthographicOffCenterFrustum.
12603
12606
  * @param relativeEpsilon - The relative epsilon tolerance to use for equality testing.
12604
12607
  * @param [absoluteEpsilon = relativeEpsilon] - The absolute epsilon tolerance to use for equality testing.
@@ -16216,7 +16219,7 @@ export namespace ScreenSpaceEventHandler {
16216
16219
 
16217
16220
  /**
16218
16221
  * Handles user input events. Custom functions can be added to be executed on
16219
- * when the user enters input.
16222
+ when the user enters input.
16220
16223
  * @param [element = document] - The element to add events to.
16221
16224
  */
16222
16225
  export class ScreenSpaceEventHandler {
@@ -16226,14 +16229,14 @@ export class ScreenSpaceEventHandler {
16226
16229
  * @param action - Function to be executed when the input event occurs.
16227
16230
  * @param type - The ScreenSpaceEventType of input event.
16228
16231
  * @param [modifier] - A KeyboardEventModifier key that is held when a <code>type</code>
16229
- * event occurs.
16232
+ event occurs.
16230
16233
  */
16231
16234
  setInputAction(action: ScreenSpaceEventHandler.PositionedEventCallback | ScreenSpaceEventHandler.MotionEventCallback | ScreenSpaceEventHandler.WheelEventCallback | ScreenSpaceEventHandler.TwoPointEventCallback | ScreenSpaceEventHandler.TwoPointMotionEventCallback, type: ScreenSpaceEventType, modifier?: KeyboardEventModifier): void;
16232
16235
  /**
16233
16236
  * Returns the function to be executed on an input event.
16234
16237
  * @param type - The ScreenSpaceEventType of input event.
16235
16238
  * @param [modifier] - A KeyboardEventModifier key that is held when a <code>type</code>
16236
- * event occurs.
16239
+ event occurs.
16237
16240
  * @returns The function to be executed on an input event.
16238
16241
  */
16239
16242
  getInputAction(type: ScreenSpaceEventType, modifier?: KeyboardEventModifier): ScreenSpaceEventHandler.PositionedEventCallback | ScreenSpaceEventHandler.MotionEventCallback | ScreenSpaceEventHandler.WheelEventCallback | ScreenSpaceEventHandler.TwoPointEventCallback | ScreenSpaceEventHandler.TwoPointMotionEventCallback;
@@ -16241,35 +16244,35 @@ export class ScreenSpaceEventHandler {
16241
16244
  * Removes the function to be executed on an input event.
16242
16245
  * @param type - The ScreenSpaceEventType of input event.
16243
16246
  * @param [modifier] - A KeyboardEventModifier key that is held when a <code>type</code>
16244
- * event occurs.
16247
+ event occurs.
16245
16248
  */
16246
16249
  removeInputAction(type: ScreenSpaceEventType, modifier?: KeyboardEventModifier): void;
16247
16250
  /**
16248
16251
  * Returns true if this object was destroyed; otherwise, false.
16249
- * <br /><br />
16250
- * If this object was destroyed, it should not be used; calling any function other than
16251
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
16252
+ <br /><br />
16253
+ If this object was destroyed, it should not be used; calling any function other than
16254
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
16252
16255
  * @returns <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
16253
16256
  */
16254
16257
  isDestroyed(): boolean;
16255
16258
  /**
16256
16259
  * Removes listeners held by this object.
16257
- * <br /><br />
16258
- * Once an object is destroyed, it should not be used; calling any function other than
16259
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
16260
- * assign the return value (<code>undefined</code>) to the object as done in the example.
16260
+ <br /><br />
16261
+ Once an object is destroyed, it should not be used; calling any function other than
16262
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
16263
+ assign the return value (<code>undefined</code>) to the object as done in the example.
16261
16264
  * @example
16262
16265
  * handler = handler && handler.destroy();
16263
16266
  */
16264
16267
  destroy(): void;
16265
16268
  /**
16266
16269
  * The amount of time, in milliseconds, that mouse events will be disabled after
16267
- * receiving any touch events, such that any emulated mouse events will be ignored.
16270
+ receiving any touch events, such that any emulated mouse events will be ignored.
16268
16271
  */
16269
16272
  static mouseEmulationIgnoreMilliseconds: number;
16270
16273
  /**
16271
16274
  * The amount of time, in milliseconds, before a touch on the screen becomes a
16272
- * touch and hold.
16275
+ touch and hold.
16273
16276
  */
16274
16277
  static touchHoldDelayMilliseconds: number;
16275
16278
  }
@@ -16612,11 +16615,11 @@ export class Spherical {
16612
16615
  static normalize(spherical: Spherical, result?: Spherical): Spherical;
16613
16616
  /**
16614
16617
  * Returns true if the first spherical is equal to the second spherical, false otherwise.
16615
- * @param left - The first Spherical to be compared.
16616
- * @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.
16617
16620
  * @returns true if the first spherical is equal to the second spherical, false otherwise.
16618
16621
  */
16619
- static equals(left: Spherical, right: Spherical): boolean;
16622
+ static equals(left?: Spherical, right?: Spherical): boolean;
16620
16623
  /**
16621
16624
  * Returns true if the first spherical is within the provided epsilon of the second spherical, false otherwise.
16622
16625
  * @param left - The first Spherical to be compared.
@@ -16627,10 +16630,10 @@ export class Spherical {
16627
16630
  static equalsEpsilon(left: Spherical, right: Spherical, epsilon?: number): boolean;
16628
16631
  /**
16629
16632
  * Returns true if this spherical is equal to the provided spherical, false otherwise.
16630
- * @param other - The Spherical to be compared.
16633
+ * @param [other] - The Spherical to be compared.
16631
16634
  * @returns true if this spherical is equal to the provided spherical, false otherwise.
16632
16635
  */
16633
- equals(other: Spherical): boolean;
16636
+ equals(other?: Spherical): boolean;
16634
16637
  /**
16635
16638
  * Creates a duplicate of this Spherical.
16636
16639
  * @param [result] - The object to store the result into, if undefined a new instance will be created.
@@ -18761,7 +18764,6 @@ If text is blank, returns undefined.
18761
18764
  * @param text - The text to write.
18762
18765
  * @param [options] - Object with the following properties:
18763
18766
  * @param [options.font = '10px sans-serif'] - The CSS font to use.
18764
- * @param [options.textBaseline = 'bottom'] - The baseline of the text.
18765
18767
  * @param [options.fill = true] - Whether to fill the text.
18766
18768
  * @param [options.stroke = false] - Whether to stroke the text.
18767
18769
  * @param [options.fillColor = Color.WHITE] - The fill color.
@@ -18775,7 +18777,6 @@ If text is blank, returns undefined.
18775
18777
  */
18776
18778
  export function writeTextToCanvas(text: string, options?: {
18777
18779
  font?: string;
18778
- textBaseline?: string;
18779
18780
  fill?: boolean;
18780
18781
  stroke?: boolean;
18781
18782
  fillColor?: Color;
@@ -19041,6 +19042,21 @@ export class BillboardVisualizer {
19041
19042
  destroy(): void;
19042
19043
  }
19043
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
+
19044
19060
  /**
19045
19061
  * A {@link GeometryUpdater} for boxes.
19046
19062
  Clients do not normally create this class directly, but instead rely on {@link DataSourceDisplay}.
@@ -20438,10 +20454,10 @@ export class DataSourceClock {
20438
20454
  clone(result?: DataSourceClock): DataSourceClock;
20439
20455
  /**
20440
20456
  * Returns true if this DataSourceClock is equivalent to the other
20441
- * @param other - The other DataSourceClock to compare to.
20457
+ * @param [other] - The other DataSourceClock to compare to.
20442
20458
  * @returns <code>true</code> if the DataSourceClocks are equal; otherwise, <code>false</code>.
20443
20459
  */
20444
- equals(other: DataSourceClock): boolean;
20460
+ equals(other?: DataSourceClock): boolean;
20445
20461
  /**
20446
20462
  * Assigns each unassigned property on this object to the value
20447
20463
  of the same property on the provided source object.
@@ -21864,10 +21880,10 @@ export class GeometryVisualizer {
21864
21880
  constructor(scene: Scene, entityCollection: EntityCollection, primitives?: PrimitiveCollection, groundPrimitives?: PrimitiveCollection);
21865
21881
  /**
21866
21882
  * Updates all of the primitives created by this visualizer to match their
21867
- * Entity counterpart at the given time.
21883
+ Entity counterpart at the given time.
21868
21884
  * @param time - The time to update to.
21869
21885
  * @returns True if the visualizer successfully updated to the provided time,
21870
- * false if the visualizer is waiting for asynchronous primitives to be created.
21886
+ false if the visualizer is waiting for asynchronous primitives to be created.
21871
21887
  */
21872
21888
  update(time: JulianDate): boolean;
21873
21889
  /**
@@ -22817,6 +22833,7 @@ export namespace ModelGraphics {
22817
22833
  * @property [colorBlendMode = ColorBlendMode.HIGHLIGHT] - An enum Property specifying how the color blends with the model.
22818
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.
22819
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.
22820
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.
22821
22838
  * @property [distanceDisplayCondition] - A Property specifying at what distance from the camera that this model will be displayed.
22822
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.
@@ -22842,6 +22859,9 @@ export namespace ModelGraphics {
22842
22859
  colorBlendMode?: Property | ColorBlendMode;
22843
22860
  colorBlendAmount?: Property | number;
22844
22861
  imageBasedLightingFactor?: Property | Cartesian2;
22862
+ environmentMapOptions?: PropertyBag | {
22863
+ [key: string]: any;
22864
+ };
22845
22865
  lightColor?: Property | Color;
22846
22866
  distanceDisplayCondition?: Property | DistanceDisplayCondition;
22847
22867
  nodeTransformations?: PropertyBag | {
@@ -22949,6 +22969,10 @@ export class ModelGraphics {
22949
22969
  * A property specifying the {@link Cartesian2} used to scale the diffuse and specular image-based lighting contribution to the final color.
22950
22970
  */
22951
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;
22952
22976
  /**
22953
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.
22954
22978
  */
@@ -22999,7 +23023,7 @@ export class ModelVisualizer {
22999
23023
  constructor(scene: Scene, entityCollection: EntityCollection);
23000
23024
  /**
23001
23025
  * Updates models created this visualizer to match their
23002
- * Entity counterpart at the given time.
23026
+ Entity counterpart at the given time.
23003
23027
  * @param time - The time to update to.
23004
23028
  * @returns This function always returns true.
23005
23029
  */
@@ -24075,10 +24099,10 @@ export class PolylineVisualizer {
24075
24099
  constructor(scene: Scene, entityCollection: EntityCollection, primitives?: PrimitiveCollection, groundPrimitives?: PrimitiveCollection);
24076
24100
  /**
24077
24101
  * Updates all of the primitives created by this visualizer to match their
24078
- * Entity counterpart at the given time.
24102
+ Entity counterpart at the given time.
24079
24103
  * @param time - The time to update to.
24080
24104
  * @returns True if the visualizer successfully updated to the provided time,
24081
- * false if the visualizer is waiting for asynchronous primitives to be created.
24105
+ false if the visualizer is waiting for asynchronous primitives to be created.
24082
24106
  */
24083
24107
  update(time: JulianDate): boolean;
24084
24108
  /**
@@ -26467,10 +26491,10 @@ export class Billboard {
26467
26491
  /**
26468
26492
  * Determines if this billboard equals another billboard. Billboards are equal if all their properties
26469
26493
  are equal. Billboards in different collections can be equal.
26470
- * @param other - The billboard to compare for equality.
26494
+ * @param [other] - The billboard to compare for equality.
26471
26495
  * @returns <code>true</code> if the billboards are equal; otherwise, <code>false</code>.
26472
26496
  */
26473
- equals(other: Billboard): boolean;
26497
+ equals(other?: Billboard): boolean;
26474
26498
  }
26475
26499
 
26476
26500
  /**
@@ -28451,6 +28475,7 @@ export namespace Cesium3DTileset {
28451
28475
  * @property [pointCloudShading] - Options for constructing a {@link PointCloudShading} object to control point attenuation based on geometric error and lighting.
28452
28476
  * @property [lightColor] - The light color when shading models. When <code>undefined</code> the scene's light color is used instead.
28453
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.
28454
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.
28455
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.
28456
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.
@@ -28476,7 +28501,6 @@ export namespace Cesium3DTileset {
28476
28501
  * @property [debugShowRenderingStatistics = false] - For debugging only. When true, draws labels to indicate the number of commands, points, triangles and features for each tile.
28477
28502
  * @property [debugShowMemoryUsage = false] - For debugging only. When true, draws labels to indicate the texture and geometry memory in megabytes used by each tile.
28478
28503
  * @property [debugShowUrl = false] - For debugging only. When true, draws labels to indicate the url of each tile.
28479
- * @param [options.environmentMapOptions] - The properties for managing dynamic environment maps on this model.
28480
28504
  */
28481
28505
  type ConstructorOptions = {
28482
28506
  show?: boolean;
@@ -28516,6 +28540,7 @@ export namespace Cesium3DTileset {
28516
28540
  pointCloudShading?: any;
28517
28541
  lightColor?: Cartesian3;
28518
28542
  imageBasedLighting?: ImageBasedLighting;
28543
+ environmentMapOptions?: DynamicEnvironmentMapManager.ConstructorOptions;
28519
28544
  backFaceCulling?: boolean;
28520
28545
  enableShowOutline?: boolean;
28521
28546
  showOutline?: boolean;
@@ -30637,7 +30662,7 @@ export class ClippingPolygon {
30637
30662
  * @param right - The second polygon.
30638
30663
  * @returns <code>true</code> if left and right are equal, <code>false</code> otherwise.
30639
30664
  */
30640
- static equals(left: Plane, right: Plane): boolean;
30665
+ static equals(left: ClippingPolygon, right: ClippingPolygon): boolean;
30641
30666
  /**
30642
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.
30643
30668
  * @param [result] - An object in which to store the result.
@@ -31745,9 +31770,9 @@ export enum DepthFunction {
31745
31770
 
31746
31771
  /**
31747
31772
  * Returns the type that the given class property has in a GLSL shader.
31748
- *
31749
- * It returns the same string as `PropertyTextureProperty.prototype.getGlslType`
31750
- * for a property texture property with the given class property
31773
+
31774
+ It returns the same string as `PropertyTextureProperty.prototype.getGlslType`
31775
+ for a property texture property with the given class property
31751
31776
  * @param classProperty - The class property
31752
31777
  * @returns The GLSL shader type string for the property
31753
31778
  */
@@ -31755,8 +31780,8 @@ export function getGlslType(classProperty: MetadataClassProperty): string;
31755
31780
 
31756
31781
  /**
31757
31782
  * Returns a shader statement that applies the inverse of the
31758
- * value transform to the given value, based on the given offset
31759
- * and scale.
31783
+ value transform to the given value, based on the given offset
31784
+ and scale.
31760
31785
  * @param input - The input value
31761
31786
  * @param offset - The offset
31762
31787
  * @param scale - The scale
@@ -31766,7 +31791,7 @@ export function unapplyValueTransform(input: string, offset: string, scale: stri
31766
31791
 
31767
31792
  /**
31768
31793
  * Returns a shader statement that applies the inverse of the
31769
- * normalization, based on the given component type
31794
+ normalization, based on the given component type
31770
31795
  * @param input - The input value
31771
31796
  * @param componentType - The component type
31772
31797
  * @returns The statement
@@ -31775,20 +31800,20 @@ export function unnormalize(input: string, componentType: string): string;
31775
31800
 
31776
31801
  /**
31777
31802
  * Creates a shader statement that returns the value of the specified
31778
- * property, normalized to the range [0, 1].
31803
+ property, normalized to the range [0, 1].
31779
31804
  * @param classProperty - The class property
31780
31805
  * @param metadataProperty - The metadata property, either
31781
- * a `PropertyTextureProperty` or a `PropertyAttributeProperty`
31806
+ a `PropertyTextureProperty` or a `PropertyAttributeProperty`
31782
31807
  * @returns The string
31783
31808
  */
31784
31809
  export function getSourceValueStringScalar(classProperty: MetadataClassProperty, metadataProperty: any): string;
31785
31810
 
31786
31811
  /**
31787
31812
  * Creates a shader statement that returns the value of the specified
31788
- * component of the given property, normalized to the range [0, 1].
31813
+ component of the given property, normalized to the range [0, 1].
31789
31814
  * @param classProperty - The class property
31790
31815
  * @param metadataProperty - The metadata property, either
31791
- * a `PropertyTextureProperty` or a `PropertyAttributeProperty`
31816
+ a `PropertyTextureProperty` or a `PropertyAttributeProperty`
31792
31817
  * @param componentName - The name, in ["x", "y", "z", "w"]
31793
31818
  * @returns The string
31794
31819
  */
@@ -31901,7 +31926,7 @@ export namespace DynamicEnvironmentMapManager {
31901
31926
  /**
31902
31927
  * Options for the DynamicEnvironmentMapManager constructor
31903
31928
  * @property [enabled = true] - If true, the environment map and related properties will continue to update.
31904
- * @property [mipmapLevels = 10] - The number of mipmap levels to generate for specular maps. More mipmap levels will produce a higher resolution specular reflection.
31929
+ * @property [mipmapLevels = 7] - The number of mipmap levels to generate for specular maps. More mipmap levels will produce a higher resolution specular reflection.
31905
31930
  * @property [maximumSecondsDifference = 3600] - The maximum amount of elapsed seconds before a new environment map is created.
31906
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.
31907
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.
@@ -34239,81 +34264,81 @@ export namespace ImageryLayer {
34239
34264
  /**
34240
34265
  * Initialization options for the ImageryLayer constructor.
34241
34266
  * @property [rectangle = imageryProvider.rectangle] - The rectangle of the layer. This rectangle
34242
- * can limit the visible portion of the imagery provider.
34267
+ can limit the visible portion of the imagery provider.
34243
34268
  * @property [alpha = 1.0] - The alpha blending value of this layer, from 0.0 to 1.0.
34244
- * This can either be a simple number or a function with the signature
34245
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34246
- * current frame state, this layer, and the x, y, and level coordinates of the
34247
- * imagery tile for which the alpha is required, and it is expected to return
34248
- * the alpha value to use for the tile.
34269
+ This can either be a simple number or a function with the signature
34270
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34271
+ current frame state, this layer, and the x, y, and level coordinates of the
34272
+ imagery tile for which the alpha is required, and it is expected to return
34273
+ the alpha value to use for the tile.
34249
34274
  * @property [nightAlpha = 1.0] - The alpha blending value of this layer on the night side of the globe, from 0.0 to 1.0.
34250
- * This can either be a simple number or a function with the signature
34251
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34252
- * current frame state, this layer, and the x, y, and level coordinates of the
34253
- * imagery tile for which the alpha is required, and it is expected to return
34254
- * the alpha value to use for the tile. This only takes effect when <code>enableLighting</code> is <code>true</code>.
34275
+ This can either be a simple number or a function with the signature
34276
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34277
+ current frame state, this layer, and the x, y, and level coordinates of the
34278
+ imagery tile for which the alpha is required, and it is expected to return
34279
+ the alpha value to use for the tile. This only takes effect when <code>enableLighting</code> is <code>true</code>.
34255
34280
  * @property [dayAlpha = 1.0] - The alpha blending value of this layer on the day side of the globe, from 0.0 to 1.0.
34256
- * This can either be a simple number or a function with the signature
34257
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34258
- * current frame state, this layer, and the x, y, and level coordinates of the
34259
- * imagery tile for which the alpha is required, and it is expected to return
34260
- * the alpha value to use for the tile. This only takes effect when <code>enableLighting</code> is <code>true</code>.
34281
+ This can either be a simple number or a function with the signature
34282
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34283
+ current frame state, this layer, and the x, y, and level coordinates of the
34284
+ imagery tile for which the alpha is required, and it is expected to return
34285
+ the alpha value to use for the tile. This only takes effect when <code>enableLighting</code> is <code>true</code>.
34261
34286
  * @property [brightness = 1.0] - The brightness of this layer. 1.0 uses the unmodified imagery
34262
- * color. Less than 1.0 makes the imagery darker while greater than 1.0 makes it brighter.
34263
- * This can either be a simple number or a function with the signature
34264
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34265
- * current frame state, this layer, and the x, y, and level coordinates of the
34266
- * imagery tile for which the brightness is required, and it is expected to return
34267
- * the brightness value to use for the tile. The function is executed for every
34268
- * frame and for every tile, so it must be fast.
34287
+ color. Less than 1.0 makes the imagery darker while greater than 1.0 makes it brighter.
34288
+ This can either be a simple number or a function with the signature
34289
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34290
+ current frame state, this layer, and the x, y, and level coordinates of the
34291
+ imagery tile for which the brightness is required, and it is expected to return
34292
+ the brightness value to use for the tile. The function is executed for every
34293
+ frame and for every tile, so it must be fast.
34269
34294
  * @property [contrast = 1.0] - The contrast of this layer. 1.0 uses the unmodified imagery color.
34270
- * Less than 1.0 reduces the contrast while greater than 1.0 increases it.
34271
- * This can either be a simple number or a function with the signature
34272
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34273
- * current frame state, this layer, and the x, y, and level coordinates of the
34274
- * imagery tile for which the contrast is required, and it is expected to return
34275
- * the contrast value to use for the tile. The function is executed for every
34276
- * frame and for every tile, so it must be fast.
34295
+ Less than 1.0 reduces the contrast while greater than 1.0 increases it.
34296
+ This can either be a simple number or a function with the signature
34297
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34298
+ current frame state, this layer, and the x, y, and level coordinates of the
34299
+ imagery tile for which the contrast is required, and it is expected to return
34300
+ the contrast value to use for the tile. The function is executed for every
34301
+ frame and for every tile, so it must be fast.
34277
34302
  * @property [hue = 0.0] - The hue of this layer. 0.0 uses the unmodified imagery color.
34278
- * This can either be a simple number or a function with the signature
34279
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34280
- * current frame state, this layer, and the x, y, and level coordinates
34281
- * of the imagery tile for which the hue is required, and it is expected to return
34282
- * the contrast value to use for the tile. The function is executed for every
34283
- * frame and for every tile, so it must be fast.
34303
+ This can either be a simple number or a function with the signature
34304
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34305
+ current frame state, this layer, and the x, y, and level coordinates
34306
+ of the imagery tile for which the hue is required, and it is expected to return
34307
+ the contrast value to use for the tile. The function is executed for every
34308
+ frame and for every tile, so it must be fast.
34284
34309
  * @property [saturation = 1.0] - The saturation of this layer. 1.0 uses the unmodified imagery color.
34285
- * Less than 1.0 reduces the saturation while greater than 1.0 increases it.
34286
- * This can either be a simple number or a function with the signature
34287
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34288
- * current frame state, this layer, and the x, y, and level coordinates
34289
- * of the imagery tile for which the saturation is required, and it is expected to return
34290
- * the contrast value to use for the tile. The function is executed for every
34291
- * frame and for every tile, so it must be fast.
34310
+ Less than 1.0 reduces the saturation while greater than 1.0 increases it.
34311
+ This can either be a simple number or a function with the signature
34312
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34313
+ current frame state, this layer, and the x, y, and level coordinates
34314
+ of the imagery tile for which the saturation is required, and it is expected to return
34315
+ the contrast value to use for the tile. The function is executed for every
34316
+ frame and for every tile, so it must be fast.
34292
34317
  * @property [gamma = 1.0] - The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color.
34293
- * This can either be a simple number or a function with the signature
34294
- * <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34295
- * current frame state, this layer, and the x, y, and level coordinates of the
34296
- * imagery tile for which the gamma is required, and it is expected to return
34297
- * the gamma value to use for the tile. The function is executed for every
34298
- * frame and for every tile, so it must be fast.
34318
+ This can either be a simple number or a function with the signature
34319
+ <code>function(frameState, layer, x, y, level)</code>. The function is passed the
34320
+ current frame state, this layer, and the x, y, and level coordinates of the
34321
+ imagery tile for which the gamma is required, and it is expected to return
34322
+ the gamma value to use for the tile. The function is executed for every
34323
+ frame and for every tile, so it must be fast.
34299
34324
  * @property [splitDirection = SplitDirection.NONE] - The {@link SplitDirection} split to apply to this layer.
34300
34325
  * @property [minificationFilter = TextureMinificationFilter.LINEAR] - The
34301
- * texture minification filter to apply to this layer. Possible values
34302
- * are <code>TextureMinificationFilter.LINEAR</code> and
34303
- * <code>TextureMinificationFilter.NEAREST</code>.
34326
+ texture minification filter to apply to this layer. Possible values
34327
+ are <code>TextureMinificationFilter.LINEAR</code> and
34328
+ <code>TextureMinificationFilter.NEAREST</code>.
34304
34329
  * @property [magnificationFilter = TextureMagnificationFilter.LINEAR] - The
34305
- * texture minification filter to apply to this layer. Possible values
34306
- * are <code>TextureMagnificationFilter.LINEAR</code> and
34307
- * <code>TextureMagnificationFilter.NEAREST</code>.
34330
+ texture minification filter to apply to this layer. Possible values
34331
+ are <code>TextureMagnificationFilter.LINEAR</code> and
34332
+ <code>TextureMagnificationFilter.NEAREST</code>.
34308
34333
  * @property [show = true] - True if the layer is shown; otherwise, false.
34309
34334
  * @property [maximumAnisotropy = maximum supported] - The maximum anisotropy level to use
34310
- * for texture filtering. If this parameter is not specified, the maximum anisotropy supported
34311
- * by the WebGL stack will be used. Larger values make the imagery look better in horizon
34312
- * views.
34335
+ for texture filtering. If this parameter is not specified, the maximum anisotropy supported
34336
+ by the WebGL stack will be used. Larger values make the imagery look better in horizon
34337
+ views.
34313
34338
  * @property [minimumTerrainLevel] - The minimum terrain level-of-detail at which to show this imagery layer,
34314
- * or undefined to show it at all levels. Level zero is the least-detailed level.
34339
+ or undefined to show it at all levels. Level zero is the least-detailed level.
34315
34340
  * @property [maximumTerrainLevel] - The maximum terrain level-of-detail at which to show this imagery layer,
34316
- * or undefined to show it at all levels. Level zero is the least-detailed level.
34341
+ or undefined to show it at all levels. Level zero is the least-detailed level.
34317
34342
  * @property [cutoutRectangle] - Cartographic rectangle for cutting out a portion of this ImageryLayer.
34318
34343
  * @property [colorToAlpha] - Color to be used as alpha.
34319
34344
  * @property [colorToAlphaThreshold = 0.004] - Threshold for color-to-alpha.
@@ -34348,22 +34373,22 @@ export namespace ImageryLayer {
34348
34373
 
34349
34374
  /**
34350
34375
  * An imagery layer that displays tiled image data from a single imagery provider
34351
- * on a {@link Globe}.
34376
+ on a {@link Globe}.
34352
34377
  * @example
34353
34378
  * // Add an OpenStreetMaps layer
34354
- * const imageryLayer = new Cesium.ImageryLayer(new Cesium.OpenStreetMapImageryProvider({
34355
- * url: "https://tile.openstreetmap.org/"
34356
- * }));
34357
- * scene.imageryLayers.add(imageryLayer);
34379
+ const imageryLayer = new Cesium.ImageryLayer(new Cesium.OpenStreetMapImageryProvider({
34380
+ url: "https://tile.openstreetmap.org/"
34381
+ }));
34382
+ scene.imageryLayers.add(imageryLayer);
34358
34383
  * @example
34359
34384
  * // Add Cesium ion's default world imagery layer
34360
- * const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
34361
- * scene.imageryLayers.add(imageryLayer);
34385
+ const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
34386
+ scene.imageryLayers.add(imageryLayer);
34362
34387
  * @example
34363
34388
  * // Add a new transparent layer from Cesium ion
34364
- * const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34365
- * imageryLayer.alpha = 0.5;
34366
- * scene.imageryLayers.add(imageryLayer);
34389
+ const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34390
+ imageryLayer.alpha = 0.5;
34391
+ scene.imageryLayers.add(imageryLayer);
34367
34392
  * @param [imageryProvider] - The imagery provider to use.
34368
34393
  * @param [options] - An object describing initialization options
34369
34394
  */
@@ -34371,27 +34396,27 @@ export class ImageryLayer {
34371
34396
  constructor(imageryProvider?: ImageryProvider, options?: ImageryLayer.ConstructorOptions);
34372
34397
  /**
34373
34398
  * The alpha blending value of this layer, with 0.0 representing fully transparent and
34374
- * 1.0 representing fully opaque.
34399
+ 1.0 representing fully opaque.
34375
34400
  */
34376
34401
  alpha: number;
34377
34402
  /**
34378
34403
  * The alpha blending value of this layer on the night side of the globe, with 0.0 representing fully transparent and
34379
- * 1.0 representing fully opaque. This only takes effect when {@link Globe#enableLighting} is <code>true</code>.
34404
+ 1.0 representing fully opaque. This only takes effect when {@link Globe#enableLighting} is <code>true</code>.
34380
34405
  */
34381
34406
  nightAlpha: number;
34382
34407
  /**
34383
34408
  * The alpha blending value of this layer on the day side of the globe, with 0.0 representing fully transparent and
34384
- * 1.0 representing fully opaque. This only takes effect when {@link Globe#enableLighting} is <code>true</code>.
34409
+ 1.0 representing fully opaque. This only takes effect when {@link Globe#enableLighting} is <code>true</code>.
34385
34410
  */
34386
34411
  dayAlpha: number;
34387
34412
  /**
34388
34413
  * The brightness of this layer. 1.0 uses the unmodified imagery color. Less than 1.0
34389
- * makes the imagery darker while greater than 1.0 makes it brighter.
34414
+ makes the imagery darker while greater than 1.0 makes it brighter.
34390
34415
  */
34391
34416
  brightness: number;
34392
34417
  /**
34393
34418
  * The contrast of this layer. 1.0 uses the unmodified imagery color. Less than 1.0 reduces
34394
- * the contrast while greater than 1.0 increases it.
34419
+ the contrast while greater than 1.0 increases it.
34395
34420
  */
34396
34421
  contrast: number;
34397
34422
  /**
@@ -34400,7 +34425,7 @@ export class ImageryLayer {
34400
34425
  hue: number;
34401
34426
  /**
34402
34427
  * The saturation of this layer. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the
34403
- * saturation while greater than 1.0 increases it.
34428
+ saturation while greater than 1.0 increases it.
34404
34429
  */
34405
34430
  saturation: number;
34406
34431
  /**
@@ -34413,20 +34438,20 @@ export class ImageryLayer {
34413
34438
  splitDirection: SplitDirection;
34414
34439
  /**
34415
34440
  * The {@link TextureMinificationFilter} to apply to this layer.
34416
- * Possible values are {@link TextureMinificationFilter.LINEAR} (the default)
34417
- * and {@link TextureMinificationFilter.NEAREST}.
34418
- *
34419
- * To take effect, this property must be set immediately after adding the imagery layer.
34420
- * Once a texture is loaded it won't be possible to change the texture filter used.
34441
+ Possible values are {@link TextureMinificationFilter.LINEAR} (the default)
34442
+ and {@link TextureMinificationFilter.NEAREST}.
34443
+
34444
+ To take effect, this property must be set immediately after adding the imagery layer.
34445
+ Once a texture is loaded it won't be possible to change the texture filter used.
34421
34446
  */
34422
34447
  minificationFilter: TextureMinificationFilter;
34423
34448
  /**
34424
34449
  * The {@link TextureMagnificationFilter} to apply to this layer.
34425
- * Possible values are {@link TextureMagnificationFilter.LINEAR} (the default)
34426
- * and {@link TextureMagnificationFilter.NEAREST}.
34427
- *
34428
- * To take effect, this property must be set immediately after adding the imagery layer.
34429
- * Once a texture is loaded it won't be possible to change the texture filter used.
34450
+ Possible values are {@link TextureMagnificationFilter.LINEAR} (the default)
34451
+ and {@link TextureMagnificationFilter.NEAREST}.
34452
+
34453
+ To take effect, this property must be set immediately after adding the imagery layer.
34454
+ Once a texture is loaded it won't be possible to change the texture filter used.
34430
34455
  */
34431
34456
  magnificationFilter: TextureMagnificationFilter;
34432
34457
  /**
@@ -34455,158 +34480,158 @@ export class ImageryLayer {
34455
34480
  readonly ready: boolean;
34456
34481
  /**
34457
34482
  * Gets an event that is raised when the imagery provider has been successfully created. Event listeners
34458
- * are passed the created instance of {@link ImageryProvider}.
34483
+ are passed the created instance of {@link ImageryProvider}.
34459
34484
  */
34460
34485
  readonly readyEvent: Event<ImageryLayer.ReadyEventCallback>;
34461
34486
  /**
34462
34487
  * Gets the rectangle of this layer. If this rectangle is smaller than the rectangle of the
34463
- * {@link ImageryProvider}, only a portion of the imagery provider is shown.
34488
+ {@link ImageryProvider}, only a portion of the imagery provider is shown.
34464
34489
  */
34465
34490
  readonly rectangle: Rectangle;
34466
34491
  /**
34467
34492
  * This value is used as the default brightness for the imagery layer if one is not provided during construction
34468
- * or by the imagery provider. This value does not modify the brightness of the imagery.
34493
+ or by the imagery provider. This value does not modify the brightness of the imagery.
34469
34494
  */
34470
34495
  static DEFAULT_BRIGHTNESS: number;
34471
34496
  /**
34472
34497
  * This value is used as the default contrast for the imagery layer if one is not provided during construction
34473
- * or by the imagery provider. This value does not modify the contrast of the imagery.
34498
+ or by the imagery provider. This value does not modify the contrast of the imagery.
34474
34499
  */
34475
34500
  static DEFAULT_CONTRAST: number;
34476
34501
  /**
34477
34502
  * This value is used as the default hue for the imagery layer if one is not provided during construction
34478
- * or by the imagery provider. This value does not modify the hue of the imagery.
34503
+ or by the imagery provider. This value does not modify the hue of the imagery.
34479
34504
  */
34480
34505
  static DEFAULT_HUE: number;
34481
34506
  /**
34482
34507
  * This value is used as the default saturation for the imagery layer if one is not provided during construction
34483
- * or by the imagery provider. This value does not modify the saturation of the imagery.
34508
+ or by the imagery provider. This value does not modify the saturation of the imagery.
34484
34509
  */
34485
34510
  static DEFAULT_SATURATION: number;
34486
34511
  /**
34487
34512
  * This value is used as the default gamma for the imagery layer if one is not provided during construction
34488
- * or by the imagery provider. This value does not modify the gamma of the imagery.
34513
+ or by the imagery provider. This value does not modify the gamma of the imagery.
34489
34514
  */
34490
34515
  static DEFAULT_GAMMA: number;
34491
34516
  /**
34492
34517
  * This value is used as the default split for the imagery layer if one is not provided during construction
34493
- * or by the imagery provider.
34518
+ or by the imagery provider.
34494
34519
  */
34495
34520
  static DEFAULT_SPLIT: SplitDirection;
34496
34521
  /**
34497
34522
  * This value is used as the default texture minification filter for the imagery layer if one is not provided
34498
- * during construction or by the imagery provider.
34523
+ during construction or by the imagery provider.
34499
34524
  */
34500
34525
  static DEFAULT_MINIFICATION_FILTER: TextureMinificationFilter;
34501
34526
  /**
34502
34527
  * This value is used as the default texture magnification filter for the imagery layer if one is not provided
34503
- * during construction or by the imagery provider.
34528
+ during construction or by the imagery provider.
34504
34529
  */
34505
34530
  static DEFAULT_MAGNIFICATION_FILTER: TextureMagnificationFilter;
34506
34531
  /**
34507
34532
  * This value is used as the default threshold for color-to-alpha if one is not provided
34508
- * during construction or by the imagery provider.
34533
+ during construction or by the imagery provider.
34509
34534
  */
34510
34535
  static DEFAULT_APPLY_COLOR_TO_ALPHA_THRESHOLD: number;
34511
34536
  /**
34512
34537
  * Create a new imagery layer from an asynchronous imagery provider. The layer will handle any asynchronous loads or errors, and begin rendering the imagery layer once ready.
34513
34538
  * @example
34514
34539
  * // Create a new base layer
34515
- * const viewer = new Cesium.Viewer("cesiumContainer", {
34516
- * baseLayer: Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34517
- * });
34540
+ const viewer = new Cesium.Viewer("cesiumContainer", {
34541
+ baseLayer: Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34542
+ });
34518
34543
  * @example
34519
34544
  * // Add a new transparent layer
34520
- * const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34521
- * imageryLayer.alpha = 0.5;
34522
- * viewer.imageryLayers.add(imageryLayer);
34545
+ const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34546
+ imageryLayer.alpha = 0.5;
34547
+ viewer.imageryLayers.add(imageryLayer);
34523
34548
  * @example
34524
34549
  * // Handle loading events
34525
- * const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34526
- * viewer.imageryLayers.add(imageryLayer);
34527
- *
34528
- * imageryLayer.readyEvent.addEventListener(provider => {
34529
- * imageryLayer.provider.errorEvent.addEventListener(error => {
34530
- * alert(`Encountered an error while loading imagery tiles! ${error}`);
34531
- * });
34532
- * });
34533
- *
34534
- * imageryLayer.errorEvent.addEventListener(error => {
34535
- * alert(`Encountered an error while creating an imagery layer! ${error}`);
34536
- * });
34550
+ const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34551
+ viewer.imageryLayers.add(imageryLayer);
34552
+
34553
+ imageryLayer.readyEvent.addEventListener(provider => {
34554
+ imageryLayer.provider.errorEvent.addEventListener(error => {
34555
+ alert(`Encountered an error while loading imagery tiles! ${error}`);
34556
+ });
34557
+ });
34558
+
34559
+ imageryLayer.errorEvent.addEventListener(error => {
34560
+ alert(`Encountered an error while creating an imagery layer! ${error}`);
34561
+ });
34537
34562
  * @param imageryProviderPromise - A promise which resolves to a imagery provider
34538
- * @param options - An object describing initialization options
34563
+ * @param [options] - An object describing initialization options
34539
34564
  * @returns The created imagery layer.
34540
34565
  */
34541
- static fromProviderAsync(imageryProviderPromise: Promise<ImageryProvider>, options: ImageryLayer.ConstructorOptions): ImageryLayer;
34566
+ static fromProviderAsync(imageryProviderPromise: Promise<ImageryProvider>, options?: ImageryLayer.ConstructorOptions): ImageryLayer;
34542
34567
  /**
34543
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.
34544
34569
  * @example
34545
34570
  * // Add a new transparent layer
34546
- * const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
34547
- * imageryLayer.alpha = 0.5;
34548
- * viewer.imageryLayers.add(imageryLayer);
34571
+ const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
34572
+ imageryLayer.alpha = 0.5;
34573
+ viewer.imageryLayers.add(imageryLayer);
34549
34574
  * @example
34550
34575
  * // Handle loading events
34551
- * const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
34552
- * viewer.imageryLayers.add(imageryLayer);
34553
- *
34554
- * imageryLayer.readyEvent.addEventListener(provider => {
34555
- * imageryLayer.provider.errorEvent.addEventListener(error => {
34556
- * alert(`Encountered an error while loading imagery tiles! ${error}`);
34557
- * });
34558
- * });
34559
- *
34560
- * imageryLayer.errorEvent.addEventListener(error => {
34561
- * alert(`Encountered an error while creating an imagery layer! ${error}`);
34562
- * });
34576
+ const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
34577
+ viewer.imageryLayers.add(imageryLayer);
34578
+
34579
+ imageryLayer.readyEvent.addEventListener(provider => {
34580
+ imageryLayer.provider.errorEvent.addEventListener(error => {
34581
+ alert(`Encountered an error while loading imagery tiles! ${error}`);
34582
+ });
34583
+ });
34584
+
34585
+ imageryLayer.errorEvent.addEventListener(error => {
34586
+ alert(`Encountered an error while creating an imagery layer! ${error}`);
34587
+ });
34563
34588
  * @param options - An object describing initialization options
34564
34589
  * @returns The created imagery layer.
34565
- *
34566
- * * @example
34567
- * // Create a new base layer
34568
- * const viewer = new Cesium.Viewer("cesiumContainer", {
34569
- * baseLayer: Cesium.ImageryLayer.fromWorldImagery();
34570
- * });
34590
+
34591
+ * @example
34592
+ // Create a new base layer
34593
+ const viewer = new Cesium.Viewer("cesiumContainer", {
34594
+ baseLayer: Cesium.ImageryLayer.fromWorldImagery();
34595
+ });
34571
34596
  */
34572
34597
  static fromWorldImagery(options: ImageryLayer.WorldImageryConstructorOptions): ImageryLayer;
34573
34598
  /**
34574
34599
  * Gets a value indicating whether this layer is the base layer in the
34575
- * {@link ImageryLayerCollection}. The base layer is the one that underlies all
34576
- * others. It is special in that it is treated as if it has global rectangle, even if
34577
- * it actually does not, by stretching the texels at the edges over the entire
34578
- * globe.
34600
+ {@link ImageryLayerCollection}. The base layer is the one that underlies all
34601
+ others. It is special in that it is treated as if it has global rectangle, even if
34602
+ it actually does not, by stretching the texels at the edges over the entire
34603
+ globe.
34579
34604
  * @returns true if this is the base layer; otherwise, false.
34580
34605
  */
34581
34606
  isBaseLayer(): boolean;
34582
34607
  /**
34583
34608
  * Returns true if this object was destroyed; otherwise, false.
34584
- * <br /><br />
34585
- * If this object was destroyed, it should not be used; calling any function other than
34586
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
34609
+ <br /><br />
34610
+ If this object was destroyed, it should not be used; calling any function other than
34611
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
34587
34612
  * @returns True if this object was destroyed; otherwise, false.
34588
34613
  */
34589
34614
  isDestroyed(): boolean;
34590
34615
  /**
34591
34616
  * Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
34592
- * release of WebGL resources, instead of relying on the garbage collector to destroy this object.
34593
- * <br /><br />
34594
- * Once an object is destroyed, it should not be used; calling any function other than
34595
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
34596
- * assign the return value (<code>undefined</code>) to the object as done in the example.
34617
+ release of WebGL resources, instead of relying on the garbage collector to destroy this object.
34618
+ <br /><br />
34619
+ Once an object is destroyed, it should not be used; calling any function other than
34620
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
34621
+ assign the return value (<code>undefined</code>) to the object as done in the example.
34597
34622
  * @example
34598
34623
  * imageryLayer = imageryLayer && imageryLayer.destroy();
34599
34624
  */
34600
34625
  destroy(): void;
34601
34626
  /**
34602
34627
  * Computes the intersection of this layer's rectangle with the imagery provider's availability rectangle,
34603
- * producing the overall bounds of imagery that can be produced by this layer.
34628
+ producing the overall bounds of imagery that can be produced by this layer.
34604
34629
  * @example
34605
34630
  * // Zoom to an imagery layer.
34606
- * const imageryRectangle = imageryLayer.getImageryRectangle();
34607
- * scene.camera.flyTo({
34608
- * destination: rectangle
34609
- * });
34631
+ const imageryRectangle = imageryLayer.getImageryRectangle();
34632
+ scene.camera.flyTo({
34633
+ destination: rectangle
34634
+ });
34610
34635
  * @returns A rectangle which defines the overall bounds of imagery that can be produced by this layer.
34611
34636
  */
34612
34637
  getImageryRectangle(): Rectangle;
@@ -34619,24 +34644,24 @@ export class ImageryLayerCollection {
34619
34644
  constructor();
34620
34645
  /**
34621
34646
  * An event that is raised when a layer is added to the collection. Event handlers are passed the layer that
34622
- * was added and the index at which it was added.
34647
+ was added and the index at which it was added.
34623
34648
  */
34624
34649
  layerAdded: Event;
34625
34650
  /**
34626
34651
  * An event that is raised when a layer is removed from the collection. Event handlers are passed the layer that
34627
- * was removed and the index from which it was removed.
34652
+ was removed and the index from which it was removed.
34628
34653
  */
34629
34654
  layerRemoved: Event;
34630
34655
  /**
34631
34656
  * An event that is raised when a layer changes position in the collection. Event handlers are passed the layer that
34632
- * was moved, its new index after the move, and its old index prior to the move.
34657
+ was moved, its new index after the move, and its old index prior to the move.
34633
34658
  */
34634
34659
  layerMoved: Event;
34635
34660
  /**
34636
34661
  * An event that is raised when a layer is shown or hidden by setting the
34637
- * {@link ImageryLayer#show} property. Event handlers are passed a reference to this layer,
34638
- * the index of the layer in the collection, and a flag that is true if the layer is now
34639
- * shown or false if it is now hidden.
34662
+ {@link ImageryLayer#show} property. Event handlers are passed a reference to this layer,
34663
+ the index of the layer in the collection, and a flag that is true if the layer is now
34664
+ shown or false if it is now hidden.
34640
34665
  */
34641
34666
  layerShownOrHidden: Event;
34642
34667
  /**
@@ -34647,27 +34672,27 @@ export class ImageryLayerCollection {
34647
34672
  * Adds a layer to the collection.
34648
34673
  * @example
34649
34674
  * const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
34650
- * scene.imageryLayers.add(imageryLayer);
34675
+ scene.imageryLayers.add(imageryLayer);
34651
34676
  * @example
34652
34677
  * const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
34653
- * scene.imageryLayers.add(imageryLayer);
34678
+ scene.imageryLayers.add(imageryLayer);
34654
34679
  * @param layer - the layer to add.
34655
34680
  * @param [index] - the index to add the layer at. If omitted, the layer will
34656
- * be added on top of all existing layers.
34681
+ be added on top of all existing layers.
34657
34682
  */
34658
34683
  add(layer: ImageryLayer, index?: number): void;
34659
34684
  /**
34660
34685
  * Creates a new layer using the given ImageryProvider and adds it to the collection.
34661
34686
  * @example
34662
34687
  * try {
34663
- * const provider = await Cesium.IonImageryProvider.fromAssetId(3812);
34664
- * scene.imageryLayers.addImageryProvider(provider);
34665
- * } catch (error) {
34666
- * console.log(`There was an error creating the imagery layer. ${error}`)
34667
- * }
34688
+ const provider = await Cesium.IonImageryProvider.fromAssetId(3812);
34689
+ scene.imageryLayers.addImageryProvider(provider);
34690
+ } catch (error) {
34691
+ console.log(`There was an error creating the imagery layer. ${error}`)
34692
+ }
34668
34693
  * @param imageryProvider - the imagery provider to create a new layer for.
34669
34694
  * @param [index] - the index to add the layer at. If omitted, the layer will
34670
- * added on top of all existing layers.
34695
+ added on top of all existing layers.
34671
34696
  * @returns The newly created layer.
34672
34697
  */
34673
34698
  addImageryProvider(imageryProvider: ImageryProvider, index?: number): ImageryLayer;
@@ -34676,7 +34701,7 @@ export class ImageryLayerCollection {
34676
34701
  * @param layer - The layer to remove.
34677
34702
  * @param [destroy = true] - whether to destroy the layers in addition to removing them.
34678
34703
  * @returns true if the layer was in the collection and was removed,
34679
- * false if the layer was not in the collection.
34704
+ false if the layer was not in the collection.
34680
34705
  */
34681
34706
  remove(layer: ImageryLayer, destroy?: boolean): boolean;
34682
34707
  /**
@@ -34724,57 +34749,57 @@ export class ImageryLayerCollection {
34724
34749
  lowerToBottom(layer: ImageryLayer): void;
34725
34750
  /**
34726
34751
  * Determines the imagery layers that are intersected by a pick ray. To compute a pick ray from a
34727
- * location on the screen, use {@link Camera.getPickRay}.
34752
+ location on the screen, use {@link Camera.getPickRay}.
34728
34753
  * @param ray - The ray to test for intersection.
34729
34754
  * @param scene - The scene.
34730
34755
  * @returns An array that includes all of
34731
- * the layers that are intersected by a given pick ray. Undefined if
34732
- * no layers are selected.
34756
+ the layers that are intersected by a given pick ray. Undefined if
34757
+ no layers are selected.
34733
34758
  */
34734
34759
  pickImageryLayers(ray: Ray, scene: Scene): ImageryLayer[] | undefined;
34735
34760
  /**
34736
34761
  * Asynchronously determines the imagery layer features that are intersected by a pick ray. The intersected imagery
34737
- * layer features are found by invoking {@link ImageryProvider#pickFeatures} for each imagery layer tile intersected
34738
- * by the pick ray. To compute a pick ray from a location on the screen, use {@link Camera.getPickRay}.
34762
+ layer features are found by invoking {@link ImageryProvider#pickFeatures} for each imagery layer tile intersected
34763
+ by the pick ray. To compute a pick ray from a location on the screen, use {@link Camera.getPickRay}.
34739
34764
  * @example
34740
34765
  * const pickRay = viewer.camera.getPickRay(windowPosition);
34741
- * const featuresPromise = viewer.imageryLayers.pickImageryLayerFeatures(pickRay, viewer.scene);
34742
- * if (!Cesium.defined(featuresPromise)) {
34743
- * console.log('No features picked.');
34744
- * } else {
34745
- * Promise.resolve(featuresPromise).then(function(features) {
34746
- * // This function is called asynchronously when the list if picked features is available.
34747
- * console.log(`Number of features: ${features.length}`);
34748
- * if (features.length > 0) {
34749
- * console.log(`First feature name: ${features[0].name}`);
34750
- * }
34751
- * });
34752
- * }
34766
+ const featuresPromise = viewer.imageryLayers.pickImageryLayerFeatures(pickRay, viewer.scene);
34767
+ if (!Cesium.defined(featuresPromise)) {
34768
+ console.log('No features picked.');
34769
+ } else {
34770
+ Promise.resolve(featuresPromise).then(function(features) {
34771
+ // This function is called asynchronously when the list if picked features is available.
34772
+ console.log(`Number of features: ${features.length}`);
34773
+ if (features.length > 0) {
34774
+ console.log(`First feature name: ${features[0].name}`);
34775
+ }
34776
+ });
34777
+ }
34753
34778
  * @param ray - The ray to test for intersection.
34754
34779
  * @param scene - The scene.
34755
34780
  * @returns A promise that resolves to an array of features intersected by the pick ray.
34756
- * If it can be quickly determined that no features are intersected (for example,
34757
- * because no active imagery providers support {@link ImageryProvider#pickFeatures}
34758
- * or because the pick ray does not intersect the surface), this function will
34759
- * return undefined.
34781
+ If it can be quickly determined that no features are intersected (for example,
34782
+ because no active imagery providers support {@link ImageryProvider#pickFeatures}
34783
+ or because the pick ray does not intersect the surface), this function will
34784
+ return undefined.
34760
34785
  */
34761
34786
  pickImageryLayerFeatures(ray: Ray, scene: Scene): Promise<ImageryLayerFeatureInfo[]> | undefined;
34762
34787
  /**
34763
34788
  * Returns true if this object was destroyed; otherwise, false.
34764
- * <br /><br />
34765
- * If this object was destroyed, it should not be used; calling any function other than
34766
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
34789
+ <br /><br />
34790
+ If this object was destroyed, it should not be used; calling any function other than
34791
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
34767
34792
  * @returns true if this object was destroyed; otherwise, false.
34768
34793
  */
34769
34794
  isDestroyed(): boolean;
34770
34795
  /**
34771
34796
  * Destroys the WebGL resources held by all layers in this collection. Explicitly destroying this
34772
- * object allows for deterministic release of WebGL resources, instead of relying on the garbage
34773
- * collector.
34774
- * <br /><br />
34775
- * Once this object is destroyed, it should not be used; calling any function other than
34776
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
34777
- * assign the return value (<code>undefined</code>) to the object as done in the example.
34797
+ object allows for deterministic release of WebGL resources, instead of relying on the garbage
34798
+ collector.
34799
+ <br /><br />
34800
+ Once this object is destroyed, it should not be used; calling any function other than
34801
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
34802
+ assign the return value (<code>undefined</code>) to the object as done in the example.
34778
34803
  * @example
34779
34804
  * layerCollection = layerCollection && layerCollection.destroy();
34780
34805
  */
@@ -35117,6 +35142,18 @@ export namespace ITwinData {
35117
35142
  * @param [rootDocument] - The path of the root document for this reality data
35118
35143
  */
35119
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>;
35120
35157
  }
35121
35158
 
35122
35159
  export namespace Label {
@@ -35400,10 +35437,10 @@ export class Label {
35400
35437
  /**
35401
35438
  * Determines if this label equals another label. Labels are equal if all their properties
35402
35439
  are equal. Labels in different collections can be equal.
35403
- * @param other - The label to compare for equality.
35440
+ * @param [other] - The label to compare for equality.
35404
35441
  * @returns <code>true</code> if the labels are equal; otherwise, <code>false</code>.
35405
35442
  */
35406
- equals(other: Label): boolean;
35443
+ equals(other?: Label): boolean;
35407
35444
  /**
35408
35445
  * Returns true if this object was destroyed; otherwise, false.
35409
35446
  <br /><br />
@@ -35951,216 +35988,216 @@ export enum MapMode2D {
35951
35988
 
35952
35989
  /**
35953
35990
  * A Material defines surface appearance through a combination of diffuse, specular,
35954
- * normal, emission, and alpha components. These values are specified using a
35955
- * JSON schema called Fabric which gets parsed and assembled into glsl shader code
35956
- * behind-the-scenes. Check out the {@link https://github.com/CesiumGS/cesium/wiki/Fabric|wiki page}
35957
- * for more details on Fabric.
35958
- * <br /><br />
35959
- * <style type="text/css">
35960
- * #materialDescriptions code {
35961
- * font-weight: normal;
35962
- * font-family: Consolas, 'Lucida Console', Monaco, monospace;
35963
- * color: #A35A00;
35964
- * }
35965
- * #materialDescriptions ul, #materialDescriptions ul ul {
35966
- * list-style-type: none;
35967
- * }
35968
- * #materialDescriptions ul ul {
35969
- * margin-bottom: 10px;
35970
- * }
35971
- * #materialDescriptions ul ul li {
35972
- * font-weight: normal;
35973
- * color: #000000;
35974
- * text-indent: -2em;
35975
- * margin-left: 2em;
35976
- * }
35977
- * #materialDescriptions ul li {
35978
- * font-weight: bold;
35979
- * color: #0053CF;
35980
- * }
35981
- * </style>
35982
- *
35983
- * Base material types and their uniforms:
35984
- * <div id='materialDescriptions'>
35985
- * <ul>
35986
- * <li>Color</li>
35987
- * <ul>
35988
- * <li><code>color</code>: rgba color object.</li>
35989
- * </ul>
35990
- * <li>Image</li>
35991
- * <ul>
35992
- * <li><code>image</code>: path to image.</li>
35993
- * <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
35994
- * </ul>
35995
- * <li>DiffuseMap</li>
35996
- * <ul>
35997
- * <li><code>image</code>: path to image.</li>
35998
- * <li><code>channels</code>: Three character string containing any combination of r, g, b, and a for selecting the desired image channels.</li>
35999
- * <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36000
- * </ul>
36001
- * <li>AlphaMap</li>
36002
- * <ul>
36003
- * <li><code>image</code>: path to image.</li>
36004
- * <li><code>channel</code>: One character string containing r, g, b, or a for selecting the desired image channel. </li>
36005
- * <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36006
- * </ul>
36007
- * <li>SpecularMap</li>
36008
- * <ul>
36009
- * <li><code>image</code>: path to image.</li>
36010
- * <li><code>channel</code>: One character string containing r, g, b, or a for selecting the desired image channel. </li>
36011
- * <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36012
- * </ul>
36013
- * <li>EmissionMap</li>
36014
- * <ul>
36015
- * <li><code>image</code>: path to image.</li>
36016
- * <li><code>channels</code>: Three character string containing any combination of r, g, b, and a for selecting the desired image channels. </li>
36017
- * <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36018
- * </ul>
36019
- * <li>BumpMap</li>
36020
- * <ul>
36021
- * <li><code>image</code>: path to image.</li>
36022
- * <li><code>channel</code>: One character string containing r, g, b, or a for selecting the desired image channel. </li>
36023
- * <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36024
- * <li><code>strength</code>: Bump strength value between 0.0 and 1.0 where 0.0 is small bumps and 1.0 is large bumps.</li>
36025
- * </ul>
36026
- * <li>NormalMap</li>
36027
- * <ul>
36028
- * <li><code>image</code>: path to image.</li>
36029
- * <li><code>channels</code>: Three character string containing any combination of r, g, b, and a for selecting the desired image channels. </li>
36030
- * <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36031
- * <li><code>strength</code>: Bump strength value between 0.0 and 1.0 where 0.0 is small bumps and 1.0 is large bumps.</li>
36032
- * </ul>
36033
- * <li>Grid</li>
36034
- * <ul>
36035
- * <li><code>color</code>: rgba color object for the whole material.</li>
36036
- * <li><code>cellAlpha</code>: Alpha value for the cells between grid lines. This will be combined with color.alpha.</li>
36037
- * <li><code>lineCount</code>: Object with x and y values specifying the number of columns and rows respectively.</li>
36038
- * <li><code>lineThickness</code>: Object with x and y values specifying the thickness of grid lines (in pixels where available).</li>
36039
- * <li><code>lineOffset</code>: Object with x and y values specifying the offset of grid lines (range is 0 to 1).</li>
36040
- * </ul>
36041
- * <li>Stripe</li>
36042
- * <ul>
36043
- * <li><code>horizontal</code>: Boolean that determines if the stripes are horizontal or vertical.</li>
36044
- * <li><code>evenColor</code>: rgba color object for the stripe's first color.</li>
36045
- * <li><code>oddColor</code>: rgba color object for the stripe's second color.</li>
36046
- * <li><code>offset</code>: Number that controls at which point into the pattern to begin drawing; with 0.0 being the beginning of the even color, 1.0 the beginning of the odd color, 2.0 being the even color again, and any multiple or fractional values being in between.</li>
36047
- * <li><code>repeat</code>: Number that controls the total number of stripes, half light and half dark.</li>
36048
- * </ul>
36049
- * <li>Checkerboard</li>
36050
- * <ul>
36051
- * <li><code>lightColor</code>: rgba color object for the checkerboard's light alternating color.</li>
36052
- * <li><code>darkColor</code>: rgba color object for the checkerboard's dark alternating color.</li>
36053
- * <li><code>repeat</code>: Object with x and y values specifying the number of columns and rows respectively.</li>
36054
- * </ul>
36055
- * <li>Dot</li>
36056
- * <ul>
36057
- * <li><code>lightColor</code>: rgba color object for the dot color.</li>
36058
- * <li><code>darkColor</code>: rgba color object for the background color.</li>
36059
- * <li><code>repeat</code>: Object with x and y values specifying the number of columns and rows of dots respectively.</li>
36060
- * </ul>
36061
- * <li>Water</li>
36062
- * <ul>
36063
- * <li><code>baseWaterColor</code>: rgba color object base color of the water.</li>
36064
- * <li><code>blendColor</code>: rgba color object used when blending from water to non-water areas.</li>
36065
- * <li><code>specularMap</code>: Single channel texture used to indicate areas of water.</li>
36066
- * <li><code>normalMap</code>: Normal map for water normal perturbation.</li>
36067
- * <li><code>frequency</code>: Number that controls the number of waves.</li>
36068
- * <li><code>animationSpeed</code>: Number that controls the animations speed of the water.</li>
36069
- * <li><code>amplitude</code>: Number that controls the amplitude of water waves.</li>
36070
- * <li><code>specularIntensity</code>: Number that controls the intensity of specular reflections.</li>
36071
- * </ul>
36072
- * <li>RimLighting</li>
36073
- * <ul>
36074
- * <li><code>color</code>: diffuse color and alpha.</li>
36075
- * <li><code>rimColor</code>: diffuse color and alpha of the rim.</li>
36076
- * <li><code>width</code>: Number that determines the rim's width.</li>
36077
- * </ul>
36078
- * <li>Fade</li>
36079
- * <ul>
36080
- * <li><code>fadeInColor</code>: diffuse color and alpha at <code>time</code></li>
36081
- * <li><code>fadeOutColor</code>: diffuse color and alpha at <code>maximumDistance</code> from <code>time</code></li>
36082
- * <li><code>maximumDistance</code>: Number between 0.0 and 1.0 where the <code>fadeInColor</code> becomes the <code>fadeOutColor</code>. A value of 0.0 gives the entire material a color of <code>fadeOutColor</code> and a value of 1.0 gives the the entire material a color of <code>fadeInColor</code></li>
36083
- * <li><code>repeat</code>: true if the fade should wrap around the texture coodinates.</li>
36084
- * <li><code>fadeDirection</code>: Object with x and y values specifying if the fade should be in the x and y directions.</li>
36085
- * <li><code>time</code>: Object with x and y values between 0.0 and 1.0 of the <code>fadeInColor</code> position</li>
36086
- * </ul>
36087
- * <li>PolylineArrow</li>
36088
- * <ul>
36089
- * <li><code>color</code>: diffuse color and alpha.</li>
36090
- * </ul>
36091
- * <li>PolylineDash</li>
36092
- * <ul>
36093
- * <li><code>color</code>: color for the line.</li>
36094
- * <li><code>gapColor</code>: color for the gaps in the line.</li>
36095
- * <li><code>dashLength</code>: Dash length in pixels.</li>
36096
- * <li><code>dashPattern</code>: The 16 bit stipple pattern for the line..</li>
36097
- * </ul>
36098
- * <li>PolylineGlow</li>
36099
- * <ul>
36100
- * <li><code>color</code>: color and maximum alpha for the glow on the line.</li>
36101
- * <li><code>glowPower</code>: strength of the glow, as a percentage of the total line width (less than 1.0).</li>
36102
- * <li><code>taperPower</code>: strength of the tapering effect, as a percentage of the total line length. If 1.0 or higher, no taper effect is used.</li>
36103
- * </ul>
36104
- * <li>PolylineOutline</li>
36105
- * <ul>
36106
- * <li><code>color</code>: diffuse color and alpha for the interior of the line.</li>
36107
- * <li><code>outlineColor</code>: diffuse color and alpha for the outline.</li>
36108
- * <li><code>outlineWidth</code>: width of the outline in pixels.</li>
36109
- * </ul>
36110
- * <li>ElevationContour</li>
36111
- * <ul>
36112
- * <li><code>color</code>: color and alpha for the contour line.</li>
36113
- * <li><code>spacing</code>: spacing for contour lines in meters.</li>
36114
- * <li><code>width</code>: Number specifying the width of the grid lines in pixels.</li>
36115
- * </ul>
36116
- * <li>ElevationRamp</li>
36117
- * <ul>
36118
- * <li><code>image</code>: color ramp image to use for coloring the terrain.</li>
36119
- * <li><code>minimumHeight</code>: minimum height for the ramp.</li>
36120
- * <li><code>maximumHeight</code>: maximum height for the ramp.</li>
36121
- * </ul>
36122
- * <li>SlopeRamp</li>
36123
- * <ul>
36124
- * <li><code>image</code>: color ramp image to use for coloring the terrain by slope.</li>
36125
- * </ul>
36126
- * <li>AspectRamp</li>
36127
- * <ul>
36128
- * <li><code>image</code>: color ramp image to use for color the terrain by aspect.</li>
36129
- * </ul>
36130
- * <li>ElevationBand</li>
36131
- * <ul>
36132
- * <li><code>heights</code>: image of heights sorted from lowest to highest.</li>
36133
- * <li><code>colors</code>: image of colors at the corresponding heights.</li>
36134
- * </ul>
36135
- * <li>WaterMask</li>
36136
- * <ul>
36137
- * <li><code>waterColor</code>: diffuse color and alpha for the areas covered by water.</li>
36138
- * <li><code>landColor</code>: diffuse color and alpha for the areas covered by land.</li>
36139
- * </ul>
36140
- * </ul>
36141
- * </ul>
36142
- * </div>
35991
+ normal, emission, and alpha components. These values are specified using a
35992
+ JSON schema called Fabric which gets parsed and assembled into glsl shader code
35993
+ behind-the-scenes. Check out the {@link https://github.com/CesiumGS/cesium/wiki/Fabric|wiki page}
35994
+ for more details on Fabric.
35995
+ <br /><br />
35996
+ <style type="text/css">
35997
+ #materialDescriptions code {
35998
+ font-weight: normal;
35999
+ font-family: Consolas, 'Lucida Console', Monaco, monospace;
36000
+ color: #A35A00;
36001
+ }
36002
+ #materialDescriptions ul, #materialDescriptions ul ul {
36003
+ list-style-type: none;
36004
+ }
36005
+ #materialDescriptions ul ul {
36006
+ margin-bottom: 10px;
36007
+ }
36008
+ #materialDescriptions ul ul li {
36009
+ font-weight: normal;
36010
+ color: #000000;
36011
+ text-indent: -2em;
36012
+ margin-left: 2em;
36013
+ }
36014
+ #materialDescriptions ul li {
36015
+ font-weight: bold;
36016
+ color: #0053CF;
36017
+ }
36018
+ </style>
36019
+
36020
+ Base material types and their uniforms:
36021
+ <div id='materialDescriptions'>
36022
+ <ul>
36023
+ <li>Color</li>
36024
+ <ul>
36025
+ <li><code>color</code>: rgba color object.</li>
36026
+ </ul>
36027
+ <li>Image</li>
36028
+ <ul>
36029
+ <li><code>image</code>: path to image.</li>
36030
+ <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36031
+ </ul>
36032
+ <li>DiffuseMap</li>
36033
+ <ul>
36034
+ <li><code>image</code>: path to image.</li>
36035
+ <li><code>channels</code>: Three character string containing any combination of r, g, b, and a for selecting the desired image channels.</li>
36036
+ <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36037
+ </ul>
36038
+ <li>AlphaMap</li>
36039
+ <ul>
36040
+ <li><code>image</code>: path to image.</li>
36041
+ <li><code>channel</code>: One character string containing r, g, b, or a for selecting the desired image channel. </li>
36042
+ <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36043
+ </ul>
36044
+ <li>SpecularMap</li>
36045
+ <ul>
36046
+ <li><code>image</code>: path to image.</li>
36047
+ <li><code>channel</code>: One character string containing r, g, b, or a for selecting the desired image channel. </li>
36048
+ <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36049
+ </ul>
36050
+ <li>EmissionMap</li>
36051
+ <ul>
36052
+ <li><code>image</code>: path to image.</li>
36053
+ <li><code>channels</code>: Three character string containing any combination of r, g, b, and a for selecting the desired image channels. </li>
36054
+ <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36055
+ </ul>
36056
+ <li>BumpMap</li>
36057
+ <ul>
36058
+ <li><code>image</code>: path to image.</li>
36059
+ <li><code>channel</code>: One character string containing r, g, b, or a for selecting the desired image channel. </li>
36060
+ <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36061
+ <li><code>strength</code>: Bump strength value between 0.0 and 1.0 where 0.0 is small bumps and 1.0 is large bumps.</li>
36062
+ </ul>
36063
+ <li>NormalMap</li>
36064
+ <ul>
36065
+ <li><code>image</code>: path to image.</li>
36066
+ <li><code>channels</code>: Three character string containing any combination of r, g, b, and a for selecting the desired image channels. </li>
36067
+ <li><code>repeat</code>: Object with x and y values specifying the number of times to repeat the image.</li>
36068
+ <li><code>strength</code>: Bump strength value between 0.0 and 1.0 where 0.0 is small bumps and 1.0 is large bumps.</li>
36069
+ </ul>
36070
+ <li>Grid</li>
36071
+ <ul>
36072
+ <li><code>color</code>: rgba color object for the whole material.</li>
36073
+ <li><code>cellAlpha</code>: Alpha value for the cells between grid lines. This will be combined with color.alpha.</li>
36074
+ <li><code>lineCount</code>: Object with x and y values specifying the number of columns and rows respectively.</li>
36075
+ <li><code>lineThickness</code>: Object with x and y values specifying the thickness of grid lines (in pixels where available).</li>
36076
+ <li><code>lineOffset</code>: Object with x and y values specifying the offset of grid lines (range is 0 to 1).</li>
36077
+ </ul>
36078
+ <li>Stripe</li>
36079
+ <ul>
36080
+ <li><code>horizontal</code>: Boolean that determines if the stripes are horizontal or vertical.</li>
36081
+ <li><code>evenColor</code>: rgba color object for the stripe's first color.</li>
36082
+ <li><code>oddColor</code>: rgba color object for the stripe's second color.</li>
36083
+ <li><code>offset</code>: Number that controls at which point into the pattern to begin drawing; with 0.0 being the beginning of the even color, 1.0 the beginning of the odd color, 2.0 being the even color again, and any multiple or fractional values being in between.</li>
36084
+ <li><code>repeat</code>: Number that controls the total number of stripes, half light and half dark.</li>
36085
+ </ul>
36086
+ <li>Checkerboard</li>
36087
+ <ul>
36088
+ <li><code>lightColor</code>: rgba color object for the checkerboard's light alternating color.</li>
36089
+ <li><code>darkColor</code>: rgba color object for the checkerboard's dark alternating color.</li>
36090
+ <li><code>repeat</code>: Object with x and y values specifying the number of columns and rows respectively.</li>
36091
+ </ul>
36092
+ <li>Dot</li>
36093
+ <ul>
36094
+ <li><code>lightColor</code>: rgba color object for the dot color.</li>
36095
+ <li><code>darkColor</code>: rgba color object for the background color.</li>
36096
+ <li><code>repeat</code>: Object with x and y values specifying the number of columns and rows of dots respectively.</li>
36097
+ </ul>
36098
+ <li>Water</li>
36099
+ <ul>
36100
+ <li><code>baseWaterColor</code>: rgba color object base color of the water.</li>
36101
+ <li><code>blendColor</code>: rgba color object used when blending from water to non-water areas.</li>
36102
+ <li><code>specularMap</code>: Single channel texture used to indicate areas of water.</li>
36103
+ <li><code>normalMap</code>: Normal map for water normal perturbation.</li>
36104
+ <li><code>frequency</code>: Number that controls the number of waves.</li>
36105
+ <li><code>animationSpeed</code>: Number that controls the animations speed of the water.</li>
36106
+ <li><code>amplitude</code>: Number that controls the amplitude of water waves.</li>
36107
+ <li><code>specularIntensity</code>: Number that controls the intensity of specular reflections.</li>
36108
+ </ul>
36109
+ <li>RimLighting</li>
36110
+ <ul>
36111
+ <li><code>color</code>: diffuse color and alpha.</li>
36112
+ <li><code>rimColor</code>: diffuse color and alpha of the rim.</li>
36113
+ <li><code>width</code>: Number that determines the rim's width.</li>
36114
+ </ul>
36115
+ <li>Fade</li>
36116
+ <ul>
36117
+ <li><code>fadeInColor</code>: diffuse color and alpha at <code>time</code></li>
36118
+ <li><code>fadeOutColor</code>: diffuse color and alpha at <code>maximumDistance</code> from <code>time</code></li>
36119
+ <li><code>maximumDistance</code>: Number between 0.0 and 1.0 where the <code>fadeInColor</code> becomes the <code>fadeOutColor</code>. A value of 0.0 gives the entire material a color of <code>fadeOutColor</code> and a value of 1.0 gives the the entire material a color of <code>fadeInColor</code></li>
36120
+ <li><code>repeat</code>: true if the fade should wrap around the texture coodinates.</li>
36121
+ <li><code>fadeDirection</code>: Object with x and y values specifying if the fade should be in the x and y directions.</li>
36122
+ <li><code>time</code>: Object with x and y values between 0.0 and 1.0 of the <code>fadeInColor</code> position</li>
36123
+ </ul>
36124
+ <li>PolylineArrow</li>
36125
+ <ul>
36126
+ <li><code>color</code>: diffuse color and alpha.</li>
36127
+ </ul>
36128
+ <li>PolylineDash</li>
36129
+ <ul>
36130
+ <li><code>color</code>: color for the line.</li>
36131
+ <li><code>gapColor</code>: color for the gaps in the line.</li>
36132
+ <li><code>dashLength</code>: Dash length in pixels.</li>
36133
+ <li><code>dashPattern</code>: The 16 bit stipple pattern for the line..</li>
36134
+ </ul>
36135
+ <li>PolylineGlow</li>
36136
+ <ul>
36137
+ <li><code>color</code>: color and maximum alpha for the glow on the line.</li>
36138
+ <li><code>glowPower</code>: strength of the glow, as a percentage of the total line width (less than 1.0).</li>
36139
+ <li><code>taperPower</code>: strength of the tapering effect, as a percentage of the total line length. If 1.0 or higher, no taper effect is used.</li>
36140
+ </ul>
36141
+ <li>PolylineOutline</li>
36142
+ <ul>
36143
+ <li><code>color</code>: diffuse color and alpha for the interior of the line.</li>
36144
+ <li><code>outlineColor</code>: diffuse color and alpha for the outline.</li>
36145
+ <li><code>outlineWidth</code>: width of the outline in pixels.</li>
36146
+ </ul>
36147
+ <li>ElevationContour</li>
36148
+ <ul>
36149
+ <li><code>color</code>: color and alpha for the contour line.</li>
36150
+ <li><code>spacing</code>: spacing for contour lines in meters.</li>
36151
+ <li><code>width</code>: Number specifying the width of the grid lines in pixels.</li>
36152
+ </ul>
36153
+ <li>ElevationRamp</li>
36154
+ <ul>
36155
+ <li><code>image</code>: color ramp image to use for coloring the terrain.</li>
36156
+ <li><code>minimumHeight</code>: minimum height for the ramp.</li>
36157
+ <li><code>maximumHeight</code>: maximum height for the ramp.</li>
36158
+ </ul>
36159
+ <li>SlopeRamp</li>
36160
+ <ul>
36161
+ <li><code>image</code>: color ramp image to use for coloring the terrain by slope.</li>
36162
+ </ul>
36163
+ <li>AspectRamp</li>
36164
+ <ul>
36165
+ <li><code>image</code>: color ramp image to use for color the terrain by aspect.</li>
36166
+ </ul>
36167
+ <li>ElevationBand</li>
36168
+ <ul>
36169
+ <li><code>heights</code>: image of heights sorted from lowest to highest.</li>
36170
+ <li><code>colors</code>: image of colors at the corresponding heights.</li>
36171
+ </ul>
36172
+ <li>WaterMask</li>
36173
+ <ul>
36174
+ <li><code>waterColor</code>: diffuse color and alpha for the areas covered by water.</li>
36175
+ <li><code>landColor</code>: diffuse color and alpha for the areas covered by land.</li>
36176
+ </ul>
36177
+ </ul>
36178
+ </ul>
36179
+ </div>
36143
36180
  * @example
36144
36181
  * // Create a color material with fromType:
36145
- * polygon.material = Cesium.Material.fromType('Color');
36146
- * polygon.material.uniforms.color = new Cesium.Color(1.0, 1.0, 0.0, 1.0);
36147
- *
36148
- * // Create the default material:
36149
- * polygon.material = new Cesium.Material();
36150
- *
36151
- * // Create a color material with full Fabric notation:
36152
- * polygon.material = new Cesium.Material({
36153
- * fabric: {
36154
- * type: 'Color',
36155
- * uniforms: {
36156
- * color: new Cesium.Color(1.0, 1.0, 0.0, 1.0)
36157
- * }
36158
- * }
36159
- * });
36182
+ polygon.material = Cesium.Material.fromType('Color');
36183
+ polygon.material.uniforms.color = new Cesium.Color(1.0, 1.0, 0.0, 1.0);
36184
+
36185
+ // Create the default material:
36186
+ polygon.material = new Cesium.Material();
36187
+
36188
+ // Create a color material with full Fabric notation:
36189
+ polygon.material = new Cesium.Material({
36190
+ fabric: {
36191
+ type: 'Color',
36192
+ uniforms: {
36193
+ color: new Cesium.Color(1.0, 1.0, 0.0, 1.0)
36194
+ }
36195
+ }
36196
+ });
36160
36197
  * @param [options] - Object with the following properties:
36161
36198
  * @param [options.strict = false] - Throws errors for issues that would normally be ignored, including unused uniforms or materials.
36162
36199
  * @param [options.translucent = true] - When <code>true</code> or a function that returns <code>true</code>, the geometry
36163
- * with this material is expected to appear translucent.
36200
+ with this material is expected to appear translucent.
36164
36201
  * @param [options.minificationFilter = TextureMinificationFilter.LINEAR] - The {@link TextureMinificationFilter} to apply to this material's textures.
36165
36202
  * @param [options.magnificationFilter = TextureMagnificationFilter.LINEAR] - The {@link TextureMagnificationFilter} to apply to this material's textures.
36166
36203
  * @param options.fabric - The fabric JSON used to generate the material.
@@ -36191,17 +36228,17 @@ export class Material {
36191
36228
  uniforms: any;
36192
36229
  /**
36193
36230
  * When <code>true</code> or a function that returns <code>true</code>,
36194
- * the geometry is expected to appear translucent.
36231
+ the geometry is expected to appear translucent.
36195
36232
  */
36196
36233
  translucent: boolean | ((...params: any[]) => any);
36197
36234
  /**
36198
36235
  * Creates a new material using an existing material type.
36199
- * <br /><br />
36200
- * Shorthand for: new Material({fabric : {type : type}});
36236
+ <br /><br />
36237
+ Shorthand for: new Material({fabric : {type : type}});
36201
36238
  * @example
36202
36239
  * const material = Cesium.Material.fromType('Color', {
36203
- * color: new Cesium.Color(1.0, 0.0, 0.0, 1.0)
36204
- * });
36240
+ color: new Cesium.Color(1.0, 0.0, 0.0, 1.0)
36241
+ });
36205
36242
  * @param type - The base material type.
36206
36243
  * @param [uniforms] - Overrides for the default uniforms.
36207
36244
  * @returns New material object.
@@ -36214,19 +36251,19 @@ export class Material {
36214
36251
  isTranslucent(): boolean;
36215
36252
  /**
36216
36253
  * Returns true if this object was destroyed; otherwise, false.
36217
- * <br /><br />
36218
- * If this object was destroyed, it should not be used; calling any function other than
36219
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
36254
+ <br /><br />
36255
+ If this object was destroyed, it should not be used; calling any function other than
36256
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
36220
36257
  * @returns True if this object was destroyed; otherwise, false.
36221
36258
  */
36222
36259
  isDestroyed(): boolean;
36223
36260
  /**
36224
36261
  * Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
36225
- * release of WebGL resources, instead of relying on the garbage collector to destroy this object.
36226
- * <br /><br />
36227
- * Once an object is destroyed, it should not be used; calling any function other than
36228
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
36229
- * assign the return value (<code>undefined</code>) to the object as done in the example.
36262
+ release of WebGL resources, instead of relying on the garbage collector to destroy this object.
36263
+ <br /><br />
36264
+ Once an object is destroyed, it should not be used; calling any function other than
36265
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
36266
+ assign the return value (<code>undefined</code>) to the object as done in the example.
36230
36267
  * @example
36231
36268
  * material = material && material.destroy();
36232
36269
  */
@@ -37801,7 +37838,7 @@ export class Model {
37801
37838
 
37802
37839
  The given name may be the name of a glTF extension, like `"EXT_example_extension"`.
37803
37840
  If the specified extension was present in the root of the underlying glTF asset,
37804
- and a loder for the specified extension has processed the extension data, then
37841
+ and a loader for the specified extension has processed the extension data, then
37805
37842
  this will return the model representation of the extension.
37806
37843
  * @param extensionName - The name of the extension
37807
37844
  * @returns The object, or `undefined`
@@ -39465,10 +39502,10 @@ export class PointPrimitive {
39465
39502
  /**
39466
39503
  * Determines if this point equals another point. Points are equal if all their properties
39467
39504
  are equal. Points in different collections can be equal.
39468
- * @param other - The point to compare for equality.
39505
+ * @param [other] - The point to compare for equality.
39469
39506
  * @returns <code>true</code> if the points are equal; otherwise, <code>false</code>.
39470
39507
  */
39471
- equals(other: PointPrimitive): boolean;
39508
+ equals(other?: PointPrimitive): boolean;
39472
39509
  }
39473
39510
 
39474
39511
  /**
@@ -40651,88 +40688,88 @@ export enum PostProcessStageSampleMode {
40651
40688
 
40652
40689
  /**
40653
40690
  * A primitive represents geometry in the {@link Scene}. The geometry can be from a single {@link GeometryInstance}
40654
- * as shown in example 1 below, or from an array of instances, even if the geometry is from different
40655
- * geometry types, e.g., an {@link RectangleGeometry} and an {@link EllipsoidGeometry} as shown in Code Example 2.
40656
- * <p>
40657
- * A primitive combines geometry instances with an {@link Appearance} that describes the full shading, including
40658
- * {@link Material} and {@link RenderState}. Roughly, the geometry instance defines the structure and placement,
40659
- * and the appearance defines the visual characteristics. Decoupling geometry and appearance allows us to mix
40660
- * and match most of them and add a new geometry or appearance independently of each other.
40661
- * </p>
40662
- * <p>
40663
- * Combining multiple instances into one primitive is called batching, and significantly improves performance for static data.
40664
- * Instances can be individually picked; {@link Scene#pick} returns their {@link GeometryInstance#id}. Using
40665
- * per-instance appearances like {@link PerInstanceColorAppearance}, each instance can also have a unique color.
40666
- * </p>
40667
- * <p>
40668
- * {@link Geometry} can either be created and batched on a web worker or the main thread. The first two examples
40669
- * show geometry that will be created on a web worker by using the descriptions of the geometry. The third example
40670
- * shows how to create the geometry on the main thread by explicitly calling the <code>createGeometry</code> method.
40671
- * </p>
40691
+ as shown in example 1 below, or from an array of instances, even if the geometry is from different
40692
+ geometry types, e.g., an {@link RectangleGeometry} and an {@link EllipsoidGeometry} as shown in Code Example 2.
40693
+ <p>
40694
+ A primitive combines geometry instances with an {@link Appearance} that describes the full shading, including
40695
+ {@link Material} and {@link RenderState}. Roughly, the geometry instance defines the structure and placement,
40696
+ and the appearance defines the visual characteristics. Decoupling geometry and appearance allows us to mix
40697
+ and match most of them and add a new geometry or appearance independently of each other.
40698
+ </p>
40699
+ <p>
40700
+ Combining multiple instances into one primitive is called batching, and significantly improves performance for static data.
40701
+ Instances can be individually picked; {@link Scene#pick} returns their {@link GeometryInstance#id}. Using
40702
+ per-instance appearances like {@link PerInstanceColorAppearance}, each instance can also have a unique color.
40703
+ </p>
40704
+ <p>
40705
+ {@link Geometry} can either be created and batched on a web worker or the main thread. The first two examples
40706
+ show geometry that will be created on a web worker by using the descriptions of the geometry. The third example
40707
+ shows how to create the geometry on the main thread by explicitly calling the <code>createGeometry</code> method.
40708
+ </p>
40672
40709
  * @example
40673
40710
  * // 1. Draw a translucent ellipse on the surface with a checkerboard pattern
40674
- * const instance = new Cesium.GeometryInstance({
40675
- * geometry : new Cesium.EllipseGeometry({
40676
- * center : Cesium.Cartesian3.fromDegrees(-100.0, 20.0),
40677
- * semiMinorAxis : 500000.0,
40678
- * semiMajorAxis : 1000000.0,
40679
- * rotation : Cesium.Math.PI_OVER_FOUR,
40680
- * vertexFormat : Cesium.VertexFormat.POSITION_AND_ST
40681
- * }),
40682
- * id : 'object returned when this instance is picked and to get/set per-instance attributes'
40683
- * });
40684
- * scene.primitives.add(new Cesium.Primitive({
40685
- * geometryInstances : instance,
40686
- * appearance : new Cesium.EllipsoidSurfaceAppearance({
40687
- * material : Cesium.Material.fromType('Checkerboard')
40688
- * })
40689
- * }));
40711
+ const instance = new Cesium.GeometryInstance({
40712
+ geometry : new Cesium.EllipseGeometry({
40713
+ center : Cesium.Cartesian3.fromDegrees(-100.0, 20.0),
40714
+ semiMinorAxis : 500000.0,
40715
+ semiMajorAxis : 1000000.0,
40716
+ rotation : Cesium.Math.PI_OVER_FOUR,
40717
+ vertexFormat : Cesium.VertexFormat.POSITION_AND_ST
40718
+ }),
40719
+ id : 'object returned when this instance is picked and to get/set per-instance attributes'
40720
+ });
40721
+ scene.primitives.add(new Cesium.Primitive({
40722
+ geometryInstances : instance,
40723
+ appearance : new Cesium.EllipsoidSurfaceAppearance({
40724
+ material : Cesium.Material.fromType('Checkerboard')
40725
+ })
40726
+ }));
40690
40727
  * @example
40691
40728
  * // 2. Draw different instances each with a unique color
40692
- * const rectangleInstance = new Cesium.GeometryInstance({
40693
- * geometry : new Cesium.RectangleGeometry({
40694
- * rectangle : Cesium.Rectangle.fromDegrees(-140.0, 30.0, -100.0, 40.0),
40695
- * vertexFormat : Cesium.PerInstanceColorAppearance.VERTEX_FORMAT
40696
- * }),
40697
- * id : 'rectangle',
40698
- * attributes : {
40699
- * color : new Cesium.ColorGeometryInstanceAttribute(0.0, 1.0, 1.0, 0.5)
40700
- * }
40701
- * });
40702
- * const ellipsoidInstance = new Cesium.GeometryInstance({
40703
- * geometry : new Cesium.EllipsoidGeometry({
40704
- * radii : new Cesium.Cartesian3(500000.0, 500000.0, 1000000.0),
40705
- * vertexFormat : Cesium.VertexFormat.POSITION_AND_NORMAL
40706
- * }),
40707
- * modelMatrix : Cesium.Matrix4.multiplyByTranslation(Cesium.Transforms.eastNorthUpToFixedFrame(
40708
- * Cesium.Cartesian3.fromDegrees(-95.59777, 40.03883)), new Cesium.Cartesian3(0.0, 0.0, 500000.0), new Cesium.Matrix4()),
40709
- * id : 'ellipsoid',
40710
- * attributes : {
40711
- * color : Cesium.ColorGeometryInstanceAttribute.fromColor(Cesium.Color.AQUA)
40712
- * }
40713
- * });
40714
- * scene.primitives.add(new Cesium.Primitive({
40715
- * geometryInstances : [rectangleInstance, ellipsoidInstance],
40716
- * appearance : new Cesium.PerInstanceColorAppearance()
40717
- * }));
40729
+ const rectangleInstance = new Cesium.GeometryInstance({
40730
+ geometry : new Cesium.RectangleGeometry({
40731
+ rectangle : Cesium.Rectangle.fromDegrees(-140.0, 30.0, -100.0, 40.0),
40732
+ vertexFormat : Cesium.PerInstanceColorAppearance.VERTEX_FORMAT
40733
+ }),
40734
+ id : 'rectangle',
40735
+ attributes : {
40736
+ color : new Cesium.ColorGeometryInstanceAttribute(0.0, 1.0, 1.0, 0.5)
40737
+ }
40738
+ });
40739
+ const ellipsoidInstance = new Cesium.GeometryInstance({
40740
+ geometry : new Cesium.EllipsoidGeometry({
40741
+ radii : new Cesium.Cartesian3(500000.0, 500000.0, 1000000.0),
40742
+ vertexFormat : Cesium.VertexFormat.POSITION_AND_NORMAL
40743
+ }),
40744
+ modelMatrix : Cesium.Matrix4.multiplyByTranslation(Cesium.Transforms.eastNorthUpToFixedFrame(
40745
+ Cesium.Cartesian3.fromDegrees(-95.59777, 40.03883)), new Cesium.Cartesian3(0.0, 0.0, 500000.0), new Cesium.Matrix4()),
40746
+ id : 'ellipsoid',
40747
+ attributes : {
40748
+ color : Cesium.ColorGeometryInstanceAttribute.fromColor(Cesium.Color.AQUA)
40749
+ }
40750
+ });
40751
+ scene.primitives.add(new Cesium.Primitive({
40752
+ geometryInstances : [rectangleInstance, ellipsoidInstance],
40753
+ appearance : new Cesium.PerInstanceColorAppearance()
40754
+ }));
40718
40755
  * @example
40719
40756
  * // 3. Create the geometry on the main thread.
40720
- * scene.primitives.add(new Cesium.Primitive({
40721
- * geometryInstances : new Cesium.GeometryInstance({
40722
- * geometry : Cesium.EllipsoidGeometry.createGeometry(new Cesium.EllipsoidGeometry({
40723
- * radii : new Cesium.Cartesian3(500000.0, 500000.0, 1000000.0),
40724
- * vertexFormat : Cesium.VertexFormat.POSITION_AND_NORMAL
40725
- * })),
40726
- * modelMatrix : Cesium.Matrix4.multiplyByTranslation(Cesium.Transforms.eastNorthUpToFixedFrame(
40727
- * Cesium.Cartesian3.fromDegrees(-95.59777, 40.03883)), new Cesium.Cartesian3(0.0, 0.0, 500000.0), new Cesium.Matrix4()),
40728
- * id : 'ellipsoid',
40729
- * attributes : {
40730
- * color : Cesium.ColorGeometryInstanceAttribute.fromColor(Cesium.Color.AQUA)
40731
- * }
40732
- * }),
40733
- * appearance : new Cesium.PerInstanceColorAppearance(),
40734
- * asynchronous : false
40735
- * }));
40757
+ scene.primitives.add(new Cesium.Primitive({
40758
+ geometryInstances : new Cesium.GeometryInstance({
40759
+ geometry : Cesium.EllipsoidGeometry.createGeometry(new Cesium.EllipsoidGeometry({
40760
+ radii : new Cesium.Cartesian3(500000.0, 500000.0, 1000000.0),
40761
+ vertexFormat : Cesium.VertexFormat.POSITION_AND_NORMAL
40762
+ })),
40763
+ modelMatrix : Cesium.Matrix4.multiplyByTranslation(Cesium.Transforms.eastNorthUpToFixedFrame(
40764
+ Cesium.Cartesian3.fromDegrees(-95.59777, 40.03883)), new Cesium.Cartesian3(0.0, 0.0, 500000.0), new Cesium.Matrix4()),
40765
+ id : 'ellipsoid',
40766
+ attributes : {
40767
+ color : Cesium.ColorGeometryInstanceAttribute.fromColor(Cesium.Color.AQUA)
40768
+ }
40769
+ }),
40770
+ appearance : new Cesium.PerInstanceColorAppearance(),
40771
+ asynchronous : false
40772
+ }));
40736
40773
  * @param [options] - Object with the following properties:
40737
40774
  * @param [options.geometryInstances] - The geometry instances - or a single geometry instance - to render.
40738
40775
  * @param [options.appearance] - The appearance used to render the primitive.
@@ -40768,67 +40805,67 @@ export class Primitive {
40768
40805
  });
40769
40806
  /**
40770
40807
  * The geometry instances rendered with this primitive. This may
40771
- * be <code>undefined</code> if <code>options.releaseGeometryInstances</code>
40772
- * is <code>true</code> when the primitive is constructed.
40773
- * <p>
40774
- * Changing this property after the primitive is rendered has no effect.
40775
- * </p>
40808
+ be <code>undefined</code> if <code>options.releaseGeometryInstances</code>
40809
+ is <code>true</code> when the primitive is constructed.
40810
+ <p>
40811
+ Changing this property after the primitive is rendered has no effect.
40812
+ </p>
40776
40813
  */
40777
40814
  readonly geometryInstances: GeometryInstance[] | GeometryInstance;
40778
40815
  /**
40779
40816
  * The {@link Appearance} used to shade this primitive. Each geometry
40780
- * instance is shaded with the same appearance. Some appearances, like
40781
- * {@link PerInstanceColorAppearance} allow giving each instance unique
40782
- * properties.
40817
+ instance is shaded with the same appearance. Some appearances, like
40818
+ {@link PerInstanceColorAppearance} allow giving each instance unique
40819
+ properties.
40783
40820
  */
40784
40821
  appearance: Appearance;
40785
40822
  /**
40786
40823
  * The {@link Appearance} used to shade this primitive when it fails the depth test. Each geometry
40787
- * instance is shaded with the same appearance. Some appearances, like
40788
- * {@link PerInstanceColorAppearance} allow giving each instance unique
40789
- * properties.
40790
- *
40791
- * <p>
40792
- * When using an appearance that requires a color attribute, like PerInstanceColorAppearance,
40793
- * add a depthFailColor per-instance attribute instead.
40794
- * </p>
40795
- *
40796
- * <p>
40797
- * Requires the EXT_frag_depth WebGL extension to render properly. If the extension is not supported,
40798
- * there may be artifacts.
40799
- * </p>
40824
+ instance is shaded with the same appearance. Some appearances, like
40825
+ {@link PerInstanceColorAppearance} allow giving each instance unique
40826
+ properties.
40827
+
40828
+ <p>
40829
+ When using an appearance that requires a color attribute, like PerInstanceColorAppearance,
40830
+ add a depthFailColor per-instance attribute instead.
40831
+ </p>
40832
+
40833
+ <p>
40834
+ Requires the EXT_frag_depth WebGL extension to render properly. If the extension is not supported,
40835
+ there may be artifacts.
40836
+ </p>
40800
40837
  */
40801
40838
  depthFailAppearance: Appearance;
40802
40839
  /**
40803
40840
  * The 4x4 transformation matrix that transforms the primitive (all geometry instances) from model to world coordinates.
40804
- * When this is the identity matrix, the primitive is drawn in world coordinates, i.e., Earth's WGS84 coordinates.
40805
- * Local reference frames can be used by providing a different transformation matrix, like that returned
40806
- * by {@link Transforms.eastNorthUpToFixedFrame}.
40807
- *
40808
- * <p>
40809
- * This property is only supported in 3D mode.
40810
- * </p>
40841
+ When this is the identity matrix, the primitive is drawn in world coordinates, i.e., Earth's WGS84 coordinates.
40842
+ Local reference frames can be used by providing a different transformation matrix, like that returned
40843
+ by {@link Transforms.eastNorthUpToFixedFrame}.
40844
+
40845
+ <p>
40846
+ This property is only supported in 3D mode.
40847
+ </p>
40811
40848
  * @example
40812
40849
  * const origin = Cesium.Cartesian3.fromDegrees(-95.0, 40.0, 200000.0);
40813
- * p.modelMatrix = Cesium.Transforms.eastNorthUpToFixedFrame(origin);
40850
+ p.modelMatrix = Cesium.Transforms.eastNorthUpToFixedFrame(origin);
40814
40851
  */
40815
40852
  modelMatrix: Matrix4;
40816
40853
  /**
40817
40854
  * Determines if the primitive will be shown. This affects all geometry
40818
- * instances in the primitive.
40855
+ instances in the primitive.
40819
40856
  */
40820
40857
  show: boolean;
40821
40858
  /**
40822
40859
  * When <code>true</code>, the renderer frustum culls and horizon culls the primitive's commands
40823
- * based on their bounding volume. Set this to <code>false</code> for a small performance gain
40824
- * if you are manually culling the primitive.
40860
+ based on their bounding volume. Set this to <code>false</code> for a small performance gain
40861
+ if you are manually culling the primitive.
40825
40862
  */
40826
40863
  cull: boolean;
40827
40864
  /**
40828
40865
  * This property is for debugging only; it is not for production use nor is it optimized.
40829
- * <p>
40830
- * Draws the bounding sphere for each draw command in the primitive.
40831
- * </p>
40866
+ <p>
40867
+ Draws the bounding sphere for each draw command in the primitive.
40868
+ </p>
40832
40869
  */
40833
40870
  debugShowBoundingVolume: boolean;
40834
40871
  /**
@@ -40861,60 +40898,60 @@ export class Primitive {
40861
40898
  readonly compressVertices: boolean;
40862
40899
  /**
40863
40900
  * Determines if the primitive is complete and ready to render. If this property is
40864
- * true, the primitive will be rendered the next time that {@link Primitive#update}
40865
- * is called.
40901
+ true, the primitive will be rendered the next time that {@link Primitive#update}
40902
+ is called.
40866
40903
  * @example
40867
40904
  * // Wait for a primitive to become ready before accessing attributes
40868
- * const removeListener = scene.postRender.addEventListener(() => {
40869
- * if (!frustumPrimitive.ready) {
40870
- * return;
40871
- * }
40872
- *
40873
- * const attributes = primitive.getGeometryInstanceAttributes('an id');
40874
- * attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA);
40875
- *
40876
- * removeListener();
40877
- * });
40905
+ const removeListener = scene.postRender.addEventListener(() => {
40906
+ if (!frustumPrimitive.ready) {
40907
+ return;
40908
+ }
40909
+
40910
+ const attributes = primitive.getGeometryInstanceAttributes('an id');
40911
+ attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA);
40912
+
40913
+ removeListener();
40914
+ });
40878
40915
  */
40879
40916
  readonly ready: boolean;
40880
40917
  /**
40881
40918
  * Called when {@link Viewer} or {@link CesiumWidget} render the scene to
40882
- * get the draw commands needed to render this primitive.
40883
- * <p>
40884
- * Do not call this function directly. This is documented just to
40885
- * list the exceptions that may be propagated when the scene is rendered:
40886
- * </p>
40919
+ get the draw commands needed to render this primitive.
40920
+ <p>
40921
+ Do not call this function directly. This is documented just to
40922
+ list the exceptions that may be propagated when the scene is rendered:
40923
+ </p>
40887
40924
  */
40888
40925
  update(): void;
40889
40926
  /**
40890
40927
  * Returns the modifiable per-instance attributes for a {@link GeometryInstance}.
40891
40928
  * @example
40892
40929
  * const attributes = primitive.getGeometryInstanceAttributes('an id');
40893
- * attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA);
40894
- * attributes.show = Cesium.ShowGeometryInstanceAttribute.toValue(true);
40895
- * attributes.distanceDisplayCondition = Cesium.DistanceDisplayConditionGeometryInstanceAttribute.toValue(100.0, 10000.0);
40896
- * attributes.offset = Cesium.OffsetGeometryInstanceAttribute.toValue(Cartesian3.IDENTITY);
40930
+ attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA);
40931
+ attributes.show = Cesium.ShowGeometryInstanceAttribute.toValue(true);
40932
+ attributes.distanceDisplayCondition = Cesium.DistanceDisplayConditionGeometryInstanceAttribute.toValue(100.0, 10000.0);
40933
+ attributes.offset = Cesium.OffsetGeometryInstanceAttribute.toValue(Cartesian3.IDENTITY);
40897
40934
  * @param id - The id of the {@link GeometryInstance}.
40898
40935
  * @returns The typed array in the attribute's format or undefined if the is no instance with id.
40899
40936
  */
40900
40937
  getGeometryInstanceAttributes(id: any): any;
40901
40938
  /**
40902
40939
  * Returns true if this object was destroyed; otherwise, false.
40903
- * <p>
40904
- * If this object was destroyed, it should not be used; calling any function other than
40905
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
40906
- * </p>
40940
+ <p>
40941
+ If this object was destroyed, it should not be used; calling any function other than
40942
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
40943
+ </p>
40907
40944
  * @returns <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
40908
40945
  */
40909
40946
  isDestroyed(): boolean;
40910
40947
  /**
40911
40948
  * Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
40912
- * release of WebGL resources, instead of relying on the garbage collector to destroy this object.
40913
- * <p>
40914
- * Once an object is destroyed, it should not be used; calling any function other than
40915
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
40916
- * assign the return value (<code>undefined</code>) to the object as done in the example.
40917
- * </p>
40949
+ release of WebGL resources, instead of relying on the garbage collector to destroy this object.
40950
+ <p>
40951
+ Once an object is destroyed, it should not be used; calling any function other than
40952
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
40953
+ assign the return value (<code>undefined</code>) to the object as done in the example.
40954
+ </p>
40918
40955
  * @example
40919
40956
  * e = e && e.destroy();
40920
40957
  */
@@ -41077,15 +41114,15 @@ export class PrimitiveCollection {
41077
41114
 
41078
41115
  /**
41079
41116
  * The container for all 3D graphical objects and state in a Cesium virtual scene. Generally,
41080
- * a scene is not created directly; instead, it is implicitly created by {@link CesiumWidget}.
41117
+ a scene is not created directly; instead, it is implicitly created by {@link CesiumWidget}.
41081
41118
  * @example
41082
41119
  * // Create scene without anisotropic texture filtering
41083
- * const scene = new Cesium.Scene({
41084
- * canvas : canvas,
41085
- * contextOptions : {
41086
- * allowTextureFilterAnisotropic : false
41087
- * }
41088
- * });
41120
+ const scene = new Cesium.Scene({
41121
+ canvas : canvas,
41122
+ contextOptions : {
41123
+ allowTextureFilterAnisotropic : false
41124
+ }
41125
+ });
41089
41126
  * @param options - Object with the following properties:
41090
41127
  * @param options.canvas - The HTML canvas element to create the scene for.
41091
41128
  * @param [options.contextOptions] - Context and WebGL creation properties.
@@ -41121,14 +41158,14 @@ export class Scene {
41121
41158
  });
41122
41159
  /**
41123
41160
  * Exceptions occurring in <code>render</code> are always caught in order to raise the
41124
- * <code>renderError</code> event. If this property is true, the error is rethrown
41125
- * after the event is raised. If this property is false, the <code>render</code> function
41126
- * returns normally after raising the event.
41161
+ <code>renderError</code> event. If this property is true, the error is rethrown
41162
+ after the event is raised. If this property is false, the <code>render</code> function
41163
+ returns normally after raising the event.
41127
41164
  */
41128
41165
  rethrowRenderErrors: boolean;
41129
41166
  /**
41130
41167
  * Determines whether or not to instantly complete the
41131
- * scene transition animation on user input.
41168
+ scene transition animation on user input.
41132
41169
  */
41133
41170
  completeMorphOnUserInput: boolean;
41134
41171
  /**
@@ -41165,106 +41202,106 @@ export class Scene {
41165
41202
  backgroundColor: Color;
41166
41203
  /**
41167
41204
  * The current morph transition time between 2D/Columbus View and 3D,
41168
- * with 0.0 being 2D or Columbus View and 1.0 being 3D.
41205
+ with 0.0 being 2D or Columbus View and 1.0 being 3D.
41169
41206
  */
41170
41207
  morphTime: number;
41171
41208
  /**
41172
41209
  * The far-to-near ratio of the multi-frustum when using a normal depth buffer.
41173
- * <p>
41174
- * This value is used to create the near and far values for each frustum of the multi-frustum. It is only used
41175
- * when {@link Scene#logarithmicDepthBuffer} is <code>false</code>. When <code>logarithmicDepthBuffer</code> is
41176
- * <code>true</code>, use {@link Scene#logarithmicDepthFarToNearRatio}.
41177
- * </p>
41210
+ <p>
41211
+ This value is used to create the near and far values for each frustum of the multi-frustum. It is only used
41212
+ when {@link Scene#logarithmicDepthBuffer} is <code>false</code>. When <code>logarithmicDepthBuffer</code> is
41213
+ <code>true</code>, use {@link Scene#logarithmicDepthFarToNearRatio}.
41214
+ </p>
41178
41215
  */
41179
41216
  farToNearRatio: number;
41180
41217
  /**
41181
41218
  * The far-to-near ratio of the multi-frustum when using a logarithmic depth buffer.
41182
- * <p>
41183
- * This value is used to create the near and far values for each frustum of the multi-frustum. It is only used
41184
- * when {@link Scene#logarithmicDepthBuffer} is <code>true</code>. When <code>logarithmicDepthBuffer</code> is
41185
- * <code>false</code>, use {@link Scene#farToNearRatio}.
41186
- * </p>
41219
+ <p>
41220
+ This value is used to create the near and far values for each frustum of the multi-frustum. It is only used
41221
+ when {@link Scene#logarithmicDepthBuffer} is <code>true</code>. When <code>logarithmicDepthBuffer</code> is
41222
+ <code>false</code>, use {@link Scene#farToNearRatio}.
41223
+ </p>
41187
41224
  */
41188
41225
  logarithmicDepthFarToNearRatio: number;
41189
41226
  /**
41190
41227
  * Determines the uniform depth size in meters of each frustum of the multifrustum in 2D. If a primitive or model close
41191
- * to the surface shows z-fighting, decreasing this will eliminate the artifact, but decrease performance. On the
41192
- * other hand, increasing this will increase performance but may cause z-fighting among primitives close to the surface.
41228
+ to the surface shows z-fighting, decreasing this will eliminate the artifact, but decrease performance. On the
41229
+ other hand, increasing this will increase performance but may cause z-fighting among primitives close to the surface.
41193
41230
  */
41194
41231
  nearToFarDistance2D: number;
41195
41232
  /**
41196
41233
  * The vertical exaggeration of the scene.
41197
- * When set to 1.0, no exaggeration is applied.
41234
+ When set to 1.0, no exaggeration is applied.
41198
41235
  */
41199
41236
  verticalExaggeration: number;
41200
41237
  /**
41201
41238
  * The reference height for vertical exaggeration of the scene.
41202
- * When set to 0.0, the exaggeration is applied relative to the ellipsoid surface.
41239
+ When set to 0.0, the exaggeration is applied relative to the ellipsoid surface.
41203
41240
  */
41204
41241
  verticalExaggerationRelativeHeight: number;
41205
41242
  /**
41206
41243
  * This property is for debugging only; it is not for production use.
41207
- * <p>
41208
- * A function that determines what commands are executed. As shown in the examples below,
41209
- * the function receives the command's <code>owner</code> as an argument, and returns a boolean indicating if the
41210
- * command should be executed.
41211
- * </p>
41212
- * <p>
41213
- * The default is <code>undefined</code>, indicating that all commands are executed.
41214
- * </p>
41244
+ <p>
41245
+ A function that determines what commands are executed. As shown in the examples below,
41246
+ the function receives the command's <code>owner</code> as an argument, and returns a boolean indicating if the
41247
+ command should be executed.
41248
+ </p>
41249
+ <p>
41250
+ The default is <code>undefined</code>, indicating that all commands are executed.
41251
+ </p>
41215
41252
  * @example
41216
41253
  * // Do not execute any commands.
41217
- * scene.debugCommandFilter = function(command) {
41218
- * return false;
41219
- * };
41220
- *
41221
- * // Execute only the billboard's commands. That is, only draw the billboard.
41222
- * const billboards = new Cesium.BillboardCollection();
41223
- * scene.debugCommandFilter = function(command) {
41224
- * return command.owner === billboards;
41225
- * };
41254
+ scene.debugCommandFilter = function(command) {
41255
+ return false;
41256
+ };
41257
+
41258
+ // Execute only the billboard's commands. That is, only draw the billboard.
41259
+ const billboards = new Cesium.BillboardCollection();
41260
+ scene.debugCommandFilter = function(command) {
41261
+ return command.owner === billboards;
41262
+ };
41226
41263
  */
41227
41264
  debugCommandFilter: (...params: any[]) => any;
41228
41265
  /**
41229
41266
  * This property is for debugging only; it is not for production use.
41230
- * <p>
41231
- * When <code>true</code>, commands are randomly shaded. This is useful
41232
- * for performance analysis to see what parts of a scene or model are
41233
- * command-dense and could benefit from batching.
41234
- * </p>
41267
+ <p>
41268
+ When <code>true</code>, commands are randomly shaded. This is useful
41269
+ for performance analysis to see what parts of a scene or model are
41270
+ command-dense and could benefit from batching.
41271
+ </p>
41235
41272
  */
41236
41273
  debugShowCommands: boolean;
41237
41274
  /**
41238
41275
  * This property is for debugging only; it is not for production use.
41239
- * <p>
41240
- * When <code>true</code>, commands are shaded based on the frustums they
41241
- * overlap. Commands in the closest frustum are tinted red, commands in
41242
- * the next closest are green, and commands in the farthest frustum are
41243
- * blue. If a command overlaps more than one frustum, the color components
41244
- * are combined, e.g., a command overlapping the first two frustums is tinted
41245
- * yellow.
41246
- * </p>
41276
+ <p>
41277
+ When <code>true</code>, commands are shaded based on the frustums they
41278
+ overlap. Commands in the closest frustum are tinted red, commands in
41279
+ the next closest are green, and commands in the farthest frustum are
41280
+ blue. If a command overlaps more than one frustum, the color components
41281
+ are combined, e.g., a command overlapping the first two frustums is tinted
41282
+ yellow.
41283
+ </p>
41247
41284
  */
41248
41285
  debugShowFrustums: boolean;
41249
41286
  /**
41250
41287
  * This property is for debugging only; it is not for production use.
41251
- * <p>
41252
- * Displays frames per second and time between frames.
41253
- * </p>
41288
+ <p>
41289
+ Displays frames per second and time between frames.
41290
+ </p>
41254
41291
  */
41255
41292
  debugShowFramesPerSecond: boolean;
41256
41293
  /**
41257
41294
  * This property is for debugging only; it is not for production use.
41258
- * <p>
41259
- * Indicates which frustum will have depth information displayed.
41260
- * </p>
41295
+ <p>
41296
+ Indicates which frustum will have depth information displayed.
41297
+ </p>
41261
41298
  */
41262
41299
  debugShowDepthFrustum: number;
41263
41300
  /**
41264
41301
  * This property is for debugging only; it is not for production use.
41265
- * <p>
41266
- * When <code>true</code>, draws outlines to show the boundaries of the camera frustums
41267
- * </p>
41302
+ <p>
41303
+ When <code>true</code>, draws outlines to show the boundaries of the camera frustums
41304
+ </p>
41268
41305
  */
41269
41306
  debugShowFrustumPlanes: boolean;
41270
41307
  /**
@@ -41273,33 +41310,33 @@ export class Scene {
41273
41310
  useDepthPicking: boolean;
41274
41311
  /**
41275
41312
  * When <code>true</code>, enables picking translucent geometry using the depth buffer. Note that {@link Scene#useDepthPicking} must also be true for enabling this to work.
41276
- *
41277
- * <p>
41278
- * There is a decrease in performance when enabled. There are extra draw calls to write depth for
41279
- * translucent geometry.
41280
- * </p>
41313
+
41314
+ <p>
41315
+ There is a decrease in performance when enabled. There are extra draw calls to write depth for
41316
+ translucent geometry.
41317
+ </p>
41281
41318
  * @example
41282
41319
  * // picking the position of a translucent primitive
41283
- * viewer.screenSpaceEventHandler.setInputAction(function onLeftClick(movement) {
41284
- * const pickedFeature = viewer.scene.pick(movement.position);
41285
- * if (!Cesium.defined(pickedFeature)) {
41286
- * // nothing picked
41287
- * return;
41288
- * }
41289
- * const worldPosition = viewer.scene.pickPosition(movement.position);
41290
- * }, Cesium.ScreenSpaceEventType.LEFT_CLICK);
41320
+ viewer.screenSpaceEventHandler.setInputAction(function onLeftClick(movement) {
41321
+ const pickedFeature = viewer.scene.pick(movement.position);
41322
+ if (!Cesium.defined(pickedFeature)) {
41323
+ // nothing picked
41324
+ return;
41325
+ }
41326
+ const worldPosition = viewer.scene.pickPosition(movement.position);
41327
+ }, Cesium.ScreenSpaceEventType.LEFT_CLICK);
41291
41328
  */
41292
41329
  pickTranslucentDepth: boolean;
41293
41330
  /**
41294
41331
  * Settings for atmosphere lighting effects affecting 3D Tiles and model rendering. This is not to be confused with
41295
- * {@link Scene#skyAtmosphere} which is responsible for rendering the sky.
41332
+ {@link Scene#skyAtmosphere} which is responsible for rendering the sky.
41296
41333
  */
41297
41334
  atmosphere: Atmosphere;
41298
41335
  /**
41299
41336
  * Blends the atmosphere to geometry far from the camera for horizon views. Allows for additional
41300
- * performance improvements by rendering less geometry and dispatching less terrain requests.
41301
- *
41302
- * Disbaled by default if an ellipsoid other than WGS84 is used.
41337
+ performance improvements by rendering less geometry and dispatching less terrain requests.
41338
+
41339
+ Disbaled by default if an ellipsoid other than WGS84 is used.
41303
41340
  */
41304
41341
  fog: Fog;
41305
41342
  /**
@@ -41308,13 +41345,13 @@ export class Scene {
41308
41345
  shadowMap: ShadowMap;
41309
41346
  /**
41310
41347
  * When <code>false</code>, 3D Tiles will render normally. When <code>true</code>, classified 3D Tile geometry will render normally and
41311
- * unclassified 3D Tile geometry will render with the color multiplied by {@link Scene#invertClassificationColor}.
41348
+ unclassified 3D Tile geometry will render with the color multiplied by {@link Scene#invertClassificationColor}.
41312
41349
  */
41313
41350
  invertClassification: boolean;
41314
41351
  /**
41315
41352
  * The highlight color of unclassified 3D Tile geometry when {@link Scene#invertClassification} is <code>true</code>.
41316
- * <p>When the color's alpha is less than 1.0, the unclassified portions of the 3D Tiles will not blend correctly with the classified positions of the 3D Tiles.</p>
41317
- * <p>Also, when the color's alpha is less than 1.0, the WEBGL_depth_texture and EXT_frag_depth WebGL extensions must be supported.</p>
41353
+ <p>When the color's alpha is less than 1.0, the unclassified portions of the 3D Tiles will not blend correctly with the classified positions of the 3D Tiles.</p>
41354
+ <p>Also, when the color's alpha is less than 1.0, the WEBGL_depth_texture and EXT_frag_depth WebGL extensions must be supported.</p>
41318
41355
  */
41319
41356
  invertClassificationColor: Color;
41320
41357
  /**
@@ -41331,18 +41368,18 @@ export class Scene {
41331
41368
  postProcessStages: PostProcessStageCollection;
41332
41369
  /**
41333
41370
  * When <code>true</code>, rendering a frame will only occur when needed as determined by changes within the scene.
41334
- * Enabling improves performance of the application, but requires using {@link Scene#requestRender}
41335
- * to render a new frame explicitly in this mode. This will be necessary in many cases after making changes
41336
- * to the scene in other parts of the API.
41371
+ Enabling improves performance of the application, but requires using {@link Scene#requestRender}
41372
+ to render a new frame explicitly in this mode. This will be necessary in many cases after making changes
41373
+ to the scene in other parts of the API.
41337
41374
  */
41338
41375
  requestRenderMode: boolean;
41339
41376
  /**
41340
41377
  * If {@link Scene#requestRenderMode} is <code>true</code>, this value defines the maximum change in
41341
- * simulation time allowed before a render is requested. Lower values increase the number of frames rendered
41342
- * and higher values decrease the number of frames rendered. If <code>undefined</code>, changes to
41343
- * the simulation time will never request a render.
41344
- * This value impacts the rate of rendering for changes in the scene like lighting, entity property updates,
41345
- * and animations.
41378
+ simulation time allowed before a render is requested. Lower values increase the number of frames rendered
41379
+ and higher values decrease the number of frames rendered. If <code>undefined</code>, changes to
41380
+ the simulation time will never request a render.
41381
+ This value impacts the rate of rendering for changes in the scene like lighting, entity property updates,
41382
+ and animations.
41346
41383
  */
41347
41384
  maximumRenderTimeChange: number;
41348
41385
  /**
@@ -41359,7 +41396,7 @@ export class Scene {
41359
41396
  light: Light;
41360
41397
  /**
41361
41398
  * Use this to set the default value for {@link Scene#logarithmicDepthBuffer} in newly constructed Scenes
41362
- * This property relies on fragmentDepth being supported.
41399
+ This property relies on fragmentDepth being supported.
41363
41400
  */
41364
41401
  static defaultLogDepthBuffer: any;
41365
41402
  /**
@@ -41444,48 +41481,48 @@ export class Scene {
41444
41481
  readonly terrainProviderChanged: Event;
41445
41482
  /**
41446
41483
  * Gets the event that will be raised before the scene is updated or rendered. Subscribers to the event
41447
- * receive the Scene instance as the first parameter and the current time as the second parameter.
41484
+ receive the Scene instance as the first parameter and the current time as the second parameter.
41448
41485
  */
41449
41486
  readonly preUpdate: Event;
41450
41487
  /**
41451
41488
  * Gets the event that will be raised immediately after the scene is updated and before the scene is rendered.
41452
- * Subscribers to the event receive the Scene instance as the first parameter and the current time as the second
41453
- * parameter.
41489
+ Subscribers to the event receive the Scene instance as the first parameter and the current time as the second
41490
+ parameter.
41454
41491
  */
41455
41492
  readonly postUpdate: Event;
41456
41493
  /**
41457
41494
  * Gets the event that will be raised when an error is thrown inside the <code>render</code> function.
41458
- * The Scene instance and the thrown error are the only two parameters passed to the event handler.
41459
- * By default, errors are not rethrown after this event is raised, but that can be changed by setting
41460
- * the <code>rethrowRenderErrors</code> property.
41495
+ The Scene instance and the thrown error are the only two parameters passed to the event handler.
41496
+ By default, errors are not rethrown after this event is raised, but that can be changed by setting
41497
+ the <code>rethrowRenderErrors</code> property.
41461
41498
  */
41462
41499
  readonly renderError: Event;
41463
41500
  /**
41464
41501
  * Gets the event that will be raised after the scene is updated and immediately before the scene is rendered.
41465
- * Subscribers to the event receive the Scene instance as the first parameter and the current time as the second
41466
- * parameter.
41502
+ Subscribers to the event receive the Scene instance as the first parameter and the current time as the second
41503
+ parameter.
41467
41504
  */
41468
41505
  readonly preRender: Event;
41469
41506
  /**
41470
41507
  * Gets the event that will be raised immediately after the scene is rendered. Subscribers to the event
41471
- * receive the Scene instance as the first parameter and the current time as the second parameter.
41508
+ receive the Scene instance as the first parameter and the current time as the second parameter.
41472
41509
  */
41473
41510
  readonly postRender: Event;
41474
41511
  /**
41475
41512
  * Gets the simulation time when the scene was last rendered. Returns undefined if the scene has not yet been
41476
- * rendered.
41513
+ rendered.
41477
41514
  */
41478
41515
  readonly lastRenderTime: JulianDate;
41479
41516
  /**
41480
41517
  * This property is for debugging only; it is not for production use.
41481
- * <p>
41482
- * When {@link Scene.debugShowFrustums} is <code>true</code>, this contains
41483
- * properties with statistics about the number of command execute per frustum.
41484
- * <code>totalCommands</code> is the total number of commands executed, ignoring
41485
- * overlap. <code>commandsInFrustums</code> is an array with the number of times
41486
- * commands are executed redundantly, e.g., how many commands overlap two or
41487
- * three frustums.
41488
- * </p>
41518
+ <p>
41519
+ When {@link Scene.debugShowFrustums} is <code>true</code>, this contains
41520
+ properties with statistics about the number of command execute per frustum.
41521
+ <code>totalCommands</code> is the total number of commands executed, ignoring
41522
+ overlap. <code>commandsInFrustums</code> is an array with the number of times
41523
+ commands are executed redundantly, e.g., how many commands overlap two or
41524
+ three frustums.
41525
+ </p>
41489
41526
  */
41490
41527
  readonly debugFrustumStatistics: any;
41491
41528
  /**
@@ -41494,8 +41531,8 @@ export class Scene {
41494
41531
  readonly scene3DOnly: boolean;
41495
41532
  /**
41496
41533
  * Gets whether or not the scene has order independent translucency enabled.
41497
- * Note that this only reflects the original construction option, and there are
41498
- * other factors that could prevent OIT from functioning on a given system configuration.
41534
+ Note that this only reflects the original construction option, and there are
41535
+ other factors that could prevent OIT from functioning on a given system configuration.
41499
41536
  */
41500
41537
  readonly orderIndependentTranslucency: boolean;
41501
41538
  /**
@@ -41508,7 +41545,7 @@ export class Scene {
41508
41545
  mode: SceneMode;
41509
41546
  /**
41510
41547
  * When <code>true</code>, splits the scene into two viewports with steroscopic views for the left and right eyes.
41511
- * Used for cardboard and WebVR.
41548
+ Used for cardboard and WebVR.
41512
41549
  */
41513
41550
  useWebVR: boolean;
41514
41551
  /**
@@ -41521,14 +41558,14 @@ export class Scene {
41521
41558
  splitPosition: number;
41522
41559
  /**
41523
41560
  * The distance from the camera at which to disable the depth test of billboards, labels and points
41524
- * to, for example, prevent clipping against terrain. When set to zero, the depth test should always
41525
- * be applied. When less than zero, the depth test should never be applied. Setting the disableDepthTestDistance
41526
- * property of a billboard, label or point will override this value.
41561
+ to, for example, prevent clipping against terrain. When set to zero, the depth test should always
41562
+ be applied. When less than zero, the depth test should never be applied. Setting the disableDepthTestDistance
41563
+ property of a billboard, label or point will override this value.
41527
41564
  */
41528
41565
  minimumDisableDepthTestDistance: number;
41529
41566
  /**
41530
41567
  * Whether or not to use a logarithmic depth buffer. Enabling this option will allow for less frustums in the multi-frustum,
41531
- * increasing performance. This property relies on fragmentDepth being supported.
41568
+ increasing performance. This property relies on fragmentDepth being supported.
41532
41569
  */
41533
41570
  logarithmicDepthBuffer: boolean;
41534
41571
  /**
@@ -41563,30 +41600,30 @@ export class Scene {
41563
41600
  getCompressedTextureFormatSupported(format: string): boolean;
41564
41601
  /**
41565
41602
  * Update and render the scene. It is usually not necessary to call this function
41566
- * directly because {@link CesiumWidget} will do it automatically.
41603
+ directly because {@link CesiumWidget} will do it automatically.
41567
41604
  * @param [time] - The simulation time at which to render.
41568
41605
  */
41569
41606
  render(time?: JulianDate): void;
41570
41607
  /**
41571
41608
  * Requests a new rendered frame when {@link Scene#requestRenderMode} is set to <code>true</code>.
41572
- * The render rate will not exceed the {@link CesiumWidget#targetFrameRate}.
41609
+ The render rate will not exceed the {@link CesiumWidget#targetFrameRate}.
41573
41610
  */
41574
41611
  requestRender(): void;
41575
41612
  /**
41576
41613
  * Returns an object with a `primitive` property that contains the first (top) primitive in the scene
41577
- * at a particular window coordinate or undefined if nothing is at the location. Other properties may
41578
- * potentially be set depending on the type of primitive and may be used to further identify the picked object.
41579
- * <p>
41580
- * When a feature of a 3D Tiles tileset is picked, <code>pick</code> returns a {@link Cesium3DTileFeature} object.
41581
- * </p>
41614
+ at a particular window coordinate or undefined if nothing is at the location. Other properties may
41615
+ potentially be set depending on the type of primitive and may be used to further identify the picked object.
41616
+ <p>
41617
+ When a feature of a 3D Tiles tileset is picked, <code>pick</code> returns a {@link Cesium3DTileFeature} object.
41618
+ </p>
41582
41619
  * @example
41583
41620
  * // On mouse over, color the feature yellow.
41584
- * handler.setInputAction(function(movement) {
41585
- * const feature = scene.pick(movement.endPosition);
41586
- * if (feature instanceof Cesium.Cesium3DTileFeature) {
41587
- * feature.color = Cesium.Color.YELLOW;
41588
- * }
41589
- * }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
41621
+ handler.setInputAction(function(movement) {
41622
+ const feature = scene.pick(movement.endPosition);
41623
+ if (feature instanceof Cesium.Cesium3DTileFeature) {
41624
+ feature.color = Cesium.Color.YELLOW;
41625
+ }
41626
+ }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
41590
41627
  * @param windowPosition - Window coordinates to perform picking on.
41591
41628
  * @param [width = 3] - Width of the pick rectangle.
41592
41629
  * @param [height = 3] - Height of the pick rectangle.
@@ -41595,15 +41632,15 @@ export class Scene {
41595
41632
  pick(windowPosition: Cartesian2, width?: number, height?: number): any;
41596
41633
  /**
41597
41634
  * Returns a {@link VoxelCell} for the voxel sample rendered at a particular window coordinate,
41598
- * or undefined if no voxel is rendered at that position.
41635
+ or undefined if no voxel is rendered at that position.
41599
41636
  * @example
41600
41637
  * On left click, report the value of the "color" property at that voxel sample.
41601
- * handler.setInputAction(function(movement) {
41602
- * const voxelCell = scene.pickVoxel(movement.position);
41603
- * if (defined(voxelCell)) {
41604
- * console.log(voxelCell.getProperty("color"));
41605
- * }
41606
- * }, Cesium.ScreenSpaceEventType.LEFT_CLICK);
41638
+ handler.setInputAction(function(movement) {
41639
+ const voxelCell = scene.pickVoxel(movement.position);
41640
+ if (defined(voxelCell)) {
41641
+ console.log(voxelCell.getProperty("color"));
41642
+ }
41643
+ }, Cesium.ScreenSpaceEventType.LEFT_CLICK);
41607
41644
  * @param windowPosition - Window coordinates to perform picking on.
41608
41645
  * @param [width = 3] - Width of the pick rectangle.
41609
41646
  * @param [height = 3] - Height of the pick rectangle.
@@ -41614,34 +41651,34 @@ export class Scene {
41614
41651
  * Pick a metadata value at the given window position.
41615
41652
  * @param windowPosition - Window coordinates to perform picking on.
41616
41653
  * @param schemaId - The ID of the metadata schema to pick values
41617
- * from. If this is `undefined`, then it will pick the values from the object
41618
- * that match the given class- and property name, regardless of the schema ID.
41654
+ from. If this is `undefined`, then it will pick the values from the object
41655
+ that match the given class- and property name, regardless of the schema ID.
41619
41656
  * @param className - The name of the metadata class to pick
41620
- * values from
41657
+ values from
41621
41658
  * @param propertyName - The name of the metadata property to pick
41622
- * values from
41659
+ values from
41623
41660
  * @returns The metadata value, or `undefined` when
41624
- * no matching metadata was found at the given position
41661
+ no matching metadata was found at the given position
41625
41662
  */
41626
41663
  pickMetadata(windowPosition: Cartesian2, schemaId: string | undefined, className: string, propertyName: string): MetadataValue | undefined;
41627
41664
  /**
41628
41665
  * Pick the schema of the metadata of the object at the given position
41629
41666
  * @param windowPosition - Window coordinates to perform picking on.
41630
41667
  * @returns The metadata schema, or `undefined` if there is no object with
41631
- * associated metadata at the given position.
41668
+ associated metadata at the given position.
41632
41669
  */
41633
41670
  pickMetadataSchema(windowPosition: Cartesian2): MetadataSchema;
41634
41671
  /**
41635
41672
  * Returns the cartesian position reconstructed from the depth buffer and window position.
41636
- * <p>
41637
- * The position reconstructed from the depth buffer in 2D may be slightly different from those
41638
- * reconstructed in 3D and Columbus view. This is caused by the difference in the distribution
41639
- * of depth values of perspective and orthographic projection.
41640
- * </p>
41641
- * <p>
41642
- * Set {@link Scene#pickTranslucentDepth} to <code>true</code> to include the depth of
41643
- * translucent primitives; otherwise, this essentially picks through translucent primitives.
41644
- * </p>
41673
+ <p>
41674
+ The position reconstructed from the depth buffer in 2D may be slightly different from those
41675
+ reconstructed in 3D and Columbus view. This is caused by the difference in the distribution
41676
+ of depth values of perspective and orthographic projection.
41677
+ </p>
41678
+ <p>
41679
+ Set {@link Scene#pickTranslucentDepth} to <code>true</code> to include the depth of
41680
+ translucent primitives; otherwise, this essentially picks through translucent primitives.
41681
+ </p>
41645
41682
  * @param windowPosition - Window coordinates to perform picking on.
41646
41683
  * @param [result] - The object on which to restore the result.
41647
41684
  * @returns The cartesian position.
@@ -41649,9 +41686,9 @@ export class Scene {
41649
41686
  pickPosition(windowPosition: Cartesian2, result?: Cartesian3): Cartesian3;
41650
41687
  /**
41651
41688
  * Returns a list of objects, each containing a `primitive` property, for all primitives at
41652
- * a particular window coordinate position. Other properties may also be set depending on the
41653
- * type of primitive and may be used to further identify the picked object. The primitives in
41654
- * the list are ordered by their visual order in the scene (front to back).
41689
+ a particular window coordinate position. Other properties may also be set depending on the
41690
+ type of primitive and may be used to further identify the picked object. The primitives in
41691
+ the list are ordered by their visual order in the scene (front to back).
41655
41692
  * @example
41656
41693
  * const pickedObjects = scene.drillPick(new Cesium.Cartesian2(100.0, 200.0));
41657
41694
  * @param windowPosition - Window coordinates to perform picking on.
@@ -41663,16 +41700,16 @@ export class Scene {
41663
41700
  drillPick(windowPosition: Cartesian2, limit?: number, width?: number, height?: number): any[];
41664
41701
  /**
41665
41702
  * Returns the height of scene geometry at the given cartographic position or <code>undefined</code> if there was no
41666
- * scene geometry to sample height from. The height of the input position is ignored. May be used to clamp objects to
41667
- * the globe, 3D Tiles, or primitives in the scene.
41668
- * <p>
41669
- * This function only samples height from globe tiles and 3D Tiles that are rendered in the current view. Samples height
41670
- * from all other primitives regardless of their visibility.
41671
- * </p>
41703
+ scene geometry to sample height from. The height of the input position is ignored. May be used to clamp objects to
41704
+ the globe, 3D Tiles, or primitives in the scene.
41705
+ <p>
41706
+ This function only samples height from globe tiles and 3D Tiles that are rendered in the current view. Samples height
41707
+ from all other primitives regardless of their visibility.
41708
+ </p>
41672
41709
  * @example
41673
41710
  * const position = new Cesium.Cartographic(-1.31968, 0.698874);
41674
- * const height = viewer.scene.sampleHeight(position);
41675
- * console.log(height);
41711
+ const height = viewer.scene.sampleHeight(position);
41712
+ console.log(height);
41676
41713
  * @param position - The cartographic position to sample height from.
41677
41714
  * @param [objectsToExclude] - A list of primitives, entities, or 3D Tiles features to not sample height from.
41678
41715
  * @param [width = 0.1] - Width of the intersection volume in meters.
@@ -41681,16 +41718,16 @@ export class Scene {
41681
41718
  sampleHeight(position: Cartographic, objectsToExclude?: object[], width?: number): number;
41682
41719
  /**
41683
41720
  * Clamps the given cartesian position to the scene geometry along the geodetic surface normal. Returns the
41684
- * clamped position or <code>undefined</code> if there was no scene geometry to clamp to. May be used to clamp
41685
- * objects to the globe, 3D Tiles, or primitives in the scene.
41686
- * <p>
41687
- * This function only clamps to globe tiles and 3D Tiles that are rendered in the current view. Clamps to
41688
- * all other primitives regardless of their visibility.
41689
- * </p>
41721
+ clamped position or <code>undefined</code> if there was no scene geometry to clamp to. May be used to clamp
41722
+ objects to the globe, 3D Tiles, or primitives in the scene.
41723
+ <p>
41724
+ This function only clamps to globe tiles and 3D Tiles that are rendered in the current view. Clamps to
41725
+ all other primitives regardless of their visibility.
41726
+ </p>
41690
41727
  * @example
41691
41728
  * // Clamp an entity to the underlying scene geometry
41692
- * const position = entity.position.getValue(Cesium.JulianDate.now());
41693
- * entity.position = viewer.scene.clampToHeight(position);
41729
+ const position = entity.position.getValue(Cesium.JulianDate.now());
41730
+ entity.position = viewer.scene.clampToHeight(position);
41694
41731
  * @param cartesian - The cartesian position.
41695
41732
  * @param [objectsToExclude] - A list of primitives, entities, or 3D Tiles features to not clamp to.
41696
41733
  * @param [width = 0.1] - Width of the intersection volume in meters.
@@ -41700,20 +41737,20 @@ export class Scene {
41700
41737
  clampToHeight(cartesian: Cartesian3, objectsToExclude?: object[], width?: number, result?: Cartesian3): Cartesian3;
41701
41738
  /**
41702
41739
  * Initiates an asynchronous {@link Scene#sampleHeight} query for an array of {@link Cartographic} positions
41703
- * using the maximum level of detail for 3D Tilesets in the scene. The height of the input positions is ignored.
41704
- * Returns a promise that is resolved when the query completes. Each point height is modified in place.
41705
- * If a height cannot be determined because no geometry can be sampled at that location, or another error occurs,
41706
- * the height is set to undefined.
41740
+ using the maximum level of detail for 3D Tilesets in the scene. The height of the input positions is ignored.
41741
+ Returns a promise that is resolved when the query completes. Each point height is modified in place.
41742
+ If a height cannot be determined because no geometry can be sampled at that location, or another error occurs,
41743
+ the height is set to undefined.
41707
41744
  * @example
41708
41745
  * const positions = [
41709
- * new Cesium.Cartographic(-1.31968, 0.69887),
41710
- * new Cesium.Cartographic(-1.10489, 0.83923)
41711
- * ];
41712
- * const promise = viewer.scene.sampleHeightMostDetailed(positions);
41713
- * promise.then(function(updatedPosition) {
41714
- * // positions[0].height and positions[1].height have been updated.
41715
- * // updatedPositions is just a reference to positions.
41716
- * }
41746
+ new Cesium.Cartographic(-1.31968, 0.69887),
41747
+ new Cesium.Cartographic(-1.10489, 0.83923)
41748
+ ];
41749
+ const promise = viewer.scene.sampleHeightMostDetailed(positions);
41750
+ promise.then(function(updatedPosition) {
41751
+ // positions[0].height and positions[1].height have been updated.
41752
+ // updatedPositions is just a reference to positions.
41753
+ }
41717
41754
  * @param positions - The cartographic positions to update with sampled heights.
41718
41755
  * @param [objectsToExclude] - A list of primitives, entities, or 3D Tiles features to not sample height from.
41719
41756
  * @param [width = 0.1] - Width of the intersection volume in meters.
@@ -41722,19 +41759,19 @@ export class Scene {
41722
41759
  sampleHeightMostDetailed(positions: Cartographic[], objectsToExclude?: object[], width?: number): Promise<Cartographic[]>;
41723
41760
  /**
41724
41761
  * Initiates an asynchronous {@link Scene#clampToHeight} query for an array of {@link Cartesian3} positions
41725
- * using the maximum level of detail for 3D Tilesets in the scene. Returns a promise that is resolved when
41726
- * the query completes. Each position is modified in place. If a position cannot be clamped because no geometry
41727
- * can be sampled at that location, or another error occurs, the element in the array is set to undefined.
41762
+ using the maximum level of detail for 3D Tilesets in the scene. Returns a promise that is resolved when
41763
+ the query completes. Each position is modified in place. If a position cannot be clamped because no geometry
41764
+ can be sampled at that location, or another error occurs, the element in the array is set to undefined.
41728
41765
  * @example
41729
41766
  * const cartesians = [
41730
- * entities[0].position.getValue(Cesium.JulianDate.now()),
41731
- * entities[1].position.getValue(Cesium.JulianDate.now())
41732
- * ];
41733
- * const promise = viewer.scene.clampToHeightMostDetailed(cartesians);
41734
- * promise.then(function(updatedCartesians) {
41735
- * entities[0].position = updatedCartesians[0];
41736
- * entities[1].position = updatedCartesians[1];
41737
- * }
41767
+ entities[0].position.getValue(Cesium.JulianDate.now()),
41768
+ entities[1].position.getValue(Cesium.JulianDate.now())
41769
+ ];
41770
+ const promise = viewer.scene.clampToHeightMostDetailed(cartesians);
41771
+ promise.then(function(updatedCartesians) {
41772
+ entities[0].position = updatedCartesians[0];
41773
+ entities[1].position = updatedCartesians[1];
41774
+ }
41738
41775
  * @param cartesians - The cartesian positions to update with clamped positions.
41739
41776
  * @param [objectsToExclude] - A list of primitives, entities, or 3D Tiles features to not clamp to.
41740
41777
  * @param [width = 0.1] - Width of the intersection volume in meters.
@@ -41743,15 +41780,15 @@ export class Scene {
41743
41780
  clampToHeightMostDetailed(cartesians: Cartesian3[], objectsToExclude?: object[], width?: number): Promise<Cartesian3[]>;
41744
41781
  /**
41745
41782
  * Transforms a position in cartesian coordinates to canvas coordinates. This is commonly used to place an
41746
- * HTML element at the same screen position as an object in the scene.
41783
+ HTML element at the same screen position as an object in the scene.
41747
41784
  * @example
41748
41785
  * // Output the canvas position of longitude/latitude (0, 0) every time the mouse moves.
41749
- * const scene = widget.scene;
41750
- * const position = Cesium.Cartesian3.fromDegrees(0.0, 0.0);
41751
- * const handler = new Cesium.ScreenSpaceEventHandler(scene.canvas);
41752
- * handler.setInputAction(function(movement) {
41753
- * console.log(scene.cartesianToCanvasCoordinates(position));
41754
- * }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
41786
+ const scene = widget.scene;
41787
+ const position = Cesium.Cartesian3.fromDegrees(0.0, 0.0);
41788
+ const handler = new Cesium.ScreenSpaceEventHandler(scene.canvas);
41789
+ handler.setInputAction(function(movement) {
41790
+ console.log(scene.cartesianToCanvasCoordinates(position));
41791
+ }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
41755
41792
  * @param position - The position in cartesian coordinates.
41756
41793
  * @param [result] - An optional object to return the input position transformed to canvas coordinates.
41757
41794
  * @returns The modified result parameter or a new Cartesian2 instance if one was not provided. This may be <code>undefined</code> if the input position is near the center of the ellipsoid.
@@ -41780,34 +41817,34 @@ export class Scene {
41780
41817
  * Update the terrain providing surface geometry for the globe.
41781
41818
  * @example
41782
41819
  * // Use Cesium World Terrain
41783
- * scene.setTerrain(Cesium.Terrain.fromWorldTerrain());
41820
+ scene.setTerrain(Cesium.Terrain.fromWorldTerrain());
41784
41821
  * @example
41785
41822
  * // Use a custom terrain provider
41786
- * const terrain = new Cesium.Terrain(Cesium.CesiumTerrainProvider.fromUrl("https://myTestTerrain.com"));
41787
- * scene.setTerrain(terrain);
41788
- *
41789
- * terrain.errorEvent.addEventListener(error => {
41790
- * alert(`Encountered an error while creating terrain! ${error}`);
41791
- * });
41823
+ const terrain = new Cesium.Terrain(Cesium.CesiumTerrainProvider.fromUrl("https://myTestTerrain.com"));
41824
+ scene.setTerrain(terrain);
41825
+
41826
+ terrain.errorEvent.addEventListener(error => {
41827
+ alert(`Encountered an error while creating terrain! ${error}`);
41828
+ });
41792
41829
  * @param terrain - The terrain provider async helper
41793
41830
  * @returns terrain The terrain provider async helper
41794
41831
  */
41795
41832
  setTerrain(terrain: Terrain): Terrain;
41796
41833
  /**
41797
41834
  * Returns true if this object was destroyed; otherwise, false.
41798
- * <br /><br />
41799
- * If this object was destroyed, it should not be used; calling any function other than
41800
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
41835
+ <br /><br />
41836
+ If this object was destroyed, it should not be used; calling any function other than
41837
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
41801
41838
  * @returns <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
41802
41839
  */
41803
41840
  isDestroyed(): boolean;
41804
41841
  /**
41805
41842
  * Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
41806
- * release of WebGL resources, instead of relying on the garbage collector to destroy this object.
41807
- * <br /><br />
41808
- * Once an object is destroyed, it should not be used; calling any function other than
41809
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
41810
- * assign the return value (<code>undefined</code>) to the object as done in the example.
41843
+ release of WebGL resources, instead of relying on the garbage collector to destroy this object.
41844
+ <br /><br />
41845
+ Once an object is destroyed, it should not be used; calling any function other than
41846
+ <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
41847
+ assign the return value (<code>undefined</code>) to the object as done in the example.
41811
41848
  * @example
41812
41849
  * scene = scene && scene.destroy();
41813
41850
  */
@@ -41816,11 +41853,11 @@ export class Scene {
41816
41853
 
41817
41854
  /**
41818
41855
  * Determine how translucent surfaces will be handled.
41819
- *
41820
- * When OIT is enabled, then this will delegate to OIT.executeCommands.
41821
- * Otherwise, it will just be executeTranslucentCommandsBackToFront
41822
- * for render passes, or executeTranslucentCommandsFrontToBack for
41823
- * other passes.
41856
+
41857
+ When OIT is enabled, then this will delegate to OIT.executeCommands.
41858
+ Otherwise, it will just be executeTranslucentCommandsBackToFront
41859
+ for render passes, or executeTranslucentCommandsFrontToBack for
41860
+ other passes.
41824
41861
  * @param scene - The scene.
41825
41862
  * @returns A function to execute translucent commands.
41826
41863
  */
@@ -42081,13 +42118,13 @@ export enum SensorVolumePortionToDisplay {
42081
42118
 
42082
42119
  /**
42083
42120
  * <div class="notice">
42084
- * Use {@link Viewer#shadowMap} to get the scene's shadow map. Do not construct this directly.
42085
- * </div>
42086
- *
42087
- * <p>
42088
- * The normalOffset bias pushes the shadows forward slightly, and may be disabled
42089
- * for applications that require ultra precise shadows.
42090
- * </p>
42121
+ Use {@link Viewer#shadowMap} to get the scene's shadow map. Do not construct this directly.
42122
+ </div>
42123
+
42124
+ <p>
42125
+ The normalOffset bias pushes the shadows forward slightly, and may be disabled
42126
+ for applications that require ultra precise shadows.
42127
+ </p>
42091
42128
  */
42092
42129
  export class ShadowMap {
42093
42130
  constructor();
@@ -43961,31 +43998,31 @@ export namespace WebMapServiceImageryProvider {
43961
43998
  * @property [parameters = WebMapServiceImageryProvider.DefaultParameters] - Additional parameters to pass to the WMS server in the GetMap URL.
43962
43999
  * @property [getFeatureInfoParameters = WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters] - Additional parameters to pass to the WMS server in the GetFeatureInfo URL.
43963
44000
  * @property [enablePickFeatures = true] - If true, {@link WebMapServiceImageryProvider#pickFeatures} will invoke
43964
- * the GetFeatureInfo operation on the WMS server and return the features included in the response. If false,
43965
- * {@link WebMapServiceImageryProvider#pickFeatures} will immediately return undefined (indicating no pickable features)
43966
- * without communicating with the server. Set this property to false if you know your WMS server does not support
43967
- * GetFeatureInfo or if you don't want this provider's features to be pickable. Note that this can be dynamically
43968
- * overridden by modifying the WebMapServiceImageryProvider#enablePickFeatures property.
44001
+ the GetFeatureInfo operation on the WMS server and return the features included in the response. If false,
44002
+ {@link WebMapServiceImageryProvider#pickFeatures} will immediately return undefined (indicating no pickable features)
44003
+ without communicating with the server. Set this property to false if you know your WMS server does not support
44004
+ GetFeatureInfo or if you don't want this provider's features to be pickable. Note that this can be dynamically
44005
+ overridden by modifying the WebMapServiceImageryProvider#enablePickFeatures property.
43969
44006
  * @property [getFeatureInfoFormats = WebMapServiceImageryProvider.DefaultGetFeatureInfoFormats] - The formats
43970
- * in which to try WMS GetFeatureInfo requests.
44007
+ in which to try WMS GetFeatureInfo requests.
43971
44008
  * @property [rectangle = Rectangle.MAX_VALUE] - The rectangle of the layer.
43972
44009
  * @property [tilingScheme = new GeographicTilingScheme()] - The tiling scheme to use to divide the world into tiles.
43973
44010
  * @property [ellipsoid] - The ellipsoid. If the tilingScheme is specified,
43974
- * this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither
43975
- * parameter is specified, the WGS84 ellipsoid is used.
44011
+ this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither
44012
+ parameter is specified, the WGS84 ellipsoid is used.
43976
44013
  * @property [tileWidth = 256] - The width of each tile in pixels.
43977
44014
  * @property [tileHeight = 256] - The height of each tile in pixels.
43978
44015
  * @property [minimumLevel = 0] - The minimum level-of-detail supported by the imagery provider. Take care when
43979
- * specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is
43980
- * likely to result in rendering problems.
44016
+ specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is
44017
+ likely to result in rendering problems.
43981
44018
  * @property [maximumLevel] - The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
43982
- * If not specified, there is no limit.
44019
+ If not specified, there is no limit.
43983
44020
  * @property [crs] - CRS specification, for use with WMS specification >= 1.3.0.
43984
44021
  * @property [srs] - SRS specification, for use with WMS specification 1.1.0 or 1.1.1
43985
44022
  * @property [credit] - A credit for the data source, which is displayed on the canvas.
43986
44023
  * @property [subdomains = 'abc'] - The subdomains to use for the <code>{s}</code> placeholder in the URL template.
43987
- * If this parameter is a single string, each character in the string is a subdomain. If it is
43988
- * an array, each element in the array is a subdomain.
44024
+ If this parameter is a single string, each character in the string is a subdomain. If it is
44025
+ an array, each element in the array is a subdomain.
43989
44026
  * @property [clock] - A Clock instance that is used when determining the value for the time dimension. Required when `times` is specified.
43990
44027
  * @property [times] - TimeIntervalCollection with its data property being an object containing time dynamic dimension and their values.
43991
44028
  * @property [getFeatureInfoUrl] - The getFeatureInfo URL of the WMS service. If the property is not defined then we use the property value of url.
@@ -44018,12 +44055,12 @@ export namespace WebMapServiceImageryProvider {
44018
44055
  * Provides tiled imagery hosted by a Web Map Service (WMS) server.
44019
44056
  * @example
44020
44057
  * const provider = new Cesium.WebMapServiceImageryProvider({
44021
- * url : 'https://sampleserver1.arcgisonline.com/ArcGIS/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer/WMSServer',
44022
- * layers : '0',
44023
- * proxy: new Cesium.DefaultProxy('/proxy/')
44024
- * });
44025
- * const imageryLayer = new Cesium.ImageryLayer(provider);
44026
- * viewer.imageryLayers.add(imageryLayer);
44058
+ url : 'https://sampleserver1.arcgisonline.com/ArcGIS/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer/WMSServer',
44059
+ layers : '0',
44060
+ proxy: new Cesium.DefaultProxy('/proxy/')
44061
+ });
44062
+ const imageryLayer = new Cesium.ImageryLayer(provider);
44063
+ viewer.imageryLayers.add(imageryLayer);
44027
44064
  * @param options - Object describing initialization options
44028
44065
  */
44029
44066
  export class WebMapServiceImageryProvider {
@@ -44066,35 +44103,35 @@ export class WebMapServiceImageryProvider {
44066
44103
  readonly rectangle: Rectangle;
44067
44104
  /**
44068
44105
  * Gets the tile discard policy. If not undefined, the discard policy is responsible
44069
- * for filtering out "missing" tiles via its shouldDiscardImage function. If this function
44070
- * returns undefined, no tiles are filtered.
44106
+ for filtering out "missing" tiles via its shouldDiscardImage function. If this function
44107
+ returns undefined, no tiles are filtered.
44071
44108
  */
44072
44109
  readonly tileDiscardPolicy: TileDiscardPolicy;
44073
44110
  /**
44074
44111
  * Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing
44075
- * to the event, you will be notified of the error and can potentially recover from it. Event listeners
44076
- * are passed an instance of {@link TileProviderError}.
44112
+ to the event, you will be notified of the error and can potentially recover from it. Event listeners
44113
+ are passed an instance of {@link TileProviderError}.
44077
44114
  */
44078
44115
  readonly errorEvent: Event;
44079
44116
  /**
44080
44117
  * Gets the credit to display when this imagery provider is active. Typically this is used to credit
44081
- * the source of the imagery.
44118
+ the source of the imagery.
44082
44119
  */
44083
44120
  readonly credit: Credit;
44084
44121
  /**
44085
44122
  * Gets a value indicating whether or not the images provided by this imagery provider
44086
- * include an alpha channel. If this property is false, an alpha channel, if present, will
44087
- * be ignored. If this property is true, any images without an alpha channel will be treated
44088
- * as if their alpha is 1.0 everywhere. When this property is false, memory usage
44089
- * and texture upload time are reduced.
44123
+ include an alpha channel. If this property is false, an alpha channel, if present, will
44124
+ be ignored. If this property is true, any images without an alpha channel will be treated
44125
+ as if their alpha is 1.0 everywhere. When this property is false, memory usage
44126
+ and texture upload time are reduced.
44090
44127
  */
44091
44128
  readonly hasAlphaChannel: boolean;
44092
44129
  /**
44093
44130
  * Gets or sets a value indicating whether feature picking is enabled. If true, {@link WebMapServiceImageryProvider#pickFeatures} will
44094
- * invoke the <code>GetFeatureInfo</code> service on the WMS server and attempt to interpret the features included in the response. If false,
44095
- * {@link WebMapServiceImageryProvider#pickFeatures} will immediately return undefined (indicating no pickable
44096
- * features) without communicating with the server. Set this property to false if you know your data
44097
- * source does not support picking features or if you don't want this provider's features to be pickable.
44131
+ invoke the <code>GetFeatureInfo</code> service on the WMS server and attempt to interpret the features included in the response. If false,
44132
+ {@link WebMapServiceImageryProvider#pickFeatures} will immediately return undefined (indicating no pickable
44133
+ features) without communicating with the server. Set this property to false if you know your data
44134
+ source does not support picking features or if you don't want this provider's features to be pickable.
44098
44135
  */
44099
44136
  enablePickFeatures: boolean;
44100
44137
  /**
@@ -44103,8 +44140,8 @@ export class WebMapServiceImageryProvider {
44103
44140
  clock: Clock;
44104
44141
  /**
44105
44142
  * Gets or sets a time interval collection that is used to get time dynamic parameters. The data of each
44106
- * TimeInterval is an object containing the keys and values of the properties that are used during
44107
- * tile requests.
44143
+ TimeInterval is an object containing the keys and values of the properties that are used during
44144
+ tile requests.
44108
44145
  */
44109
44146
  times: TimeIntervalCollection;
44110
44147
  /**
@@ -44126,36 +44163,36 @@ export class WebMapServiceImageryProvider {
44126
44163
  * @param level - The tile level.
44127
44164
  * @param [request] - The request object. Intended for internal use only.
44128
44165
  * @returns A promise for the image that will resolve when the image is available, or
44129
- * undefined if there are too many active requests to the server, and the request should be retried later.
44166
+ undefined if there are too many active requests to the server, and the request should be retried later.
44130
44167
  */
44131
44168
  requestImage(x: number, y: number, level: number, request?: Request): Promise<ImageryTypes> | undefined;
44132
44169
  /**
44133
44170
  * Asynchronously determines what features, if any, are located at a given longitude and latitude within
44134
- * a tile.
44171
+ a tile.
44135
44172
  * @param x - The tile X coordinate.
44136
44173
  * @param y - The tile Y coordinate.
44137
44174
  * @param level - The tile level.
44138
44175
  * @param longitude - The longitude at which to pick features.
44139
44176
  * @param latitude - The latitude at which to pick features.
44140
44177
  * @returns A promise for the picked features that will resolve when the asynchronous
44141
- * picking completes. The resolved value is an array of {@link ImageryLayerFeatureInfo}
44142
- * instances. The array may be empty if no features are found at the given location.
44178
+ picking completes. The resolved value is an array of {@link ImageryLayerFeatureInfo}
44179
+ instances. The array may be empty if no features are found at the given location.
44143
44180
  */
44144
44181
  pickFeatures(x: number, y: number, level: number, longitude: number, latitude: number): Promise<ImageryLayerFeatureInfo[]> | undefined;
44145
44182
  /**
44146
44183
  * The default parameters to include in the WMS URL to obtain images. The values are as follows:
44147
- * service=WMS
44148
- * version=1.1.1
44149
- * request=GetMap
44150
- * styles=
44151
- * format=image/jpeg
44184
+ service=WMS
44185
+ version=1.1.1
44186
+ request=GetMap
44187
+ styles=
44188
+ format=image/jpeg
44152
44189
  */
44153
44190
  static readonly DefaultParameters: any;
44154
44191
  /**
44155
44192
  * The default parameters to include in the WMS URL to get feature information. The values are as follows:
44156
- * service=WMS
44157
- * version=1.1.1
44158
- * request=GetFeatureInfo
44193
+ service=WMS
44194
+ version=1.1.1
44195
+ request=GetFeatureInfo
44159
44196
  */
44160
44197
  static readonly GetFeatureInfoDefaultParameters: any;
44161
44198
  }
@@ -44955,12 +44992,12 @@ export class BaseLayerPickerViewModel {
44955
44992
  });
44956
44993
  /**
44957
44994
  * Gets or sets an array of ProviderViewModel instances available for imagery selection.
44958
- * This property is observable.
44995
+ This property is observable.
44959
44996
  */
44960
44997
  imageryProviderViewModels: ProviderViewModel[];
44961
44998
  /**
44962
44999
  * Gets or sets an array of ProviderViewModel instances available for terrain selection.
44963
- * This property is observable.
45000
+ This property is observable.
44964
45001
  */
44965
45002
  terrainProviderViewModels: ProviderViewModel[];
44966
45003
  /**
@@ -45001,7 +45038,7 @@ export class BaseLayerPickerViewModel {
45001
45038
  * @param options.iconUrl - An icon representing the layer.
45002
45039
  * @param [options.category] - A category for the layer.
45003
45040
  * @param options.creationFunction - A function or Command
45004
- * that creates one or more providers which will be added to the globe when this item is selected.
45041
+ that creates one or more providers which will be added to the globe when this item is selected.
45005
45042
  */
45006
45043
  export class ProviderViewModel {
45007
45044
  constructor(options: {
@@ -45025,7 +45062,7 @@ export class ProviderViewModel {
45025
45062
  iconUrl: string;
45026
45063
  /**
45027
45064
  * Gets the Command that creates one or more providers which will be added to
45028
- * the globe when this item is selected.
45065
+ the globe when this item is selected.
45029
45066
  */
45030
45067
  readonly creationCommand: Command;
45031
45068
  /**