Skip to content

Scene & Globe

Scene and globe configuration options.

Scene

scene

Scene and post-processing configuration for CesiumJS viewers.

BloomConfig

Bases: CesiumBase

Bloom glow configuration.

to_js_statements(stages_var)

Generate statements for Cesium's built-in bloom stage.

FXAAConfig

Bases: CesiumBase

Fast approximate anti-aliasing configuration.

to_js_statements(stages_var)

Generate the FXAA enablement statement.

AmbientOcclusionConfig

Bases: CesiumBase

Screen-space ambient occlusion configuration.

to_js_statements(stages_var)

Generate statements for Cesium's ambient-occlusion stage.

PostProcessConfig

Bases: CesiumBase

Built-in post-processing effects for a CesiumJS scene.

to_js_statements(viewer_var='viewer')

Generate statements for every explicitly configured effect.

SceneConfig

Bases: CesiumBase

Configuration applied to a CesiumJS scene after viewer creation.

to_js_statements(viewer_var='viewer')

Generate JavaScript statements for the configured scene values.

Globe

globe

Globe configuration for CesiumJS viewer.

GlobeConfig

Bases: CesiumBase

Configuration for the CesiumJS globe.

Generates JS statements to configure globe properties after viewer creation.

to_js_statements(viewer_var='viewer')

Generate JS statements to configure the globe after viewer creation.

Terrain can be vertically exaggerated relative to a reference height:

globe = cesiumkit.GlobeConfig(
    terrain_exaggeration=3.0,
    terrain_exaggeration_relative_height=100.0,
)
viewer = cesiumkit.Viewer(globe=globe)

CesiumJS 1.119 applies these settings through the scene's vertical exaggeration properties; GlobeConfig provides the Python-facing grouping.

Rendering performance

Viewer constructor controls expose explicit rendering, resolution scaling, frame-rate limits, and render-loop error reporting:

viewer = cesiumkit.Viewer(
    request_render_mode=True,
    maximum_render_time_change=0.0,
    resolution_scale=0.75,
    target_frame_rate=30,
    show_renderer_errors=True,
)

SceneConfig also exposes request_render_mode and maximum_render_time_change for post-construction scene configuration.

Post-processing

Bloom, FXAA, and ambient occlusion are independently configurable. No stages are changed unless a config is explicitly supplied:

scene = cesiumkit.SceneConfig(
    post_process=cesiumkit.PostProcessConfig(
        bloom=cesiumkit.BloomConfig(enabled=True, contrast=128, brightness=-0.3),
        fxaa=cesiumkit.FXAAConfig(enabled=True),
        ambient_occlusion=cesiumkit.AmbientOcclusionConfig(enabled=True, intensity=1),
    )
)
viewer = cesiumkit.Viewer(scene=scene)