Skip to 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.

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

Property Type Description
terrainProvider TerrainProvider
skyBox SkyBox | undefined
skyAtmosphere SkyAtmosphere | undefined
globe Globe
requestRenderMode boolean
maximumRenderTimeChange number
msaaSamples number
gamma number
backgroundColor Color
completeMorphOnUserInput boolean
debugShowCommands boolean
debugShowDepthFrustum number
debugShowFramesPerSecond boolean
debugShowFrustumPlanes boolean
debugShowFrustums boolean
eyeSeparation number
farToNearRatio number
focalLength number
fog Fog
highDynamicRange boolean
invertClassification boolean
invertClassificationColor Color
light Light
logarithmicDepthBuffer boolean
logarithmicDepthFarToNearRatio number
minimumDisableDepthTestDistance number
moon Moon | undefined
morphTime number
nearToFarDistance2D number
pickTranslucentDepth boolean
rethrowRenderErrors boolean
shadowMap ShadowMap
specularEnvironmentMaps string
sphericalHarmonicCoefficients Cartesian3[]
sun Sun | undefined
sunBloom boolean
useDepthPicking boolean
useWebVR boolean
splitPosition number
verticalExaggeration number
verticalExaggerationRelativeHeight number
atmosphere Atmosphere

N/A

Property Type Description
onMorphComplete (() => void) | undefined
onMorphStart (() => void) | undefined
onPostRender (() => void) | undefined
onPreRender (() => void) | undefined
onPreUpdate (() => void) | undefined
onPostUpdate (() => void) | undefined
onRenderError (() => void) | undefined
onTerrainProviderChange (() => void) | undefined
Property Type Description
children ReactNode
mode SceneMode | undefined
morphDuration number | undefined If this prop is set and when mode prop is changed, the scene morphs with this duration (seconds).
enableEdgeVisibility boolean | undefined Whether or not to enable edge visibility rendering for 3D tiles.When enabled, creates a framebuffer with multiple render targets for advanced edge detection and visibility techniques.Maps to Cesium’s internal _enableEdgeVisibility property.