Class SceneSettings

Represents the settings for the currently loaded scene.

Here is a list of properties that can be accessed using the get and set methods:

Path Type Description Default Value
physics object Physics related settings for the scene.
physics.gravity Array<number> An array of 3 numbers that represents the gravity force.
render object Render settings for the scene.
render.exposure number The exposure value tweaks the overall brightness of the scene.
render.fog string The type of fog used in the scene. Can be one of pc.FOG_NONE, pc.FOG_LINEAR, pc.FOG_EXP, pc.FOG_EXP2.
render.fog_color Array<number> An array of 3 numbers representing the color of the fog.
render.fog_density number The density of the fog. This property is only valid if the fog property is set to pc.FOG_EXP or pc.FOG_EXP2.
render.fog_end number The distance from the viewpoint where linear fog reaches its maximum. This property is only valid if the fog property is set to pc.FOG_LINEAR.
render.fog_start number The distance from the viewpoint where linear fog begins. This property is only valid if the fog property is set to pc.FOG_LINEAR.
render.gamma_correction number The gamma correction to apply when rendering the scene. Can be one of pc.GAMMA_NONE, pc.GAMMA_SRGB.
render.global_ambient Array<number> An array of 3 numbers representing the color of the scene's ambient light.
render.lightmapMaxResolution number The maximum lightmap resolution.
render.lightmapMode number The lightmap baking mode. Can be one of pc.BAKE_COLOR, pc.BAKE_COLORDIR.
render.lightmapSizeMultiplier number The lightmap resolution multiplier.
render.skybox number The id of the cubemap texture to be used as the scene's skybox.
render.skyboxIntensity number Multiplier for skybox intensity.
render.skyboxMip number The mip level of the skybox to be displayed. Only valid for prefiltered cubemap skyboxes.
render.skyboxRotation Array<number> An array of 3 numbers representing the rotation of the skybox. [0,0,0]
render.tonemapping number The tonemapping transform to apply when writing fragments to the frame buffer. Can be: pc.TONEMAP_LINEAR, pc.TONEMAP_FILMIC, pc.TONEMAP_HEJL, pc.TONEMAP_ACES.

Hierarchy

  • Events
    • SceneSettings

Constructors

constructor

Accessors

history

Methods

_initializeObserver _onLoadScene get has json set

Constructors

Private constructor

Accessors

history

Methods

Private _initializeObserver

Private _onLoadScene

get

  • get(path): any

  • Gets value at path. See the SceneSettings overview for a full list of properties.

    Parameters

    • path: string

      The path

    Returns any

    The value

    Example

    console.log(editor.settings.scene.get('render.fog'));

has

  • has(path): boolean

  • Checks if path exists. See the SceneSettings overview for a full list of properties.

    Parameters

    • path: string

      The path

    Returns boolean

    True if path exists

    Example

    console.log(editor.settings.scene.has('render.fog'));

json

  • json(): object

  • Returns JSON representation of scene settings data

    Returns object

    • The data

    Example

    console.log(editor.settings.scene.json());

set

  • set(path, value): boolean

  • Sets value at path. See the SceneSettings overview for a full list of properties.

    Parameters

    • path: string

      The path

    • value: any

      The value

    Returns boolean

    Whether the value was set

    Example

    editor.settings.scene.set('render.fog', 'none');

Settings

Member Visibility

Theme

On This Page

constructorhistory_initializeObserver_onLoadScenegethasjsonset