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

    Every setting of the viewer: the engine's (engine), then the viewer's groups, each under its title and icon in the panels (a group titled as another shown with it). Kept in the local storage under the viewer's settingsStorageKey.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    camera: CameraSettings = ...

    The camera's commands.

    dev: DevSettings = ...

    Debug mode, logs, debug drawings and developer tools.

    engine: EngineSettings = ...

    The engine's settings: drawing, meshes, lighting, post-processing, culling, loading.

    helpers: HelpersSettings = ...

    The grid and axes of the scene.

    icon: "general" = 'general'

    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.

    loading: ViewerLoadingSettings = ...

    What the viewer does once files are loaded.

    scene: ViewerSceneSettings = ...

    The double click and the transform of the objects, shown with the engine's scene settings.

    title: "Viewer" = 'Viewer'

    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>

    • The viewer's groups an interface shows in the engine's: its loading and scene settings, completing theirs (one "Loading" group, one "Scene" group).

      Returns ReadonlyMap<Settings, Settings>

    • 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