Skip to content

API.md

Latest commit

 

History

History
265 lines (165 loc) · 4.64 KB

API.md

File metadata and controls

265 lines (165 loc) · 4.64 KB

3d-tiles-renderer/core/plugins

CesiumIonAuth

Authentication helper for Cesium Ion. Fetches and caches a bearer token from the Cesium Ion endpoint and injects it into outgoing requests. Supports optional automatic token refresh on 4xx responses.

.apiToken

apiToken: string

The Cesium Ion access token.

.autoRefreshToken

autoRefreshToken: boolean

Whether to automatically refresh the token on 4xx errors.

.authURL

authURL: string | null

The endpoint URL used to fetch the bearer token.

.constructor

constructor(
	{
		apiToken: string,
		autoRefreshToken = false: boolean,
	}
)

CesiumIonAuthPlugin

Plugin for authenticating requests to Cesium Ion. Handles token refresh, asset endpoint resolution, and attribution collection. Automatically registers a GoogleCloudAuthPlugin when the resolved asset is an external Google photorealistic tileset.

.assetId

assetId: number | null

The Cesium Ion asset ID to load, or null if using an explicit root URL.

.autoRefreshToken

autoRefreshToken: boolean

Whether to automatically refresh the token on 4xx errors.

.useRecommendedSettings

useRecommendedSettings: boolean

Whether to apply recommended renderer settings for Cesium Ion assets.

.assetTypeHandler

assetTypeHandler: ( type: string, tiles: TilesRendererBase, asset: Object ) => void

Callback invoked when the resolved Cesium Ion asset type is not 3DTILES.

.tiles

tiles: Object | null

The TilesRenderer instance this plugin is registered with.

.constructor

constructor(
	{
		apiToken: string,
		assetId = null: number | null,
		autoRefreshToken = false: boolean,
		useRecommendedSettings = true: boolean,
		assetTypeHandler?: (
			type: string,
			tiles: TilesRendererBase,
			asset: Object
		) => void,
	}
)

EnforceNonZeroErrorPlugin

Plugin that ensures every tile has a non-zero geometric error. Tiles with a geometric error of zero are assigned a derived value based on the nearest ancestor with a non-zero error, halved once per level of depth below that ancestor.

GoogleCloudAuth

Authentication helper for Google Cloud Maps APIs. Manages session-token creation and renewal for both the Photorealistic 3D Tiles API and the 2D Map Tiles API, injecting the API key and session token into outgoing requests.

.apiToken

apiToken: string

The Google Cloud API key.

.autoRefreshToken

autoRefreshToken: boolean

Whether to automatically refresh the session token on 4xx errors.

.authURL

authURL: string

The endpoint URL used to create or refresh the session token.

.sessionToken

sessionToken: string | null

The current session token, or null if not yet established.

.sessionOptions

sessionOptions: Object | null

Session options passed as the POST body when creating a Map Tiles session.

.constructor

constructor(
	{
		apiToken: string,
		sessionOptions = null: Object | null,
		autoRefreshToken = false: boolean,
	}
)

GoogleCloudAuthPlugin

Plugin for authenticating requests to the Google Cloud Maps APIs, including the Photorealistic 3D Tiles and 2D Map Tiles APIs. Handles session-token management, per-tile attribution collection, and optional logo attribution.

.apiToken

apiToken: string

The Google Cloud API key.

.useRecommendedSettings

useRecommendedSettings: boolean

Whether to apply recommended renderer settings for photorealistic tiles.

.logoUrl

logoUrl: string | null

URL of a logo image to include in attribution output, or null if not set.

.tiles

tiles: Object | null

The TilesRenderer instance this plugin is registered with.

.constructor

constructor(
	{
		apiToken: string,
		sessionOptions = null: Object | null,
		autoRefreshToken = false: boolean,
		logoUrl = null: string | null,
		useRecommendedSettings = true: boolean,
	}
)

ImplicitTilingPlugin

Plugin that adds support for 3D Tiles 1.1 implicit tiling. Intercepts tiles that carry an implicitTiling field and expands them by loading and parsing .subtree files, generating child tiles according to the implicit subdivision scheme.

QuantizedMeshLoaderBase

extends LoaderBase

Base loader for quantized-mesh terrain tiles. Parses the binary quantized-mesh format into structured vertex, index, edge, and extension data. Sets the required Accept header automatically. Subclasses should implement geometry construction from the parsed result.

ParsedBitstream