@stereograph/teiaviewer - v17.8.0-dev
    Preparing search index...

    Class MeasureLineController

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    isMeasureLineController: true
    isSceneObjectController: true
    signals: {
        onObjectAdded: ViewerSignal<
            (object: MeasureLineAnchor | MeasureLine) => void,
        >;
        onObjectRemoved: ViewerSignal<
            (object: MeasureLineAnchor | MeasureLine) => void,
        >;
        onObjectUpdated: ViewerSignal<
            (object: MeasureLineAnchor | MeasureLine) => void,
        >;
        onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
    } = ...

    Accessors

    • get count(): number

      Controller objects count

      Returns number

    • get firstObject(): null | TObject

      Returns null | TObject

    • 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

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

      Parameters

      Returns boolean

    • Adds the given object to the controller. Controllers may not support object hierarchy.

      Parameters

      Returns void

    • Clears all objects from the controller

      Returns void

    • Returns MeasureLine

    • 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 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 null | MeasureLineAnchor | MeasureLine

    • Returns a generator of objects with the given uuids

      Parameters

      • uuids: Iterable<string>

      Returns Generator<MeasureLineAnchor | MeasureLine>

    • Returns number

    • Returns whether the controller has the given uuid

      Parameters

      • uuid: string

      Returns boolean

    • Parameters

      • value: number

      Returns void