Cesium3DTileset

Cesium3DTileset is a 3D tile set.

• Cesium element: Cesium3DTileset
• Example: Cesium3DTileset

Availability

Inside Viewer or CesiumWidget component. A Cesium3DTileset object will be attached to the PrimitiveCollection of the Viewer or CesiumWidget.

Example

A Cesium3DTileset is loaded asynchronously, so it has no bounding sphere yet during the first render. To fly/zoom the camera to the tileset once it is completely loaded, use the onReady callback, which receives the loaded Cesium3DTileset:

import { useRef } from "react";
import { Viewer as CesiumViewer } from "cesium";
import { Viewer, Cesium3DTileset, CesiumComponentRef } from "resium";

const ExampleComponent = () => {
  const ref = useRef<CesiumComponentRef<CesiumViewer>>(null);

  return (
    <Viewer full ref={ref}>
      <Cesium3DTileset
        url="./tileset/tileset.json"
        onReady={tileset => {
          ref.current?.cesiumElement?.zoomTo(tileset);
        }}
      />
    </Viewer>
  );
};

Note

The deprecated Cesium3DTileset.readyPromise has been removed from CesiumJS, so it no longer resolves. Use the onReady prop instead.

Properties

Cesium properties

Property	Type	Description
show	boolean
splitDirection	SplitDirection
debugShowBoundingVolume	boolean
modelMatrix	Matrix4
outlineColor	Color
shadows	ShadowMode
maximumScreenSpaceError	number
cullRequestsWhileMoving	boolean
cullRequestsWhileMovingMultiplier	number
preloadWhenHidden	boolean
preloadFlightDestinations	boolean
preferLeaves	boolean
progressiveResolutionHeightFraction	number
foveatedScreenSpaceError	boolean
foveatedConeSize	number
foveatedMinimumScreenSpaceErrorRelaxation	number
foveatedInterpolationCallback	foveatedInterpolationCallback
foveatedTimeDelay	number
dynamicScreenSpaceError	boolean
dynamicScreenSpaceErrorDensity	number
dynamicScreenSpaceErrorFactor	number
dynamicScreenSpaceErrorHeightFalloff	number
edgeDisplayMode	EdgeDisplayMode
skipLevelOfDetail	boolean
baseScreenSpaceError	number
skipScreenSpaceErrorFactor	number
skipLevels	number
immediatelyLoadDesiredLevelOfDetail	boolean
loadSiblings	boolean
clippingPlanes	ClippingPlaneCollection
clippingPolygons	ClippingPolygonCollection
lightColor	Cartesian3
colorBlendAmount	number
colorBlendMode	Cesium3DTileColorBlendMode
debugFreezeFrame	boolean
debugColorizeTiles	boolean
debugWireframe	boolean
debugShowContentBoundingVolume	boolean
debugShowViewerRequestVolume	boolean
debugShowGeometricError	boolean
debugShowRenderingStatistics	boolean
debugShowMemoryUsage	boolean
debugShowUrl	boolean
style	Cesium3DTileStyle | undefined
backFaceCulling	boolean
showOutline	boolean
vectorClassificationOnly	boolean
vectorKeepDecodedPositions	boolean
customShader	CustomShader | undefined
imageBasedLighting	ImageBasedLighting
showCreditsOnScreen	boolean
featureIdLabel	string
instanceFeatureIdLabel	string
cacheBytes	number
maximumCacheOverflowBytes	number
enableCollision	boolean

Cesium read-only properties

Property	Type	Description
heightReference	HeightReference | undefined
classificationType	ClassificationType | undefined
scene	Scene | undefined
ellipsoid	Ellipsoid | undefined
modelUpAxis	Axis | undefined
modelForwardAxis	Axis | undefined
cullWithChildrenBounds	boolean | undefined
environmentMapOptions	ConstructorOptions | undefined
enableShowOutline	boolean | undefined
projectTo2D	boolean | undefined
enablePick	boolean | undefined
asynchronouslyLoadImagery	boolean | undefined
debugHeatmapTilePropertyName	string | undefined
enableDebugWireframe	boolean | undefined

Cesium events

Property	Type	Description
onAllTilesLoad	(() => void) | undefined
onInitialTilesLoad	(() => void) | undefined
onLoadProgress	((numberOfPendingRequests: number, numberOfTilesProcessing: number) => void) | undefined
onTileFailed	((error: any) => void) | undefined
onTileLoad	((tile: Cesium3DTile) => void) | undefined
onTileUnload	((tile: Cesium3DTile) => void) | undefined
onTileVisible	((tile: Cesium3DTile) => void) | undefined

Other properties

Property	Type	Description
onClick	((movement: CesiumMovementEvent, target: T) => void) | undefined
onDoubleClick	((movement: CesiumMovementEvent, target: T) => void) | undefined
onMouseDown	((movement: CesiumMovementEvent, target: T) => void) | undefined
onMouseUp	((movement: CesiumMovementEvent, target: T) => void) | undefined
onMiddleClick	((movement: CesiumMovementEvent, target: T) => void) | undefined
onMiddleDown	((movement: CesiumMovementEvent, target: T) => void) | undefined
onMiddleUp	((movement: CesiumMovementEvent, target: T) => void) | undefined
onMouseMove	((movement: CesiumMovementEvent, target: T) => void) | undefined
onPinchEnd	((movement: CesiumMovementEvent, target: T) => void) | undefined
onPinchMove	((movement: CesiumMovementEvent, target: T) => void) | undefined
onPinchStart	((movement: CesiumMovementEvent, target: T) => void) | undefined
onRightClick	((movement: CesiumMovementEvent, target: T) => void) | undefined
onRightDown	((movement: CesiumMovementEvent, target: T) => void) | undefined
onRightUp	((movement: CesiumMovementEvent, target: T) => void) | undefined
onMouseEnter	((movement: CesiumMovementEvent, target: T) => void) | undefined
onMouseLeave	((movement: CesiumMovementEvent, target: T) => void) | undefined
onReady	((tileset: Cesium3DTileset) => void) | undefined	Calls when the tile set is completely loaded.
onError	((err: unknown) => void) | undefined
url	string | Resource | Promise<Resource>