Documentation - v20.0.0-dev
    Preparing search index...

    The settings of the lighting of the objects (Lighting), physically based: an environment map, a head light and a sun, each of a ratio from 0 to 1, normalized by their sum into intensities summing to 1 (the colours kept). Applied live.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    environmentRatio: NumberController = ...

    Strength of the environment map (ambient light and reflections), 0 to 1, against the head light and the sun: the three are normalized by their sum into intensities summing to 1.

    headLightRatio: NumberController = ...

    Strength of the light from the camera (every face seen is lit), against the two others.

    icon: "lighting" = 'lighting'

    Drawn by an interface before its title.

    isCategory: boolean = false

    A category of the group holding it: drawn by an interface inside that group (e.g. the post-processing's antialiasing and ambient occlusion), which stays a group of its own even without settings of its own (a group of groups only is drawn in place, e.g. the engine's).

    isSettings: true

    Tells a group of settings from a setting, without instanceof.

    sunAzimuth: NumberController = ...

    Direction of the sun around the vertical (y), in degrees, from z towards x.

    sunColor: ColorController = ...

    Colour of the sun, sRGB.

    sunElevation: NumberController = ...

    Height of the sun above the horizon, in degrees.

    sunRatio: NumberController = ...

    Strength of the sun (a light from a fixed direction), against the two others.

    title: "Lighting" = 'Lighting'

    Shown by an interface above its settings.

    Methods

    • Sets the settings config gives, each validated (see ValueController.validate): a value refused is skipped with a warning, the others set. The keys that are not settings are ignored (e.g. of a config saved by another version).

      Parameters

      Returns void

    • Disconnects every listener of the settings: they are not used after.

      Returns void

    • The values changed from their default, group by group, but those never saved (ValueControllerOptions.skipSave): a config for applyConfig, what is saved.

      Returns SettingsConfig<this>

    • Sets the settings saved under key in the local storage (saveToLocalStorage); none saved: unchanged. A value refused (e.g. by a later version) is skipped with a warning, the others set (see applyConfig); saved settings that cannot be read are ignored with a warning.

      Parameters

      • key: string

      Returns void

    • Sets every setting back to its default.

      Returns void

    • Saves the values changed from their default under key in the local storage, the key removed when none is: the others follow the defaults of the next versions.

      Parameters

      • key: string

      Returns void