@stereograph/teiaviewer - v17.8.0-dev
    Preparing search index...

    Class TeiaViewer

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    behaviorManager: BehaviorManager
    commandHistory: CommandHistory
    materialFactory: MaterialFactory
    notificationCenter: NotificationCenter
    objectStateHistory: ObjectStateHistory

    Handle the history of object states

    raycaster: ViewerRaycaster
    scene: TeiaViewerScene
    settings: {
        backupName: StringController;
        camera: {
            centerCameraWhenLoading: BooleanController;
            stepDistanceZoom: NumberController;
        };
        debug: BooleanController;
        dev: {
            drawDebug: BooleanController;
            enableAuthentication: BooleanController;
            verbose: BooleanController;
        };
        doubleClickDelay: NumberController;
        forceLocalSettings: BooleanController;
        inputSearchTeiaFilter: ObjectController<TeiaSearchCondition[]>;
        keyboardType: SelectController<readonly ["unknown", "azerty", "qwerty"]>;
        lights: {
            ambientLightIntensity: NumberController;
            cameraLightIntensity: NumberController;
        };
        loading: {
            batchingMeshCountUpdateThreshold: NumberController;
            batchingWorkersCount: NumberController;
            edgeGeometryMinAngle: NumberController;
            loadingWorkersCount: NumberController;
            maxBatchingIndexCount: NumberController;
            maxBatchingProxyCount: NumberController;
            maxBatchingVertexCount: NumberController;
        };
        map: {
            nbOfPlanesPerLine: NumberController;
            opacity: NumberController;
            planeSize: NumberController;
            shape: SelectController<readonly [square, circle]>;
            showMap: BooleanController;
            size: NumberController;
        };
        memory: {
            memoryUsageCriticalLevel: NumberController;
            memoryUsageWarningLevel: NumberController;
        };
        objectCountWarningLimit: NumberController;
        objects: {
            doubleSide: BooleanController;
            edgesColor: ColorController;
            flatShading: BooleanController;
            highlightColor: ColorController;
            measureLineSpriteSize: NumberController;
            xRayOpacity: NumberController;
        };
        objectsPerRequest: NumberController;
        permissions: ObjectController<TeiaViewerPermissions>;
        projection: { enable: BooleanController };
        scene: {
            axesSize: NumberController;
            backgroundColor: ColorController;
            gridSize: NumberController;
            showGrid: BooleanController;
            showOriginAxisHelper: BooleanController;
            showSceneAxisHelper: BooleanController;
        };
        selection: { layer: SelectController<readonly [Base, Overlay]> };
        snapping: { snappingEdgesThreshold: NumberController };
        transform: {
            pivotPoint: SelectController<readonly ["Center", "Min", "Max"]>;
        };
        twinApi: { baseUrl: StringController; token: StringController };
        ui: {
            showObjectHierarchyBanner: BooleanController;
            showToolbar: BooleanController;
            treeViewPageSize: NumberController;
        };
    }

    Viewer settings

    Type declaration

    Signals emitted by the viewer

    stats: ViewerStats = ...
    twinApiClient: ApiClient
    viewports: TeiaViewportCore[] = ...
    widgetFactory: WidgetFactory

    Factory creating widgets used by the viewer viewport

    Accessors

    • get plugins(): ReadonlyMap<string, ViewerPlugin<Viewer, Record<string, never>>>

      Returns ReadonlyMap<string, ViewerPlugin<Viewer, Record<string, never>>>

    • get version(): string

      Returns string

    • get viewport(): null | ViewportCore

      Returns null | ViewportCore

    Methods

    • Returns void

    • 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

    • Type Parameters

      • TKey extends never

      Parameters

      Returns ViewerPluginRegistry[TKey]

    • Returns void

    • Type Parameters

      • TKey extends never

      Parameters

      Returns void