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

    The settings of the meshes (MeshController): their selection, x-ray and edges, applied live; their transparency threshold and how they are stored (Containers, the InstanceTable), hidden, read at the creation of the scene.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    containerEdgesPerVertex: NumberController = ...

    Edge indices allocated per vertex: above the 1.0-1.8 measured on .mgeom format 2 files.

    containerIndices: NumberController = ...

    Triangle indices of a Container made for a few geometries (1,000,000: 10 MB with its vertices and edges, following from the ratios below), e.g. objects added one by one: they go where there is room, a new Container of this size made when none has. The new geometries of an addition larger than it go together to a Container of their exact size (e.g. a group of the MeshLoader). Each Container is a draw call per pass in WebGL2 and an emit pass in WebGPU.

    containerIndicesPerVertex: NumberController = ...

    Triangle indices per vertex, giving the vertices of a Container: the lowest of the 4.0-5.4 measured on .mgeom format 2 files (flat triangles share their vertices), so the indices fill up first.

    containerMaxMB: NumberController = ...

    Bytes of a Container of the exact size at most, in MB (10^6 bytes): an addition larger is split into several (a geometry larger alone takes one of its own). 120 MB keeps each of its arrays under the 128 MiB of a storage buffer every WebGPU device binds.

    defaultEdgeColor: ColorController = ...

    Edge colour of the parts whose input gives none, sRGB: applies to the parts added after.

    edgesPassEnabled: BooleanController = ...

    Whether the edges' pass runs: the parts' sharp edges drawn in each part's edge colour; off, the pass is skipped, no edge drawn. Hidden from the interfaces, which hide the edges object by object (the viewer's render mode).

    icon: "meshes" = 'meshes'

    Drawn by an interface before its title.

    instanceCapacity: NumberController = ...

    Initial capacity of the InstanceTable, in instances; it grows by doubling.

    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.

    opaqueAbove: NumberController = ...

    Parts drawn with this opacity or more are opaque; those of a lower one are transparent: drawn after the opaque parts of their layer, blended, without writing the depth, in no particular order (as TeiaViewer). The opacity drawn is the part's, times xRayOpacity when x-ray (InstanceTable.getDrawnOpacity). Read at the creation of the scene.

    selectionColor: ColorController = ...

    Colour of the selected objects' faces, sRGB: ochre. Their opacity is kept.

    selectionEdgeColor: ColorController = ...

    Colour of the selected objects' edges, sRGB.

    selectionOverlay: BooleanController = ...

    Whether the selected objects are drawn in the top layer (MeshLayer.Layer4), over the other objects, seen through them; else in their own layer, which they keep either way.

    title: "Meshes" = 'Meshes'

    Shown by an interface above its settings.

    xRayOpacity: NumberController = ...

    The opacity of the objects seen through (MeshProxy.xRay) is multiplied by this, their edges' too: 1 draws them as they are.

    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