GooglePhotorealistic3DTileset

GooglePhotorealistic3DTileset provides Google Maps Photorealistic 3D Tiles.

This component asynchronously creates a Cesium3DTileset via Cesium’s createGooglePhotorealistic3DTileset factory and attaches it to the PrimitiveCollection of the Viewer or CesiumWidget.

An API key may be required. Set it globally via Cesium.GoogleMaps.defaultApiKey, or pass it through the apiKey prop. (It is named apiKey, not key, because key is a reserved React prop and would never reach the component.)

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

GoogleMaps.defaultApiKey = "your_google_api_key";

const App = () => {
  const ref = useRef<CesiumComponentRef<CesiumViewer>>(null);
  return (
    <Viewer full ref={ref}>
      <GooglePhotorealistic3DTileset
        onReady={tileset => {
          ref.current?.cesiumElement?.zoomTo(tileset);
        }}
      />
    </Viewer>
  );
};

• Cesium element: GooglePhotorealistic3DTileset
• Example: GooglePhotorealistic3DTileset

Availability

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

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
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	Calls when an error occurs while creating the tile set.
apiKey	string | undefined	The API key to access Google Photorealistic 3D Tiles. If not provided, uses GoogleMaps.defaultApiKey. (Named apiKey because key is reserved by React.)
onlyUsingWithGoogleGeocoder	true | undefined	Whether to use the tiles only with the Google geocoder.