Class ObjectStateManager

An instance of ObjectStateManager keeps track of all the viewer-related state and distributes this state to other components, usually viewers. This state includes:

  • Visibility of objects
  • User-changed colors of objects
  • Selection of objects
  • Object labelling
  • View fitting of objects

Most applications will have one ObjectStateManager, but you can have more. The most common scenatio is to have one ObjectStateManager, one Viewer3d and one Viewer2d. Both viewers being connected to the same ObjectStateManager so that the state is kept in sync.

Constructors

constructor

Properties

invisibleQidsSet objectColorMap selectedQidsSet visibleQidsSet

Methods

addBuildingStoreyExclusiveVisibilityListener addColorListener addHoverListener addListener addListenerForAll addLoadedListener addSelectionListener addToPickableSet addToSelectionSet addToVisibleSet addViewFitListener addViewFitModelsListener addVisibilityListener changeColor changeColorMulti clearSelection getInvisibleQids getModelManager getSelectedQids getVisibleQids highlightQuery hoverOff hoverOn inverseOfVisible isVisible queryToQids removeBuildingStoreyExclusiveVisibilityListener removeColorListener removeFromPickableSet removeFromSelectionSet removeFromVisibleSet removeListener removeListenerForAll removeQids removeSelectionListener removeViewFitListener removeViewFitModelsListener removeVisibilityListener resetAll resetColor setBuildingStoreysVisibility setBuildingStoreysVisibleExclusive setLabels setNoBuildingStoreysVisibility setPickableSet setToSelectionSet setVisibleSet viewFit

Constructors

constructor

Properties

Private Readonly invisibleQidsSet

invisibleQidsSet: Set<string>

Private Readonly objectColorMap

objectColorMap: Map<string, TinyColor>

Private Readonly selectedQidsSet

selectedQidsSet: Set<string>

Private Readonly visibleQidsSet

visibleQidsSet: Set<string>

Methods

addBuildingStoreyExclusiveVisibilityListener

addColorListener

addHoverListener

addListener

addListenerForAll

addLoadedListener

addSelectionListener

addToPickableSet

  • addToPickableSet(query, force?, type?): Promise<void>

  • Add the provided objects to the currently pickable set of objects

    Parameters

    • query: Iterable<string> | BimQuery

      Either a query or Iterable of Qid

    • Optional force: boolean

      Whether to force this change, when forced, any viewer-specific settings are overruled

    • Optional type: string

      Always "BIM"

    Returns Promise<void>

addToSelectionSet

  • addToSelectionSet(query, type?): Promise<void>

  • Add a set of objects to the selected set

    Parameters

    • query: Iterable<string> | BimQuery
    • Optional type: string

    Returns Promise<void>

addToVisibleSet

  • addToVisibleSet(query, force?, type?): Promise<void>

  • Add the provided objects to the currently visible set of objects *

    Parameters

    • query: Iterable<string> | BimQuery

      Either a query or Iterable of Qid *

    • Optional force: boolean

      Whether to force this change, when forced, any viewer-specific settings are overruled *

    • Optional type: string

      Always "BIM"

    Returns Promise<void>

addViewFitListener

addViewFitModelsListener

addVisibilityListener

changeColor

  • changeColor(query, color): Promise<void>

  • Change the color of a given set of objects. When changing the colors of multiple sets of objects, use the more efficient changeColorMulti method.

    Parameters

    • query: Iterable<string> | BimQuery

      A query or iterable of Qids, the objects to change color

    • color: Color

      The new color, many representations are supported including "#00FF00", "#F0", "[r, g, b, a]" and "red"

    Returns Promise<void>

    A Promise that triggers when all connected listeners have applied the change

changeColorMulti

  • changeColorMulti(changes): Promise<void>

  • Change the colors of a given set of objects.

    Parameters

    Returns Promise<void>

    A Promise that triggers when all connected listeners have applied the change

clearSelection

getInvisibleQids

  • getInvisibleQids(): Set<string>

  • Returns Set<string>

    A Set of the QIDS that are currently invisible. The returned Set must be treated as read-only.

getModelManager

getSelectedQids

  • getSelectedQids(): Set<string>

  • Returns Set<string>

    A Set of the QIDS that are currently selected. The returned Set must be treated as read-only.

getVisibleQids

  • getVisibleQids(): Set<string>

  • Returns Set<string>

    A Set of the QIDS that are currently visible. The returned Set must be treated as read-only.

highlightQuery

hoverOff

  • hoverOff(qid): void

  • Change the state of the given qid to not being hovered on anymore. In the Viewer3d tis will fade out the green glow over time.

    Parameters

    • qid: string

      The Qid of the object not being hovered over anymore

    Returns void

hoverOn

  • hoverOn(qid, screenspaceLocation?): void

  • Change the state of the given qid to being hovered on. In the Viewer3d this will give the object a green glow

    Parameters

    • qid: string

      The Qid of the object being hovered over

    • Optional screenspaceLocation: vec2

      The screen space location of the hover event. This is not relevant/available in all situations and can be null

    Returns void

Private inverseOfVisible

isVisible

queryToQids

removeBuildingStoreyExclusiveVisibilityListener

removeColorListener

removeFromPickableSet

  • removeFromPickableSet(query, force?, type?): Promise<void>

  • Remove objects from the set of pickable objects

    Parameters

    • query: Iterable<string> | BimQuery

      Either a query or Iterable of Qid

    • Optional force: boolean

      Whether to force this change, when forced, any viewer-specific settings are overruled

    • Optional type: string

      Always "BIM"

    Returns Promise<void>

removeFromSelectionSet

  • removeFromSelectionSet(query, type?): Promise<void>

  • Remove the provided objects from the current selection

    Parameters

    • query: Iterable<string> | BimQuery
    • Optional type: string

    Returns Promise<void>

removeFromVisibleSet

  • removeFromVisibleSet(query, force?, type?): Promise<void>

  • Remove objects from the set of visible objects

    Parameters

    • query: Iterable<string> | BimQuery

      Either a query or Iterable of Qid

    • Optional force: boolean

      Whether to force this change, when forced, any viewer-specific settings are overruled

    • Optional type: string

      Always "BIM"

    Returns Promise<void>

removeListener

removeListenerForAll

Private removeQids

removeSelectionListener

removeViewFitListener

removeViewFitModelsListener

removeVisibilityListener

resetAll

  • resetAll(): Promise<void>

  • Resets the internal ObjectStateManager state to the default state, which means:

    • Visibility is reset to the original visibility, by default this leaves out the types IFCOPENINGELEMENT, IFCPROJECT, IFCBUILDING, IFCBUILDINGSTOREY and IFCZONE
    • Color, all objects are reset to their original color
    • Selection, any selected objects will be unselected

    All of these changes trigger the regular listeners and therefore the connected viewers.

    Returns Promise<void>

resetColor

  • resetColor(query): Promise<void>

  • Parameters

    • query: Iterable<string> | BimQuery

      A query or iterable of Qids, the objects to reset color

    Returns Promise<void>

    A Promise that triggers when all connected listeners have applied the change

setBuildingStoreysVisibility

  • setBuildingStoreysVisibility(buildingStoreyQids, visible): Promise<void>

  • Parameters

    • buildingStoreyQids: Iterable<string>
    • visible: boolean

    Returns Promise<void>

setBuildingStoreysVisibleExclusive

  • setBuildingStoreysVisibleExclusive(query, hideOpenings?): Promise<unknown>

  • Parameters

    • query: Iterable<string> | BimQuery
    • Optional hideOpenings: boolean

    Returns Promise<unknown>

setLabels

  • setLabels(labels): void

  • Change the labels of objects. Depending on the viewer labels are visualized differently.

    Parameters

    • labels: Label[]

      An array of Label

    Returns void

setNoBuildingStoreysVisibility

setPickableSet

  • setPickableSet(query, force?, type?): Promise<void>

  • Update the set of pickable objects, replacing any previous pickable state

    Parameters

    • query: Iterable<string> | BimQuery

      Either a query or Iterable of Qid

    • Optional force: boolean

      Whether to force this change, when forced, any viewer-specific settings are overruled

    • Optional type: string

      Always "BIM"

    Returns Promise<void>

setToSelectionSet

  • setToSelectionSet(query, type?): Promise<void>

  • Replace the currently selected set by the provided set of objects

    Parameters

    • query: Iterable<string> | BimQuery
    • Optional type: string

    Returns Promise<void>

setVisibleSet

  • setVisibleSet(query, force?, type?): Promise<void>

  • Update the set of visible objects, replacing any previous visibily state

    Parameters

    • query: Iterable<string> | BimQuery

      Either a query or Iterable of Qid

    • Optional force: boolean

      Whether to force this change, when forced, any viewer-specific settings are overruled

    • Optional type: string

      Always "BIM"

    Returns Promise<void>

viewFit

  • viewFit(query, options): Promise<void>

  • Calling this method will update all connected viewers in a way that all of them are afterwards showing at least all of the queried objects.

    Parameters

    • query: Iterable<string> | BimQuery

      A query or iterable of Qids, the objects to reset color

    • options: ViewFitOptions

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorinvisibleQidsSetobjectColorMapselectedQidsSetvisibleQidsSetaddBuildingStoreyExclusiveVisibilityListeneraddColorListeneraddHoverListeneraddListeneraddListenerForAlladdLoadedListeneraddSelectionListeneraddToPickableSetaddToSelectionSetaddToVisibleSetaddViewFitListeneraddViewFitModelsListeneraddVisibilityListenerchangeColorchangeColorMulticlearSelectiongetInvisibleQidsgetModelManagergetSelectedQidsgetVisibleQidshighlightQueryhoverOffhoverOninverseOfVisibleisVisiblequeryToQidsremoveBuildingStoreyExclusiveVisibilityListenerremoveColorListenerremoveFromPickableSetremoveFromSelectionSetremoveFromVisibleSetremoveListenerremoveListenerForAllremoveQidsremoveSelectionListenerremoveViewFitListenerremoveViewFitModelsListenerremoveVisibilityListenerresetAllresetColorsetBuildingStoreysVisibilitysetBuildingStoreysVisibleExclusivesetLabelssetNoBuildingStoreysVisibilitysetPickableSetsetToSelectionSetsetVisibleSetviewFit