Package-level declarations
Types
A collection of key-value pairs that is stored as a hash for easy lookup but also provides an array for fast iteration.
Attribute compression and decompression functions.
An enum describing the attribute type for glTF and 3D Tiles.
Creates an instance of an AxisAlignedBoundingBox from the minimum and maximum points along the x, y, and z axes.
A function used to compare two items while performing a binary search.
A bounding rectangle given by a corner, width and height.
A bounding sphere with a center and a radius.
Describes a cube centered at the origin.
A description of the outline of a cube centered at the origin.
An object with the position, direction, and up vector of a camera, such as Camera.
A 2D Cartesian point.
A 3D Cartesian point.
A 4D Cartesian point.
A position defined by longitude, latitude, and height.
A Catmull-Rom spline is a cubic spline where the tangent at control points, except the first and last, are computed using the previous and next control points. Catmull-Rom splines are in the class C1.
A description of a circle on the ellipsoid. Circle geometry can be rendered with both Primitive and GroundPrimitive.
A description of the outline of a circle on the ellipsoid.
Constants used by Clock.tick to determine behavior when Clock.startTime or Clock.stopTime is reached.
Constants to determine how much time advances with each call to Clock.tick.
Value and type information for per-instance geometry color.
WebGL component datatypes. Components are intrinsics, which form attributes, which form vertices.
A spline that evaluates to a constant value. Although this follows the Spline interface, it does not maintain an internal array of times since its value never changes.
A description of a polygon composed of arbitrary coplanar positions.
A description of the outline of a polygon composed of arbitrary coplanar positions.
Style options for corners.
A description of a corridor. Corridor geometry can be rendered with both Primitive and GroundPrimitive.
A description of a corridor outline.
Defines functions for 3rd order polynomial functions of one variable with only real coefficients.
The culling volume defined by planes.
A description of a cylinder.
A description of the outline of a cylinder.
Constructs an exception object that is thrown due to a developer error, e.g., invalid argument, argument out of range, etc. This exception should only be thrown during development; it usually indicates a bug in the calling code. This exception should never be caught; instead the calling code should strive not to generate it.
Determines visibility based on the distance to the camera.
Value and type information for per-instance geometry attribute that determines if the geometry instance has a distance display condition.
A description of an ellipse on an ellipsoid. Ellipse geometry can be rendered with both Primitive and GroundPrimitive.
A description of the outline of an ellipse on an ellipsoid.
A quadratic surface defined in Cartesian coordinates by the equation (x / a)^2 + (y / b)^2 + (z / c)^2 = 1. Primarily used by Cesium to represent the shape of planetary bodies.
Determine whether or not other objects are visible or hidden behind the visible horizon defined by an Ellipsoid and a camera position. The ellipsoid is assumed to be located at the origin of the coordinate system. This class uses the algorithm described in the Horizon Culling blog post.
Initializes a geodesic on the ellipsoid connecting the two provided planetodetic points.
A description of an ellipsoid centered at the origin.
A description of the outline of an ellipsoid centered at the origin.
Initializes a rhumb line on the ellipsoid connecting the two provided planetodetic points.
A plane tangent to the provided ellipsoid at the provided origin. If origin is not on the surface of the ellipsoid, it's surface projection will be used. If origin is at the center of the ellipsoid, an exception will be thrown.
A fixed-point encoding of a Cartesian3 with 64-bit floating-point components, as two Cartesian3 values that, when converted to 32-bit floating-point and added, approximate the original input.
A convenience object that simplifies the common pattern of attaching event listeners to several events, then removing all those listeners at once later, for example, in a destroy method.
Constants to determine how an interpolated value is extrapolated when querying outside the bounds of available data.
Contains functions for transforming positions to various reference frames.
A simple map projection where longitude and latitude are linearly mapped to X and Y by multiplying them by the Ellipsoid.maximumRadius. This projection is commonly known as geographic, equirectangular, equidistant cylindrical, or plate carrée. When using the WGS84 ellipsoid, it is also known as EPSG:4326.
A geometry representation with attributes forming vertices and optional index data defining primitives. Geometries and an Appearance, which describes the shading, can be assigned to a Primitive for visualization. A Primitive can be created from many heterogeneous - in many cases - geometries for performance.
Values and type information for geometry attributes. A Geometry generally contains one or more attributes. All attributes together form the geometry's vertices.
Attributes, which make up a geometry's vertices. Each property in this object corresponds to a GeometryAttribute containing the attribute's data.
Base class for all geometry creation utility classes that can be passed to GeometryInstance for asynchronous geometry creation.
Geometry instancing allows one Geometry object to be positions in several different locations and colored uniquely. For example, one BoxGeometry can be instanced several times, each with a different modelMatrix to change its position, rotation, and scale.
Values and type information for per-instance geometry attributes.
Represents which vertices should have a value of true for the applyOffset attribute
Content pipeline functions for geometries.
Represents a Gregorian date in a more precise format than the JavaScript Date object. In addition to submillisecond precision, this object can also represent leap seconds.
Defines a heading angle, pitch angle, and range in a local frame. Heading is the rotation from the local east direction where a positive angle is increasing southward. Pitch is the rotation from the local xy-plane. Positive pitch angles are above the plane. Negative pitch angles are below the plane. Range is the distance from the center of the frame.
A rotation expressed as a heading, pitch, and roll. Heading is the rotation about the negative z axis. Pitch is the rotation about the negative y axis. Roll is the rotation about the positive x axis.
An InterpolationAlgorithm for performing Hermite interpolation.
A Hermite spline is a cubic interpolating spline. Points, incoming tangents, outgoing tangents, and times must be defined for each control point. The outgoing tangents are defined for points 0, n - 2 and the incoming tangents are defined for points 1, n - 1. For example, when interpolating a segment of the curve between points[i] and points[i + 1], the tangents at the points will be outTangents[i] and inTangents[i], respectively.
Constants for WebGL index datatypes. These corresponds to the type parameter of drawElements.
An enum describing the type of interpolation used in a glTF animation.
This enumerated type is used in determining where, relative to the frustum, an object is located. The object can either be fully contained within the frustum (INSIDE), partially inside the frustum and partially outside (INTERSECTING), or somewhere entirely outside of the frustum's 6 planes (OUTSIDE).
Contains functions for operating on 2D triangles.
Functions for computing the intersection between geometries such as rays, planes, triangles, and ellipsoids.
Represents an astronomical Julian date, which is the number of days since noon on January 1, -4712 (4713 BC). For increased precision, this class stores the whole number part of the date and the seconds part of the date in separate components. In order to be safe for arithmetic and represent leap seconds, the date is always stored in the International Atomic Time standard TimeStandard.TAI.
An InterpolationAlgorithm for performing Lagrange interpolation.
Describes a single leap second, which is constructed from a JulianDate and a numerical offset representing the number of seconds TAI is ahead of the UTC time standard.
An InterpolationAlgorithm for performing linear interpolation.
A spline that uses piecewise linear interpolation to create a curve.
The name of an axis in a local reference frame centered at a point on the ellipsoid: 'east', 'north', 'up', 'west', 'south', or 'down'.
Computes a 4x4 transformation matrix from a reference frame centered at the provided origin to the provided ellipsoid's fixed reference frame.
Defines how geodetic ellipsoid coordinates (Cartographic) project to a flat map like Cesium's 2D and Columbus View modes.
A 2x2 matrix, indexable as a column-major order array. Constructor parameters are in row-major order for code readability.
A 3x3 matrix, indexable as a column-major order array. Constructor parameters are in row-major order for code readability.
A 4x4 matrix, indexable as a column-major order array. Constructor parameters are in row-major order for code readability.
A function used to compare two items while performing a merge sort.
A spline that linearly interpolates over an array of weight values used by morph targets.
Represents a scalar value's lower and upper bound at a near distance and far distance in eye space.
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 visible horizon defined by the occluder and camera position.
Creates an instance of an OrientedBoundingBox. An OrientedBoundingBox of some object is a closed and convex rectangular cuboid. It can provide a tighter bounding volume than BoundingSphere or AxisAlignedBoundingBox in many cases.
The viewing frustum is defined by 6 planes. Each plane is represented by a Cartesian4 object, where the x, y, and z components define the unit vector normal to the plane, and the w component is the distance of the plane from the origin/camera position.
The viewing frustum is defined by 6 planes. Each plane is represented by a Cartesian4 object, where the x, y, and z components define the unit vector normal to the plane, and the w component is the distance of the plane from the origin/camera position.
Static interface for Packable types which are interpolated in a different representation than their packed value. These methods and properties are expected to be defined on a constructor function.
The viewing frustum is defined by 6 planes. Each plane is represented by a Cartesian4 object, where the x, y, and z components define the unit vector normal to the plane, and the w component is the distance of the plane from the origin/camera position.
The viewing frustum is defined by 6 planes. Each plane is represented by a Cartesian4 object, where the x, y, and z components define the unit vector normal to the plane, and the w component is the distance of the plane from the origin/camera position.
The data type of a pixel.
The format of a pixel, i.e., the number of components it has and what they represent.
A plane in Hessian Normal Form defined by
Describes geometry representing a plane centered at the origin, with a unit width and length.
Describes geometry representing the outline of a plane centered at the origin, with a unit width and length.
A description of a polygon on the ellipsoid. The polygon is defined by a polygon hierarchy. Polygon geometry can be rendered with both Primitive and GroundPrimitive.
An hierarchy of linear rings which define a polygon and its holes. The holes themselves may also have holes which nest inner polygons.
A description of the outline of a polygon on the ellipsoid. The polygon is defined by a polygon hierarchy.
Polygon geometry processing functions, including triangulation and subdivision.
A description of a polyline modeled as a line strip; the first two positions define a line segment, and each additional position defines a line segment from the previous position. The polyline is capable of displaying with a material.
Polyline geometry processing functions, including arc generation and subdivision.
A description of a polyline with a volume (a 2D shape extruded along a polyline).
A description of a polyline with a volume (a 2D shape extruded along a polyline).
The type of a geometric primitive, i.e., points, lines, and triangles.
Defines functions for 2nd order polynomial functions of one variable with only real coefficients.
Defines functions for 4th order polynomial functions of one variable with only real coefficients.
A set of 4-dimensional coordinates used to represent rotation in 3-dimensional space.
A spline that uses spherical linear (slerp) interpolation to create a quaternion curve. The generated curve is in the class C1.
Represents a ray that extends infinitely from the provided origin in the provided direction.
A description of a cartographic rectangle on an ellipsoid centered at the origin. Rectangle geometry can be rendered with both Primitive and GroundPrimitive.
A description of the outline of a a cartographic rectangle on an ellipsoid centered at the origin.
Constants for identifying well-known reference frames.
Constructs an exception object that is thrown due to an error that can occur at runtime, e.g., out of memory, could not compile shader, etc. If a function may throw this exception, the calling code should be prepared to catch it.
Value and type information for per-instance geometry attribute that determines if the geometry instance will be shown.
A description of a polyline modeled as a line strip; the first two positions define a line segment, and each additional position defines a line segment from the previous position.
A description of a sphere centered at the origin.
A description of the outline of a sphere.
A spline that is composed of piecewise constants representing a step function.
An interval defined by a start and a stop time; optionally including those times as part of the interval. Arbitrary data can optionally be associated with each instance for used with TimeIntervalCollection.
A non-overlapping collection of TimeInterval instances sorted by start time.
Provides the type of time standards which JulianDate can take as input.
Constants for identifying well-known tracking reference frames.
An affine transformation defined by a translation, rotation, and scale.
Uses the Tridiagonal Matrix Algorithm, also known as the Thomas Algorithm, to solve a system of linear equations where the coefficient matrix is a tridiagonal matrix.
A vertex format defines what attributes make up a vertex. A VertexFormat can be provided to a Geometry to request that certain properties be computed, e.g., just position, position and normal, etc.
Functions for computing vertically-exaggerated heights and positions.
This enumerated type is used in determining to what extent an object, the occludee, is visible during horizon culling. An occluder may fully block an occludee, in which case it has no visibility, may partially block an occludee from view, or may not block it at all, leading to full visibility.
A description of a wall, which is similar to a KML line string. A wall is defined by a series of points, which extrude down to the ground. Optionally, they can extrude downwards to a specified height.
A description of a wall outline. A wall is defined by a series of points, which extrude down to the ground. Optionally, they can extrude downwards to a specified height.
The map projection used by Google Maps, Bing Maps, and most of ArcGIS Online, EPSG:3857. This projection use longitude and latitude expressed with the WGS84 and transforms them to Mercator using the spherical (rather than ellipsoidal) equations.
Winding order defines the order of vertices for a triangle to be considered front-facing.
Properties
Functions
Computes the barycentric coordinates for a point with respect to a triangle.
Finds an item in a sorted array.
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.
Creates a Globally unique identifier (GUID) string. A GUID is 128 bits long, and can guarantee uniqueness across space and time.
Destroys an object. Each of the object's functions, including functions in its prototype, is replaced with a function that throws a 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.
Formats an error object into a String. If available, uses name, message, and stack properties, otherwise, falls back on toString().
Given a relative Uri and a base Uri, returns the absolute Uri of the relative Uri.
Given a URI, returns the base path of the URI.
Given a URI, returns the extension of the URI.
Given a URI, returns the last segment of the URI, removing any path or query information.
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.
Determines if a given date is a leap year.
A stable merge sort.
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.
Determines if a point is inside a triangle.
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.
Converts the value from sRGB color space to linear color space.
Represents a point in stereographic coordinates, which can be obtained by projecting a cartesian coordinate from one pole onto a tangent plane at the other pole. The stereographic projection faithfully represents the relative directions of all great circles passing through its center point. To faithfully represents angles everywhere, this is a conformal projection, which means points are projected onto an arbrary sphere.
Subdivides an array into a number of smaller, equal sized arrays.