| | |
| | | COMPRESSED_RGB_PVRTC_2BPPV1_IMG = 35841, |
| | | COMPRESSED_RGBA_PVRTC_4BPPV1_IMG = 35842, |
| | | COMPRESSED_RGBA_PVRTC_2BPPV1_IMG = 35843, |
| | | COMPRESSED_RGBA_ASTC_4x4_WEBGL = 37808, |
| | | COMPRESSED_RGB_ETC1_WEBGL = 36196, |
| | | COMPRESSED_RGBA_BPTC_UNORM = 36492, |
| | | HALF_FLOAT_OES = 36193, |
| | | DOUBLE = 5130, |
| | | READ_BUFFER = 3074, |
| | |
| | | MAX_ELEMENT_INDEX = 36203, |
| | | TEXTURE_IMMUTABLE_LEVELS = 33503, |
| | | MAX_TEXTURE_MAX_ANISOTROPY_EXT = 34047 |
| | | }/** |
| | | } |
| | | |
| | | /** |
| | | * A {@link TerrainProvider} that produces terrain geometry by tessellating height maps |
| | | retrieved from Elevation Tiles of an an ArcGIS ImageService. |
| | | * @example |
| | |
| | | to the event, you will be notified of the error and can potentially recover from it. Event listeners |
| | | are passed an instance of {@link TileProviderError}. |
| | | */ |
| | | errorEvent: Event; |
| | | readonly errorEvent: Event; |
| | | /** |
| | | * Gets the credit to display when this terrain provider is active. Typically this is used to credit |
| | | the source of the terrain. This function should not be called before {@link ArcGISTiledElevationTerrainProvider#ready} returns true. |
| | | */ |
| | | credit: Credit; |
| | | readonly credit: Credit; |
| | | /** |
| | | * Gets the tiling scheme used by this provider. This function should |
| | | not be called before {@link ArcGISTiledElevationTerrainProvider#ready} returns true. |
| | | */ |
| | | tilingScheme: GeographicTilingScheme; |
| | | readonly tilingScheme: GeographicTilingScheme; |
| | | /** |
| | | * Gets a value indicating whether or not the provider is ready for use. |
| | | */ |
| | | ready: boolean; |
| | | readonly ready: boolean; |
| | | /** |
| | | * Gets a promise that resolves to true when the provider is ready for use. |
| | | */ |
| | |
| | | as a reflective surface with animated waves. This function should not be |
| | | called before {@link ArcGISTiledElevationTerrainProvider#ready} returns true. |
| | | */ |
| | | hasWaterMask: boolean; |
| | | readonly hasWaterMask: boolean; |
| | | /** |
| | | * Gets a value indicating whether or not the requested tiles include vertex normals. |
| | | This function should not be called before {@link ArcGISTiledElevationTerrainProvider#ready} returns true. |
| | | */ |
| | | hasVertexNormals: boolean; |
| | | readonly hasVertexNormals: boolean; |
| | | /** |
| | | * Gets an object that can be used to determine availability of terrain from this provider, such as |
| | | at points and in rectangles. This function should not be called before |
| | | {@link TerrainProvider#ready} returns true. This property may be undefined if availability |
| | | information is not available. |
| | | */ |
| | | availability: TileAvailability; |
| | | readonly availability: TileAvailability; |
| | | /** |
| | | * Requests the geometry for a given tile. This function should not be called before |
| | | {@link ArcGISTiledElevationTerrainProvider#ready} returns true. The result includes terrain |
| | |
| | | * @param level - The level of the tile for which to request geometry. |
| | | * @returns Undefined if not supported, otherwise true or false. |
| | | */ |
| | | getTileDataAvailable(x: number, y: number, level: number): boolean; |
| | | getTileDataAvailable(x: number, y: number, level: number): boolean | undefined; |
| | | /** |
| | | * Makes sure we load availability data for a tile |
| | | * @param x - The X coordinate of the tile for which to request geometry. |
| | |
| | | }); |
| | | * @param sphere - The sphere. |
| | | * @param cartesian - The point |
| | | * @returns The estimated distance squared from the bounding sphere to the point. |
| | | * @returns The distance squared from the bounding sphere to the point. Returns 0 if the point is inside the sphere. |
| | | */ |
| | | static distanceSquaredTo(sphere: BoundingSphere, cartesian: Cartesian3): number; |
| | | /** |
| | |
| | | to the event, you will be notified of the error and can potentially recover from it. Event listeners |
| | | are passed an instance of {@link TileProviderError}. |
| | | */ |
| | | errorEvent: Event; |
| | | readonly errorEvent: Event; |
| | | /** |
| | | * Gets the credit to display when this terrain provider is active. Typically this is used to credit |
| | | the source of the terrain. This function should not be called before {@link CesiumTerrainProvider#ready} returns true. |
| | | */ |
| | | credit: Credit; |
| | | readonly credit: Credit; |
| | | /** |
| | | * Gets the tiling scheme used by this provider. This function should |
| | | not be called before {@link CesiumTerrainProvider#ready} returns true. |
| | | */ |
| | | tilingScheme: GeographicTilingScheme; |
| | | readonly tilingScheme: GeographicTilingScheme; |
| | | /** |
| | | * Gets a value indicating whether or not the provider is ready for use. |
| | | */ |
| | | ready: boolean; |
| | | readonly ready: boolean; |
| | | /** |
| | | * Gets a promise that resolves to true when the provider is ready for use. |
| | | */ |
| | |
| | | as a reflective surface with animated waves. This function should not be |
| | | called before {@link CesiumTerrainProvider#ready} returns true. |
| | | */ |
| | | hasWaterMask: boolean; |
| | | readonly hasWaterMask: boolean; |
| | | /** |
| | | * Gets a value indicating whether or not the requested tiles include vertex normals. |
| | | This function should not be called before {@link CesiumTerrainProvider#ready} returns true. |
| | | */ |
| | | hasVertexNormals: boolean; |
| | | readonly hasVertexNormals: boolean; |
| | | /** |
| | | * Gets a value indicating whether or not the requested tiles include metadata. |
| | | This function should not be called before {@link CesiumTerrainProvider#ready} returns true. |
| | | */ |
| | | hasMetadata: boolean; |
| | | readonly hasMetadata: boolean; |
| | | /** |
| | | * Boolean flag that indicates if the client should request vertex normals from the server. |
| | | Vertex normals data is appended to the standard tile mesh data only if the client requests the vertex normals and |
| | | if the server provides vertex normals. |
| | | */ |
| | | requestVertexNormals: boolean; |
| | | readonly requestVertexNormals: boolean; |
| | | /** |
| | | * Boolean flag that indicates if the client should request a watermask from the server. |
| | | Watermask data is appended to the standard tile mesh data only if the client requests the watermask and |
| | | if the server provides a watermask. |
| | | */ |
| | | requestWaterMask: boolean; |
| | | readonly requestWaterMask: boolean; |
| | | /** |
| | | * Boolean flag that indicates if the client should request metadata from the server. |
| | | Metadata is appended to the standard tile mesh data only if the client requests the metadata and |
| | | if the server provides a metadata. |
| | | */ |
| | | requestMetadata: boolean; |
| | | readonly requestMetadata: boolean; |
| | | /** |
| | | * Gets an object that can be used to determine availability of terrain from this provider, such as |
| | | at points and in rectangles. This function should not be called before |
| | |
| | | exists deeper in the tree rather than it all being discoverable at the root. However, a tile that |
| | | is available now will not become unavailable in the future. |
| | | */ |
| | | availability: TileAvailability; |
| | | readonly availability: TileAvailability; |
| | | /** |
| | | * Gets the maximum geometric error allowed in a tile at a given level. |
| | | * @param level - The tile level for which to get the maximum geometric error. |
| | |
| | | * @param level - The level of the tile for which to request geometry. |
| | | * @returns Undefined if not supported or availability is unknown, otherwise true or false. |
| | | */ |
| | | getTileDataAvailable(x: number, y: number, level: number): boolean; |
| | | getTileDataAvailable(x: number, y: number, level: number): boolean | undefined; |
| | | /** |
| | | * Makes sure we load availability data for a tile |
| | | * @param x - The X coordinate of the tile for which to request geometry. |
| | |
| | | /** |
| | | * Describes a compressed texture and contains a compressed texture buffer. |
| | | * @param internalFormat - The pixel format of the compressed texture. |
| | | * @param pixelDatatype - The pixel datatype of the compressed texture. |
| | | * @param width - The width of the texture. |
| | | * @param height - The height of the texture. |
| | | * @param buffer - The compressed texture buffer. |
| | | */ |
| | | export class CompressedTextureBuffer { |
| | | constructor(internalFormat: PixelFormat, width: number, height: number, buffer: Uint8Array); |
| | | constructor(internalFormat: PixelFormat, pixelDatatype: PixelDatatype, width: number, height: number, buffer: Uint8Array); |
| | | /** |
| | | * The format of the compressed texture. |
| | | */ |
| | | readonly internalFormat: PixelFormat; |
| | | /** |
| | | * The datatype of the compressed texture. |
| | | */ |
| | | readonly pixelDatatype: PixelDatatype; |
| | | /** |
| | | * The width of the texture. |
| | | */ |
| | |
| | | * @returns Intersect.OUTSIDE, Intersect.INTERSECTING, or Intersect.INSIDE. |
| | | */ |
| | | computeVisibility(boundingVolume: any): Intersect; |
| | | } |
| | | |
| | | export namespace CustomHeightmapTerrainProvider { |
| | | /** |
| | | * @param x - The X coordinate of the tile for which to request geometry. |
| | | * @param y - The Y coordinate of the tile for which to request geometry. |
| | | * @param level - The level of the tile for which to request geometry. |
| | | */ |
| | | type GeometryCallback = (x: number, y: number, level: number) => Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | number[] | Promise<Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | number[]> | undefined; |
| | | } |
| | | |
| | | /** |
| | | * A simple {@link TerrainProvider} that gets height values from a callback function. |
| | | It can be used for procedurally generated terrain or as a way to load custom |
| | | heightmap data without creating a subclass of {@link TerrainProvider}. |
| | | |
| | | There are some limitations such as no water mask, no vertex normals, and no |
| | | availability, so a full-fledged {@link TerrainProvider} subclass is better suited |
| | | for these more sophisticated use cases. |
| | | * @example |
| | | * var viewer = new Cesium.Viewer("cesiumContainer", { |
| | | terrainProvider: new Cesium.CustomHeightmapTerrainProvider({ |
| | | width: 32, |
| | | height: 32, |
| | | callback: function (x, y, level) { |
| | | return new Float32Array(32 * 32); // all zeros |
| | | }, |
| | | }), |
| | | }); |
| | | * @param options - Object with the following properties: |
| | | * @param options.callback - The callback function for requesting tile geometry. |
| | | * @param options.width - The number of columns per heightmap tile. |
| | | * @param options.height - The number of rows per heightmap tile. |
| | | * @param [options.tilingScheme] - The tiling scheme specifying how the ellipsoidal |
| | | surface is broken into tiles. If this parameter is not provided, a {@link GeographicTilingScheme} |
| | | is used. |
| | | * @param [options.ellipsoid] - The ellipsoid. If the tilingScheme is specified, |
| | | this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither |
| | | parameter is specified, the WGS84 ellipsoid is used. |
| | | * @param [options.credit] - A credit for the data source, which is displayed on the canvas. |
| | | */ |
| | | export class CustomHeightmapTerrainProvider { |
| | | constructor(options: { |
| | | callback: CustomHeightmapTerrainProvider.GeometryCallback; |
| | | width: number; |
| | | height: number; |
| | | tilingScheme?: TilingScheme; |
| | | ellipsoid?: Ellipsoid; |
| | | credit?: Credit | string; |
| | | }); |
| | | /** |
| | | * Gets an event that is raised when the terrain provider encounters an asynchronous error. By subscribing |
| | | to the event, you will be notified of the error and can potentially recover from it. Event listeners |
| | | are passed an instance of {@link TileProviderError}. |
| | | */ |
| | | readonly errorEvent: Event; |
| | | /** |
| | | * Gets the credit to display when this terrain provider is active. Typically this is used to credit |
| | | the source of the terrain. |
| | | */ |
| | | readonly credit: Credit; |
| | | /** |
| | | * Gets the tiling scheme used by this provider. |
| | | */ |
| | | readonly tilingScheme: TilingScheme; |
| | | /** |
| | | * Gets a value indicating whether or not the provider is ready for use. |
| | | */ |
| | | readonly ready: boolean; |
| | | /** |
| | | * Gets a promise that resolves to true when the provider is ready for use. |
| | | */ |
| | | readonly readyPromise: Promise<boolean>; |
| | | /** |
| | | * Gets a value indicating whether or not the provider includes a water mask. The water mask |
| | | indicates which areas of the globe are water rather than land, so they can be rendered |
| | | as a reflective surface with animated waves. |
| | | Water mask is not supported by {@link CustomHeightmapTerrainProvider}, so the return |
| | | value will always be false. |
| | | */ |
| | | readonly hasWaterMask: boolean; |
| | | /** |
| | | * Gets a value indicating whether or not the requested tiles include vertex normals. |
| | | Vertex normals are not supported by {@link CustomHeightmapTerrainProvider}, so the return |
| | | value will always be false. |
| | | */ |
| | | readonly hasVertexNormals: boolean; |
| | | /** |
| | | * Gets the number of columns per heightmap tile. |
| | | */ |
| | | readonly width: boolean; |
| | | /** |
| | | * Gets the number of rows per heightmap tile. |
| | | */ |
| | | readonly height: boolean; |
| | | /** |
| | | * Requests the geometry for a given tile. The result includes terrain |
| | | data and indicates that all child tiles are available. |
| | | * @param x - The X coordinate of the tile for which to request geometry. |
| | | * @param y - The Y coordinate of the tile for which to request geometry. |
| | | * @param level - The level of the tile for which to request geometry. |
| | | * @param [request] - The request object. Intended for internal use only. |
| | | * @returns A promise for the requested geometry. If this method |
| | | returns undefined instead of a promise, it is an indication that too many requests are already |
| | | pending and the request will be retried later. |
| | | */ |
| | | requestTileGeometry(x: number, y: number, level: number, request?: Request): Promise<TerrainData> | undefined; |
| | | /** |
| | | * Gets the maximum geometric error allowed in a tile at a given level. |
| | | * @param level - The tile level for which to get the maximum geometric error. |
| | | * @returns The maximum geometric error. |
| | | */ |
| | | getLevelMaximumGeometricError(level: number): number; |
| | | /** |
| | | * Determines whether data for a tile is available to be loaded. |
| | | * @param x - The X coordinate of the tile for which to request geometry. |
| | | * @param y - The Y coordinate of the tile for which to request geometry. |
| | | * @param level - The level of the tile for which to request geometry. |
| | | * @returns Undefined if not supported, otherwise true or false. |
| | | */ |
| | | getTileDataAvailable(x: number, y: number, level: number): boolean | undefined; |
| | | /** |
| | | * Makes sure we load availability data for a tile |
| | | * @param x - The X coordinate of the tile for which to request geometry. |
| | | * @param y - The Y coordinate of the tile for which to request geometry. |
| | | * @param level - The level of the tile for which to request geometry. |
| | | * @returns Undefined if nothing need to be loaded or a Promise that resolves when all required tiles are loaded |
| | | */ |
| | | loadTileDataAvailability(x: number, y: number, level: number): undefined | Promise<void>; |
| | | } |
| | | |
| | | /** |
| | |
| | | to the event, you will be notified of the error and can potentially recover from it. Event listeners |
| | | are passed an instance of {@link TileProviderError}. |
| | | */ |
| | | errorEvent: Event; |
| | | readonly errorEvent: Event; |
| | | /** |
| | | * Gets the credit to display when this terrain provider is active. Typically this is used to credit |
| | | the source of the terrain. This function should not be called before {@link EllipsoidTerrainProvider#ready} returns true. |
| | | */ |
| | | credit: Credit; |
| | | readonly credit: Credit; |
| | | /** |
| | | * Gets the tiling scheme used by this provider. This function should |
| | | not be called before {@link EllipsoidTerrainProvider#ready} returns true. |
| | | */ |
| | | tilingScheme: GeographicTilingScheme; |
| | | readonly tilingScheme: GeographicTilingScheme; |
| | | /** |
| | | * Gets a value indicating whether or not the provider is ready for use. |
| | | */ |
| | | ready: boolean; |
| | | readonly ready: boolean; |
| | | /** |
| | | * Gets a promise that resolves to true when the provider is ready for use. |
| | | */ |
| | |
| | | as a reflective surface with animated waves. This function should not be |
| | | called before {@link EllipsoidTerrainProvider#ready} returns true. |
| | | */ |
| | | hasWaterMask: boolean; |
| | | readonly hasWaterMask: boolean; |
| | | /** |
| | | * Gets a value indicating whether or not the requested tiles include vertex normals. |
| | | This function should not be called before {@link EllipsoidTerrainProvider#ready} returns true. |
| | | */ |
| | | hasVertexNormals: boolean; |
| | | readonly hasVertexNormals: boolean; |
| | | /** |
| | | * Gets an object that can be used to determine availability of terrain from this provider, such as |
| | | at points and in rectangles. This function should not be called before |
| | | {@link TerrainProvider#ready} returns true. This property may be undefined if availability |
| | | information is not available. |
| | | */ |
| | | availability: TileAvailability; |
| | | readonly availability: TileAvailability; |
| | | /** |
| | | * Requests the geometry for a given tile. This function should not be called before |
| | | {@link TerrainProvider#ready} returns true. The result includes terrain |
| | |
| | | * @param level - The level of the tile for which to request geometry. |
| | | * @returns Undefined if not supported, otherwise true or false. |
| | | */ |
| | | getTileDataAvailable(x: number, y: number, level: number): boolean; |
| | | getTileDataAvailable(x: number, y: number, level: number): boolean | undefined; |
| | | /** |
| | | * Makes sure we load availability data for a tile |
| | | * @param x - The X coordinate of the tile for which to request geometry. |
| | |
| | | */ |
| | | export namespace FeatureDetection { |
| | | /** |
| | | * Detects whether the current browser supports Basis Universal textures and the web assembly modules needed to transcode them. |
| | | * @returns true if the browser supports web assembly modules and the scene supports Basis Universal textures, false if not. |
| | | */ |
| | | function supportsBasis(scene: Scene): boolean; |
| | | /** |
| | | * Detects whether the current browser supports the full screen standard. |
| | | * @returns true if the browser supports the full screen standard, false if not. |
| | | */ |
| | |
| | | * @returns true if the browser supports typed arrays, false if not. |
| | | */ |
| | | function supportsTypedArrays(): boolean; |
| | | /** |
| | | * Detects whether the current browser supports BigInt64Array typed arrays. |
| | | * @returns true if the browser supports BigInt64Array typed arrays, false if not. |
| | | */ |
| | | function supportsBigInt64Array(): boolean; |
| | | /** |
| | | * Detects whether the current browser supports BigUint64Array typed arrays. |
| | | * @returns true if the browser supports BigUint64Array typed arrays, false if not. |
| | | */ |
| | | function supportsBigUint64Array(): boolean; |
| | | /** |
| | | * Detects whether the current browser supports BigInt. |
| | | * @returns true if the browser supports BigInt, false if not. |
| | | */ |
| | | function supportsBigInt(): boolean; |
| | | /** |
| | | * Detects whether the current browser supports Web Workers. |
| | | * @returns true if the browsers supports Web Workers, false if not. |
| | |
| | | as a reflective surface with animated waves. This function should not be |
| | | called before {@link GoogleEarthEnterpriseTerrainProvider#ready} returns true. |
| | | */ |
| | | hasWaterMask: boolean; |
| | | readonly hasWaterMask: boolean; |
| | | /** |
| | | * Gets a value indicating whether or not the requested tiles include vertex normals. |
| | | This function should not be called before {@link GoogleEarthEnterpriseTerrainProvider#ready} returns true. |
| | | */ |
| | | hasVertexNormals: boolean; |
| | | readonly hasVertexNormals: boolean; |
| | | /** |
| | | * Gets an object that can be used to determine availability of terrain from this provider, such as |
| | | at points and in rectangles. This function should not be called before |
| | | {@link GoogleEarthEnterpriseTerrainProvider#ready} returns true. This property may be undefined if availability |
| | | information is not available. |
| | | */ |
| | | availability: TileAvailability; |
| | | readonly availability: TileAvailability; |
| | | /** |
| | | * Requests the geometry for a given tile. This function should not be called before |
| | | {@link GoogleEarthEnterpriseTerrainProvider#ready} returns true. The result must include terrain data and |
| | |
| | | * @param level - The level of the tile for which to request geometry. |
| | | * @returns Undefined if not supported, otherwise true or false. |
| | | */ |
| | | getTileDataAvailable(x: number, y: number, level: number): boolean; |
| | | getTileDataAvailable(x: number, y: number, level: number): boolean | undefined; |
| | | /** |
| | | * Makes sure we load availability data for a tile |
| | | * @param x - The X coordinate of the tile for which to request geometry. |
| | |
| | | } |
| | | |
| | | /** |
| | | * Hilbert Order helper functions. |
| | | */ |
| | | export namespace HilbertOrder { } |
| | | |
| | | /** |
| | | * Constants for WebGL index datatypes. These corresponds to the |
| | | <code>type</code> parameter of {@link http://www.khronos.org/opengles/sdk/docs/man/xhtml/glDrawElements.xml|drawElements}. |
| | | */ |
| | |
| | | * @param [options.preferBlob = false] - If true, we will load the image via a blob. |
| | | * @param [options.preferImageBitmap = false] - If true, image will be decoded during fetch and an <code>ImageBitmap</code> is returned. |
| | | * @param [options.flipY = false] - If true, image will be vertically flipped during decode. Only applies if the browser supports <code>createImageBitmap</code>. |
| | | * @param [options.skipColorSpaceConversion = false] - If true, any custom gamma or color profiles in the image will be ignored. Only applies if the browser supports <code>createImageBitmap</code>. |
| | | * @returns a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority. |
| | | */ |
| | | fetchImage(options?: { |
| | | preferBlob?: boolean; |
| | | preferImageBitmap?: boolean; |
| | | flipY?: boolean; |
| | | skipColorSpaceConversion?: boolean; |
| | | }): Promise<ImageBitmap> | Promise<HTMLImageElement> | undefined; |
| | | } |
| | | |
| | |
| | | */ |
| | | evaluate(time: number, result?: Cartesian3): Cartesian3; |
| | | } |
| | | |
| | | /** |
| | | * Asynchronously loads and parses the given URL to a CRN file or parses the raw binary data of a CRN file. |
| | | Returns a promise that will resolve to an object containing the image buffer, width, height and format once loaded, |
| | | or reject if the URL failed to load or failed to parse the data. The data is loaded |
| | | using XMLHttpRequest, which means that in order to make requests to another origin, |
| | | the server must have Cross-Origin Resource Sharing (CORS) headers enabled. |
| | | * @example |
| | | * // load a single URL asynchronously |
| | | Cesium.loadCRN('some/url').then(function(textureData) { |
| | | var width = textureData.width; |
| | | var height = textureData.height; |
| | | var format = textureData.internalFormat; |
| | | var arrayBufferView = textureData.bufferView; |
| | | // use the data to create a texture |
| | | }).otherwise(function(error) { |
| | | // an error occurred |
| | | }); |
| | | * @param resourceOrUrlOrBuffer - The URL of the binary data or an ArrayBuffer. |
| | | * @returns A promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority. |
| | | */ |
| | | export function loadCRN(resourceOrUrlOrBuffer: Resource | string | ArrayBuffer): Promise<CompressedTextureBuffer> | undefined; |
| | | |
| | | /** |
| | | * Asynchronously loads and parses the given URL to a KTX file or parses the raw binary data of a KTX file. |
| | | Returns a promise that will resolve to an object containing the image buffer, width, height and format once loaded, |
| | | or reject if the URL failed to load or failed to parse the data. The data is loaded |
| | | using XMLHttpRequest, which means that in order to make requests to another origin, |
| | | the server must have Cross-Origin Resource Sharing (CORS) headers enabled. |
| | | <p> |
| | | The following are part of the KTX format specification but are not supported: |
| | | <ul> |
| | | <li>Big-endian files</li> |
| | | <li>Metadata</li> |
| | | <li>3D textures</li> |
| | | <li>Texture Arrays</li> |
| | | <li>Cubemaps</li> |
| | | <li>Mipmaps</li> |
| | | </ul> |
| | | </p> |
| | | * @example |
| | | * // load a single URL asynchronously |
| | | Cesium.loadKTX('some/url').then(function(ktxData) { |
| | | var width = ktxData.width; |
| | | var height = ktxData.height; |
| | | var format = ktxData.internalFormat; |
| | | var arrayBufferView = ktxData.bufferView; |
| | | // use the data to create a texture |
| | | }).otherwise(function(error) { |
| | | // an error occurred |
| | | }); |
| | | * @param resourceOrUrlOrBuffer - The URL of the binary data or an ArrayBuffer. |
| | | * @returns A promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority. |
| | | */ |
| | | export function loadKTX(resourceOrUrlOrBuffer: Resource | string | ArrayBuffer): Promise<CompressedTextureBuffer> | undefined; |
| | | |
| | | /** |
| | | * Defines how geodetic ellipsoid coordinates ({@link Cartographic}) project to a |
| | |
| | | static setColumn(matrix: Matrix4, index: number, cartesian: Cartesian4, result: Matrix4): Matrix4; |
| | | /** |
| | | * Computes a new matrix that replaces the translation in the rightmost column of the provided |
| | | matrix with the provided translation. This assumes the matrix is an affine transformation |
| | | matrix with the provided translation. This assumes the matrix is an affine transformation. |
| | | * @param matrix - The matrix to use. |
| | | * @param translation - The translation that replaces the translation of the provided matrix. |
| | | * @param result - The object onto which to store the result. |
| | |
| | | */ |
| | | static setTranslation(matrix: Matrix4, translation: Cartesian3, result: Matrix4): Matrix4; |
| | | /** |
| | | * Computes a new matrix that replaces the scale with the provided scale. This assumes the matrix is an affine transformation |
| | | * Computes a new matrix that replaces the scale with the provided scale. |
| | | This assumes the matrix is an affine transformation. |
| | | * @param matrix - The matrix to use. |
| | | * @param scale - The scale that replaces the scale of the provided matrix. |
| | | * @param result - The object onto which to store the result. |
| | |
| | | */ |
| | | static subtract(left: Matrix4, right: Matrix4, result: Matrix4): Matrix4; |
| | | /** |
| | | * Computes the product of two matrices assuming the matrices are |
| | | affine transformation matrices, where the upper left 3x3 elements |
| | | are a rotation matrix, and the upper three elements in the fourth |
| | | column are the translation. The bottom row is assumed to be [0, 0, 0, 1]. |
| | | * Computes the product of two matrices assuming the matrices are affine transformation matrices, |
| | | where the upper left 3x3 elements are any matrix, and |
| | | the upper three elements in the fourth column are the translation. |
| | | The bottom row is assumed to be [0, 0, 0, 1]. |
| | | The matrix is not verified to be in the proper form. |
| | | This method is faster than computing the product for general 4x4 |
| | | matrices using {@link Matrix4.multiply}. |
| | |
| | | static multiplyByUniformScale(matrix: Matrix4, scale: number, result: Matrix4): Matrix4; |
| | | /** |
| | | * Multiplies an affine transformation matrix (with a bottom row of <code>[0.0, 0.0, 0.0, 1.0]</code>) |
| | | by an implicit non-uniform scale matrix. This is an optimization |
| | | by an implicit non-uniform scale matrix. This is an optimization |
| | | for <code>Matrix4.multiply(m, Matrix4.fromUniformScale(scale), m);</code>, where |
| | | <code>m</code> must be an affine matrix. |
| | | This function performs fewer allocations and arithmetic operations. |
| | |
| | | */ |
| | | static equalsEpsilon(left?: Matrix4, right?: Matrix4, epsilon?: number): boolean; |
| | | /** |
| | | * Gets the translation portion of the provided matrix, assuming the matrix is a affine transformation matrix. |
| | | * Gets the translation portion of the provided matrix, assuming the matrix is an affine transformation matrix. |
| | | * @param matrix - The matrix to use. |
| | | * @param result - The object onto which to store the result. |
| | | * @returns The modified result parameter. |
| | | */ |
| | | static getTranslation(matrix: Matrix4, result: Cartesian3): Cartesian3; |
| | | /** |
| | | * Gets the upper left 3x3 rotation matrix of the provided matrix, assuming the matrix is an affine transformation matrix. |
| | | * Gets the upper left 3x3 matrix of the provided matrix. |
| | | * @example |
| | | * // returns a Matrix3 instance from a Matrix4 instance |
| | | |
| | |
| | | /** |
| | | * Computes the inverse of the provided matrix using Cramers Rule. |
| | | If the determinant is zero, the matrix can not be inverted, and an exception is thrown. |
| | | If the matrix is an affine transformation matrix, it is more efficient |
| | | If the matrix is a proper rigid transformation, it is more efficient |
| | | to invert it with {@link Matrix4.inverseTransformation}. |
| | | * @param matrix - The matrix to invert. |
| | | * @param result - The object onto which to store the result. |
| | |
| | | */ |
| | | static inverse(matrix: Matrix4, result: Matrix4): Matrix4; |
| | | /** |
| | | * Computes the inverse of the provided matrix assuming it is |
| | | an affine transformation matrix, where the upper left 3x3 elements |
| | | are a rotation matrix, and the upper three elements in the fourth |
| | | column are the translation. The bottom row is assumed to be [0, 0, 0, 1]. |
| | | * Computes the inverse of the provided matrix assuming it is a proper rigid matrix, |
| | | where the upper left 3x3 elements are a rotation matrix, |
| | | and the upper three elements in the fourth column are the translation. |
| | | The bottom row is assumed to be [0, 0, 0, 1]. |
| | | The matrix is not verified to be in the proper form. |
| | | This method is faster than computing the inverse for a general 4x4 |
| | | matrix using {@link Matrix4.inverse}. |
| | |
| | | }); |
| | | * @param box - The box. |
| | | * @param cartesian - The point |
| | | * @returns The estimated distance squared from the bounding sphere to the point. |
| | | * @returns The distance squared from the oriented bounding box to the point. Returns 0 if the point is inside the box. |
| | | */ |
| | | static distanceSquaredTo(box: OrientedBoundingBox, cartesian: Cartesian3): number; |
| | | /** |
| | |
| | | */ |
| | | RGBA_PVRTC_2BPPV1 = WebGLConstants.COMPRESSED_RGBA_PVRTC_2BPPV1_IMG, |
| | | /** |
| | | * A pixel format containing red, green, blue, and alpha channels that is ASTC compressed. |
| | | */ |
| | | RGBA_ASTC = WebGLConstants.COMPRESSED_RGBA_ASTC_4x4_WEBGL, |
| | | /** |
| | | * A pixel format containing red, green, and blue channels that is ETC1 compressed. |
| | | */ |
| | | RGB_ETC1 = WebGLConstants.COMPRESSED_RGB_ETC1_WEBGL |
| | | RGB_ETC1 = WebGLConstants.COMPRESSED_RGB_ETC1_WEBGL, |
| | | /** |
| | | * A pixel format containing red, green, and blue channels that is ETC2 compressed. |
| | | */ |
| | | RGB8_ETC2 = WebGLConstants.COMPRESSED_RGB8_ETC2, |
| | | /** |
| | | * A pixel format containing red, green, blue, and alpha channels that is ETC2 compressed. |
| | | */ |
| | | RGBA8_ETC2_EAC = WebGLConstants.COMPRESSED_RGBA8_ETC2_EAC, |
| | | /** |
| | | * A pixel format containing red, green, blue, and alpha channels that is BC7 compressed. |
| | | */ |
| | | RGBA_BC7 = WebGLConstants.COMPRESSED_RGBA_BPTC_UNORM |
| | | } |
| | | |
| | | /** |
| | |
| | | * @param [options.preferBlob = false] - If true, we will load the image via a blob. |
| | | * @param [options.preferImageBitmap = false] - If true, image will be decoded during fetch and an <code>ImageBitmap</code> is returned. |
| | | * @param [options.flipY = false] - If true, image will be vertically flipped during decode. Only applies if the browser supports <code>createImageBitmap</code>. |
| | | * @param [options.skipColorSpaceConversion = false] - If true, any custom gamma or color profiles in the image will be ignored. Only applies if the browser supports <code>createImageBitmap</code>. |
| | | * @returns a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority. |
| | | */ |
| | | fetchImage(options?: { |
| | | preferBlob?: boolean; |
| | | preferImageBitmap?: boolean; |
| | | flipY?: boolean; |
| | | skipColorSpaceConversion?: boolean; |
| | | }): Promise<ImageBitmap> | Promise<HTMLImageElement> | undefined; |
| | | /** |
| | | * Creates a Resource and calls fetchImage() on it. |
| | |
| | | * @param [options.request] - A Request object that will be used. Intended for internal use only. |
| | | * @param [options.preferBlob = false] - If true, we will load the image via a blob. |
| | | * @param [options.preferImageBitmap = false] - If true, image will be decoded during fetch and an <code>ImageBitmap</code> is returned. |
| | | * @param [options.skipColorSpaceConversion = false] - If true, any custom gamma or color profiles in the image will be ignored. Only applies when requesting an image and the browser supports <code>createImageBitmap</code>. |
| | | * @returns a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority. |
| | | */ |
| | | static fetchImage(options: { |
| | |
| | | request?: Request; |
| | | preferBlob?: boolean; |
| | | preferImageBitmap?: boolean; |
| | | skipColorSpaceConversion?: boolean; |
| | | }): Promise<ImageBitmap> | Promise<HTMLImageElement> | undefined; |
| | | /** |
| | | * Asynchronously loads the given resource as text. Returns a promise that will resolve to |
| | |
| | | to the event, you will be notified of the error and can potentially recover from it. Event listeners |
| | | are passed an instance of {@link TileProviderError}. |
| | | */ |
| | | errorEvent: Event; |
| | | readonly errorEvent: Event; |
| | | /** |
| | | * Gets the credit to display when this terrain provider is active. Typically this is used to credit |
| | | the source of the terrain. This function should |
| | | not be called before {@link TerrainProvider#ready} returns true. |
| | | */ |
| | | credit: Credit; |
| | | readonly credit: Credit; |
| | | /** |
| | | * Gets the tiling scheme used by the provider. This function should |
| | | not be called before {@link TerrainProvider#ready} returns true. |
| | | */ |
| | | tilingScheme: TilingScheme; |
| | | readonly tilingScheme: TilingScheme; |
| | | /** |
| | | * Gets a value indicating whether or not the provider is ready for use. |
| | | */ |
| | | ready: boolean; |
| | | readonly ready: boolean; |
| | | /** |
| | | * Gets a promise that resolves to true when the provider is ready for use. |
| | | */ |
| | |
| | | as a reflective surface with animated waves. This function should not be |
| | | called before {@link TerrainProvider#ready} returns true. |
| | | */ |
| | | hasWaterMask: boolean; |
| | | readonly hasWaterMask: boolean; |
| | | /** |
| | | * Gets a value indicating whether or not the requested tiles include vertex normals. |
| | | This function should not be called before {@link TerrainProvider#ready} returns true. |
| | | */ |
| | | hasVertexNormals: boolean; |
| | | readonly hasVertexNormals: boolean; |
| | | /** |
| | | * Gets an object that can be used to determine availability of terrain from this provider, such as |
| | | at points and in rectangles. This function should not be called before |
| | | {@link TerrainProvider#ready} returns true. This property may be undefined if availability |
| | | information is not available. |
| | | */ |
| | | availability: TileAvailability; |
| | | readonly availability: TileAvailability; |
| | | /** |
| | | * Gets a list of indices for a triangle mesh representing a regular grid. Calling |
| | | this function multiple times with the same grid width and height returns the |
| | |
| | | * @param level - The level of the tile for which to request geometry. |
| | | * @returns Undefined if not supported by the terrain provider, otherwise true or false. |
| | | */ |
| | | getTileDataAvailable(x: number, y: number, level: number): boolean; |
| | | getTileDataAvailable(x: number, y: number, level: number): boolean | undefined; |
| | | /** |
| | | * Makes sure we load availability data for a tile |
| | | * @param x - The X coordinate of the tile for which to request geometry. |
| | |
| | | to the event, you will be notified of the error and can potentially recover from it. Event listeners |
| | | are passed an instance of {@link TileProviderError}. |
| | | */ |
| | | errorEvent: Event; |
| | | readonly errorEvent: Event; |
| | | /** |
| | | * Gets the credit to display when this terrain provider is active. Typically this is used to credit |
| | | the source of the terrain. This function should not be called before {@link VRTheWorldTerrainProvider#ready} returns true. |
| | | */ |
| | | credit: Credit; |
| | | readonly credit: Credit; |
| | | /** |
| | | * Gets the tiling scheme used by this provider. This function should |
| | | not be called before {@link VRTheWorldTerrainProvider#ready} returns true. |
| | | */ |
| | | tilingScheme: GeographicTilingScheme; |
| | | readonly tilingScheme: GeographicTilingScheme; |
| | | /** |
| | | * Gets a value indicating whether or not the provider is ready for use. |
| | | */ |
| | | ready: boolean; |
| | | readonly ready: boolean; |
| | | /** |
| | | * Gets a promise that resolves to true when the provider is ready for use. |
| | | */ |
| | |
| | | as a reflective surface with animated waves. This function should not be |
| | | called before {@link VRTheWorldTerrainProvider#ready} returns true. |
| | | */ |
| | | hasWaterMask: boolean; |
| | | readonly hasWaterMask: boolean; |
| | | /** |
| | | * Gets a value indicating whether or not the requested tiles include vertex normals. |
| | | This function should not be called before {@link VRTheWorldTerrainProvider#ready} returns true. |
| | | */ |
| | | hasVertexNormals: boolean; |
| | | readonly hasVertexNormals: boolean; |
| | | /** |
| | | * Gets an object that can be used to determine availability of terrain from this provider, such as |
| | | at points and in rectangles. This function should not be called before |
| | | {@link TerrainProvider#ready} returns true. This property may be undefined if availability |
| | | information is not available. |
| | | */ |
| | | availability: TileAvailability; |
| | | readonly availability: TileAvailability; |
| | | /** |
| | | * Requests the geometry for a given tile. This function should not be called before |
| | | {@link VRTheWorldTerrainProvider#ready} returns true. The result includes terrain |
| | |
| | | * @param level - The level of the tile for which to request geometry. |
| | | * @returns Undefined if not supported, otherwise true or false. |
| | | */ |
| | | getTileDataAvailable(x: number, y: number, level: number): boolean; |
| | | getTileDataAvailable(x: number, y: number, level: number): boolean | undefined; |
| | | /** |
| | | * Makes sure we load availability data for a tile |
| | | * @param x - The X coordinate of the tile for which to request geometry. |
| | |
| | | outlineColor: Property | undefined; |
| | | /** |
| | | * Gets or sets the numeric Property specifying the width of the outline. |
| | | <p> |
| | | Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}. |
| | | </p> |
| | | */ |
| | | outlineWidth: Property | undefined; |
| | | /** |
| | |
| | | */ |
| | | positions: Property | undefined; |
| | | /** |
| | | * Gets or sets the numeric Property specifying the width of the corridor. |
| | | * Gets or sets the numeric Property specifying the width of the outline. |
| | | */ |
| | | width: Property | undefined; |
| | | /** |
| | |
| | | outlineColor: Property | undefined; |
| | | /** |
| | | * Gets or sets the numeric Property specifying the width of the outline. |
| | | <p> |
| | | Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}. |
| | | </p> |
| | | */ |
| | | outlineWidth: Property | undefined; |
| | | /** |
| | |
| | | outlineColor: Property | undefined; |
| | | /** |
| | | * Gets or sets the numeric Property specifying the width of the outline. |
| | | <p> |
| | | Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}. |
| | | </p> |
| | | */ |
| | | outlineWidth: Property | undefined; |
| | | /** |
| | |
| | | outlineColor: Property | undefined; |
| | | /** |
| | | * Gets or sets the numeric Property specifying the width of the outline. |
| | | <p> |
| | | Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}. |
| | | </p> |
| | | */ |
| | | outlineWidth: Property | undefined; |
| | | /** |
| | |
| | | outlineColor: Property | undefined; |
| | | /** |
| | | * Gets or sets the numeric Property specifying the width of the outline. |
| | | <p> |
| | | Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}. |
| | | </p> |
| | | */ |
| | | outlineWidth: Property | undefined; |
| | | /** |
| | |
| | | */ |
| | | credit: Credit; |
| | | /** |
| | | * Gets the KML Tours that are used to guide the camera to specified destinations on given time intervals. |
| | | */ |
| | | kmlTours: KmlTour[]; |
| | | /** |
| | | * Asynchronously loads the provided KML data, replacing any existing data. |
| | | * @param data - A url, parsed KML document, or Blob containing binary KMZ data or a parsed KML document. |
| | | * @param [options] - An object with the following properties: |
| | |
| | | } |
| | | |
| | | /** |
| | | * Describes a KmlTour, which uses KmlTourFlyTo, and KmlTourWait to |
| | | guide the camera to a specified destinations on given time intervals. |
| | | * @param name - name parsed from KML |
| | | * @param id - id parsed from KML |
| | | * @param playlist - array with KMLTourFlyTos, KMLTourWaits and KMLTourSoundCues |
| | | * @param playlist - array with KmlTourFlyTos and KmlTourWaits |
| | | */ |
| | | export class KmlTour { |
| | | constructor(name: string, id: string, playlist: any[]); |
| | |
| | | } |
| | | |
| | | /** |
| | | * Transitions the KmlTour to the next destination. This transition is facilitated |
| | | using a specified flyToMode over a given number of seconds. |
| | | * @param duration - entry duration |
| | | * @param flyToMode - KML fly to mode: bounce, smooth, etc |
| | | * @param view - KmlCamera or KmlLookAt |
| | |
| | | } |
| | | |
| | | /** |
| | | * Pauses the KmlTour for a given number of seconds. |
| | | * @param duration - entry duration |
| | | */ |
| | | export class KmlTourWait { |
| | |
| | | outlineColor: Property | undefined; |
| | | /** |
| | | * Gets or sets the numeric Property specifying the width of the outline. |
| | | <p> |
| | | Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}. |
| | | </p> |
| | | */ |
| | | outlineWidth: Property | undefined; |
| | | /** |
| | |
| | | outlineColor: Property | undefined; |
| | | /** |
| | | * Gets or sets the numeric Property specifying the width of the outline. |
| | | <p> |
| | | Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}. |
| | | </p> |
| | | */ |
| | | outlineWidth: Property | undefined; |
| | | /** |
| | |
| | | outlineColor: Property | undefined; |
| | | /** |
| | | * Gets or sets the numeric Property specifying the width of the outline. |
| | | <p> |
| | | Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}. |
| | | </p> |
| | | */ |
| | | outlineWidth: Property | undefined; |
| | | /** |
| | |
| | | outlineColor: Property | undefined; |
| | | /** |
| | | * Gets or sets the numeric Property specifying the width of the outline. |
| | | <p> |
| | | Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}. |
| | | </p> |
| | | */ |
| | | outlineWidth: Property | undefined; |
| | | /** |
| | |
| | | outlineColor: Property | undefined; |
| | | /** |
| | | * Gets or sets the numeric Property specifying the width of the outline. |
| | | <p> |
| | | Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}. |
| | | </p> |
| | | */ |
| | | outlineWidth: Property | undefined; |
| | | /** |
| | |
| | | */ |
| | | readonly batchTableByteLength: number; |
| | | /** |
| | | * Gets the array of {@link Cesium3DTileContent} objects that represent the |
| | | content a composite's inner tiles, which can also be composites. |
| | | * Gets the array of {@link Cesium3DTileContent} objects for contents that contain other contents, such as composite tiles. The inner contents may in turn have inner contents, such as a composite tile that contains a composite tile. |
| | | */ |
| | | readonly innerContents: any[]; |
| | | /** |
| | |
| | | */ |
| | | readonly url: string; |
| | | /** |
| | | * Determines if the tile's batch table has a property. If it does, each feature in |
| | | the tile will have the property. |
| | | * Returns whether the feature has this property. |
| | | * @param batchId - The batchId for the feature. |
| | | * @param name - The case-sensitive name of the property. |
| | | * @returns <code>true</code> if the property exists; otherwise, <code>false</code>. |
| | | * @returns <code>true</code> if the feature has this property; otherwise, <code>false</code>. |
| | | */ |
| | | hasProperty(batchId: number, name: string): boolean; |
| | | /** |
| | |
| | | */ |
| | | color: Color; |
| | | /** |
| | | * Gets a typed array containing the ECEF positions of the polyline. |
| | | Returns undefined if {@link Cesium3DTileset#vectorKeepDecodedPositions} is false |
| | | or the feature is not a polyline in a vector tile. |
| | | */ |
| | | polylinePositions: Float64Array; |
| | | /** |
| | | * Gets the tileset containing the feature. |
| | | */ |
| | | readonly tileset: Cesium3DTileset; |
| | |
| | | console.log(propertyName + ': ' + feature.getProperty(propertyName)); |
| | | } |
| | | * @param name - The case-sensitive name of the property. |
| | | * @returns The value of the property or <code>undefined</code> if the property does not exist. |
| | | * @returns The value of the property or <code>undefined</code> if the feature does not have this property. |
| | | */ |
| | | getProperty(name: string): any; |
| | | /** |
| | |
| | | console.log(propertyName + ': ' + feature.getProperty(propertyName)); |
| | | } |
| | | * @param name - The case-sensitive name of the property. |
| | | * @returns The value of the property or <code>undefined</code> if the property does not exist. |
| | | * @returns The value of the property or <code>undefined</code> if the feature does not have this property. |
| | | */ |
| | | getProperty(name: string): any; |
| | | /** |
| | |
| | | } |
| | | |
| | | /** |
| | | * A {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification|3D Tiles tileset}, |
| | | * A {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification|3D Tiles tileset}, |
| | | used for streaming massive heterogeneous 3D geospatial datasets. |
| | | * @example |
| | | * var tileset = scene.primitives.add(new Cesium.Cesium3DTileset({ |
| | |
| | | * @param [options.lightColor] - The light color when shading models. When <code>undefined</code> the scene's light color is used instead. |
| | | * @param [options.luminanceAtZenith = 0.2] - The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map. |
| | | * @param [options.sphericalHarmonicCoefficients] - The third order spherical harmonic coefficients used for the diffuse color of image-based lighting. |
| | | * @param [options.specularEnvironmentMaps] - A URL to a KTX file that contains a cube map of the specular lighting and the convoluted specular mipmaps. |
| | | * @param [options.specularEnvironmentMaps] - A URL to a KTX2 file that contains a cube map of the specular lighting and the convoluted specular mipmaps. |
| | | * @param [options.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. |
| | | * @param [options.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. |
| | | * @param [options.vectorClassificationOnly = false] - Indicates that only the tileset's vector tiles should be used for classification. |
| | | * @param [options.vectorKeepDecodedPositions = false] - Whether vector tiles should keep decoded positions in memory. This is used with {@link Cesium3DTileFeature.getPolylinePositions}. |
| | | * @param [options.debugHeatmapTilePropertyName] - The tile variable to colorize as a heatmap. All rendered tiles will be colorized relative to each other's specified variable value. |
| | | * @param [options.pickPrimitive] - The primitive to be rendered during the pick pass instead of the tileset. |
| | | * @param [options.debugFreezeFrame = false] - For debugging only. Determines if only the tiles from last frame should be used for rendering. |
| | | * @param [options.debugColorizeTiles = false] - For debugging only. When true, assigns a random color to each tile. |
| | | * @param [options.debugWireframe = false] - For debugging only. When true, render's each tile's content as a wireframe. |
| | |
| | | sphericalHarmonicCoefficients?: Cartesian3[]; |
| | | specularEnvironmentMaps?: string; |
| | | backFaceCulling?: boolean; |
| | | showOutline?: boolean; |
| | | vectorClassificationOnly?: boolean; |
| | | vectorKeepDecodedPositions?: boolean; |
| | | debugHeatmapTilePropertyName?: string; |
| | | pickPrimitive?: any; |
| | | debugFreezeFrame?: boolean; |
| | | debugColorizeTiles?: boolean; |
| | | debugWireframe?: boolean; |
| | |
| | | <li><code>url</code>: the url of the failed tile.</li> |
| | | <li><code>message</code>: the error message.</li> |
| | | </ul> |
| | | <p> |
| | | If the <code>3DTILES_multiple_contents</code> extension is used, this event is raised once per inner content with errors. |
| | | </p> |
| | | * @example |
| | | * tileset.tileFailed.addEventListener(function(error) { |
| | | console.log('An error occurred loading tile: ' + error.url); |
| | |
| | | */ |
| | | backFaceCulling: boolean; |
| | | /** |
| | | * The primitive to be rendered during the pick pass instead of the tileset. |
| | | * 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. |
| | | */ |
| | | pickPrimitive: any; |
| | | readonly showOutline: boolean; |
| | | /** |
| | | * This property is for debugging only; it is not optimized for production use. |
| | | <p> |
| | |
| | | */ |
| | | debugShowUrl: boolean; |
| | | /** |
| | | * Function for examining vector lines as they are being streamed. |
| | | */ |
| | | examineVectorLinesFunction: (...params: any[]) => any; |
| | | /** |
| | | * Gets the tileset's asset object property, which contains metadata about the tileset. |
| | | <p> |
| | | See the {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification#reference-asset|asset schema reference} |
| | | See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification#reference-asset|asset schema reference} |
| | | in the 3D Tiles spec for the full set of properties. |
| | | </p> |
| | | */ |
| | |
| | | /** |
| | | * Gets the tileset's properties dictionary object, which contains metadata about per-feature properties. |
| | | <p> |
| | | See the {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification#reference-properties|properties schema reference} |
| | | See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification#reference-properties|properties schema reference} |
| | | in the 3D Tiles spec for the full set of properties. |
| | | </p> |
| | | * @example |
| | |
| | | readonly basePath: string; |
| | | /** |
| | | * The style, defined using the |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification/Styling|3D Tiles Styling language}, |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language}, |
| | | applied to each feature in the tileset. |
| | | <p> |
| | | Assign <code>undefined</code> to remove the style, which will restore the visual |
| | |
| | | event is raised, so code in <code>tileVisible</code> can manually set a feature's |
| | | properties (e.g. color and show) after the style is applied. When |
| | | a new style is assigned any manually set properties are overwritten. |
| | | </p> |
| | | <p> |
| | | Use an always "true" condition to specify the Color for all objects that are not |
| | | overridden by pre-existing conditions. Otherwise, the default color Cesium.Color.White |
| | | will be used. Similarly, use an always "true" condition to specify the show property |
| | | for all objects that are not overridden by pre-existing conditions. Otherwise, the |
| | | default show value true will be used. |
| | | </p> |
| | | * @example |
| | | * tileset.style = new Cesium.Cesium3DTileStyle({ |
| | |
| | | */ |
| | | imageBasedLightingFactor: Cartesian2; |
| | | /** |
| | | * Indicates that only the tileset's vector tiles should be used for classification. |
| | | */ |
| | | vectorClassificationOnly: boolean; |
| | | /** |
| | | * Whether vector tiles should keep decoded positions in memory. |
| | | This is used with {@link Cesium3DTileFeature.getPolylinePositions}. |
| | | */ |
| | | vectorKeepDecodedPositions: boolean; |
| | | /** |
| | | * Provides a hook to override the method used to request the tileset json |
| | | useful when fetching tilesets from remote servers |
| | | * @param tilesetUrl - The url of the json file to be fetched |
| | |
| | | * A style that is applied to a {@link Cesium3DTileset}. |
| | | <p> |
| | | Evaluates an expression defined using the |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification/Styling|3D Tiles Styling language}. |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language}. |
| | | </p> |
| | | * @example |
| | | * tileset.style = new Cesium.Cesium3DTileStyle({ |
| | |
| | | constructor(style?: Resource | string | any); |
| | | /** |
| | | * Gets the object defining the style using the |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification/Styling|3D Tiles Styling language}. |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language}. |
| | | */ |
| | | readonly style: any; |
| | | /** |
| | |
| | | * An expression for a style applied to a {@link Cesium3DTileset}. |
| | | <p> |
| | | Evaluates a conditions expression defined using the |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification/Styling|3D Tiles Styling language}. |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language}. |
| | | </p> |
| | | <p> |
| | | Implements the {@link StyleExpression} interface. |
| | |
| | | /** |
| | | * Evaluates the result of an expression, optionally using the provided feature's properties. If the result of |
| | | the expression in the |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification/Styling|3D Tiles Styling language} |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language} |
| | | is of type <code>Boolean</code>, <code>Number</code>, or <code>String</code>, the corresponding JavaScript |
| | | primitive type will be returned. If the result is a <code>RegExp</code>, a Javascript <code>RegExp</code> |
| | | object will be returned. If the result is a <code>Cartesian2</code>, <code>Cartesian3</code>, or <code>Cartesian4</code>, |
| | |
| | | specified, a default style is used which gives each building or building part a |
| | | color inferred from its OpenStreetMap <code>tags</code>. If no color can be inferred, |
| | | <code>options.defaultColor</code> is used. |
| | | * @param [options.showOutline = true] - Whether to show outlines around buildings. When true, |
| | | outlines are displayed. When false, outlines are not displayed. |
| | | */ |
| | | export function createOsmBuildings(options?: { |
| | | defaultColor?: Color; |
| | | style?: Cesium3DTileStyle; |
| | | showOutline?: boolean; |
| | | }): Cesium3DTileset; |
| | | |
| | | /** |
| | |
| | | * An expression for a style applied to a {@link Cesium3DTileset}. |
| | | <p> |
| | | Evaluates an expression defined using the |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification/Styling|3D Tiles Styling language}. |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language}. |
| | | </p> |
| | | <p> |
| | | Implements the {@link StyleExpression} interface. |
| | |
| | | /** |
| | | * Evaluates the result of an expression, optionally using the provided feature's properties. If the result of |
| | | the expression in the |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification/Styling|3D Tiles Styling language} |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language} |
| | | is of type <code>Boolean</code>, <code>Number</code>, or <code>String</code>, the corresponding JavaScript |
| | | primitive type will be returned. If the result is a <code>RegExp</code>, a Javascript <code>RegExp</code> |
| | | object will be returned. If the result is a <code>Cartesian2</code>, <code>Cartesian3</code>, or <code>Cartesian4</code>, |
| | |
| | | A brightness shift of -1.0 is complete darkness, which will let space show through. |
| | | */ |
| | | atmosphereBrightnessShift: number; |
| | | /** |
| | | * A scalar used to exaggerate the terrain. Defaults to <code>1.0</code> (no exaggeration). |
| | | A value of <code>2.0</code> scales the terrain by 2x. |
| | | A value of <code>0.0</code> makes the terrain completely flat. |
| | | Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid. |
| | | */ |
| | | terrainExaggeration: number; |
| | | /** |
| | | * The height from which terrain is exaggerated. Defaults to <code>0.0</code> (scaled relative to ellipsoid surface). |
| | | Terrain that is above this height will scale upwards and terrain that is below this height will scale downwards. |
| | | Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid. |
| | | If {@link Globe#terrainExaggeration} is <code>1.0</code> this value will have no effect. |
| | | */ |
| | | terrainExaggerationRelativeHeight: number; |
| | | /** |
| | | * Whether to show terrain skirts. Terrain skirts are geometry extending downwards from a tile's edges used to hide seams between neighboring tiles. |
| | | Skirts are always hidden when the camera is underground or translucency is enabled. |
| | |
| | | */ |
| | | lowerToBottom(layer: ImageryLayer): void; |
| | | /** |
| | | * Determines the imagery layers that are intersected by a pick ray. To compute a pick ray from a |
| | | location on the screen, use {@link Camera.getPickRay}. |
| | | * @param ray - The ray to test for intersection. |
| | | * @param scene - The scene. |
| | | * @returns An array that includes all of |
| | | the layers that are intersected by a given pick ray. Undefined if |
| | | no layers are selected. |
| | | */ |
| | | pickImageryLayers(ray: Ray, scene: Scene): ImageryLayer[] | undefined; |
| | | /** |
| | | * Asynchronously determines the imagery layer features that are intersected by a pick ray. The intersected imagery |
| | | layer features are found by invoking {@link ImageryProvider#pickFeatures} for each imagery layer tile intersected |
| | | by the pick ray. To compute a pick ray from a location on the screen, use {@link Camera.getPickRay}. |
| | |
| | | <li><code>specularMap</code>: Single channel texture used to indicate areas of water.</li> |
| | | <li><code>normalMap</code>: Normal map for water normal perturbation.</li> |
| | | <li><code>frequency</code>: Number that controls the number of waves.</li> |
| | | <li><code>normalMap</code>: Normal map for water normal perturbation.</li> |
| | | <li><code>animationSpeed</code>: Number that controls the animations speed of the water.</li> |
| | | <li><code>amplitude</code>: Number that controls the amplitude of water waves.</li> |
| | | <li><code>specularIntensity</code>: Number that controls the intensity of specular reflections.</li> |
| | |
| | | * {@link https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_techniques_webgl/README.md|KHR_techniques_webgl} |
| | | * </li><li> |
| | | * {@link https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_texture_transform/README.md|KHR_texture_transform} |
| | | * </li><li> |
| | | * {@link https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_texture_basisu|KHR_texture_basisu} |
| | | * </li> |
| | | * </ul> |
| | | * </p> |
| | | * <p> |
| | | * Note: for models with compressed textures using the KHR_texture_basisu extension, we recommend power of 2 textures in both dimensions |
| | | * for maximum compatibility. This is because some samplers require power of 2 textures ({@link https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Tutorial/Using_textures_in_WebGL|Using textures in WebGL}) |
| | | * and KHR_texture_basisu requires multiple of 4 dimensions ({@link https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_texture_basisu/README.md#additional-requirements|KHR_texture_basisu additional requirements}). |
| | | * </p> |
| | | * <p> |
| | | * For high-precision rendering, Cesium supports the {@link https://github.com/KhronosGroup/glTF/blob/master/extensions/1.0/Vendor/CESIUM_RTC/README.md|CESIUM_RTC} extension, which introduces the |
| | |
| | | * @param [options.lightColor] - The light color when shading the model. When <code>undefined</code> the scene's light color is used instead. |
| | | * @param [options.luminanceAtZenith = 0.2] - The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map. |
| | | * @param [options.sphericalHarmonicCoefficients] - The third order spherical harmonic coefficients used for the diffuse color of image-based lighting. |
| | | * @param [options.specularEnvironmentMaps] - A URL to a KTX file that contains a cube map of the specular lighting and the convoluted specular mipmaps. |
| | | * @param [options.specularEnvironmentMaps] - A URL to a KTX2 file that contains a cube map of the specular lighting and the convoluted specular mipmaps. |
| | | * @param [options.credit] - A credit for the data source, which is displayed on the canvas. |
| | | * @param [options.backFaceCulling = true] - Whether to cull back-facing geometry. When true, back face culling is determined by the material's doubleSided property; when false, back face culling is disabled. Back faces are not culled if {@link Model#color} is translucent or {@link Model#silhouetteSize} is greater than 0.0. |
| | | * @param [options.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. |
| | | */ |
| | | export class Model { |
| | | constructor(options?: { |
| | |
| | | specularEnvironmentMaps?: string; |
| | | credit?: Credit | string; |
| | | backFaceCulling?: boolean; |
| | | showOutline?: boolean; |
| | | }); |
| | | /** |
| | | * Determines if the model primitive will be shown. |
| | |
| | | * translucent or {@link Model#silhouetteSize} is greater than 0.0. |
| | | */ |
| | | backFaceCulling: boolean; |
| | | /** |
| | | * 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. |
| | | */ |
| | | readonly showOutline: boolean; |
| | | /** |
| | | * This property is for debugging only; it is not for production use nor is it optimized. |
| | | * <p> |
| | |
| | | */ |
| | | sphericalHarmonicCoefficients: Cartesian3[]; |
| | | /** |
| | | * A URL to a KTX file that contains a cube map of the specular lighting and the convoluted specular mipmaps. |
| | | * A URL to a KTX2 file that contains a cube map of the specular lighting and the convoluted specular mipmaps. |
| | | */ |
| | | specularEnvironmentMaps: string; |
| | | /** |
| | |
| | | * {@link https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_techniques_webgl/README.md|KHR_techniques_webgl} |
| | | * </li><li> |
| | | * {@link https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_texture_transform/README.md|KHR_texture_transform} |
| | | * </li><li> |
| | | * {@link https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_texture_basisu/README.md|KHR_texture_basisu} |
| | | * </li> |
| | | * </ul> |
| | | * </p> |
| | |
| | | * @param [options.dequantizeInShader = true] - Determines if a {@link https://github.com/google/draco|Draco} encoded model is dequantized on the GPU. This decreases total memory usage for encoded models. |
| | | * @param [options.credit] - A credit for the model, which is displayed on the canvas. |
| | | * @param [options.backFaceCulling = true] - Whether to cull back-facing geometry. When true, back face culling is determined by the material's doubleSided property; when false, back face culling is disabled. Back faces are not culled if {@link Model#color} is translucent or {@link Model#silhouetteSize} is greater than 0.0. |
| | | * @param [options.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. |
| | | * @returns The newly created model. |
| | | */ |
| | | static fromGltf(options: { |
| | |
| | | dequantizeInShader?: boolean; |
| | | credit?: Credit | string; |
| | | backFaceCulling?: boolean; |
| | | showOutline?: boolean; |
| | | }): Model; |
| | | /** |
| | | * Returns the glTF node with the given <code>name</code> property. This is used to |
| | |
| | | postProcessStages.add(Cesium.PostProcessLibrary.createSilhouetteStage([yellowEdge, greenEdge]); |
| | | * @returns A post-process stage that applies an edge detection effect. |
| | | */ |
| | | function createEdgeDetectionStage(): PostProcessStageComposite; |
| | | function createEdgeDetectionStage(): PostProcessStage; |
| | | /** |
| | | * Whether or not an edge detection stage is supported. |
| | | <p> |
| | |
| | | * // 3. Create the geometry on the main thread. |
| | | scene.primitives.add(new Cesium.Primitive({ |
| | | geometryInstances : new Cesium.GeometryInstance({ |
| | | geometry : Cesium.EllipsoidGeometry.createGeometry(new Cesium.EllipsoidGeometry({ |
| | | radii : new Cesium.Cartesian3(500000.0, 500000.0, 1000000.0), |
| | | vertexFormat : Cesium.VertexFormat.POSITION_AND_NORMAL |
| | | })), |
| | | modelMatrix : Cesium.Matrix4.multiplyByTranslation(Cesium.Transforms.eastNorthUpToFixedFrame( |
| | | Cesium.Cartesian3.fromDegrees(-95.59777, 40.03883)), new Cesium.Cartesian3(0.0, 0.0, 500000.0), new Cesium.Matrix4()), |
| | | id : 'ellipsoid', |
| | | attributes : { |
| | | color : Cesium.ColorGeometryInstanceAttribute.fromColor(Cesium.Color.AQUA) |
| | | } |
| | | geometry : Cesium.EllipsoidGeometry.createGeometry(new Cesium.EllipsoidGeometry({ |
| | | radii : new Cesium.Cartesian3(500000.0, 500000.0, 1000000.0), |
| | | vertexFormat : Cesium.VertexFormat.POSITION_AND_NORMAL |
| | | })), |
| | | modelMatrix : Cesium.Matrix4.multiplyByTranslation(Cesium.Transforms.eastNorthUpToFixedFrame( |
| | | Cesium.Cartesian3.fromDegrees(-95.59777, 40.03883)), new Cesium.Cartesian3(0.0, 0.0, 500000.0), new Cesium.Matrix4()), |
| | | id : 'ellipsoid', |
| | | attributes : { |
| | | color : Cesium.ColorGeometryInstanceAttribute.fromColor(Cesium.Color.AQUA) |
| | | } |
| | | }), |
| | | appearance : new Cesium.PerInstanceColorAppearance() |
| | | appearance : new Cesium.PerInstanceColorAppearance(), |
| | | asynchronous : false |
| | | })); |
| | | * @param [options] - Object with the following properties: |
| | | * @param [options.geometryInstances] - The geometry instances - or a single geometry instance - to render. |
| | |
| | | * @param [options.mapProjection = new GeographicProjection()] - The map projection to use in 2D and Columbus View modes. |
| | | * @param [options.orderIndependentTranslucency = true] - If true and the configuration supports it, use order independent translucency. |
| | | * @param [options.scene3DOnly = false] - If true, optimizes memory use and performance for 3D mode but disables the ability to use 2D or Columbus View. |
| | | * @param [options.terrainExaggeration = 1.0] - A scalar used to exaggerate the terrain. Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid. |
| | | * @param [options.shadows = false] - Determines if shadows are cast by light sources. |
| | | * @param [options.mapMode2D = MapMode2D.INFINITE_SCROLL] - Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction. |
| | | * @param [options.requestRenderMode = false] - If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application, but requires using {@link Scene#requestRender} to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}. |
| | |
| | | mapProjection?: MapProjection; |
| | | orderIndependentTranslucency?: boolean; |
| | | scene3DOnly?: boolean; |
| | | terrainExaggeration?: number; |
| | | shadows?: boolean; |
| | | mapMode2D?: MapMode2D; |
| | | requestRenderMode?: boolean; |
| | |
| | | */ |
| | | sphericalHarmonicCoefficients: Cartesian3[]; |
| | | /** |
| | | * The url to the KTX file containing the specular environment map and convoluted mipmaps for image-based lighting of PBR models. |
| | | * The url to the KTX2 file containing the specular environment map and convoluted mipmaps for image-based lighting of PBR models. |
| | | */ |
| | | specularEnvironmentMaps: string; |
| | | /** |
| | |
| | | */ |
| | | mode: SceneMode; |
| | | /** |
| | | * Gets the scalar used to exaggerate the terrain. |
| | | * Gets or sets the scalar used to exaggerate the terrain. |
| | | */ |
| | | readonly terrainExaggeration: number; |
| | | terrainExaggeration: number; |
| | | /** |
| | | * When <code>true</code>, splits the scene into two viewports with steroscopic views for the left and right eyes. |
| | | Used for cardboard and WebVR. |
| | |
| | | * @param [options.softShadows = false] - Whether percentage-closer-filtering is enabled for producing softer shadows. |
| | | * @param [options.darkness = 0.3] - The shadow darkness. |
| | | * @param [options.normalOffset = true] - Whether a normal bias is applied to shadows. |
| | | * @param [options.fadingEnabled = true] - Whether shadows start to fade out once the light gets closer to the horizon. |
| | | */ |
| | | export class ShadowMap { |
| | | constructor(options: { |
| | |
| | | softShadows?: boolean; |
| | | darkness?: number; |
| | | normalOffset?: boolean; |
| | | fadingEnabled?: boolean; |
| | | }); |
| | | /** |
| | | * Determines the darkness of the shadows. |
| | | */ |
| | | darkness: number; |
| | | /** |
| | | * Determines whether shadows start to fade out once the light gets closer to the horizon. |
| | | */ |
| | | fadingEnabled: boolean; |
| | | /** |
| | | * Determines the maximum distance of the shadow map. Only applicable for cascaded shadows. Larger distances may result in lower quality shadows. |
| | | */ |
| | |
| | | * An expression for a style applied to a {@link Cesium3DTileset}. |
| | | <p> |
| | | Derived classes of this interface evaluate expressions in the |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification/Styling|3D Tiles Styling language}. |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language}. |
| | | </p> |
| | | <p> |
| | | This type describes an interface and is not intended to be instantiated directly. |
| | |
| | | /** |
| | | * Evaluates the result of an expression, optionally using the provided feature's properties. If the result of |
| | | the expression in the |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification/Styling|3D Tiles Styling language} |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language} |
| | | is of type <code>Boolean</code>, <code>Number</code>, or <code>String</code>, the corresponding JavaScript |
| | | primitive type will be returned. If the result is a <code>RegExp</code>, a Javascript <code>RegExp</code> |
| | | object will be returned. If the result is a <code>Cartesian2</code>, <code>Cartesian3</code>, or <code>Cartesian4</code>, |
| | |
| | | * @param [options.shadows = ShadowMode.ENABLED] - Determines whether the point cloud casts or receives shadows from light sources. |
| | | * @param [options.maximumMemoryUsage = 256] - The maximum amount of memory in MB that can be used by the point cloud. |
| | | * @param [options.shading] - Options for constructing a {@link PointCloudShading} object to control point attenuation and eye dome lighting. |
| | | * @param [options.style] - The style, defined using the {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification/Styling|3D Tiles Styling language}, applied to each point in the point cloud. |
| | | * @param [options.style] - The style, defined using the {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language}, applied to each point in the point cloud. |
| | | * @param [options.clippingPlanes] - The {@link ClippingPlaneCollection} used to selectively disable rendering the point cloud. |
| | | */ |
| | | export class TimeDynamicPointCloud { |
| | |
| | | shading: PointCloudShading; |
| | | /** |
| | | * The style, defined using the |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification/Styling|3D Tiles Styling language}, |
| | | {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language}, |
| | | applied to each point in the point cloud. |
| | | <p> |
| | | Assign <code>undefined</code> to remove the style, which will restore the visual |
| | |
| | | * @param [options.creditContainer] - The DOM element or ID that will contain the {@link CreditDisplay}. If not specified, the credits are added |
| | | to the bottom of the widget itself. |
| | | * @param [options.creditViewport] - The DOM element or ID that will contain the credit pop up created by the {@link CreditDisplay}. If not specified, it will appear over the widget itself. |
| | | * @param [options.terrainExaggeration = 1.0] - A scalar used to exaggerate the terrain. Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid. |
| | | * @param [options.shadows = false] - Determines if shadows are cast by light sources. |
| | | * @param [options.terrainShadows = ShadowMode.RECEIVE_ONLY] - Determines if the terrain casts or receives shadows from light sources. |
| | | * @param [options.mapMode2D = MapMode2D.INFINITE_SCROLL] - Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction. |
| | |
| | | contextOptions?: any; |
| | | creditContainer?: Element | string; |
| | | creditViewport?: Element | string; |
| | | terrainExaggeration?: number; |
| | | shadows?: boolean; |
| | | terrainShadows?: ShadowMode; |
| | | mapMode2D?: MapMode2D; |
| | |
| | | * @property [creditViewport] - The DOM element or ID that will contain the credit pop up created by the {@link CreditDisplay}. If not specified, it will appear over the widget itself. |
| | | * @property [dataSources = new DataSourceCollection()] - The collection of data sources visualized by the widget. If this parameter is provided, |
| | | the instance is assumed to be owned by the caller and will not be destroyed when the viewer is destroyed. |
| | | * @property [terrainExaggeration = 1.0] - A scalar used to exaggerate the terrain. Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid. |
| | | * @property [shadows = false] - Determines if shadows are cast by light sources. |
| | | * @property [terrainShadows = ShadowMode.RECEIVE_ONLY] - Determines if the terrain casts or receives shadows from light sources. |
| | | * @property [mapMode2D = MapMode2D.INFINITE_SCROLL] - Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction. |
| | |
| | | creditContainer?: Element | string; |
| | | creditViewport?: Element | string; |
| | | dataSources?: DataSourceCollection; |
| | | terrainExaggeration?: number; |
| | | shadows?: boolean; |
| | | terrainShadows?: ShadowMode; |
| | | mapMode2D?: MapMode2D; |
| | |
| | | declare module "cesium/Source/Core/Credit" { import { Credit } from 'cesium'; export default Credit; } |
| | | declare module "cesium/Source/Core/CubicRealPolynomial" { import { CubicRealPolynomial } from 'cesium'; export default CubicRealPolynomial; } |
| | | declare module "cesium/Source/Core/CullingVolume" { import { CullingVolume } from 'cesium'; export default CullingVolume; } |
| | | declare module "cesium/Source/Core/CustomHeightmapTerrainProvider" { import { CustomHeightmapTerrainProvider } from 'cesium'; export default CustomHeightmapTerrainProvider; } |
| | | declare module "cesium/Source/Core/CylinderGeometry" { import { CylinderGeometry } from 'cesium'; export default CylinderGeometry; } |
| | | declare module "cesium/Source/Core/CylinderOutlineGeometry" { import { CylinderOutlineGeometry } from 'cesium'; export default CylinderOutlineGeometry; } |
| | | declare module "cesium/Source/Core/DefaultProxy" { import { DefaultProxy } from 'cesium'; export default DefaultProxy; } |
| | |
| | | declare module "cesium/Source/Core/HeightmapTerrainData" { import { HeightmapTerrainData } from 'cesium'; export default HeightmapTerrainData; } |
| | | declare module "cesium/Source/Core/HermitePolynomialApproximation" { import { HermitePolynomialApproximation } from 'cesium'; export default HermitePolynomialApproximation; } |
| | | declare module "cesium/Source/Core/HermiteSpline" { import { HermiteSpline } from 'cesium'; export default HermiteSpline; } |
| | | declare module "cesium/Source/Core/HilbertOrder" { import { HilbertOrder } from 'cesium'; export default HilbertOrder; } |
| | | declare module "cesium/Source/Core/IndexDatatype" { import { IndexDatatype } from 'cesium'; export default IndexDatatype; } |
| | | declare module "cesium/Source/Core/InterpolationAlgorithm" { import { InterpolationAlgorithm } from 'cesium'; export default InterpolationAlgorithm; } |
| | | declare module "cesium/Source/Core/Intersect" { import { Intersect } from 'cesium'; export default Intersect; } |
| | |
| | | declare module "cesium/Source/Core/LeapSecond" { import { LeapSecond } from 'cesium'; export default LeapSecond; } |
| | | declare module "cesium/Source/Core/LinearApproximation" { import { LinearApproximation } from 'cesium'; export default LinearApproximation; } |
| | | declare module "cesium/Source/Core/LinearSpline" { import { LinearSpline } from 'cesium'; export default LinearSpline; } |
| | | declare module "cesium/Source/Core/loadCRN" { import { loadCRN } from 'cesium'; export default loadCRN; } |
| | | declare module "cesium/Source/Core/loadKTX" { import { loadKTX } from 'cesium'; export default loadKTX; } |
| | | declare module "cesium/Source/Core/MapProjection" { import { MapProjection } from 'cesium'; export default MapProjection; } |
| | | declare module "cesium/Source/Core/Math" { import { Math } from 'cesium'; export default Math; } |
| | | declare module "cesium/Source/Core/Matrix2" { import { Matrix2 } from 'cesium'; export default Matrix2; } |