year is a leap year.
+ */
+export function isLeapYear(year: number): boolean;
+
/**
* Constants related to ISO8601 support.
*/
@@ -11243,6 +11504,33 @@ export class Matrix4 implements ArrayLikecomparator.
+ */
+export function mergeSort(array: any[], comparator: mergeSortComparator, userDefinedObject?: any): void;
+
+/**
+ * A function used to compare two items while performing a merge sort.
+ * @example
+ * function compareNumbers(a, b, userDefinedObject) {
+ * return a - b;
+ * }
+ * @param a - An item in the array.
+ * @param b - An item in the array.
+ * @param [userDefinedObject] - An object that was passed to {@link mergeSort}.
+ */
+export type mergeSortComparator = (a: any, b: any, userDefinedObject?: any) => number;
+
/**
* A spline that linearly interpolates over an array of weight values used by morph targets.
* @example
@@ -11370,6 +11658,21 @@ export class NearFarScalar {
equals(right?: NearFarScalar): boolean;
}
+/**
+ * Converts an object representing a set of name/value pairs into a query string,
+ * with names and values encoded properly for use in a URL. Values that are arrays
+ * will produce multiple values with the same name.
+ * @example
+ * const str = Cesium.objectToQuery({
+ * key1 : 'some value',
+ * key2 : 'a/b',
+ * key3 : ['x', 'y']
+ * });
+ * @param obj - The object containing data to encode.
+ * @returns An encoded query string.
+ */
+export function objectToQuery(obj: any): string;
+
/**
* Creates an Occluder derived from an object's position and radius, as well as the camera position.
* The occluder can be used to determine whether or not other objects are visible or hidden behind the
@@ -12619,6 +12922,23 @@ export class PlaneOutlineGeometry {
static createGeometry(): Geometry | undefined;
}
+/**
+ * Determines if a point is inside a triangle.
+ * @example
+ * // Returns true
+ * const p = new Cesium.Cartesian2(0.25, 0.25);
+ * const b = Cesium.pointInsideTriangle(p,
+ * new Cesium.Cartesian2(0.0, 0.0),
+ * new Cesium.Cartesian2(1.0, 0.0),
+ * new Cesium.Cartesian2(0.0, 1.0));
+ * @param point - The point to test.
+ * @param p0 - The first point of the triangle.
+ * @param p1 - The second point of the triangle.
+ * @param p2 - The third point of the triangle.
+ * @returns true if the point is inside the triangle; otherwise, false.
+ */
+export function pointInsideTriangle(point: Cartesian2 | Cartesian3, p0: Cartesian2 | Cartesian3, p1: Cartesian2 | Cartesian3, p2: Cartesian2 | Cartesian3): boolean;
+
/**
* A description of a polygon on the ellipsoid. The polygon is defined by a polygon hierarchy. Polygon geometry can be rendered with both {@link Primitive} and {@link GroundPrimitive}.
* @example
@@ -13790,6 +14110,23 @@ export class QuaternionSpline {
evaluate(time: number, result?: Quaternion): Quaternion;
}
+/**
+ * Parses a query string into an object, where the keys and values of the object are the
+ * name/value pairs from the query string, decoded. If a name appears multiple times,
+ * the value in the object will be an array of values.
+ * @example
+ * const obj = Cesium.queryToObject('key1=some%20value&key2=a%2Fb&key3=x&key3=y');
+ * // obj will be:
+ * // {
+ * // key1 : 'some value',
+ * // key2 : 'a/b',
+ * // key3 : ['x', 'y']
+ * // }
+ * @param queryString - The query string.
+ * @returns An object containing the parameters parsed from the query string.
+ */
+export function queryToObject(queryString: string): any;
+
/**
* A queue that can enqueue items at the end, and dequeue items from the front.
*/
@@ -14386,6 +14723,28 @@ export namespace Request {
type PriorityCallback = () => number;
}
+/**
+ * A browser-independent function to request a new animation frame. This is used to create
+ * an application's draw loop as shown in the example below.
+ * @example
+ * // Create a draw loop using requestAnimationFrame. The
+ * // tick callback function is called for every animation frame.
+ * function tick() {
+ * scene.render();
+ * Cesium.requestAnimationFrame(tick);
+ * }
+ * tick();
+ * @param callback - The function to call when the next frame should be drawn.
+ * @returns An ID that can be passed to {@link cancelAnimationFrame} to cancel the request.
+ */
+export function requestAnimationFrame(callback: requestAnimationFrameCallback): number;
+
+/**
+ * A function that will be called when the next frame should be drawn.
+ * @param timestamp - A timestamp for the frame, in milliseconds.
+ */
+export type requestAnimationFrameCallback = (timestamp: number) => void;
+
/**
* An event that is raised when a request encounters an error.
* @param [statusCode] - The HTTP error status code, such as 404.
@@ -15388,6 +15747,59 @@ export class RuntimeError extends Error {
readonly stack: string;
}
+/**
+ * Initiates a terrain height query for an array of {@link Cartographic} positions by
+ * requesting tiles from a terrain provider, sampling, and interpolating. The interpolation
+ * matches the triangles used to render the terrain at the specified level. The query
+ * happens asynchronously, so this function returns a promise that is resolved when
+ * the query completes. Each point height is modified in place. If a height can not be
+ * determined because no terrain data is available for the specified level at that location,
+ * or another error occurs, the height is set to undefined. As is typical of the
+ * {@link Cartographic} type, the supplied height is a height above the reference ellipsoid
+ * (such as {@link Ellipsoid.WGS84}) rather than an altitude above mean sea level. In other
+ * words, it will not necessarily be 0.0 if sampled in the ocean. This function needs the
+ * terrain level of detail as input, if you need to get the altitude of the terrain as precisely
+ * as possible (i.e. with maximum level of detail) use {@link sampleTerrainMostDetailed}.
+ * @example
+ * // Query the terrain height of two Cartographic positions
+ * const terrainProvider = Cesium.createWorldTerrain();
+ * const positions = [
+ * Cesium.Cartographic.fromDegrees(86.925145, 27.988257),
+ * Cesium.Cartographic.fromDegrees(87.0, 28.0)
+ * ];
+ * const promise = Cesium.sampleTerrain(terrainProvider, 11, positions);
+ * Promise.resolve(promise).then(function(updatedPositions) {
+ * // positions[0].height and positions[1].height have been updated.
+ * // updatedPositions is just a reference to positions.
+ * });
+ * @param terrainProvider - The terrain provider from which to query heights.
+ * @param level - The terrain level-of-detail from which to query terrain heights.
+ * @param positions - The positions to update with terrain heights.
+ * @returns A promise that resolves to the provided list of positions when terrain the query has completed.
+ */
+export function sampleTerrain(terrainProvider: TerrainProvider, level: number, positions: Cartographic[]): PromiseitemToFind in the array, if it exists. If itemToFind
- * does not exist, the return value is a negative number which is the bitwise complement (~)
- * of the index before which the itemToFind should be inserted in order to maintain the
- * sorted order of the array.
- */
-export function binarySearch(array: any[], itemToFind: any, comparator: binarySearchComparator): number;
-
-/**
- * A function used to compare two items while performing a binary search.
- * @example
- * function compareNumbers(a, b) {
- * return a - b;
- * }
- * @param a - An item in the array.
- * @param b - The item being searched for.
- */
-export type binarySearchComparator = (a: any, b: any) => number;
-
-/**
- * Given a relative URL under the Cesium base URL, returns an absolute URL.
- * @example
- * const viewer = new Cesium.Viewer("cesiumContainer", {
- * imageryProvider: new Cesium.TileMapServiceImageryProvider({
- * url: Cesium.buildModuleUrl("Assets/Textures/NaturalEarthII"),
- * }),
- * baseLayerPicker: false,
- * });
- * @param relativeUrl - The relative path.
- * @returns The absolutely URL representation of the provided path.
- */
-export function buildModuleUrl(relativeUrl: string): string;
-
-/**
- * A browser-independent function to cancel an animation frame requested using {@link requestAnimationFrame}.
- * @param requestID - The value returned by {@link requestAnimationFrame}.
- */
-export function cancelAnimationFrame(requestID: number): void;
-
-/**
- * Clones an object, returning a new object containing the same properties.
- * @param object - The object to clone.
- * @param [deep = false] - If true, all properties will be deep cloned recursively.
- * @returns The cloned object.
- */
-export function clone(object: any, deep?: boolean): any;
-
-/**
- * Merges two objects, copying their properties onto a new combined object. When two objects have the same
- * property, the value of the property on the first object is used. If either object is undefined,
- * it will be treated as an empty object.
- * @example
- * const object1 = {
- * propOne : 1,
- * propTwo : {
- * value1 : 10
- * }
- * }
- * const object2 = {
- * propTwo : 2
- * }
- * const final = Cesium.combine(object1, object2);
- *
- * // final === {
- * // propOne : 1,
- * // propTwo : {
- * // value1 : 10
- * // }
- * // }
- * @param [object1] - The first object to merge.
- * @param [object2] - The second object to merge.
- * @param [deep = false] - Perform a recursive merge.
- * @returns The combined object containing all properties from both objects.
- */
-export function combine(object1?: any, object2?: any, deep?: boolean): any;
-
-/**
- * Creates a Globally unique identifier (GUID) string. A GUID is 128 bits long, and can guarantee uniqueness across space and time.
- * @example
- * this.guid = Cesium.createGuid();
- */
-export function createGuid(): string;
-
-/**
- * Creates a {@link CesiumTerrainProvider} instance for the {@link https://cesium.com/content/#cesium-world-terrain|Cesium World Terrain}.
- * @example
- * // Create Cesium World Terrain with default settings
- * const viewer = new Cesium.Viewer('cesiumContainer', {
- * terrainProvider : Cesium.createWorldTerrain();
- * });
- * @example
- * // Create Cesium World Terrain with water and normals.
- * const viewer1 = new Cesium.Viewer('cesiumContainer', {
- * terrainProvider : Cesium.createWorldTerrain({
- * requestWaterMask : true,
- * requestVertexNormals : true
- * });
- * });
+ * Writes the given text into a new canvas. The canvas will be sized to fit the text.
+ * If text is blank, returns undefined.
+ * @param text - The text to write.
* @param [options] - Object with the following properties:
- * @param [options.requestVertexNormals = false] - Flag that indicates if the client should request additional lighting information from the server if available.
- * @param [options.requestWaterMask = false] - Flag that indicates if the client should request per tile water masks from the server if available.
- */
-export function createWorldTerrain(options?: {
- requestVertexNormals?: boolean;
- requestWaterMask?: boolean;
-}): CesiumTerrainProvider;
-
-/**
- * Returns the first parameter if not undefined, otherwise the second parameter.
- * Useful for setting a default value for a parameter.
- * @example
- * param = Cesium.defaultValue(param, 'default');
- * @returns Returns the first parameter if not undefined, otherwise the second parameter.
- */
-export function defaultValue(a: any, b: any): any;
-
-/**
- * @example
- * if (Cesium.defined(positions)) {
- * doSomething();
- * } else {
- * doSomethingElse();
- * }
- * @param value - The object.
- * @returns Returns true if the object is defined, returns false otherwise.
- */
-export function defined(value: any): boolean;
-
-/**
- * Destroys an object. Each of the object's functions, including functions in its prototype,
- * is replaced with a function that throws a {@link DeveloperError}, except for the object's
- * isDestroyed function, which is set to a function that returns true.
- * The object's properties are removed with delete.
- * - * This function is used by objects that hold native resources, e.g., WebGL resources, which - * need to be explicitly released. Client code calls an object's
destroy function,
- * which then releases the native resource and calls destroyObject to put itself
- * in a destroyed state.
- * @example
- * // How a texture would destroy itself.
- * this.destroy = function () {
- * _gl.deleteTexture(_texture);
- * return Cesium.destroyObject(this);
- * };
- * @param object - The object to destroy.
- * @param [message] - The message to include in the exception that is thrown if
- * a destroyed object's function is called.
+ * @param [options.font = '10px sans-serif'] - The CSS font to use.
+ * @param [options.textBaseline = 'bottom'] - The baseline of the text.
+ * @param [options.fill = true] - Whether to fill the text.
+ * @param [options.stroke = false] - Whether to stroke the text.
+ * @param [options.fillColor = Color.WHITE] - The fill color.
+ * @param [options.strokeColor = Color.BLACK] - The stroke color.
+ * @param [options.strokeWidth = 1] - The stroke width.
+ * @param [options.backgroundColor = Color.TRANSPARENT] - The background color of the canvas.
+ * @param [options.padding = 0] - The pixel size of the padding to add around the text.
+ * @returns A new canvas with the given text drawn into it. The dimensions object
+ * from measureText will also be added to the returned canvas. If text is
+ * blank, returns undefined.
*/
-export function destroyObject(object: any, message?: string): void;
+export function writeTextToCanvas(text: string, options?: {
+ font?: string;
+ textBaseline?: string;
+ fill?: boolean;
+ stroke?: boolean;
+ fillColor?: Color;
+ strokeColor?: Color;
+ strokeWidth?: number;
+ backgroundColor?: Color;
+ padding?: number;
+}): HTMLCanvasElement | undefined;
-/**
- * Formats an error object into a String. If available, uses name, message, and stack
- * properties, otherwise, falls back on toString().
- * @param object - The item to find in the array.
- * @returns A string containing the formatted error.
- */
-export function formatError(object: any): string;
+export namespace BillboardGraphics {
+ /**
+ * Initialization options for the BillboardGraphics constructor
+ * @property [show = true] - A boolean Property specifying the visibility of the billboard.
+ * @property [image] - A Property specifying the Image, URI, or Canvas to use for the billboard.
+ * @property [scale = 1.0] - A numeric Property specifying the scale to apply to the image size.
+ * @property [pixelOffset = Cartesian2.ZERO] - A {@link Cartesian2} Property specifying the pixel offset.
+ * @property [eyeOffset = Cartesian3.ZERO] - A {@link Cartesian3} Property specifying the eye offset.
+ * @property [horizontalOrigin = HorizontalOrigin.CENTER] - A Property specifying the {@link HorizontalOrigin}.
+ * @property [verticalOrigin = VerticalOrigin.CENTER] - A Property specifying the {@link VerticalOrigin}.
+ * @property [heightReference = HeightReference.NONE] - A Property specifying what the height is relative to.
+ * @property [color = Color.WHITE] - A Property specifying the tint {@link Color} of the image.
+ * @property [rotation = 0] - A numeric Property specifying the rotation about the alignedAxis.
+ * @property [alignedAxis = Cartesian3.ZERO] - A {@link Cartesian3} Property specifying the unit vector axis of rotation.
+ * @property [sizeInMeters] - A boolean Property specifying whether this billboard's size should be measured in meters.
+ * @property [width] - A numeric Property specifying the width of the billboard in pixels, overriding the native size.
+ * @property [height] - A numeric Property specifying the height of the billboard in pixels, overriding the native size.
+ * @property [scaleByDistance] - A {@link NearFarScalar} Property used to scale the point based on distance from the camera.
+ * @property [translucencyByDistance] - A {@link NearFarScalar} Property used to set translucency based on distance from the camera.
+ * @property [pixelOffsetScaleByDistance] - A {@link NearFarScalar} Property used to set pixelOffset based on distance from the camera.
+ * @property [imageSubRegion] - A Property specifying a {@link BoundingRectangle} that defines a sub-region of the image to use for the billboard, rather than the entire image, measured in pixels from the bottom-left.
+ * @property [distanceDisplayCondition] - A Property specifying at what distance from the camera that this billboard will be displayed.
+ * @property [disableDepthTestDistance] - A Property specifying the distance from the camera at which to disable the depth test to.
+ */
+ type ConstructorOptions = {
+ show?: Property | boolean;
+ image?: Property | string | HTMLCanvasElement;
+ scale?: Property | number;
+ pixelOffset?: Property | Cartesian2;
+ eyeOffset?: Property | Cartesian3;
+ horizontalOrigin?: Property | HorizontalOrigin;
+ verticalOrigin?: Property | VerticalOrigin;
+ heightReference?: Property | HeightReference;
+ color?: Property | Color;
+ rotation?: Property | number;
+ alignedAxis?: Property | Cartesian3;
+ sizeInMeters?: Property | boolean;
+ width?: Property | number;
+ height?: Property | number;
+ scaleByDistance?: Property | NearFarScalar;
+ translucencyByDistance?: Property | NearFarScalar;
+ pixelOffsetScaleByDistance?: Property | NearFarScalar;
+ imageSubRegion?: Property | BoundingRectangle;
+ distanceDisplayCondition?: Property | DistanceDisplayCondition;
+ disableDepthTestDistance?: Property | number;
+ };
+}
/**
- * Given a relative Uri and a base Uri, returns the absolute Uri of the relative Uri.
- * @example
- * //absolute Uri will be "https://test.com/awesome.png";
- * const absoluteUri = Cesium.getAbsoluteUri('awesome.png', 'https://test.com');
- * @param relative - The relative Uri.
- * @param [base] - The base Uri.
- * @returns The absolute Uri of the given relative Uri.
- */
-export function getAbsoluteUri(relative: string, base?: string): string;
-
-/**
- * Given a URI, returns the base path of the URI.
- * @example
- * // basePath will be "/Gallery/";
- * const basePath = Cesium.getBaseUri('/Gallery/simple.czml?value=true&example=false');
- *
- * // basePath will be "/Gallery/?value=true&example=false";
- * const basePath = Cesium.getBaseUri('/Gallery/simple.czml?value=true&example=false', true);
- * @param uri - The Uri.
- * @param [includeQuery = false] - Whether or not to include the query string and fragment form the uri
- * @returns The base path of the Uri.
- */
-export function getBaseUri(uri: string, includeQuery?: boolean): string;
-
-/**
- * Given a URI, returns the extension of the URI.
- * @example
- * //extension will be "czml";
- * const extension = Cesium.getExtensionFromUri('/Gallery/simple.czml?value=true&example=false');
- * @param uri - The Uri.
- * @returns The extension of the Uri.
- */
-export function getExtensionFromUri(uri: string): string;
-
-/**
- * Given a URI, returns the last segment of the URI, removing any path or query information.
- * @example
- * //fileName will be"simple.czml";
- * const fileName = Cesium.getFilenameFromUri('/Gallery/simple.czml?value=true&example=false');
- * @param uri - The Uri.
- * @returns The last segment of the Uri.
- */
-export function getFilenameFromUri(uri: string): string;
-
-/**
- * Extract a pixel array from a loaded image. Draws the image
- * into a canvas so it can read the pixels back.
- * @param image - The image to extract pixels from.
- * @param width - The width of the image. If not defined, then image.width is assigned.
- * @param height - The height of the image. If not defined, then image.height is assigned.
- * @returns The pixels of the image.
- */
-export function getImagePixels(image: HTMLImageElement | ImageBitmap, width: number, height: number): ImageData;
-
-/**
- * Gets a timestamp that can be used in measuring the time between events. Timestamps
- * are expressed in milliseconds, but it is not specified what the milliseconds are
- * measured from. This function uses performance.now() if it is available, or Date.now()
- * otherwise.
- * @returns The timestamp in milliseconds since some unspecified reference time.
- */
-export function getTimestamp(): number;
-
-/**
- * Determines if a given date is a leap year.
- * @example
- * const leapYear = Cesium.isLeapYear(2000); // true
- * @param year - The year to be tested.
- * @returns True if year is a leap year.
- */
-export function isLeapYear(year: number): boolean;
-
-/**
- * A stable merge sort.
- * @example
- * // Assume array contains BoundingSpheres in world coordinates.
- * // Sort them in ascending order of distance from the camera.
- * const position = camera.positionWC;
- * Cesium.mergeSort(array, function(a, b, position) {
- * return Cesium.BoundingSphere.distanceSquaredTo(b, position) - Cesium.BoundingSphere.distanceSquaredTo(a, position);
- * }, position);
- * @param array - The array to sort.
- * @param comparator - The function to use to compare elements in the array.
- * @param [userDefinedObject] - Any item to pass as the third parameter to comparator.
- */
-export function mergeSort(array: any[], comparator: mergeSortComparator, userDefinedObject?: any): void;
-
-/**
- * A function used to compare two items while performing a merge sort.
- * @example
- * function compareNumbers(a, b, userDefinedObject) {
- * return a - b;
- * }
- * @param a - An item in the array.
- * @param b - An item in the array.
- * @param [userDefinedObject] - An object that was passed to {@link mergeSort}.
- */
-export type mergeSortComparator = (a: any, b: any, userDefinedObject?: any) => number;
-
-/**
- * Converts an object representing a set of name/value pairs into a query string,
- * with names and values encoded properly for use in a URL. Values that are arrays
- * will produce multiple values with the same name.
- * @example
- * const str = Cesium.objectToQuery({
- * key1 : 'some value',
- * key2 : 'a/b',
- * key3 : ['x', 'y']
- * });
- * @param obj - The object containing data to encode.
- * @returns An encoded query string.
- */
-export function objectToQuery(obj: any): string;
-
-/**
- * Determines if a point is inside a triangle.
- * @example
- * // Returns true
- * const p = new Cesium.Cartesian2(0.25, 0.25);
- * const b = Cesium.pointInsideTriangle(p,
- * new Cesium.Cartesian2(0.0, 0.0),
- * new Cesium.Cartesian2(1.0, 0.0),
- * new Cesium.Cartesian2(0.0, 1.0));
- * @param point - The point to test.
- * @param p0 - The first point of the triangle.
- * @param p1 - The second point of the triangle.
- * @param p2 - The third point of the triangle.
- * @returns true if the point is inside the triangle; otherwise, false.
- */
-export function pointInsideTriangle(point: Cartesian2 | Cartesian3, p0: Cartesian2 | Cartesian3, p1: Cartesian2 | Cartesian3, p2: Cartesian2 | Cartesian3): boolean;
-
-/**
- * Parses a query string into an object, where the keys and values of the object are the
- * name/value pairs from the query string, decoded. If a name appears multiple times,
- * the value in the object will be an array of values.
- * @example
- * const obj = Cesium.queryToObject('key1=some%20value&key2=a%2Fb&key3=x&key3=y');
- * // obj will be:
- * // {
- * // key1 : 'some value',
- * // key2 : 'a/b',
- * // key3 : ['x', 'y']
- * // }
- * @param queryString - The query string.
- * @returns An object containing the parameters parsed from the query string.
- */
-export function queryToObject(queryString: string): any;
-
-/**
- * A browser-independent function to request a new animation frame. This is used to create
- * an application's draw loop as shown in the example below.
- * @example
- * // Create a draw loop using requestAnimationFrame. The
- * // tick callback function is called for every animation frame.
- * function tick() {
- * scene.render();
- * Cesium.requestAnimationFrame(tick);
- * }
- * tick();
- * @param callback - The function to call when the next frame should be drawn.
- * @returns An ID that can be passed to {@link cancelAnimationFrame} to cancel the request.
- */
-export function requestAnimationFrame(callback: requestAnimationFrameCallback): number;
-
-/**
- * A function that will be called when the next frame should be drawn.
- * @param timestamp - A timestamp for the frame, in milliseconds.
- */
-export type requestAnimationFrameCallback = (timestamp: number) => void;
-
-/**
- * Initiates a terrain height query for an array of {@link Cartographic} positions by
- * requesting tiles from a terrain provider, sampling, and interpolating. The interpolation
- * matches the triangles used to render the terrain at the specified level. The query
- * happens asynchronously, so this function returns a promise that is resolved when
- * the query completes. Each point height is modified in place. If a height can not be
- * determined because no terrain data is available for the specified level at that location,
- * or another error occurs, the height is set to undefined. As is typical of the
- * {@link Cartographic} type, the supplied height is a height above the reference ellipsoid
- * (such as {@link Ellipsoid.WGS84}) rather than an altitude above mean sea level. In other
- * words, it will not necessarily be 0.0 if sampled in the ocean. This function needs the
- * terrain level of detail as input, if you need to get the altitude of the terrain as precisely
- * as possible (i.e. with maximum level of detail) use {@link sampleTerrainMostDetailed}.
- * @example
- * // Query the terrain height of two Cartographic positions
- * const terrainProvider = Cesium.createWorldTerrain();
- * const positions = [
- * Cesium.Cartographic.fromDegrees(86.925145, 27.988257),
- * Cesium.Cartographic.fromDegrees(87.0, 28.0)
- * ];
- * const promise = Cesium.sampleTerrain(terrainProvider, 11, positions);
- * Promise.resolve(promise).then(function(updatedPositions) {
- * // positions[0].height and positions[1].height have been updated.
- * // updatedPositions is just a reference to positions.
- * });
- * @param terrainProvider - The terrain provider from which to query heights.
- * @param level - The terrain level-of-detail from which to query terrain heights.
- * @param positions - The positions to update with terrain heights.
- * @returns A promise that resolves to the provided list of positions when terrain the query has completed.
- */
-export function sampleTerrain(terrainProvider: TerrainProvider, level: number, positions: Cartographic[]): Promise- *
- * 
- * Example billboards - *
- *
- * @param [options] - Object describing initialization options
+ * Describes a two dimensional icon located at the position of the containing {@link Entity}.
+ * - * Example billboards - *
+ *
+ *
+ * Example billboards + *
+ *
+ * @param [options] - Object describing initialization options
*/
export class BillboardGraphics {
constructor(options?: BillboardGraphics.ConstructorOptions);
@@ -20969,6 +20998,76 @@ export class EntityView {
update(time: JulianDate, boundingSphere?: BoundingSphere): void;
}
+/**
+ * @property kml - The generated KML.
+ * @property externalFiles - An object dictionary of external files
+ */
+export type exportKmlResultKml = {
+ kml: string;
+ externalFiles: {
+ [key: string]: Blob;
+ };
+};
+
+/**
+ * @property kmz - The generated kmz file.
+ */
+export type exportKmlResultKmz = {
+ kmz: Blob;
+};
+
+/**
+ * Exports an EntityCollection as a KML document. Only Point, Billboard, Model, Path, Polygon, Polyline geometries
+ * will be exported. Note that there is not a 1 to 1 mapping of Entity properties to KML Feature properties. For
+ * example, entity properties that are time dynamic but cannot be dynamic in KML are exported with their values at
+ * options.time or the beginning of the EntityCollection's time interval if not specified. For time-dynamic properties
+ * that are supported in KML, we use the samples if it is a {@link SampledProperty} otherwise we sample the value using
+ * the options.sampleDuration. Point, Billboard, Model and Path geometries with time-dynamic positions will be exported
+ * as gx:Track Features. Not all Materials are representable in KML, so for more advanced Materials just the primary
+ * color is used. Canvas objects are exported as PNG images.
+ * @example
+ * Cesium.exportKml({
+ * entities: entityCollection
+ * })
+ * .then(function(result) {
+ * // The XML string is in result.kml
+ *
+ * const externalFiles = result.externalFiles
+ * for(const file in externalFiles) {
+ * // file is the name of the file used in the KML document as the href
+ * // externalFiles[file] is a blob with the contents of the file
+ * }
+ * });
+ * @param options - An object with the following properties:
+ * @param options.entities - The EntityCollection to export as KML.
+ * @param [options.ellipsoid = Ellipsoid.WGS84] - The ellipsoid for the output file.
+ * @param [options.modelCallback] - A callback that will be called with a {@link ModelGraphics} instance and should return the URI to use in the KML. Required if a model exists in the entity collection.
+ * @param [options.time = entities.computeAvailability().start] - The time value to use to get properties that are not time varying in KML.
+ * @param [options.defaultAvailability = entities.computeAvailability()] - The interval that will be sampled if an entity doesn't have an availability.
+ * @param [options.sampleDuration = 60] - The number of seconds to sample properties that are varying in KML.
+ * @param [options.kmz = false] - If true KML and external files will be compressed into a kmz file.
+ * @returns A promise that resolved to an object containing the KML string and a dictionary of external file blobs, or a kmz file as a blob if options.kmz is true.
+ */
+export function exportKml(options: {
+ entities: EntityCollection;
+ ellipsoid?: Ellipsoid;
+ modelCallback?: exportKmlModelCallback;
+ time?: JulianDate;
+ defaultAvailability?: TimeInterval;
+ sampleDuration?: number;
+ kmz?: boolean;
+}): Promise+ * Example billboards + *
externalFiles object, which is the list of files embedded in the exported KMZ,
+ * or otherwise returned with the KML string when exporting.
+ * @param model - The ModelGraphics instance for an Entity.
+ * @param time - The time that any properties should use to get the value.
+ * @param externalFiles - An object that maps a filename to a Blob or a Promise that resolves to a Blob.
+ */
+export type exportKmlModelCallback = (model: ModelGraphics, time: JulianDate, externalFiles: any) => string;
+
export namespace GeoJsonDataSource {
/**
* Initialization options for the load method.
@@ -24922,76 +25021,6 @@ export class WallGraphics {
merge(source: WallGraphics): void;
}
-/**
- * @property kml - The generated KML.
- * @property externalFiles - An object dictionary of external files
- */
-export type exportKmlResultKml = {
- kml: string;
- externalFiles: {
- [key: string]: Blob;
- };
-};
-
-/**
- * @property kmz - The generated kmz file.
- */
-export type exportKmlResultKmz = {
- kmz: Blob;
-};
-
-/**
- * Exports an EntityCollection as a KML document. Only Point, Billboard, Model, Path, Polygon, Polyline geometries
- * will be exported. Note that there is not a 1 to 1 mapping of Entity properties to KML Feature properties. For
- * example, entity properties that are time dynamic but cannot be dynamic in KML are exported with their values at
- * options.time or the beginning of the EntityCollection's time interval if not specified. For time-dynamic properties
- * that are supported in KML, we use the samples if it is a {@link SampledProperty} otherwise we sample the value using
- * the options.sampleDuration. Point, Billboard, Model and Path geometries with time-dynamic positions will be exported
- * as gx:Track Features. Not all Materials are representable in KML, so for more advanced Materials just the primary
- * color is used. Canvas objects are exported as PNG images.
- * @example
- * Cesium.exportKml({
- * entities: entityCollection
- * })
- * .then(function(result) {
- * // The XML string is in result.kml
- *
- * const externalFiles = result.externalFiles
- * for(const file in externalFiles) {
- * // file is the name of the file used in the KML document as the href
- * // externalFiles[file] is a blob with the contents of the file
- * }
- * });
- * @param options - An object with the following properties:
- * @param options.entities - The EntityCollection to export as KML.
- * @param [options.ellipsoid = Ellipsoid.WGS84] - The ellipsoid for the output file.
- * @param [options.modelCallback] - A callback that will be called with a {@link ModelGraphics} instance and should return the URI to use in the KML. Required if a model exists in the entity collection.
- * @param [options.time = entities.computeAvailability().start] - The time value to use to get properties that are not time varying in KML.
- * @param [options.defaultAvailability = entities.computeAvailability()] - The interval that will be sampled if an entity doesn't have an availability.
- * @param [options.sampleDuration = 60] - The number of seconds to sample properties that are varying in KML.
- * @param [options.kmz = false] - If true KML and external files will be compressed into a kmz file.
- * @returns A promise that resolved to an object containing the KML string and a dictionary of external file blobs, or a kmz file as a blob if options.kmz is true.
- */
-export function exportKml(options: {
- entities: EntityCollection;
- ellipsoid?: Ellipsoid;
- modelCallback?: exportKmlModelCallback;
- time?: JulianDate;
- defaultAvailability?: TimeInterval;
- sampleDuration?: number;
- kmz?: boolean;
-}): PromiseexternalFiles object, which is the list of files embedded in the exported KMZ,
- * or otherwise returned with the KML string when exporting.
- * @param model - The ModelGraphics instance for an Entity.
- * @param time - The time that any properties should use to get the value.
- * @param externalFiles - An object that maps a filename to a Blob or a Promise that resolves to a Blob.
- */
-export type exportKmlModelCallback = (model: ModelGraphics, time: JulianDate, externalFiles: any) => string;
-
/**
* The data type of a pixel.
*/
@@ -26287,24 +26316,6 @@ export enum BlendFunction {
SOURCE_ALPHA_SATURATE = WebGLConstants.SRC_ALPHA_SATURATE
}
-/**
- * Determines how opaque and translucent parts of billboards, points, and labels are blended with the scene.
- */
-export enum BlendOption {
- /**
- * The billboards, points, or labels in the collection are completely opaque.
- */
- OPAQUE = 0,
- /**
- * The billboards, points, or labels in the collection are completely translucent.
- */
- TRANSLUCENT = 1,
- /**
- * The billboards, points, or labels in the collection are both opaque and translucent.
- */
- OPAQUE_AND_TRANSLUCENT = 2
-}
-
/**
* The blending state combines {@link BlendEquation} and {@link BlendFunction} and the
* enabled flag to define the full blending state for combining source and
@@ -26332,6 +26343,24 @@ export namespace BlendingState {
const ADDITIVE_BLEND: any;
}
+/**
+ * Determines how opaque and translucent parts of billboards, points, and labels are blended with the scene.
+ */
+export enum BlendOption {
+ /**
+ * The billboards, points, or labels in the collection are completely opaque.
+ */
+ OPAQUE = 0,
+ /**
+ * The billboards, points, or labels in the collection are completely translucent.
+ */
+ TRANSLUCENT = 1,
+ /**
+ * The billboards, points, or labels in the collection are both opaque and translucent.
+ */
+ OPAQUE_AND_TRANSLUCENT = 2
+}
+
/**
* A ParticleEmitter that emits particles within a box.
* Particles will be positioned randomly within the box and have initial velocities emanating from the center of the box.
@@ -27704,1560 +27733,1574 @@ export class Cesium3DTilePointFeature {
}
/**
- * A style that is applied to a {@link Cesium3DTileset}.
- * - * Evaluates an expression defined using the - * {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language}. - *
+ * A {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification|3D Tiles tileset}, + * used for streaming massive heterogeneous 3D geospatial datasets. * @example - * tileset.style = new Cesium.Cesium3DTileStyle({ - * color : { - * conditions : [ - * ['${Height} >= 100', 'color("purple", 0.5)'], - * ['${Height} >= 50', 'color("red")'], - * ['true', 'color("blue")'] - * ] - * }, - * show : '${Height} > 0', - * meta : { - * description : '"Building id ${id} has height ${Height}."' - * } - * }); + * const tileset = scene.primitives.add(new Cesium.Cesium3DTileset({ + * url : 'http://localhost:8002/tilesets/Seattle/tileset.json' + * })); * @example - * tileset.style = new Cesium.Cesium3DTileStyle({ - * color : 'vec4(${Temperature})', - * pointSize : '${Temperature} * 2.0' - * }); - * @param [style] - An object defining a style. + * // Common setting for the skipLevelOfDetail optimization + * const tileset = scene.primitives.add(new Cesium.Cesium3DTileset({ + * url : 'http://localhost:8002/tilesets/Seattle/tileset.json', + * skipLevelOfDetail : true, + * baseScreenSpaceError : 1024, + * skipScreenSpaceErrorFactor : 16, + * skipLevels : 1, + * immediatelyLoadDesiredLevelOfDetail : false, + * loadSiblings : false, + * cullWithChildrenBounds : true + * })); + * @example + * // Common settings for the dynamicScreenSpaceError optimization + * const tileset = scene.primitives.add(new Cesium.Cesium3DTileset({ + * url : 'http://localhost:8002/tilesets/Seattle/tileset.json', + * dynamicScreenSpaceError : true, + * dynamicScreenSpaceErrorDensity : 0.00278, + * dynamicScreenSpaceErrorFactor : 4.0, + * dynamicScreenSpaceErrorHeightFalloff : 0.25 + * })); + * @param options - Object with the following properties: + * @param options.url - The url to a tileset JSON file. + * @param [options.show = true] - Determines if the tileset will be shown. + * @param [options.modelMatrix = Matrix4.IDENTITY] - A 4x4 transformation matrix that transforms the tileset's root tile. + * @param [options.modelUpAxis = Axis.Y] - Which axis is considered up when loading models for tile contents. + * @param [options.modelForwardAxis = Axis.X] - Which axis is considered forward when loading models for tile contents. + * @param [options.shadows = ShadowMode.ENABLED] - Determines whether the tileset casts or receives shadows from light sources. + * @param [options.maximumScreenSpaceError = 16] - The maximum screen space error used to drive level of detail refinement. + * @param [options.maximumMemoryUsage = 512] - The maximum amount of memory in MB that can be used by the tileset. + * @param [options.cullWithChildrenBounds = true] - Optimization option. Whether to cull tiles using the union of their children bounding volumes. + * @param [options.cullRequestsWhileMoving = true] - Optimization option. Don't request tiles that will likely be unused when they come back because of the camera's movement. This optimization only applies to stationary tilesets. + * @param [options.cullRequestsWhileMovingMultiplier = 60.0] - Optimization option. Multiplier used in culling requests while moving. Larger is more aggressive culling, smaller less aggressive culling. + * @param [options.preloadWhenHidden = false] - Preload tiles whentileset.show is false. Loads tiles as if the tileset is visible but does not render them.
+ * @param [options.preloadFlightDestinations = true] - Optimization option. Preload tiles at the camera's flight destination while the camera is in flight.
+ * @param [options.preferLeaves = false] - Optimization option. Prefer loading of leaves first.
+ * @param [options.dynamicScreenSpaceError = false] - Optimization option. Reduce the screen space error for tiles that are further away from the camera.
+ * @param [options.dynamicScreenSpaceErrorDensity = 0.00278] - Density used to adjust the dynamic screen space error, similar to fog density.
+ * @param [options.dynamicScreenSpaceErrorFactor = 4.0] - A factor used to increase the computed dynamic screen space error.
+ * @param [options.dynamicScreenSpaceErrorHeightFalloff = 0.25] - A ratio of the tileset's height at which the density starts to falloff.
+ * @param [options.progressiveResolutionHeightFraction = 0.3] - Optimization option. If between (0.0, 0.5], tiles at or above the screen space error for the reduced screen resolution of progressiveResolutionHeightFraction*screenHeight will be prioritized first. This can help get a quick layer of tiles down while full resolution tiles continue to load.
+ * @param [options.foveatedScreenSpaceError = true] - Optimization option. Prioritize loading tiles in the center of the screen by temporarily raising the screen space error for tiles around the edge of the screen. Screen space error returns to normal once all the tiles in the center of the screen as determined by the {@link Cesium3DTileset#foveatedConeSize} are loaded.
+ * @param [options.foveatedConeSize = 0.1] - Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control the cone size that determines which tiles are deferred. Tiles that are inside this cone are loaded immediately. Tiles outside the cone are potentially deferred based on how far outside the cone they are and their screen space error. This is controlled by {@link Cesium3DTileset#foveatedInterpolationCallback} and {@link Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation}. Setting this to 0.0 means the cone will be the line formed by the camera position and its view direction. Setting this to 1.0 means the cone encompasses the entire field of view of the camera, disabling the effect.
+ * @param [options.foveatedMinimumScreenSpaceErrorRelaxation = 0.0] - Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control the starting screen space error relaxation for tiles outside the foveated cone. The screen space error will be raised starting with tileset value up to {@link Cesium3DTileset#maximumScreenSpaceError} based on the provided {@link Cesium3DTileset#foveatedInterpolationCallback}.
+ * @param [options.foveatedInterpolationCallback = Math.lerp] - Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control how much to raise the screen space error for tiles outside the foveated cone, interpolating between {@link Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation} and {@link Cesium3DTileset#maximumScreenSpaceError}
+ * @param [options.foveatedTimeDelay = 0.2] - Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control how long in seconds to wait after the camera stops moving before deferred tiles start loading in. This time delay prevents requesting tiles around the edges of the screen when the camera is moving. Setting this to 0.0 will immediately request all tiles in any given view.
+ * @param [options.skipLevelOfDetail = false] - Optimization option. Determines if level of detail skipping should be applied during the traversal.
+ * @param [options.baseScreenSpaceError = 1024] - When skipLevelOfDetail is true, the screen space error that must be reached before skipping levels of detail.
+ * @param [options.skipScreenSpaceErrorFactor = 16] - When skipLevelOfDetail is true, a multiplier defining the minimum screen space error to skip. Used in conjunction with skipLevels to determine which tiles to load.
+ * @param [options.skipLevels = 1] - When skipLevelOfDetail is true, a constant defining the minimum number of levels to skip when loading tiles. When it is 0, no levels are skipped. Used in conjunction with skipScreenSpaceErrorFactor to determine which tiles to load.
+ * @param [options.immediatelyLoadDesiredLevelOfDetail = false] - When skipLevelOfDetail is true, only tiles that meet the maximum screen space error will ever be downloaded. Skipping factors are ignored and just the desired tiles are loaded.
+ * @param [options.loadSiblings = false] - When skipLevelOfDetail is true, determines whether siblings of visible tiles are always downloaded during traversal.
+ * @param [options.clippingPlanes] - The {@link ClippingPlaneCollection} used to selectively disable rendering the tileset.
+ * @param [options.classificationType] - Determines whether terrain, 3D Tiles or both will be classified by this tileset. See {@link Cesium3DTileset#classificationType} for details about restrictions and limitations.
+ * @param [options.ellipsoid = Ellipsoid.WGS84] - The ellipsoid determining the size and shape of the globe.
+ * @param [options.pointCloudShading] - Options for constructing a {@link PointCloudShading} object to control point attenuation based on geometric error and lighting.
+ * @param [options.lightColor] - The light color when shading models. When undefined the scene's light color is used instead.
+ * @param [options.imageBasedLighting] - The properties for managing image-based lighting for this tileset.
+ * @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.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.
+ * @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.outlineColor = Color.BLACK] - The color to use when rendering outlines.
+ * @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.featureIdLabel = "featureId_0"] - Label of the feature ID set to use for picking and styling. For EXT_mesh_features, this is the feature ID's label property, or "featureId_N" (where N is the index in the featureIds array) when not specified. EXT_feature_metadata did not have a label field, so such feature ID sets are always labeled "featureId_N" where N is the index in the list of all feature Ids, where feature ID attributes are listed before feature ID textures. If featureIdLabel is an integer N, it is converted to the string "featureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
+ * @param [options.instanceFeatureIdLabel = "instanceFeatureId_0"] - Label of the instance feature ID set used for picking and styling. If instanceFeatureIdLabel is set to an integer N, it is converted to the string "instanceFeatureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
+ * @param [options.showCreditsOnScreen = false] - Whether to display the credits of this tileset on screen.
+ * @param [options.splitDirection = SplitDirection.NONE] - The {@link SplitDirection} split to apply to this tileset.
+ * @param [options.projectTo2D = false] - Whether to accurately project the tileset to 2D. If this is true, the tileset will be projected accurately to 2D, but it will use more memory to do so. If this is false, the tileset will use less memory and will still render in 2D / CV mode, but its projected positions may be inaccurate. This cannot be set after the tileset has loaded.
+ * @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.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.enableDebugWireframe] - For debugging only. This must be true for debugWireframe to work for ModelExperimental in WebGL1. This cannot be set after the tileset has loaded.
+ * @param [options.debugWireframe = false] - For debugging only. When true, render's each tile's content as a wireframe.
+ * @param [options.debugShowBoundingVolume = false] - For debugging only. When true, renders the bounding volume for each tile.
+ * @param [options.debugShowContentBoundingVolume = false] - For debugging only. When true, renders the bounding volume for each tile's content.
+ * @param [options.debugShowViewerRequestVolume = false] - For debugging only. When true, renders the viewer request volume for each tile.
+ * @param [options.debugShowGeometricError = false] - For debugging only. When true, draws labels to indicate the geometric error of each tile.
+ * @param [options.debugShowRenderingStatistics = false] - For debugging only. When true, draws labels to indicate the number of commands, points, triangles and features for each tile.
+ * @param [options.debugShowMemoryUsage = false] - For debugging only. When true, draws labels to indicate the texture and geometry memory in megabytes used by each tile.
+ * @param [options.debugShowUrl = false] - For debugging only. When true, draws labels to indicate the url of each tile.
*/
-export class Cesium3DTileStyle {
- constructor(style?: any);
+export class Cesium3DTileset {
+ constructor(options: {
+ url: Resource | string | Promisetrue, the style is ready and its expressions can be evaluated. When
- * a style is constructed with an object, as opposed to a url, this is true immediately.
+ * Optimization option. Multiplier used in culling requests while moving. Larger is more aggressive culling, smaller less aggressive culling.
*/
- readonly ready: boolean;
+ cullRequestsWhileMovingMultiplier: number;
/**
- * Gets the promise that will be resolved when the the style is ready and its expressions can be evaluated.
+ * Optimization option. If between (0.0, 0.5], tiles at or above the screen space error for the reduced screen resolution of progressiveResolutionHeightFraction*screenHeight will be prioritized first. This can help get a quick layer of tiles down while full resolution tiles continue to load.
*/
- readonly readyPromise: Promiseshow property. Alternatively a boolean, string, or object defining a show style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * Optimization option. Prefer loading of leaves first.
+ */
+ preferLeaves: boolean;
+ /**
+ * Preload tiles when tileset.show is false. Loads tiles as if the tileset is visible but does not render them.
+ */
+ preloadWhenHidden: boolean;
+ /**
+ * Optimization option. Fetch tiles at the camera's flight destination while the camera is in flight.
+ */
+ preloadFlightDestinations: boolean;
+ /**
+ * Optimization option. Whether the tileset should refine based on a dynamic screen space error. Tiles that are further
+ * away will be rendered with lower detail than closer tiles. This improves performance by rendering fewer
+ * tiles and making less requests, but may result in a slight drop in visual quality for tiles in the distance.
+ * The algorithm is biased towards "street views" where the camera is close to the ground plane of the tileset and looking
+ * at the horizon. In addition results are more accurate for tightly fitting bounding volumes like box and region.
+ */
+ dynamicScreenSpaceError: boolean;
+ /**
+ * Optimization option. Prioritize loading tiles in the center of the screen by temporarily raising the
+ * screen space error for tiles around the edge of the screen. Screen space error returns to normal once all
+ * the tiles in the center of the screen as determined by the {@link Cesium3DTileset#foveatedConeSize} are loaded.
+ */
+ foveatedScreenSpaceError: boolean;
+ /**
+ * Gets or sets a callback to control how much to raise the screen space error for tiles outside the foveated cone,
+ * interpolating between {@link Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation} and {@link Cesium3DTileset#maximumScreenSpaceError}.
+ */
+ foveatedInterpolationCallback: Cesium3DTileset.foveatedInterpolationCallback;
+ /**
+ * Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control
+ * how long in seconds to wait after the camera stops moving before deferred tiles start loading in.
+ * This time delay prevents requesting tiles around the edges of the screen when the camera is moving.
+ * Setting this to 0.0 will immediately request all tiles in any given view.
+ */
+ foveatedTimeDelay: number;
+ /**
+ * A scalar that determines the density used to adjust the dynamic screen space error, similar to {@link Fog}. Increasing this
+ * value has the effect of increasing the maximum screen space error for all tiles, but in a non-linear fashion.
+ * The error starts at 0.0 and increases exponentially until a midpoint is reached, and then approaches 1.0 asymptotically.
+ * This has the effect of keeping high detail in the closer tiles and lower detail in the further tiles, with all tiles
+ * beyond a certain distance all roughly having an error of 1.0.
*
- * The expression must return or convert to a Boolean.
+ * The dynamic error is in the range [0.0, 1.0) and is multiplied by dynamicScreenSpaceErrorFactor to produce the
+ * final dynamic error. This dynamic error is then subtracted from the tile's actual screen space error.
*
- * This expression is applicable to all tile formats.
+ * Increasing dynamicScreenSpaceErrorDensity has the effect of moving the error midpoint closer to the camera.
+ * It is analogous to moving fog closer to the camera.
*
color property. Alternatively a string or object defining a color style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
- *
- * The expression must return a Color.
- *
- * This expression is applicable to all tile formats. + * Valid values are between 0.0 and 1.0. *
- * @example - * const style = new Cesium3DTileStyle({ - * color : '(${Temperature} > 90) ? color("red") : color("white")' - * }); - * style.color.evaluateColor(feature, result); // returns a Cesium.Color object - * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override color expression with a custom function - * style.color = { - * evaluateColor : function(feature, result) { - * return Cesium.Color.clone(Cesium.Color.WHITE, result); - * } - * }; - * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override color expression with a string - * style.color = 'color("blue")'; - * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override color expression with a condition - * style.color = { - * conditions : [ - * ['${height} > 2', 'color("cyan")'], - * ['true', 'color("blue")'] - * ] - * }; */ - color: StyleExpression; + dynamicScreenSpaceErrorHeightFalloff: number; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'spointSize property. Alternatively a string or object defining a point size style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * Determines whether the tileset casts or receives shadows from light sources.
*
- * The expression must return a Number.
+ * Enabling shadows has a performance impact. A tileset that casts shadows must be rendered twice, once from the camera and again from the light's point of view.
*
- * This expression is only applicable to point features in a Vector tile or a Point Cloud tile.
+ * Shadows are rendered only when {@link Viewer#shadows} is true.
*
pointOutlineColor property. Alternatively a string or object defining a color style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * Determines if the tileset will be shown.
+ */
+ show: boolean;
+ /**
+ * Defines how per-feature colors set from the Cesium API or declarative styling blend with the source colors from
+ * the original feature, e.g. glTF material or per-point color in the tile.
+ */
+ colorBlendMode: Cesium3DTileColorBlendMode;
+ /**
+ * Defines the value used to linearly interpolate between the source color and feature color when the {@link Cesium3DTileset#colorBlendMode} is MIX.
+ * A value of 0.0 results in the source color while a value of 1.0 results in the feature color, with any value in-between
+ * resulting in a mix of the source color and feature color.
+ */
+ colorBlendAmount: number;
+ /**
+ * The event fired to indicate progress of loading new tiles. This event is fired when a new tile
+ * is requested, when a requested tile is finished downloading, and when a downloaded tile has been
+ * processed and is ready to render.
*
- * The expression must return a Color.
+ * The number of pending tile requests, numberOfPendingRequests, and number of tiles
+ * processing, numberOfTilesProcessing are passed to the event listener.
*
- * This expression is only applicable to point features in a Vector tile. + * This event is fired at the end of the frame after the scene is rendered. *
* @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override pointOutlineColor expression with a string - * style.pointOutlineColor = 'color("blue")'; - * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override pointOutlineColor expression with a condition - * style.pointOutlineColor = { - * conditions : [ - * ['${height} > 2', 'color("cyan")'], - * ['true', 'color("blue")'] - * ] - * }; + * tileset.loadProgress.addEventListener(function(numberOfPendingRequests, numberOfTilesProcessing) { + * if ((numberOfPendingRequests === 0) && (numberOfTilesProcessing === 0)) { + * console.log('Stopped loading'); + * return; + * } + * + * console.log(`Loading: requests: ${numberOfPendingRequests}, processing: ${numberOfTilesProcessing}`); + * }); */ - pointOutlineColor: StyleExpression; + loadProgress: Event; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'spointOutlineWidth property. Alternatively a string or object defining a number style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
- *
- * The expression must return a Number.
- *
- * This expression is only applicable to point features in a Vector tile. + * This event is fired at the end of the frame after the scene is rendered. *
* @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override pointOutlineWidth expression with a string - * style.pointOutlineWidth = '5'; - * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override pointOutlineWidth expression with a condition - * style.pointOutlineWidth = { - * conditions : [ - * ['${height} > 2', '5'], - * ['true', '0'] - * ] - * }; + * tileset.allTilesLoaded.addEventListener(function() { + * console.log('All tiles are loaded'); + * }); */ - pointOutlineWidth: StyleExpression; + allTilesLoaded: Event; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'slabelColor property. Alternatively a string or object defining a color style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
- *
- * The expression must return a Color.
- *
- * This expression is only applicable to point features in a Vector tile. + * This event is fired at the end of the frame after the scene is rendered. *
* @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override labelColor expression with a string - * style.labelColor = 'color("blue")'; - * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override labelColor expression with a condition - * style.labelColor = { - * conditions : [ - * ['${height} > 2', 'color("cyan")'], - * ['true', 'color("blue")'] - * ] - * }; + * tileset.initialTilesLoaded.addEventListener(function() { + * console.log('Initial tiles are loaded'); + * }); */ - labelColor: StyleExpression; + initialTilesLoaded: Event; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'slabelOutlineColor property. Alternatively a string or object defining a color style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * The event fired to indicate that a tile's content was loaded.
*
- * The expression must return a Color.
+ * The loaded {@link Cesium3DTile} is passed to the event listener.
*
- * This expression is only applicable to point features in a Vector tile. + * This event is fired during the tileset traversal while the frame is being rendered + * so that updates to the tile take effect in the same frame. Do not create or modify + * Cesium entities or primitives during the event listener. *
* @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override labelOutlineColor expression with a string - * style.labelOutlineColor = 'color("blue")'; - * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override labelOutlineColor expression with a condition - * style.labelOutlineColor = { - * conditions : [ - * ['${height} > 2', 'color("cyan")'], - * ['true', 'color("blue")'] - * ] - * }; + * tileset.tileLoad.addEventListener(function(tile) { + * console.log('A tile was loaded.'); + * }); */ - labelOutlineColor: StyleExpression; + tileLoad: Event; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'slabelOutlineWidth property. Alternatively a string or object defining a number style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * The event fired to indicate that a tile's content was unloaded.
*
- * The expression must return a Number.
+ * The unloaded {@link Cesium3DTile} is passed to the event listener.
*
- * This expression is only applicable to point features in a Vector tile. + * This event is fired immediately before the tile's content is unloaded while the frame is being + * rendered so that the event listener has access to the tile's content. Do not create + * or modify Cesium entities or primitives during the event listener. *
* @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override labelOutlineWidth expression with a string - * style.labelOutlineWidth = '5'; - * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override labelOutlineWidth expression with a condition - * style.labelOutlineWidth = { - * conditions : [ - * ['${height} > 2', '5'], - * ['true', '0'] - * ] - * }; + * tileset.tileUnload.addEventListener(function(tile) { + * console.log('A tile was unloaded from the cache.'); + * }); */ - labelOutlineWidth: StyleExpression; + tileUnload: Event; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'sfont property. Alternatively a string or object defining a string style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * The event fired to indicate that a tile's content failed to load.
*
- * The expression must return a String.
+ * If there are no event listeners, error messages will be logged to the console.
*
- * This expression is only applicable to point features in a Vector tile. + * The error object passed to the listener contains two properties: + *
-
+ *
url: the url of the failed tile.
+ * message: the error message.
+ *
+ * If multiple contents are present, this event is raised once per inner content with errors. *
* @example - * const style = new Cesium3DTileStyle({ - * font : '(${Temperature} > 90) ? "30px Helvetica" : "24px Helvetica"' + * tileset.tileFailed.addEventListener(function(error) { + * console.log(`An error occurred loading tile: ${error.url}`); + * console.log(`Error: ${error.message}`); * }); - * style.font.evaluate(feature); // returns a String - * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override font expression with a custom function - * style.font = { - * evaluate : function(feature) { - * return '24px Helvetica'; - * } - * }; */ - font: StyleExpression; + tileFailed: Event; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'slabel style property. Alternatively a string or object defining a number style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * This event fires once for each visible tile in a frame. This can be used to manually
+ * style a tileset.
*
- * The expression must return a LabelStyle.
+ * The visible {@link Cesium3DTile} is passed to the event listener.
*
- * This expression is only applicable to point features in a Vector tile. + * This event is fired during the tileset traversal while the frame is being rendered + * so that updates to the tile take effect in the same frame. Do not create or modify + * Cesium entities or primitives during the event listener. *
* @example - * const style = new Cesium3DTileStyle({ - * labelStyle : `(\${Temperature} > 90) ? ${LabelStyle.FILL_AND_OUTLINE} : ${LabelStyle.FILL}` + * tileset.tileVisible.addEventListener(function(tile) { + * if (tile.content instanceof Cesium.Batched3DModel3DTileContent) { + * console.log('A Batched 3D Model tile is visible.'); + * } * }); - * style.labelStyle.evaluate(feature); // returns a LabelStyle * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override labelStyle expression with a custom function - * style.labelStyle = { - * evaluate : function(feature) { - * return LabelStyle.FILL; + * // Apply a red style and then manually set random colors for every other feature when the tile becomes visible. + * tileset.style = new Cesium.Cesium3DTileStyle({ + * color : 'color("red")' + * }); + * tileset.tileVisible.addEventListener(function(tile) { + * const content = tile.content; + * const featuresLength = content.featuresLength; + * for (let i = 0; i < featuresLength; i+=2) { + * content.getFeature(i).color = Cesium.Color.fromRandom(); * } - * }; + * }); */ - labelStyle: StyleExpression; + tileVisible: Event; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'slabelText property. Alternatively a string or object defining a string style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * Optimization option. Determines if level of detail skipping should be applied during the traversal.
*
- * The expression must return a String.
+ * The common strategy for replacement-refinement traversal is to store all levels of the tree in memory and require
+ * all children to be loaded before the parent can refine. With this optimization levels of the tree can be skipped
+ * entirely and children can be rendered alongside their parents. The tileset requires significantly less memory when
+ * using this optimization.
*
- * This expression is only applicable to point features in a Vector tile.
+ * Only used when {@link Cesium3DTileset#skipLevelOfDetail} is true.
*
backgroundColor property. Alternatively a string or object defining a color style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * Multiplier defining the minimum screen space error to skip.
+ * For example, if a tile has screen space error of 100, no tiles will be loaded unless they
+ * are leaves or have a screen space error <= 100 / skipScreenSpaceErrorFactor.
*
- * The expression must return a Color.
+ * Only used when {@link Cesium3DTileset#skipLevelOfDetail} is true.
*
- * This expression is only applicable to point features in a Vector tile.
+ * Only used when {@link Cesium3DTileset#skipLevelOfDetail} is true.
*
backgroundPadding property. Alternatively a string or object defining a vec2 style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * When true, only tiles that meet the maximum screen space error will ever be downloaded.
+ * Skipping factors are ignored and just the desired tiles are loaded.
*
- * The expression must return a Cartesian2.
+ * Only used when {@link Cesium3DTileset#skipLevelOfDetail} is true.
*
- * This expression is only applicable to point features in a Vector tile.
+ * Only used when {@link Cesium3DTileset#skipLevelOfDetail} is true.
*
backgroundEnabled property. Alternatively a string or object defining a boolean style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * The light color when shading models. When undefined the scene's light color is used instead.
*
- * The expression must return a Boolean.
+ * For example, disabling additional light sources by setting
+ * tileset.imageBasedLighting.imageBasedLightingFactor = new Cartesian2(0.0, 0.0)
+ * will make the tileset much darker. Here, increasing the intensity of the light source will make the tileset brighter.
*
- * This expression is only applicable to point features in a Vector tile. + * When enableModelExperimental is set to true, this property can be toggled + * at runtime. However, when enableModelExperimental is false, this property + * is readonly (it can only be set in the constructor). *
- * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override backgroundEnabled expression with a string - * style.backgroundEnabled = 'true'; - * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override backgroundEnabled expression with a condition - * style.backgroundEnabled = { - * conditions : [ - * ['${height} > 2', 'true'], - * ['true', 'false'] - * ] - * }; */ - backgroundEnabled: StyleExpression; + showOutline: boolean; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'sscaleByDistance property. Alternatively a string or object defining a vec4 style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * The color to use when rendering outlines. This option is only used
+ * when enableModelExperimental is set to true.
+ */
+ outlineColor: Color;
+ /**
+ * The {@link SplitDirection} to apply to this tileset.
+ */
+ splitDirection: SplitDirection;
+ /**
+ * This property is for debugging only; it is not optimized for production use.
*
- * The expression must return a Cartesian4.
+ * Determines if only the tiles from last frame should be used for rendering. This
+ * effectively "freezes" the tileset to the previous frame so it is possible to zoom
+ * out and see what was rendered.
*
- * This expression is only applicable to point features in a Vector tile. + * When true, assigns a random color to each tile. This is useful for visualizing + * what features belong to what tiles, especially with additive refinement where features + * from parent tiles may be interleaved with features from child tiles. *
- * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override scaleByDistance expression with a string - * style.scaleByDistance = 'vec4(1.5e2, 2.0, 1.5e7, 0.5)'; - * style.scaleByDistance.evaluate(feature); // returns a Cartesian4 */ - scaleByDistance: StyleExpression; + debugColorizeTiles: boolean; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'stranslucencyByDistance property. Alternatively a string or object defining a vec4 style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * This property is for debugging only; it is not optimized for production use.
*
- * The expression must return a Cartesian4.
+ * When true, renders each tile's content as a wireframe.
*
- * This expression is only applicable to point features in a Vector tile. + * When true, renders the bounding volume for each visible tile. The bounding volume is + * white if the tile has a content bounding volume or is empty; otherwise, it is red. Tiles that don't meet the + * screen space error and are still refining to their descendants are yellow. *
- * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override translucencyByDistance expression with a string - * style.translucencyByDistance = 'vec4(1.5e2, 1.0, 1.5e7, 0.2)'; - * style.translucencyByDistance.evaluate(feature); // returns a Cartesian4 */ - translucencyByDistance: StyleExpression; + debugShowBoundingVolume: boolean; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'sdistanceDisplayCondition property. Alternatively a string or object defining a vec2 style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * This property is for debugging only; it is not optimized for production use.
*
- * The expression must return a Cartesian2.
+ * When true, renders the bounding volume for each visible tile's content. The bounding volume is
+ * blue if the tile has a content bounding volume; otherwise it is red.
*
- * This expression is only applicable to point features in a Vector tile. + * When true, renders the viewer request volume for each tile. *
- * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override distanceDisplayCondition expression with a string - * style.distanceDisplayCondition = 'vec2(0.0, 5.5e6)'; - * style.distanceDisplayCondition.evaluate(feature); // returns a Cartesian2 */ - distanceDisplayCondition: StyleExpression; + debugShowViewerRequestVolume: boolean; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'sheightOffset property. Alternatively a string or object defining a number style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * This property is for debugging only; it is not optimized for production use.
*
- * The expression must return a Number.
+ * When true, draws labels to indicate the geometric error of each tile.
*
- * This expression is only applicable to point features in a Vector tile. + * When true, draws labels to indicate the number of commands, points, triangles and features of each tile. *
- * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override heightOffset expression with a string - * style.heightOffset = '2.0'; - * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override heightOffset expression with a condition - * style.heightOffset = { - * conditions : [ - * ['${height} > 2', '4.0'], - * ['true', '2.0'] - * ] - * }; */ - heightOffset: StyleExpression; + debugShowRenderingStatistics: boolean; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'sanchorLineEnabled property. Alternatively a string or object defining a boolean style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * This property is for debugging only; it is not optimized for production use.
*
- * The expression must return a Boolean.
+ * When true, draws labels to indicate the geometry and texture memory usage of each tile.
*
- * This expression is only applicable to point features in a Vector tile. + * When true, draws labels to indicate the url of each tile. *
- * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override anchorLineEnabled expression with a string - * style.anchorLineEnabled = 'true'; - * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override anchorLineEnabled expression with a condition - * style.anchorLineEnabled = { - * conditions : [ - * ['${height} > 2', 'true'], - * ['true', 'false'] - * ] - * }; */ - anchorLineEnabled: StyleExpression; + debugShowUrl: boolean; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'sanchorLineColor property. Alternatively a string or object defining a color style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * 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.
*
- * The expression must return a Color.
+ * 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.
*
- * This expression is only applicable to point features in a Vector tile. + * 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. *
* @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override anchorLineColor expression with a string - * style.anchorLineColor = 'color("blue")'; - * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override anchorLineColor expression with a condition - * style.anchorLineColor = { - * conditions : [ - * ['${height} > 2', 'color("cyan")'], - * ['true', 'color("blue")'] - * ] - * }; + * console.log(`Maximum building height: ${tileset.properties.height.maximum}`); + * console.log(`Minimum building height: ${tileset.properties.height.minimum}`); */ - anchorLineColor: StyleExpression; + readonly properties: any; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'simage property. Alternatively a string or object defining a string style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * When true, the tileset's root tile is loaded and the tileset is ready to render.
+ * This is set to true right before {@link Cesium3DTileset#readyPromise} is resolved.
+ */
+ readonly ready: boolean;
+ /**
+ * Gets the promise that will be resolved when the tileset's root tile is loaded and the tileset is ready to render.
*
- * The expression must return a String.
+ * This promise is resolved at the end of the frame before the first frame the tileset is rendered in.
*
- * This expression is only applicable to point features in a Vector tile. - *
- * @example - * const style = new Cesium3DTileStyle({ - * image : '(${Temperature} > 90) ? "/url/to/image1" : "/url/to/image2"' - * }); - * style.image.evaluate(feature); // returns a String * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override image expression with a custom function - * style.image = { - * evaluate : function(feature) { - * return '/url/to/image'; + * tileset.readyPromise.then(function(tileset) { + * // tile.properties is not defined until readyPromise resolves. + * const properties = tileset.properties; + * if (Cesium.defined(properties)) { + * for (const name in properties) { + * console.log(properties[name]); + * } * } - * }; + * }); */ - image: StyleExpression; + readonly readyPromise: PromisedisableDepthTestDistance property. Alternatively a string or object defining a number style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
- *
- * The expression must return a Number.
- *
- * This expression is only applicable to point features in a Vector tile. - *
- * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override disableDepthTestDistance expression with a string - * style.disableDepthTestDistance = '1000.0'; - * style.disableDepthTestDistance.evaluate(feature); // returns a Number + * Whentrue, all tiles that meet the screen space error this frame are loaded. The tileset is
+ * completely loaded for this view.
*/
- disableDepthTestDistance: StyleExpression;
+ readonly tilesLoaded: boolean;
/**
- * Gets or sets the {@link StyleExpression} object used to evaluate the style's horizontalOrigin property. Alternatively a string or object defining a number style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * The resource used to fetch the tileset JSON file
+ */
+ readonly resource: Resource;
+ /**
+ * The base path that non-absolute paths in tileset JSON file are relative to.
+ */
+ readonly basePath: string;
+ /**
+ * The style, defined using the
+ * {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language},
+ * applied to each feature in the tileset.
*
- * The expression must return a HorizontalOrigin.
+ * Assign undefined to remove the style, which will restore the visual
+ * appearance of the tileset to its default when no style was applied.
*
- * This expression is only applicable to point features in a Vector tile.
+ * The style is applied to a tile before the {@link Cesium3DTileset#tileVisible}
+ * event is raised, so code in tileVisible 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.
+ *
+ * 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. *
* @example - * const style = new Cesium3DTileStyle({ - * horizontalOrigin : HorizontalOrigin.LEFT + * tileset.style = new Cesium.Cesium3DTileStyle({ + * color : { + * conditions : [ + * ['${Height} >= 100', 'color("purple", 0.5)'], + * ['${Height} >= 50', 'color("red")'], + * ['true', 'color("blue")'] + * ] + * }, + * show : '${Height} > 0', + * meta : { + * description : '"Building id ${id} has height ${Height}."' + * } * }); - * style.horizontalOrigin.evaluate(feature); // returns a HorizontalOrigin - * @example - * const style = new Cesium.Cesium3DTileStyle(); - * // Override horizontalOrigin expression with a custom function - * style.horizontalOrigin = { - * evaluate : function(feature) { - * return HorizontalOrigin.CENTER; - * } - * }; */ - horizontalOrigin: StyleExpression; + style: Cesium3DTileStyle | undefined; /** - * Gets or sets the {@link StyleExpression} object used to evaluate the style'sverticalOrigin property. Alternatively a string or object defining a number style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
- *
- * The expression must return a VerticalOrigin.
- *
- * This expression is only applicable to point features in a Vector tile.
+ * To enable {@link ModelExperimental}, set {@link ExperimentalFeatures.enableModelExperimental} or tileset.enableModelExperimental to true.
*
labelHorizontalOrigin property. Alternatively a string or object defining a number style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * The maximum screen space error used to drive level of detail refinement. This value helps determine when a tile
+ * refines to its descendants, and therefore plays a major role in balancing performance with visual quality.
*
- * The expression must return a HorizontalOrigin.
+ * A tile's screen space error is roughly equivalent to the number of pixels wide that would be drawn if a sphere with a
+ * radius equal to the tile's geometric error were rendered at the tile's position. If this value exceeds
+ * maximumScreenSpaceError the tile refines to its descendants.
*
- * This expression is only applicable to point features in a Vector tile.
+ * Depending on the tileset, maximumScreenSpaceError may need to be tweaked to achieve the right balance.
+ * Higher values provide better performance but lower visual quality.
*
labelVerticalOrigin property. Alternatively a string or object defining a number style can be used.
- * The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
+ * The maximum amount of GPU memory (in MB) that may be used to cache tiles. This value is estimated from
+ * geometry, textures, and batch table textures of loaded tiles. For point clouds, this value also
+ * includes per-point metadata.
*
- * The expression must return a VerticalOrigin.
+ * Tiles not in view are unloaded to enforce this.
*
- * This expression is only applicable to point features in a Vector tile. + * If decreasing this value results in unloading tiles, the tiles are unloaded the next frame. *
+ *
+ * If tiles sized more than maximumMemoryUsage are needed
+ * to meet the desired screen space error, determined by {@link Cesium3DTileset#maximumScreenSpaceError},
+ * for the current view, then the memory usage of the tiles loaded will exceed
+ * maximumMemoryUsage. For example, if the maximum is 256 MB, but
+ * 300 MB of tiles are needed to meet the screen space error, then 300 MB of tiles may be loaded. When
+ * these tiles go out of view, they will be unloaded.
+ *
tileset.show is false. Loads tiles as if the tileset is visible but does not render them.
- * @param [options.preloadFlightDestinations = true] - Optimization option. Preload tiles at the camera's flight destination while the camera is in flight.
- * @param [options.preferLeaves = false] - Optimization option. Prefer loading of leaves first.
- * @param [options.dynamicScreenSpaceError = false] - Optimization option. Reduce the screen space error for tiles that are further away from the camera.
- * @param [options.dynamicScreenSpaceErrorDensity = 0.00278] - Density used to adjust the dynamic screen space error, similar to fog density.
- * @param [options.dynamicScreenSpaceErrorFactor = 4.0] - A factor used to increase the computed dynamic screen space error.
- * @param [options.dynamicScreenSpaceErrorHeightFalloff = 0.25] - A ratio of the tileset's height at which the density starts to falloff.
- * @param [options.progressiveResolutionHeightFraction = 0.3] - Optimization option. If between (0.0, 0.5], tiles at or above the screen space error for the reduced screen resolution of progressiveResolutionHeightFraction*screenHeight will be prioritized first. This can help get a quick layer of tiles down while full resolution tiles continue to load.
- * @param [options.foveatedScreenSpaceError = true] - Optimization option. Prioritize loading tiles in the center of the screen by temporarily raising the screen space error for tiles around the edge of the screen. Screen space error returns to normal once all the tiles in the center of the screen as determined by the {@link Cesium3DTileset#foveatedConeSize} are loaded.
- * @param [options.foveatedConeSize = 0.1] - Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control the cone size that determines which tiles are deferred. Tiles that are inside this cone are loaded immediately. Tiles outside the cone are potentially deferred based on how far outside the cone they are and their screen space error. This is controlled by {@link Cesium3DTileset#foveatedInterpolationCallback} and {@link Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation}. Setting this to 0.0 means the cone will be the line formed by the camera position and its view direction. Setting this to 1.0 means the cone encompasses the entire field of view of the camera, disabling the effect.
- * @param [options.foveatedMinimumScreenSpaceErrorRelaxation = 0.0] - Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control the starting screen space error relaxation for tiles outside the foveated cone. The screen space error will be raised starting with tileset value up to {@link Cesium3DTileset#maximumScreenSpaceError} based on the provided {@link Cesium3DTileset#foveatedInterpolationCallback}.
- * @param [options.foveatedInterpolationCallback = Math.lerp] - Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control how much to raise the screen space error for tiles outside the foveated cone, interpolating between {@link Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation} and {@link Cesium3DTileset#maximumScreenSpaceError}
- * @param [options.foveatedTimeDelay = 0.2] - Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control how long in seconds to wait after the camera stops moving before deferred tiles start loading in. This time delay prevents requesting tiles around the edges of the screen when the camera is moving. Setting this to 0.0 will immediately request all tiles in any given view.
- * @param [options.skipLevelOfDetail = false] - Optimization option. Determines if level of detail skipping should be applied during the traversal.
- * @param [options.baseScreenSpaceError = 1024] - When skipLevelOfDetail is true, the screen space error that must be reached before skipping levels of detail.
- * @param [options.skipScreenSpaceErrorFactor = 16] - When skipLevelOfDetail is true, a multiplier defining the minimum screen space error to skip. Used in conjunction with skipLevels to determine which tiles to load.
- * @param [options.skipLevels = 1] - When skipLevelOfDetail is true, a constant defining the minimum number of levels to skip when loading tiles. When it is 0, no levels are skipped. Used in conjunction with skipScreenSpaceErrorFactor to determine which tiles to load.
- * @param [options.immediatelyLoadDesiredLevelOfDetail = false] - When skipLevelOfDetail is true, only tiles that meet the maximum screen space error will ever be downloaded. Skipping factors are ignored and just the desired tiles are loaded.
- * @param [options.loadSiblings = false] - When skipLevelOfDetail is true, determines whether siblings of visible tiles are always downloaded during traversal.
- * @param [options.clippingPlanes] - The {@link ClippingPlaneCollection} used to selectively disable rendering the tileset.
- * @param [options.classificationType] - Determines whether terrain, 3D Tiles or both will be classified by this tileset. See {@link Cesium3DTileset#classificationType} for details about restrictions and limitations.
- * @param [options.ellipsoid = Ellipsoid.WGS84] - The ellipsoid determining the size and shape of the globe.
- * @param [options.pointCloudShading] - Options for constructing a {@link PointCloudShading} object to control point attenuation based on geometric error and lighting.
- * @param [options.lightColor] - The light color when shading models. When undefined the scene's light color is used instead.
- * @param [options.imageBasedLighting] - The properties for managing image-based lighting for this tileset.
- * @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.featureIdLabel = "featureId_0"] - Label of the feature ID set to use for picking and styling. For EXT_mesh_features, this is the feature ID's label property, or "featureId_N" (where N is the index in the featureIds array) when not specified. EXT_feature_metadata did not have a label field, so such feature ID sets are always labeled "featureId_N" where N is the index in the list of all feature Ids, where feature ID attributes are listed before feature ID textures. If featureIdLabel is an integer N, it is converted to the string "featureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
- * @param [options.instanceFeatureIdLabel = "instanceFeatureId_0"] - Label of the instance feature ID set used for picking and styling. If instanceFeatureIdLabel is set to an integer N, it is converted to the string "instanceFeatureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
- * @param [options.showCreditsOnScreen = false] - Whether to display the credits of this tileset on screen.
- * @param [options.splitDirection = SplitDirection.NONE] - The {@link SplitDirection} split to apply to this tileset.
- * @param [options.projectTo2D = false] - Whether to accurately project the tileset to 2D. If this is true, the tileset will be projected accurately to 2D, but it will use more memory to do so. If this is false, the tileset will use less memory and will still render in 2D / CV mode, but its projected positions may be inaccurate. This cannot be set after the tileset has loaded.
- * @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.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.enableDebugWireframe] - For debugging only. This must be true for debugWireframe to work for ModelExperimental in WebGL1. This cannot be set after the tileset has loaded.
- * @param [options.debugWireframe = false] - For debugging only. When true, render's each tile's content as a wireframe.
- * @param [options.debugShowBoundingVolume = false] - For debugging only. When true, renders the bounding volume for each tile.
- * @param [options.debugShowContentBoundingVolume = false] - For debugging only. When true, renders the bounding volume for each tile's content.
- * @param [options.debugShowViewerRequestVolume = false] - For debugging only. When true, renders the viewer request volume for each tile.
- * @param [options.debugShowGeometricError = false] - For debugging only. When true, draws labels to indicate the geometric error of each tile.
- * @param [options.debugShowRenderingStatistics = false] - For debugging only. When true, draws labels to indicate the number of commands, points, triangles and features for each tile.
- * @param [options.debugShowMemoryUsage = false] - For debugging only. When true, draws labels to indicate the texture and geometry memory in megabytes used by each tile.
- * @param [options.debugShowUrl = false] - For debugging only. When true, draws labels to indicate the url of each tile.
- */
-export class Cesium3DTileset {
- constructor(options: {
- url: Resource | string | PromiseprogressiveResolutionHeightFraction*screenHeight will be prioritized first. This can help get a quick layer of tiles down while full resolution tiles continue to load.
+ * Determines whether terrain, 3D Tiles or both will be classified by this tileset.
+ * + * This option is only applied to tilesets containing batched 3D models, geometry data, or vector data. Even when undefined, vector data and geometry data + * must render as classifications and will default to rendering on both terrain and other 3D Tiles tilesets. + *
+ *+ * When enabled for batched 3D model tilesets, there are a few requirements/limitations on the glTF: + *
-
+ *
- POSITION and _BATCHID semantics are required. + *
- All indices with the same batch id must occupy contiguous sections of the index buffer. + *
- All shaders and techniques are ignored. The generated shader simply multiplies the position by the model-view-projection matrix. + *
- The only supported extensions are CESIUM_RTC and WEB3D_quantized_attributes. + *
- Only one node is supported. + *
- Only one mesh per node is supported. + *
- Only one primitive per mesh is supported. + *
tileset.show is false. Loads tiles as if the tileset is visible but does not render them.
+ * Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control the cone size that determines which tiles are deferred.
+ * Tiles that are inside this cone are loaded immediately. Tiles outside the cone are potentially deferred based on how far outside the cone they are and {@link Cesium3DTileset#foveatedInterpolationCallback} and {@link Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation}.
+ * Setting this to 0.0 means the cone will be the line formed by the camera position and its view direction. Setting this to 1.0 means the cone encompasses the entire field of view of the camera, essentially disabling the effect.
*/
- preloadWhenHidden: boolean;
+ foveatedConeSize: number;
/**
- * Optimization option. Fetch tiles at the camera's flight destination while the camera is in flight.
+ * Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control the starting screen space error relaxation for tiles outside the foveated cone.
+ * The screen space error will be raised starting with this value up to {@link Cesium3DTileset#maximumScreenSpaceError} based on the provided {@link Cesium3DTileset#foveatedInterpolationCallback}.
*/
- preloadFlightDestinations: boolean;
+ foveatedMinimumScreenSpaceErrorRelaxation: number;
/**
- * Optimization option. Whether the tileset should refine based on a dynamic screen space error. Tiles that are further
- * away will be rendered with lower detail than closer tiles. This improves performance by rendering fewer
- * tiles and making less requests, but may result in a slight drop in visual quality for tiles in the distance.
- * The algorithm is biased towards "street views" where the camera is close to the ground plane of the tileset and looking
- * at the horizon. In addition results are more accurate for tightly fitting bounding volumes like box and region.
+ * Returns the extras property at the top-level of the tileset JSON, which contains application specific metadata.
+ * Returns undefined if extras does not exist.
*/
- dynamicScreenSpaceError: boolean;
+ readonly extras: any;
/**
- * Optimization option. Prioritize loading tiles in the center of the screen by temporarily raising the
- * screen space error for tiles around the edge of the screen. Screen space error returns to normal once all
- * the tiles in the center of the screen as determined by the {@link Cesium3DTileset#foveatedConeSize} are loaded.
+ * The properties for managing image-based lighting on this tileset.
*/
- foveatedScreenSpaceError: boolean;
+ imageBasedLighting: ImageBasedLighting;
/**
- * Gets or sets a callback to control how much to raise the screen space error for tiles outside the foveated cone,
- * interpolating between {@link Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation} and {@link Cesium3DTileset#maximumScreenSpaceError}.
+ * Indicates that only the tileset's vector tiles should be used for classification.
*/
- foveatedInterpolationCallback: Cesium3DTileset.foveatedInterpolationCallback;
+ vectorClassificationOnly: boolean;
/**
- * Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control
- * how long in seconds to wait after the camera stops moving before deferred tiles start loading in.
- * This time delay prevents requesting tiles around the edges of the screen when the camera is moving.
- * Setting this to 0.0 will immediately request all tiles in any given view.
+ * Whether vector tiles should keep decoded positions in memory.
+ * This is used with {@link Cesium3DTileFeature.getPolylinePositions}.
*/
- foveatedTimeDelay: number;
+ vectorKeepDecodedPositions: boolean;
/**
- * A scalar that determines the density used to adjust the dynamic screen space error, similar to {@link Fog}. Increasing this
- * value has the effect of increasing the maximum screen space error for all tiles, but in a non-linear fashion.
- * The error starts at 0.0 and increases exponentially until a midpoint is reached, and then approaches 1.0 asymptotically.
- * This has the effect of keeping high detail in the closer tiles and lower detail in the further tiles, with all tiles
- * beyond a certain distance all roughly having an error of 1.0.
+ * Determines whether the credits of the tileset will be displayed on the screen
+ */
+ showCreditsOnScreen: boolean;
+ /**
+ * Label of the feature ID set to use for picking and styling.
*
- * The dynamic error is in the range [0.0, 1.0) and is multiplied by dynamicScreenSpaceErrorFactor to produce the
- * final dynamic error. This dynamic error is then subtracted from the tile's actual screen space error.
+ * For EXT_mesh_features, this is the feature ID's label property, or
+ * "featureId_N" (where N is the index in the featureIds array) when not
+ * specified. EXT_feature_metadata did not have a label field, so such
+ * feature ID sets are always labeled "featureId_N" where N is the index in
+ * the list of all feature Ids, where feature ID attributes are listed before
+ * feature ID textures.
*
- * Increasing dynamicScreenSpaceErrorDensity has the effect of moving the error midpoint closer to the camera.
- * It is analogous to moving fog closer to the camera.
+ * If featureIdLabel is set to an integer N, it is converted to
+ * the string "featureId_N" automatically. If both per-primitive and
+ * per-instance feature IDs are present, the instance feature IDs take
+ * priority.
*
+ * If instanceFeatureIdLabel is set to an integer N, it is converted to + * the string "instanceFeatureId_N" automatically. + * If both per-primitive and per-instance feature IDs are present, the + * instance feature IDs take priority. + *
*/ - dynamicScreenSpaceErrorFactor: number; + instanceFeatureIdLabel: string; /** - * A ratio of the tileset's height at which the density starts to falloff. If the camera is below this height the - * full computed density is applied, otherwise the density falls off. This has the effect of higher density at - * street level views. + * 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 + * @returns A promise that resolves with the fetched json data + */ + static loadJson(tilesetUrl: Resource | string): Promise