Class Scene

A scene is graphical representation of an environment. It manages the scene hierarchy, all graphical objects, lights, and scene-wide properties.

Hierarchy (View Summary)

Properties

ambientBake ambientBakeOcclusionBrightness ambientBakeOcclusionContrast ambientLight ambientLuminance exposure fogColor fogDensity fogEnd fogStart lightmapFilterEnabled lightmapHDR lightmapMaxResolution lightmapMode lightmapSizeMultiplier physicalUnits root

Accessors

ambientBakeNumSamples ambientBakeSpherePart clusteredLightingEnabled envAtlas fog gammaCorrection layers lighting lightmapFilterRange lightmapFilterSmoothness lightmapPixelFormat prefilteredCubemaps skybox skyboxIntensity skyboxLuminance skyboxMip skyboxRotation toneMapping

Methods

fire hasEvent off on once setSkybox

Events

EVENT_SETLAYERS EVENT_SETSKYBOX

Properties

ambientBake

ambientBake: boolean = false

If enabled, the ambient lighting will be baked into lightmaps. This will be either the Scene#skybox if set up, otherwise Scene#ambientLight. Defaults to false.

ambientBakeOcclusionBrightness

ambientBakeOcclusionBrightness: number = 0

If Scene#ambientBake is true, this specifies the brightness of ambient occlusion. Typical range is -1 to 1. Defaults to 0, representing no change to brightness.

ambientBakeOcclusionContrast

ambientBakeOcclusionContrast: number = 0

If Scene#ambientBake is true, this specifies the contrast of ambient occlusion. Typical range is -1 to 1. Defaults to 0, representing no change to contrast.

ambientLight

ambientLight: Color = ...

The color of the scene's ambient light. Defaults to black (0, 0, 0).

ambientLuminance

ambientLuminance: number = 0

The luminosity of the scene's ambient light in lux (lm/m^2). Used if physicalUnits is true. Defaults to 0.

exposure

exposure: number = 1

The exposure value tweaks the overall brightness of the scene. Ignored if physicalUnits is true. Defaults to 1.

fogColor

fogColor: Color = ...

The color of the fog (if enabled). Defaults to black (0, 0, 0).

fogDensity

fogDensity: number = 0

The density of the fog (if enabled). This property is only valid if the fog property is set to FOG_EXP or FOG_EXP2. Defaults to 0.

fogEnd

fogEnd: number = 1000

The distance from the viewpoint where linear fog reaches its maximum. This property is only valid if the fog property is set to FOG_LINEAR. Defaults to 1000.

fogStart

fogStart: number = 1

The distance from the viewpoint where linear fog begins. This property is only valid if the fog property is set to FOG_LINEAR. Defaults to 1.

lightmapFilterEnabled

lightmapFilterEnabled: boolean = false

Enables bilateral filter on runtime baked color lightmaps, which removes the noise and banding while preserving the edges. Defaults to false. Note that the filtering takes place in the image space of the lightmap, and it does not filter across lightmap UV space seams, often making the seams more visible. It's important to balance the strength of the filter with number of samples used for lightmap baking to limit the visible artifacts.

lightmapHDR

lightmapHDR: boolean = false

Enables HDR lightmaps. This can result in smoother lightmaps especially when many samples are used. Defaults to false.

lightmapMaxResolution

lightmapMaxResolution: number = 2048

The maximum lightmap resolution. Defaults to 2048.

lightmapMode

lightmapMode: number = BAKE_COLORDIR

The lightmap baking mode. Can be:

  • BAKE_COLOR: single color lightmap
  • BAKE_COLORDIR: single color lightmap + dominant light direction (used for bump or specular). Only lights with bakeDir=true will be used for generating the dominant light direction.

Defaults to BAKE_COLORDIR.

lightmapSizeMultiplier

lightmapSizeMultiplier: number = 1

The lightmap resolution multiplier. Defaults to 1.

physicalUnits

physicalUnits: boolean = false

Use physically based units for cameras and lights. When used, the exposure value is ignored.

root

root: Entity = null

The root entity of the scene, which is usually the only child to the Application root entity.

Accessors

ambientBakeNumSamples

  • get ambientBakeNumSamples(): number

  • Gets the number of samples used to bake the ambient light into the lightmap.

    Returns number

  • set ambientBakeNumSamples(value: number): void

  • Sets the number of samples used to bake the ambient light into the lightmap. Note that Scene#ambientBake must be true for this to have an effect. Defaults to 1. Maximum value is 255.

    Parameters

    • value: number

    Returns void

ambientBakeSpherePart

  • get ambientBakeSpherePart(): number

  • Gets the part of the sphere which represents the source of ambient light.

    Returns number

  • set ambientBakeSpherePart(value: number): void

  • Sets the part of the sphere which represents the source of ambient light. Note that Scene#ambientBake must be true for this to have an effect. The valid range is 0..1, representing a part of the sphere from top to the bottom. A value of 0.5 represents the upper hemisphere. A value of 1 represents a full sphere. Defaults to 0.4, which is a smaller upper hemisphere as this requires fewer samples to bake.

    Parameters

    • value: number

    Returns void

clusteredLightingEnabled

  • get clusteredLightingEnabled(): boolean

  • Gets whether clustered lighting is enabled.

    Returns boolean

  • set clusteredLightingEnabled(value: boolean): void

  • Sets whether clustered lighting is enabled. Set to false before the first frame is rendered to use non-clustered lighting. Defaults to true.

    Parameters

    • value: boolean

    Returns void

envAtlas

fog

gammaCorrection

layers

lighting

lightmapFilterRange

lightmapFilterSmoothness

lightmapPixelFormat

prefilteredCubemaps

skybox

skyboxIntensity

skyboxLuminance

skyboxMip

skyboxRotation

toneMapping

Methods

fire

  • fire(
        name: string,
        arg1?: any,
        arg2?: any,
        arg3?: any,
        arg4?: any,
        arg5?: any,
        arg6?: any,
        arg7?: any,
        arg8?: any,
    ): EventHandler

  • Fire an event, all additional arguments are passed on to the event listener.

    Parameters

    • name: string

      Name of event to fire.

    • Optionalarg1: any

      First argument that is passed to the event handler.

    • Optionalarg2: any

      Second argument that is passed to the event handler.

    • Optionalarg3: any

      Third argument that is passed to the event handler.

    • Optionalarg4: any

      Fourth argument that is passed to the event handler.

    • Optionalarg5: any

      Fifth argument that is passed to the event handler.

    • Optionalarg6: any

      Sixth argument that is passed to the event handler.

    • Optionalarg7: any

      Seventh argument that is passed to the event handler.

    • Optionalarg8: any

      Eighth argument that is passed to the event handler.

    Returns EventHandler

    Self for chaining.

    Example

    obj.fire('test', 'This is the message');

hasEvent

  • hasEvent(name: string): boolean

  • Test if there are any handlers bound to an event name.

    Parameters

    • name: string

      The name of the event to test.

    Returns boolean

    True if the object has handlers bound to the specified event name.

    Example

    obj.on('test', function () { }); // bind an event to 'test'
    obj.hasEvent('test'); // returns true
    obj.hasEvent('hello'); // returns false

off

  • off(name?: string, callback?: HandleEventCallback, scope?: object): EventHandler

  • Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

    Parameters

    • Optionalname: string

      Name of the event to unbind.

    • Optionalcallback: HandleEventCallback

      Function to be unbound.

    • Optionalscope: object

      Scope that was used as the this when the event is fired.

    Returns EventHandler

    Self for chaining.

    Example

    const handler = function () {
    };
    obj.on('test', handler);

    obj.off(); // Removes all events
    obj.off('test'); // Removes all events called 'test'
    obj.off('test', handler); // Removes all handler functions, called 'test'
    obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

on

  • on(name: string, callback: HandleEventCallback, scope?: object): EventHandle

  • Attach an event handler to an event.

    Parameters

    • name: string

      Name of the event to bind the callback to.

    • callback: HandleEventCallback

      Function that is called when event is fired. Note the callback is limited to 8 arguments.

    • Optionalscope: object = ...

      Object to use as 'this' when the event is fired, defaults to current this.

    Returns EventHandle

    Can be used for removing event in the future.

    Example

    obj.on('test', function (a, b) {
        console.log(a + b);
    });
    obj.fire('test', 1, 2); // prints 3 to the console

    Example

    const evt = obj.on('test', function (a, b) {
        console.log(a + b);
    });
    // some time later
    evt.off();

once

  • once(name: string, callback: HandleEventCallback, scope?: object): EventHandle

  • Attach an event handler to an event. This handler will be removed after being fired once.

    Parameters

    • name: string

      Name of the event to bind the callback to.

    • callback: HandleEventCallback

      Function that is called when event is fired. Note the callback is limited to 8 arguments.

    • Optionalscope: object = ...

      Object to use as 'this' when the event is fired, defaults to current this.

    Returns EventHandle

    • can be used for removing event in the future.

    Example

    obj.once('test', function (a, b) {
        console.log(a + b);
    });
    obj.fire('test', 1, 2); // prints 3 to the console
    obj.fire('test', 1, 2); // not going to get handled

setSkybox

  • setSkybox(cubemaps?: Texture[]): void

  • Sets the cubemap for the scene skybox.

    Parameters

    • Optionalcubemaps: Texture[]

      An array of cubemaps corresponding to the skybox at different mip levels. If undefined, scene will remove skybox. Cubemap array should be of size 7, with the first element (index 0) corresponding to the base cubemap (mip level 0) with original resolution. Each remaining element (index 1-6) corresponds to a fixed prefiltered resolution (128x128, 64x64, 32x32, 16x16, 8x8, 4x4).

    Returns void

Events

StaticEVENT_SETLAYERS

EVENT_SETLAYERS: string = 'set:layers'

Fired when the layer composition is set. Use this event to add callbacks or advanced properties to your layers. The handler is passed the old and the new LayerComposition.

Example

app.scene.on('set:layers', (oldComp, newComp) => {
    const list = newComp.layerList;
    for (let i = 0; i < list.length; i++) {
        const layer = list[i];
        switch (layer.name) {
            case 'MyLayer':
                layer.onEnable = myOnEnableFunction;
                layer.onDisable = myOnDisableFunction;
                break;
            case 'MyOtherLayer':
                layer.shaderPass = myShaderPass;
                break;
        }
    }
});

StaticEVENT_SETSKYBOX

EVENT_SETSKYBOX: string = 'set:skybox'

Fired when the skybox is set. The handler is passed the Texture that is the previously used skybox cubemap texture. The new skybox cubemap texture is in the Scene#skybox property.

Example

app.scene.on('set:skybox', (oldSkybox) => {
    console.log(`Skybox changed from ${oldSkybox.name} to ${app.scene.skybox.name}`);
});

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
Events