Skip to content

Cesium3DTileset

Cesium3DTileset is a 3D tile set.

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

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>
);
};
PropertyTypeDescription
showboolean
splitDirectionSplitDirection
debugShowBoundingVolumeboolean
modelMatrixMatrix4
outlineColorColor
shadowsShadowMode
maximumScreenSpaceErrornumber
cullRequestsWhileMovingboolean
cullRequestsWhileMovingMultipliernumber
preloadWhenHiddenboolean
preloadFlightDestinationsboolean
preferLeavesboolean
progressiveResolutionHeightFractionnumber
foveatedScreenSpaceErrorboolean
foveatedConeSizenumber
foveatedMinimumScreenSpaceErrorRelaxationnumber
foveatedInterpolationCallbackfoveatedInterpolationCallback
foveatedTimeDelaynumber
dynamicScreenSpaceErrorboolean
dynamicScreenSpaceErrorDensitynumber
dynamicScreenSpaceErrorFactornumber
dynamicScreenSpaceErrorHeightFalloffnumber
skipLevelOfDetailboolean
baseScreenSpaceErrornumber
skipScreenSpaceErrorFactornumber
skipLevelsnumber
immediatelyLoadDesiredLevelOfDetailboolean
loadSiblingsboolean
clippingPlanesClippingPlaneCollection
clippingPolygonsClippingPolygonCollection
lightColorCartesian3
colorBlendAmountnumber
colorBlendModeCesium3DTileColorBlendMode
debugFreezeFrameboolean
debugColorizeTilesboolean
debugWireframeboolean
debugShowContentBoundingVolumeboolean
debugShowViewerRequestVolumeboolean
debugShowGeometricErrorboolean
debugShowRenderingStatisticsboolean
debugShowMemoryUsageboolean
debugShowUrlboolean
styleCesium3DTileStyle | undefined
backFaceCullingboolean
showOutlineboolean
vectorClassificationOnlyboolean
vectorKeepDecodedPositionsboolean
customShaderCustomShader | undefined
imageBasedLightingImageBasedLighting
showCreditsOnScreenboolean
featureIdLabelstring
instanceFeatureIdLabelstring
cacheBytesnumber
maximumCacheOverflowBytesnumber
enableCollisionboolean
PropertyTypeDescription
heightReferenceHeightReference | undefined
classificationTypeClassificationType | undefined
sceneScene | undefined
ellipsoidEllipsoid | undefined
modelUpAxisAxis | undefined
modelForwardAxisAxis | undefined
cullWithChildrenBoundsboolean | undefined
environmentMapOptionsConstructorOptions | undefined
enableShowOutlineboolean | undefined
projectTo2Dboolean | undefined
enablePickboolean | undefined
asynchronouslyLoadImageryboolean | undefined
debugHeatmapTilePropertyNamestring | undefined
enableDebugWireframeboolean | undefined
PropertyTypeDescription
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
PropertyTypeDescription
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) | undefinedCalls when the tile set is completely loaded.
onError((err: unknown) => void) | undefined
urlstring | Resource | Promise<Resource>