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

    The settings of the Scene shared by its meshes and sprites: picking, applied live; and the uploads and the BoxTree, hidden, read at the creation of the scene.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    boxTreeGrowNodes: NumberController = ...

    BoxTree nodes added when the pool is full (48 MB).

    boxTreeInitialNodes: NumberController = ...

    BoxTree nodes allocated at first (48 MB: 500,000 parts), boxTreeMaxNodes at most.

    boxTreeMaxNodes: NumberController = ...

    Largest node count: a part takes 2 nodes (a binary tree, a leaf per part), 48 bytes each. Only reserved (address space): the memory used follows the parts. 16,777,216 nodes: 8 million parts, 768 MB at most (Paprec has 1,497,000 parts, CiteAdmin 601,000).

    boxTreeRebuildCostRatio: NumberController = ...

    The tree is rebuilt (surface area heuristic, in a worker) when its cost ratio (internal nodes' surface area over the leaves') went over the one of its last rebuild times this; and always the first time.

    boxTreeRebuildDelayMs: NumberController = ...

    Milliseconds without parts added, moved or removed before the BoxTree worker checks whether the tree degraded enough to be rebuilt (see rebuildCostRatio): a load in progress keeps adding, its rebuild waits for its end.

    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.

    lineThresholdPixels: NumberController = ...

    Pixels from a line (of a part drawing lines) within which a ray through the screen hits it: the default of LineThreshold.fromCamera.

    maxCuttingPlanes: NumberController = ...

    Cutting planes at most (CuttingPlanesController.maxPlanes): the size of the shaders' plane arrays, each fragment testing only those set. 8: a section box (6 planes) and 2 more. Read at the creation of the scene.

    title: "Scene" = 'Scene'

    Shown by an interface above its settings.

    uploadMaxRanges: NumberController = ...

    Ranges of changed elements uploaded at most, the closest merged: each is an upload call.

    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