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

    Owns the scene graph: the engine's scene (engineScene: its objects, BoxTree, picking, lighting, and the three.js scene of the objects drawn outside the engine), the current ObjectSelection, and the SceneObjectControllers that own every SceneObject (bimMeshController, spriteController, clippingPlaneController, plus any a plugin registers via addObjectController). An object is added to and removed from the scene through its controller (controller.addObject, object.controller.removeObject).

    Index

    Constructors

    Properties

    _viewer: Viewer
    bimMeshController: BimMeshController
    clippingPlaneController: ClippingPlaneController
    engineScene: Scene

    The engine's scene, on the viewer's settings.engine: its objects and BoxTree, and its threeScene, which holds the three.js objects drawn outside the engine (addInternalObject).

    grid: Grid = ...
    originAxesHelper: AxesHelper = ...
    raycaster: ViewerRaycaster

    The picking of the scene: its engine objects, then each controller's.

    sceneAxesHelper: AxesHelper = ...
    spriteController: SpriteController

    Accessors

    Methods

    • Adds a three.js object drawn outside the engine (a helper, a gizmo) to the engine's threeScene, in the viewer's group of them (emptied by clear).

      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

    • Permanently releases the scene objects and GPU resources owned by the scene.

      Returns void

    • Returns the bounding box of all objects in the scene

      Parameters

      Returns Box3

    • Returns the bounding sphere of all objects in the scene

      Parameters

      Returns Sphere

    • The sphere the camera frames (on loading, reset, preset views): the bounds of the engine's objects (its BoxTree), without the addObjectToBoundingBox objects (e.g. a map far wider than the model); the whole scene's while the BoxTree is empty.

      Parameters

      Returns Sphere

    • The object of this uuid, in any of the controllers; null when there is none. With getObjectsByUUID and hasObjectUUID, the scene's search across its controllers, for what is given uuids (resolved once, as the commands do): to walk objects, go through controllers.

      Parameters

      • uuid: string

      Returns SceneObject | null

    • The objects of these uuids, in their order, in any of the controllers; the unknown uuids left out (see getObjectByUUID).

      Parameters

      • uuids: Iterable<string>

      Returns SceneObject[]

    • Whether an object of this uuid is in the scene, in any of its controllers.

      Parameters

      • uuid: string

      Returns boolean

    • Removes a three.js object of addInternalObject.

      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

    • Parameters

      Returns void

    • Reads again the bounds of the addObjectToBoundingBox objects: call it once one of them moved or changed size (e.g. a map placed), the scene's bounds (and the camera's depth range) following.

      Returns void