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

    Class ObjectSelection

    An immutable snapshot of the set of SceneObjects currently selected in the scene. Changing the selection replaces the viewer's current instance with a new one rather than mutating this one — see ViewerScene.setObjectSelection.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    allVisibleObjectsSelected id isObjectSelection

    Accessors

    isEmpty length

    Methods

    equalsTo getBimMeshes getBimMeshUuids getBoundingBox getBoundingSphere getFirstObject getFirstUuid getLastObject getLastUuid getMeshes getMeshesDeep getObjects getUuids hasObject toString

    Constructors

    • Parameters

      • objects: Iterable<SceneObject> = []
      • allVisibleObjectsSelected: boolean = false

      Returns ObjectSelection

    Properties

    allVisibleObjectsSelected: boolean = false
    id: number
    isObjectSelection: true

    Accessors

    • get isEmpty(): boolean

      Returns boolean

    • get length(): number

      Returns number

    Methods

    • Parameters

      • other: this

      Returns boolean

    • Returns Generator<BimMesh>

    • Returns Generator<string>

    • Parameters

      • target: Box3

      Returns Box3

    • Parameters

      • target: Sphere

      Returns Sphere

    • Returns SceneObject | null

    • Returns string | null

    • Returns SceneObject | null

    • Returns string | null

    • Returns Generator<SceneMesh>

    • Generates a generator to yield SceneMesh objects deeply (the ones in groups too) from the provided objects.

      Parameters

      • objects: Iterable<SceneObject> = ...

        The iterable of SceneObjects to traverse (default is the internal _objects).

      Returns Generator<SceneMesh>

      A generator that yields SceneMesh objects.

    • Returns Generator<SceneObject>

    • Returns Generator<string>

    • Parameters

      Returns boolean

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods