Skip to main content

Scene

Scene can operate the scene of the Viewer or CesiumWidget. All properties are applied to single scene of them.

Note: Following code is not recommended as occur extra rendering steps:

<Viewer>
<Scene>
<Globe>
<Camera>
<Entity />
</Camera>
</Globe>
</Scene>
</Viewer>

Scene component's role is just changing fields of Viewer#scene, so following code is recommended.

<Viewer>
<Scene />
<Globe />
<Camera />
<Entity />
</Viewer>

For details, refer to "Component location" chapter in Guide.

Availability

Scene can be mounted insideViewer or CesiumWidget components. It can not be mounted more than once for each Viewer or CesiumWidget.

Properties

Cesium properties

PropertyTypeDescription
terrainProviderTerrainProvider
skyBoxSkyBox
skyAtmosphereSkyAtmosphere
globeGlobe
requestRenderModeboolean
maximumRenderTimeChangenumber
msaaSamplesnumber
gammanumber
backgroundColorColor
completeMorphOnUserInputboolean
debugCommandFilter(...params: any[]) => any
debugShowCommandsboolean
debugShowDepthFrustumnumber
debugShowFramesPerSecondboolean
debugShowFrustumPlanesboolean
debugShowFrustumsboolean
eyeSeparationnumber
farToNearRationumber
focalLengthnumber
fogFog
highDynamicRangeboolean
invertClassificationboolean
invertClassificationColorColor
lightLight
logarithmicDepthBufferboolean
logarithmicDepthFarToNearRationumber
minimumDisableDepthTestDistancenumber
moonMoon
morphTimenumber
nearToFarDistance2Dnumber
pickTranslucentDepthboolean
rethrowRenderErrorsboolean
shadowMapShadowMap
specularEnvironmentMapsstring
sphericalHarmonicCoefficientsCartesian3[]
sunSun
sunBloomboolean
useDepthPickingboolean
useWebVRboolean
postProcessStagesPostProcessStageCollection
splitPositionnumber

Cesium read-only properties

N/A

Cesium events

PropertyTypeDescription
onMorphComplete() => void
onMorphStart() => void
onPostRender() => void
onPreRender() => void
onPreUpdate() => void
onPostUpdate() => void
onRenderError() => void
onTerrainProviderChange() => void

Other properties

PropertyTypeDescription
childrenReactNode
modeSceneMode
morphDurationnumberIf this prop is set and when mode prop is changed, the scene morphs with this duration (seconds).