@stereograph/teiaviewer - v18.6.0-dev
    Preparing search index...

    Class ViewerScene

    Index

    Constructors

    Properties

    ambientLight: AmbientLight = ...
    bimMeshController: BimMeshController
    clippingPlaneController: ClippingPlaneController
    grid: Grid = ...
    lightsController: ViewerLightsController
    originAxesHelper: AxesHelper = ...
    sceneAxesHelper: AxesHelper = ...
    snapModeHelper: SnapModeHelper = ...
    spriteController: SceneSpriteController

    Accessors

    • get background(): ColorRepresentation

      Returns ColorRepresentation

    • set background(color: ColorRepresentation): void

      Parameters

      • color: ColorRepresentation

      Returns void

    Methods

    • Adds a three.js object to the internal three.js scene

      Parameters

      • object: Object3D

      Returns void

    • Adds the object to its corresponding controller in the scene

      Parents cannot cross different controllers.

      Parameters

      Returns void

    • Adds an object to the bounding box computations of the scene.

      Useful for objects that are not raycastable, and thus, not in the box tree.

      Parameters

      Returns void

    • Returns Generator<SceneObject, void, any>

    • Returns Generator<string, void, any>

    • Returns Generator<SceneObject>

    • Returns Generator<string>

    • Returns Generator<SceneObject, void, any>

    • Returns Generator<string, void, any>

    • Returns the bounding box of all objects in the scene

      Parameters

      • target: Box3

      Returns Box3

    • Returns the bounding sphere of all objects in the scene

      Parameters

      • target: Sphere

      Returns void

    • Returns the bounding box of all objects in the box tree

      Parameters

      • target: Box3

      Returns Box3

    • Parameters

      • target: Sphere

      Returns Sphere

    • Returns the number of objects in the box tree

      Returns number

    • Parameters

      • uuid: string

      Returns null | SceneObject

    • Parameters

      • uuids: Iterable<string>

      Returns Generator<SceneObject, void, unknown>

    • Parameters

      • uuid: string

      Returns boolean

    • Parameters

      • ray: Ray
      • scale: number = 1

      Returns BoxTreeIntersection<RaycastableSceneObject>[]

    • Removes a three.js object from the internal three.js scene

      Parameters

      • object: Object3D

      Returns void

    • Removes the object from its corresponding controller in the scene.

      Parameters

      Returns void

    • Removes an object from the bounding box computations of the scene

      Useful for objects that are not raycastable, and thus, not in the box tree.

      Parameters

      Returns void

    • Whether to show the box tree helper

      Parameters

      • value: boolean

      Returns void

    • Returns void