Documentation - v19.2.0-dev
    Preparing search index...

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

    Index

    Constructors

    Properties

    behaviorController: BehaviorController
    commandHistory: CommandHistory
    developerTools: DeveloperToolController
    materialFactory: MaterialFactory
    objectStateHistory: ObjectStateHistory

    Handle the history of object states

    sceneLoader: SceneLoader
    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;
            showDevTools: BooleanController;
            showInfoTools: BooleanController;
            verbose: BooleanController;
        };
        doubleClickDelay: NumberController;
        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;
            centerSceneOnLoading: BooleanController;
            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 };
        render: { resolutionScaling: NumberController };
        scene: {
            axesSize: NumberController;
            backgroundColor: ColorController;
            gridSize: NumberController;
            showGrid: BooleanController;
            showOriginAxisHelper: BooleanController;
            showSceneAxisHelper: BooleanController;
        };
        snapping: { snappingEdgesThreshold: NumberController };
    }

    Viewer settings

    Type Declaration

    signals: ViewerSignals

    Signals emitted by the viewer

    stats: ViewerStats = ...

    Accessors

    • get version(): string

      Returns the viewer version defined in package.json

      Returns string

    • get viewport(): Viewport | null

      Returns Viewport | null

    Methods

    • Attaches the given viewport canvas to the viewer. Will dispose any current viewport.

      Parameters

      • canvas: HTMLCanvasElement

      Returns Viewport

    • Returns void

    • Detaches the current viewport from the viewer.

      Returns void

    • Returns void

    • Returns whether the given plugin (identified with its key) has been registered in the viewer

      Type Parameters

      • TKey extends never

      Parameters

      Returns boolean

    • Registers the given plugin to the viewer

      Type Parameters

      • TKey extends never
      • TPlugin extends never

      Parameters

      Returns void

    • Requests for a frame render in the viewport if any

      Returns void

    • Unregisters the plugin from the viewer.

      Type Parameters

      • TKey extends never

      Parameters

      • key: TKey

        The plugin key.

      Returns void