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

    Base controller for managing meshes. Use this controller only if you want your objects to be considered as standard SceneMesh (i.e. automatic support for selection, xRay, boxTree, BVH, etc). It is made for displaying content not tools.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _objects: Map<string, BimMesh> = ...
    _viewer: Viewer
    ignoreViewportRenderMode: false

    Indicates whether the mesh controller should ignore the render mode changes of the viewport

    isBimMeshController: true
    isSceneMeshController: true
    isSceneObjectController: true
    roots: Set<BimMesh> = ...
    signals: {
        onObjectAdded: ViewerSignal<(object: BimMesh) => void>;
        onObjectRemoved: ViewerSignal<(object: BimMesh) => void>;
        onObjectUpdated: ViewerSignal<(object: BimMesh) => void>;
        onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
    } = ...

    Accessors

    • get count(): number

      Controller objects count

      Returns number

    • get firstObject(): TObject | null

      Returns TObject | null

    • get uuids(): MapIterator<string>

      Iterator over all the uuids contained in the controller.

      Returns MapIterator<string>

    • get visible(): boolean

      Returns boolean

    • set visible(value: boolean): void

      Controller visibility (independant from object own visibility).

      Hiding a controller will hide all its children without modifying their own visibility.

      Parameters

      • value: boolean

      Returns void

    Methods

    • To be implemented by controllers to set global visibility (at controller level)

      Parameters

      • value: boolean

      Returns void

    • Indicates whether the controller accepts the SceneObject as a potential child.

      Parameters

      Returns boolean

    • Parameters

      Returns void

    • Adds the given building mesh to the controller and puts it in its parent if given. If a building mesh already exists for the uuid, returns.

      Parameters

      • mesh: BimMesh
      • parentUuid: string | null

      Returns void

    • Clears all objects from the controller

      Returns void

    • Disposes the controller and destroy its data

      Returns void

    • Returns a generator of hidden object uuids of this controller

      Returns Generator<string>

    • Returns a generator of objects of this controller

      Returns Generator<BimMesh>

    • Returns a generator of object uuids of this controller

      Returns Generator<string>

    • Returns a generator if visible object uuids of this controller

      Returns Generator<string>

    • Returns the object associated with the given uuid if found

      Parameters

      • uuid: string

      Returns BimMesh | null

    • Returns a generator of objects with the given uuids

      Parameters

      • uuids: Iterable<string>

      Returns Generator<BimMesh>

    • Returns whether the controller has the given uuid

      Parameters

      • uuid: string

      Returns boolean

    • Removes the given object from the controller.

      Parameters

      Returns void

    • Parameters

      • planes: Plane[]

      Returns void

    • Parameters

      • value: boolean

      Returns void

    • Parameters

      • value: boolean

      Returns void