Class Viewer

Base class that handles data and events of a 3D scene.

Hierarchy (View Summary)

Viewer
- TeiaViewer

Index

Constructors

constructor

new Viewer(cfg?: RecursivePartial): Viewer
Parameters
- cfg: RecursivePartial = {}
Returns Viewer
- Defined in src/viewer/core/Viewer.ts:75

Properties

`Readonly`behaviorManager

behaviorManager: BehaviorManager

`Readonly`commandHistory

commandHistory: CommandHistory

`Readonly`materialFactory

materialFactory: MaterialFactory

`Readonly`notificationCenter

notificationCenter: NotificationCenter

`Readonly`objectStateHistory

objectStateHistory: ObjectStateHistory

Handle the history of object states

`Readonly`raycaster

raycaster: ViewerRaycaster

`Readonly`scene

scene: ViewerScene

`Readonly`settings

settings: {
    ao: {
        active: BooleanController;
        antialiasingActive: BooleanController;
        aoRadius: NumberController;
        aoSamples: NumberController;
        color: ColorController;
        denoiseRadius: NumberController;
        denoiseSamples: NumberController;
        depthAwareUpsampling: BooleanController;
        distanceFalloff: NumberController;
        halfRes: BooleanController;
        intensity: NumberController;
        transparencyAware: BooleanController;
    };
    backupName: StringController;
    camera: {
        centerCameraWhenLoading: BooleanController;
        stepDistanceZoom: NumberController;
    };
    debug: BooleanController;
    dev: { drawDebug: BooleanController; verbose: BooleanController };
    doubleClickDelay: NumberController;
    keyboardType: SelectController<readonly ["unknown", "azerty", "qwerty"]>;
    lights: {
        ambientLightIntensity: NumberController;
        cameraLightIntensity: NumberController;
        directionalLightIntensity: NumberController;
        hemisphereLightIntensity: NumberController;
        skyAzimuth: NumberController;
        skyElevation: NumberController;
        skyIsVisible: BooleanController;
        skyMieCoefficient: NumberController;
        skyMieDirectionalG: NumberController;
        skyRayleigh: NumberController;
        skyTurbidity: NumberController;
    };
    loading: {
        batchingMeshCountUpdateThreshold: NumberController;
        batchingWorkersCount: NumberController;
        edgeGeometryMinAngle: NumberController;
        loadingWorkersCount: NumberController;
        maxBatchingIndexCount: NumberController;
        maxBatchingProxyCount: NumberController;
        maxBatchingVertexCount: NumberController;
    };
    memory: {
        memoryUsageCriticalLevel: NumberController;
        memoryUsageWarningLevel: NumberController;
    };
    objects: {
        defaultEdgesColor: ColorController;
        doubleSide: BooleanController;
        flatShading: BooleanController;
        highlightColor: ColorController;
        pivotPoint: SelectController<readonly ["Center", "Min", "Max"]>;
        selectionLayer: SelectController<readonly [Base, SelectedObject]>;
        xRayOpacity: NumberController;
    };
    raycast: { marginError: NumberController };
    scene: {
        axesSize: NumberController;
        backgroundColor: ColorController;
        gridSize: NumberController;
        showGrid: BooleanController;
        showOriginAxisHelper: BooleanController;
        showSceneAxisHelper: BooleanController;
    };
    snapping: { snappingEdgesThreshold: NumberController };
    ui: {
        disableToolbar: BooleanController;
        showObjectHierarchyBanner: BooleanController;
        showToolbar: BooleanController;
        treeViewPageSize: NumberController;
        widgetZoneBottomMargin: NumberController;
    };
}

Viewer settings

Type declaration

ao: {
    active: BooleanController;
    antialiasingActive: BooleanController;
    aoRadius: NumberController;
    aoSamples: NumberController;
    color: ColorController;
    denoiseRadius: NumberController;
    denoiseSamples: NumberController;
    depthAwareUpsampling: BooleanController;
    distanceFalloff: NumberController;
    halfRes: BooleanController;
    intensity: NumberController;
    transparencyAware: BooleanController;
}
Ambient occlusion settings
backupName: StringController
Name of the backup to save the settings in the local storage
Default Value
```
"Default"
```
camera: {
centerCameraWhenLoading: BooleanController;
stepDistanceZoom: NumberController;
}
Camera settings
- centerCameraWhenLoading: BooleanController
  Center the viewport camera on scene bounding sphere when loading content
  Default Value
```
true
```
- stepDistanceZoom: NumberController
  The added or removed distance when we click on the "zoom in / zoom out" buttons in the toolbar (CameraZoomOutCommand / CameraZoomInCommand)
  Default Value
```
10
```
debug: BooleanController
Show debug tools
Default Value
```
false
```
dev: { drawDebug: BooleanController; verbose: BooleanController }
Developer settings
- drawDebug: BooleanController
  Whether to active the draw debugs (draw debug objects to scene)
  Default Value
```
false
```
- verbose: BooleanController
  Verbose console logging. If true, info and time measures will be displayed in console
  Default Value
```
false
```
doubleClickDelay: NumberController
Delay in milliseconds between two successing clicks/taps to be consider event as DoubleClick/Tap
Default Value
```
250
```
Min
100

Max
500
keyboardType: SelectController<readonly ["unknown", "azerty", "qwerty"]>
Type of the keyboard
Default Value
```
"unknown"
```
lights: {
    ambientLightIntensity: NumberController;
    cameraLightIntensity: NumberController;
    directionalLightIntensity: NumberController;
    hemisphereLightIntensity: NumberController;
    skyAzimuth: NumberController;
    skyElevation: NumberController;
    skyIsVisible: BooleanController;
    skyMieCoefficient: NumberController;
    skyMieDirectionalG: NumberController;
    skyRayleigh: NumberController;
    skyTurbidity: NumberController;
}
Light settings
loading: {
    batchingMeshCountUpdateThreshold: NumberController;
    batchingWorkersCount: NumberController;
    edgeGeometryMinAngle: NumberController;
    loadingWorkersCount: NumberController;
    maxBatchingIndexCount: NumberController;
    maxBatchingProxyCount: NumberController;
    maxBatchingVertexCount: NumberController;
}
Loading settings
- batchingMeshCountUpdateThreshold: NumberController
  Number of meshes to batch in the worker before sending an update to main thread
  Default Value
```
1000
```
  Min
  100
  
  Max
  2000
- batchingWorkersCount: NumberController
  Number of WebWorkers used to re-arrange geometry buffers
  Default Value
```
navigator.hardwareConcurrency
```
  Min
  1
  
  Max
  navigator.hardwareConcurrency
- edgeGeometryMinAngle: NumberController
  Edge threshold used to compute edge geometries
  Default Value
```
60
```
- loadingWorkersCount: NumberController
  Number of WebWorkers used to load scene
  Default Value
```
navigator.hardwareConcurrency
```
  Min
  1
  
  Max
  navigator.hardwareConcurrency
- maxBatchingIndexCount: NumberController
  Maximum size of the index buffer for a batch
  Default Value
```
1e7
```
  Min
  1e6
  
  Max
  1e7
- maxBatchingProxyCount: NumberController
  Maximum number of object per batch
  Default Value
```
3000
```
  Min
  500
  
  Max
  7000
- maxBatchingVertexCount: NumberController
  Maximum size of the vertex buffer for a batch
  Default Value
```
1e7
```
  Min
  1e6
  
  Max
  1e7
memory: {
memoryUsageCriticalLevel: NumberController;
memoryUsageWarningLevel: NumberController;
}
JS Memory settings
- memoryUsageCriticalLevel: NumberController
  Max percentage of memory used before displaying a critical warning
  Default Value
```
0.8
```
  Min
  0
  
  Max
  1
- memoryUsageWarningLevel: NumberController
  Max percentage of memory used before displaying a warning
  Default Value
```
0.5
```
  Min
  0
  
  Max
  1
objects: {
    defaultEdgesColor: ColorController;
    doubleSide: BooleanController;
    flatShading: BooleanController;
    highlightColor: ColorController;
    pivotPoint: SelectController<readonly ["Center", "Min", "Max"]>;
    selectionLayer: SelectController<readonly [Base, SelectedObject]>;
    xRayOpacity: NumberController;
}
Objects settings
- defaultEdgesColor: ColorController
- doubleSide: BooleanController
- flatShading: BooleanController
- highlightColor: ColorController
  Color used to highlight selected objects in the scene
  Default Value
```
#fabd38
```
- pivotPoint: SelectController<readonly ["Center", "Min", "Max"]>
  Pivot point of the group transform
  Default Value
```
false (PivotPoint.center)
```
- selectionLayer: SelectController<readonly [Base, SelectedObject]>
  Layer to use for selection
- xRayOpacity: NumberController
raycast: { marginError: NumberController }
Selection settings
- marginError: NumberController
  Max distance in world units (meters) between the ray and a the object to be selected (e.g. Lines)
scene: {
    axesSize: NumberController;
    backgroundColor: ColorController;
    gridSize: NumberController;
    showGrid: BooleanController;
    showOriginAxisHelper: BooleanController;
    showSceneAxisHelper: BooleanController;
}
Scene settings
- axesSize: NumberController
  Size of the AxesHelper
  Default Value
```
10
```
  Min
  1
  
  Max
  1000
- backgroundColor: ColorController
  Background color of the scene
  Default Value
```
#aabbdd
```
- gridSize: NumberController
  Size of the grid
  Default Value
```
100
```
  Min
  10
  
  Max
  1000
- showGrid: BooleanController
  Whether to show a grid in the scene
  Default Value
```
false
```
- showOriginAxisHelper: BooleanController
  Whether to show an AxisHelper on the (0,0,0) coordinates
  Default Value
```
false
```
- showSceneAxisHelper: BooleanController
  Whether to show an AxisHelper on the center of the bounding sphere of the scene
  Default Value
```
false
```
snapping: { snappingEdgesThreshold: NumberController }
Snapping settings
- snappingEdgesThreshold: NumberController
  Threshold used to snap on edges
ui: {
    disableToolbar: BooleanController;
    showObjectHierarchyBanner: BooleanController;
    showToolbar: BooleanController;
    treeViewPageSize: NumberController;
    widgetZoneBottomMargin: NumberController;
}
Ui Settings
- disableToolbar: BooleanController
  Whether to disable the toolbar (if any added)
  Default Value
```
false
```
- showObjectHierarchyBanner: BooleanController
  Whether the selected object hierarchy banner is open by default
  Default Value
```
false
```
- showToolbar: BooleanController
  Whether to show the toolbar (if any added)
  Default Value
```
true
```
- treeViewPageSize: NumberController
  Default number of children displayed per parent in the tree view, also the size of added children
  Default Value
```
30
```
  Min
  1
  
  Max
  30
- widgetZoneBottomMargin: NumberController
  Margin bottom in which the widgets can't go
  Default Value
```
60
```
  Min
  0
  
  Max
  300

`Readonly`signals

signals: ViewerSignals

Signals emitted by the viewer

`Readonly`stats

stats: ViewerStats = ...

`Readonly`viewports

viewports: ViewportCore[] = ...

`Readonly`widgetFactory

widgetFactory: WidgetFactory

Factory creating widgets used by the viewer viewport

Accessors

plugins

get plugins(): ReadonlyMap<string, ViewerPlugin<Viewer, Record<string, never>>>
Returns ReadonlyMap<string, ViewerPlugin<Viewer, Record<string, never>>>
- Defined in src/viewer/core/Viewer.ts:167

version

get version(): string
Returns string
- Defined in src/viewer/core/Viewer.ts:215

viewport

get viewport(): null | ViewportCore
Returns null | ViewportCore
- Defined in src/viewer/core/Viewer.ts:91

Methods

addBehavior

addBehavior(behavior: ViewerBehavior): void
Parameters
- behavior: ViewerBehavior
Returns void
- Defined in src/viewer/core/Viewer.ts:126

clear

clear(): void
Returns void
- Defined in src/viewer/core/Viewer.ts:115

getObjectUUID

getObjectUUID(object: SerializedBatchedMeshProxy): string
Returns the uuid to use for the given object. Called internally for each object loaded. Override this method to set a custom UUID for objects. By default, Three.js Object3D uuid is used.
Parameters
- object: SerializedBatchedMeshProxy
  The object to return the uuid for
Returns string
- Defined in src/viewer/core/Viewer.ts:142

getPlugin

getPlugin<TKey extends keyof ViewerPluginRegistry>(
key: TKey,
): ViewerPluginRegistry[TKey]
Type Parameters
- TKey extends keyof ViewerPluginRegistry
Parameters
- key: TKey
Returns ViewerPluginRegistry[TKey]
- Defined in src/viewer/core/Viewer.ts:171

registerPlugin

registerPlugin<
    TKey extends keyof ViewerPluginRegistry,
    TPlugin extends
        (
            | object
            | MapPlugin
            | ObjectTransformPlugin
            | ExportPlanPlugin
            | MeasureLinePlugin
            | ZonePlugin
        ) & ViewerPlugin<Viewer, any>,
>(
    key: TKey,
    plugin: TPlugin,
): void
Type Parameters
- TKey extends keyof ViewerPluginRegistry
- TPlugin extends (
      | object
      | MapPlugin
      | ObjectTransformPlugin
      | ExportPlanPlugin
      | MeasureLinePlugin
      | ZonePlugin
  ) & ViewerPlugin<Viewer, any>
Parameters
- key: TKey
- plugin: TPlugin
Returns void
- Defined in src/viewer/core/Viewer.ts:180

removeBehavior

removeBehavior(behavior: ViewerBehavior): void
Parameters
- behavior: ViewerBehavior
Returns void
- Defined in src/viewer/core/Viewer.ts:130

requestRender

requestRender(): void
Returns void
- Defined in src/viewer/core/Viewer.ts:146

unregisterPlugin

unregisterPlugin<TKey extends keyof ViewerPluginRegistry>(key: TKey): void
Type Parameters
- TKey extends keyof ViewerPluginRegistry
Parameters
- key: TKey
Returns void
- Defined in src/viewer/core/Viewer.ts:209

Class Viewer

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Viewer

Properties

ReadonlybehaviorManager

ReadonlycommandHistory

ReadonlymaterialFactory

ReadonlynotificationCenter

ReadonlyobjectStateHistory

Readonlyraycaster

Readonlyscene

Readonlysettings

Type declaration

backupName: StringController

Default Value

camera: { centerCameraWhenLoading: BooleanController; stepDistanceZoom: NumberController;}

centerCameraWhenLoading: BooleanController

Default Value

stepDistanceZoom: NumberController

Default Value

debug: BooleanController

Default Value

dev: { drawDebug: BooleanController; verbose: BooleanController }

drawDebug: BooleanController

Default Value

verbose: BooleanController

Default Value

doubleClickDelay: NumberController

Default Value

Min

Max

keyboardType: SelectController<readonly ["unknown", "azerty", "qwerty"]>

Default Value

batchingMeshCountUpdateThreshold: NumberController

Default Value

Min

Max

batchingWorkersCount: NumberController

Default Value

Min

Max

edgeGeometryMinAngle: NumberController

Default Value

loadingWorkersCount: NumberController

Default Value

Min

Max

maxBatchingIndexCount: NumberController

Default Value

Min

Max

maxBatchingProxyCount: NumberController

Default Value

Min

Max

maxBatchingVertexCount: NumberController

Default Value

Min

Max

memory: { memoryUsageCriticalLevel: NumberController; memoryUsageWarningLevel: NumberController;}

memoryUsageCriticalLevel: NumberController

Default Value

Min

Max

memoryUsageWarningLevel: NumberController

Default Value

Min

Max

defaultEdgesColor: ColorController

doubleSide: BooleanController

flatShading: BooleanController

highlightColor: ColorController

`Readonly`behaviorManager

`Readonly`commandHistory

`Readonly`materialFactory

`Readonly`notificationCenter

`Readonly`objectStateHistory

`Readonly`raycaster

`Readonly`scene

`Readonly`settings

camera: {
centerCameraWhenLoading: BooleanController;
stepDistanceZoom: NumberController;
}

memory: {
memoryUsageCriticalLevel: NumberController;
memoryUsageWarningLevel: NumberController;
}

scene: {
axesSize: NumberController;
backgroundColor: ColorController;
gridSize: NumberController;
showGrid: BooleanController;
showOriginAxisHelper: BooleanController;
showSceneAxisHelper: BooleanController;
}

ui: {
disableToolbar: BooleanController;
showObjectHierarchyBanner: BooleanController;
showToolbar: BooleanController;
treeViewPageSize: NumberController;
widgetZoneBottomMargin: NumberController;
}

`Readonly`signals

`Readonly`stats

`Readonly`viewports

`Readonly`widgetFactory