Interface ObjectStateListener

An interface that can be implemented to be notified about certain ObjectStateManager related events. All of the methods allow the ability to return a Promise. When a Promise is returned, the ObjectStateManager will wait before it will trigger the next listener until the Promise resolves. Keep that in mind when returning a Promise.

Hierarchy

  • ObjectStateListener

Properties

setLabels? unloaded?

Methods

addedToSelectionSet? addedToVisibleSet? colorChanged? colorReset? primarySelectionChanged? removedFromSelectionSet? removedFromVisibleSet? setBuildingStoreyVisibleExclusive? setBuildingStoreysVisibleExclusive? setToSelectionSet? setVisibleSet? viewFit? viewFitModels?

Properties

Optional setLabels

setLabels?: ((labels: Iterable<Label>) => void | Promise<unknown>)

Type declaration

    • (labels: Iterable<Label>): void | Promise<unknown>

    • Parameters

      Returns void | Promise<unknown>

Optional unloaded

unloaded?: ((qids: Iterable<string>) => void | Promise<void>)

Type declaration

    • (qids: Iterable<string>): void | Promise<void>

    • Parameters

      • qids: Iterable<string>

      Returns void | Promise<void>

Methods

Optional addedToSelectionSet

  • This method will get called when objects have been added to the selection.

    Qids

    Iterable<@bimworks/jssdk#Qid> that provides the @bimworks/jssdk#Qids of the objects added to the selection set. @type:

    Parameters

    • qids: Iterable<string>
    • type: string

    Returns void | Promise<void>

Optional addedToVisibleSet

  • Parameters

    • qids: Iterable<string>

    Returns void | Promise<void>

Optional colorChanged

Optional colorReset

Optional primarySelectionChanged

Optional removedFromSelectionSet

  • Parameters

    • qids: Iterable<string>
    • type: string

    Returns void | Promise<void>

Optional removedFromVisibleSet

  • Parameters

    • qids: Iterable<string>
    • Optional type: string

    Returns void | Promise<void>

Optional setBuildingStoreyVisibleExclusive

Optional setBuildingStoreysVisibleExclusive

  • Parameters

    • buildingStoreyQids: Iterable<string>
    • hideOpenings: boolean

    Returns void | Promise<void>

Optional setToSelectionSet

  • This method will get called when the set of selected objects has been

    Qids

    Iterable<@bimworks/jssdk#Qid> that provides the @bimworks/jssdk#Qids of the objects added to the selection set. @type:

    Parameters

    • qids: Iterable<string>
    • qidsToUnselect: Iterable<string>
    • type: string

    Returns void | Promise<void>

Optional setVisibleSet

  • Parameters

    • qids: Iterable<string>
    • qidsToHide: Iterable<string>

    Returns void | Promise<unknown>

Optional viewFit

Optional viewFitModels

Settings

Member Visibility

Theme

Generated using TypeDoc