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

    The viewer's settings of the scene: the double click and the transform of its objects. Shown in the engine's group (ViewerSettings.getGroupsShownWithEngine).

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    doubleClickDelay: NumberController = ...

    Longest delay between two clicks or taps of a double click, in milliseconds.

    icon: "scene" = 'scene'

    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.

    pivotPoint: SelectController<"Center" | "Min" | "Max"> = ...

    Where a group of objects is moved, turned and scaled from: its bounds' centre, min or max.

    title: "Scene" = 'Scene'

    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