Class ObjectStateManager

Hierarchy

ObjectStateManager

Index

Constructors

constructor

new ObjectStateManager(modelManager: ModelManager, settings?: ObjectStateManagerSettings): ObjectStateManager
Parameters
- modelManager: ModelManager
- Optional settings: ObjectStateManagerSettings
Returns ObjectStateManager
- Defined in ViewerCommon/viewercommon.d.ts:219

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

addBuildingStoreyExclusiveVisibilityListener(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:314

addColorListener

addColorListener(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:310

addListener

addListener(type: ObjectStateListenerType, target: ObjectStateListener): void
Parameters
- type: ObjectStateListenerType
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:320

addListenerForAll

addListenerForAll(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:322

addLoadedListener

addLoadedListener(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:305

addSelectionListener

addSelectionListener(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:306

addToSelectionSet

addToSelectionSet(query: Iterable<string> | BimQuery, type?: string): Promise<void>
Add a set of objects to the selected set
Parameters
- query: Iterable<string> | BimQuery
- Optional type: string
Returns Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:251

addToVisibleSet

addToVisibleSet(query: Iterable<string> | BimQuery): Promise<void>
Add the provided objects to the currently visible set of objects
Parameters
- query: Iterable<string> | BimQuery
Returns Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:276

addViewFitListener

addViewFitListener(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:312

addViewFitModelsListener

addViewFitModelsListener(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:317

addVisibilityListener

addVisibilityListener(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:308

changeColor

changeColor(query: Iterable<string> | BimQuery, color: Color): Promise<void>
Change the color of a given set of objects

Returns
A Promise that triggers when all connected listeners have applied the change
Parameters
- query: Iterable<string> | BimQuery
- color: Color
Returns Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:288

clearSelection

clearSelection(type?: string): Promise<void>
Clear the current selection
Parameters
- Optional type: string
Returns Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:266

getInvisibleQids

getInvisibleQids(): Set<string>
Returns
A Set of the QIDS that are currently invisible. The returned Set must be treated as read-only.

Returns Set<string>
- Defined in ViewerCommon/viewercommon.d.ts:234

getSelectedQids

getSelectedQids(): Set<string>
Returns
A Set of the QIDS that are currently selected. The returned Set must be treated as read-only.

Returns Set<string>
- Defined in ViewerCommon/viewercommon.d.ts:239

getVisibleQids

getVisibleQids(): Set<string>
Returns
A Set of the QIDS that are currently visible. The returned Set must be treated as read-only.

Returns Set<string>
- Defined in ViewerCommon/viewercommon.d.ts:229

highlightQuery

highlightQuery(origin: ObjectStateListener, query: Iterable<string> | BimQuery, highlightColor: Color, backgroundColor: Color): Promise<unknown>
Parameters
- origin: ObjectStateListener
- query: Iterable<string> | BimQuery
- highlightColor: Color
- backgroundColor: Color
Returns Promise<unknown>
- Defined in ViewerCommon/viewercommon.d.ts:290

`Private` inverseOfVisible

inverseOfVisible(qids: Iterable<string>): ReadonlySet<string>
Parameters
- qids: Iterable<string>
Returns ReadonlySet<string>
- Defined in ViewerCommon/viewercommon.d.ts:326

isVisible

isVisible(qid: string): boolean
Returns
Whether the given Qid is visible
Parameters
- qid: string
Returns boolean
- Defined in ViewerCommon/viewercommon.d.ts:246

`Private` queryToQids

queryToQids(query: Iterable<string> | BimQuery): Promise<Set<string>>
Parameters
- query: Iterable<string> | BimQuery
Returns Promise<Set<string>>
- Defined in ViewerCommon/viewercommon.d.ts:241

removeBuildingStoreyExclusiveVisibilityListener

removeBuildingStoreyExclusiveVisibilityListener(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:315

removeColorListener

removeColorListener(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:311

removeFromSelectionSet

removeFromSelectionSet(query: Iterable<string> | BimQuery, type?: string): Promise<void>
Remove the provided objects from the current selection
Parameters
- query: Iterable<string> | BimQuery
- Optional type: string
Returns Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:261

removeFromVisibleSet

removeFromVisibleSet(query: Iterable<string> | BimQuery, type?: string): Promise<void>
Parameters
- query: Iterable<string> | BimQuery
- Optional type: string
Returns Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:278

removeListener

removeListener(type: ObjectStateListenerType, target: ObjectStateListener): void
Parameters
- type: ObjectStateListenerType
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:321

removeListenerForAll

removeListenerForAll(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:323

`Private` removeQids

removeQids(qids: any): Promise<unknown>
For internal use only
Parameters
- qids: any
Returns Promise<unknown>
- Defined in ViewerCommon/viewercommon.d.ts:271

removeSelectionListener

removeSelectionListener(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:307

removeViewFitListener

removeViewFitListener(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:313

removeViewFitModelsListener

removeViewFitModelsListener(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:318

removeVisibilityListener

removeVisibilityListener(target: ObjectStateListener): void
Parameters
- target: ObjectStateListener
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:309

resetAll

resetAll(): Promise<void>
Returns Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:300

resetColor

resetColor(query: Iterable<string> | BimQuery): Promise<void>
Returns
A Promise that triggers when all connected listeners have applied the change
Parameters
- query: Iterable<string> | BimQuery
Returns Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:296

setBuildingStoreysVisibleExclusive

setBuildingStoreysVisibleExclusive(query: Iterable<string> | BimQuery, hideOpenings?: boolean): Promise<unknown>
Parameters
- query: Iterable<string> | BimQuery
- Optional hideOpenings: boolean
Returns Promise<unknown>
- Defined in ViewerCommon/viewercommon.d.ts:328

setLabels

setLabels(labels: Label[]): void
Parameters
- labels: Label[]
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:302

setToSelectionSet

setToSelectionSet(query: Iterable<string> | BimQuery, type?: string): Promise<void>
Replace the currently selected set by the provided set of objects
Parameters
- query: Iterable<string> | BimQuery
- Optional type: string
Returns Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:256

setVisibleSet

setVisibleSet(query: Iterable<string> | BimQuery): Promise<void>
Parameters
- query: Iterable<string> | BimQuery
Returns Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:280

viewFit

viewFit(query: Iterable<string> | BimQuery, options: ViewFitOptions): Promise<void>
Parameters
- query: Iterable<string> | BimQuery
- options: ViewFitOptions
Returns Promise<void>
- Defined in ViewerCommon/viewercommon.d.ts:298

Generated using TypeDoc