docsby gkjohnson
Draping Cesium ion imagery over the globe
import { TilesRenderer } from '3d-tiles-renderer/three';
import { GeneratedSurfacePlugin, CesiumIonOverlay } from '3d-tiles-renderer/three/plugins';

const tiles = new TilesRenderer();
tiles.registerPlugin( new GeneratedSurfacePlugin( {
	overlay: new CesiumIonOverlay( { assetId: 3954, apiToken: 'YOUR_CESIUM_ION_TOKEN' } ),
	applyOverlayTexture: true,
} ) );
On this page

Methods

new CesiumIonOverlay(
	options?: {
		// Cesium Ion API token for authentication.
		apiToken?: string,

		// Cesium Ion asset ID.
		assetId?: number,

		// Automatically refresh the auth token before it expires.
		autoRefreshToken: boolean = false,

		// Overlay opacity (0–1).
		opacity: number = 1,

		// Tint color.
		color: number | Color = 0xffffff,

		// Planar projection frame. If null, cartographic projection is used.
		frame: Matrix4 = null,

		// URL rewriting callback.
		preprocessURL: function = null,

		// Use alpha channel as a surface mask.
		alphaMask: boolean = false,

		// Invert the alpha channel.
		alphaInvert: boolean = false
	}
)

Inherited