Class Viewer3d

A 3D BIM viewer based on WebGL2. Minimal example:

Example

// Set up a connection with the repository
const factory = new BimWorksClientFactory("https://dev.bim.works");
// Create a new client, based on a pre-created API Token
const client = await factory.createClientWithApiToken("[YOUR API TOKEN]");
// The unique Version UUID of your model
const versionUuid = "[VERSION_UUID]";

// The ModelManager is responsible for keeping track of which models are loaded/unloaded
const modelManager = new ModelManager(client);

// The ObjectStateManager is responsible for keeping track of certain states of loaded objects such as visibility, color, selection
const objectStateManager = new ObjectStateManager(modelManager);
 
// Create a new Viewer3d
const viewer = new Viewer3d(objectStateManager);

// Initialize the new viewer, make sure to only continue after the returned Promise is resolved 
await viewer.initializeViewer();

// Add the canvas to the body of the page, so we can see it
document.body.appendChild(viewer.container);

// Load the required Version information from the server
const version = await client.fs.getNodeVersion(versionUuid);
// Load the model
await modelManager.addModels([version]);
// All models have now loaded successfully

Implements

ObjectStateListener

Index

Constructors

constructor

new Viewer3d(objectStateManager, loadProgressHandler?, settings?): Viewer3d
Create a new Viewer3d.
Parameters
- objectStateManager: ObjectStateManager
  The ObjectStateManager manages all object related state such as visibility, color and selection
- OptionalloadProgressHandler: LoadProgressHandler
  An object that get's specific methods called when there is progress to be reported
- Optionalsettings: Viewer3dSettings
  Optional settings
Returns Viewer3d
- Defined in viewer3d.d.ts:45

Properties

`Readonly`bimSurfer

bimSurfer: unknown

`Readonly`client

client: BimWorksClient

`Readonly`container

container: HTMLElement

`Readonly`modelManager

modelManager: ModelManager

`Readonly`objectStateManager

objectStateManager: ObjectStateManager

`Readonly`settings

settings: Viewer3dSettings

Methods

activateHistory

activateHistory(value): unknown
Parameters
- value: unknown
Returns unknown
- Defined in viewer3d.d.ts:147

addGisLayer

addGisLayer(id, gisLayer): void
Add a GIS Layer to the viewer
Parameters
- id: string
- gisLayer: GisLayer
Returns void
- Defined in viewer3d.d.ts:76

addModeChangeListener

addModeChangeListener(listener): void
Add a listener for mode updates
Parameters
- listener: ((mode: ViewerMode) => void)
  - - (mode): void
    - Parameters
      mode: ViewerMode
      Returns void
Returns void
- Defined in viewer3d.d.ts:298

addModels

addModels(versions): unknown
Parameters
- versions: Version[]
Returns unknown
- Defined in viewer3d.d.ts:103

addVertexClickListener

addVertexClickListener(listener): void
Register a listener to be called whenever a point is selected in MeasurementType "POINT"
Parameters
- listener: ((vertexInfo: unknown) => void)
  - - (vertexInfo): void
    - Parameters
      vertexInfo: unknown
      Returns void
Returns void
- Defined in viewer3d.d.ts:167

addedToSelectionSet

addedToSelectionSet(qids): void | Promise<void>
This method will get called when objects have been added to the selection.
Parameters
- qids: Iterable<string>
Returns void | Promise<void>
Implementation of ObjectStateListener.addedToSelectionSet
- Defined in viewer3d.d.ts:118

addedToVisibleSet

addedToVisibleSet(qids): void | Promise<void>
{@inheritDoc @bimworks/viewercommon!ObjectStateListener.addedToVisibleSet}
Parameters
- qids: Iterable<string>
Returns void | Promise<void>
Implementation of ObjectStateListener.addedToVisibleSet
- Defined in viewer3d.d.ts:127

colorChanged

colorChanged(qids, color): void | Promise<void>
{@inheritDoc @bimworks/viewercommon!ObjectStateListener.colorChanged}
Parameters
- qids: Iterable<string>
- color: Color
Returns void | Promise<void>
Implementation of ObjectStateListener.colorChanged
- Defined in viewer3d.d.ts:136

colorReset

colorReset(qids): void | Promise<void>
{@inheritDoc @bimworks/viewercommon!ObjectStateListener.colorReset}
Parameters
- qids: Iterable<string>
Returns void | Promise<void>
Implementation of ObjectStateListener.colorReset
- Defined in viewer3d.d.ts:139

createDefaultRenderLayer

createDefaultRenderLayer(): unknown
Returns unknown
- Defined in viewer3d.d.ts:157

destroy

destroy(): void
Destroys the viewer and any (heavy) resources associated with it. As long as there is a reference to the Viewer3d instance it won't be completely destroyed.

Returns void
- Defined in viewer3d.d.ts:275

disableSectionPlanes

disableSectionPlanes(): void
Disable any active sectionplanes

Returns void
- Defined in viewer3d.d.ts:309

focus

focus(): void
Focus the viewer

Returns void
- Defined in viewer3d.d.ts:390

frontView

frontView(): void
View the set of loaded models from the front

Returns void
- Defined in viewer3d.d.ts:85

getCamera

getCamera(): unknown
Returns unknown
The current Camera
- Defined in viewer3d.d.ts:162

getCanvas

getCanvas(): unknown
Returns unknown
The Canvas element used for rendering 3D content
- Defined in viewer3d.d.ts:329

getFocusAabb

getFocusAabb(): unknown
Returns unknown
- Defined in viewer3d.d.ts:151

getHeight

getHeight(): number
Get the height of the viewer in pixels

Returns number
- Defined in viewer3d.d.ts:324

getHistoryItem

getHistoryItem(): unknown
Returns unknown
- Defined in viewer3d.d.ts:148

getMeasuring

getMeasuring(): Measuring
Get a reference to the Measuring component which can be used for measurements related actions

Returns Measuring
- Defined in viewer3d.d.ts:366

getMode

getMode(): ViewerMode
Returns ViewerMode
The current viewer mode, either LOCAL (Using local coordinates) or GEO (Using geo coordinates)
- Defined in viewer3d.d.ts:63

getName

getName(): unknown
Returns unknown
- Defined in viewer3d.d.ts:146

getSectionPlanes

getSectionPlanes(): SectionPlanes
Get a reference to the SectionPlanes component which can be used for creating/modifying/removing section planes and boxes

Returns SectionPlanes
- Defined in viewer3d.d.ts:372

getSelectionMode

getSelectionMode(): SelectionMode
Returns SelectionMode
The current selection mode
- Defined in viewer3d.d.ts:385

getWidth

getWidth(): number
Get the width of the viewer in pixels

Returns number
- Defined in viewer3d.d.ts:319

hoverOff

hoverOff(qid): void
Called then the given object is not being hovered on anymore
Parameters
- qid: string
  The Qid of the object that is not being hovered over anymore
Returns void
Implementation of ObjectStateListener.hoverOff
- Defined in viewer3d.d.ts:347

hoverOn

hoverOn(qid, previousQid, screenspaceLocation): void
Called then the given object is being hovered on
Parameters
- qid: string
  The Qid of the object being hovered over
- previousQid: string
  The Qid of the previous objects that was being hovered over
- screenspaceLocation: vec2
  The screenspace location of the hover event. This can be useful to for example place a popup/tooltip at that location. Screenspace location is x, y coordinate between 0, 0 and canvas width,height
Returns void
Implementation of ObjectStateListener.hoverOn
- Defined in viewer3d.d.ts:344

initializeViewer

initializeViewer(): Promise<void>
Initializes the Viewer3d, it is important to wait for this async method to finish before calling any other methods on the viewer

Returns Promise<void>
- Defined in viewer3d.d.ts:79

internalLoadGisLayer

internalLoadGisLayer(id, geoReference): unknown
Parameters
- id: unknown
- geoReference: unknown
Returns unknown
- Defined in viewer3d.d.ts:154

isDoorOpeningRendering

isDoorOpeningRendering(): boolean
Returns boolean
Whether rendering of generated door opening directions is currently enabled
- Defined in viewer3d.d.ts:248

isFaceRendering

isFaceRendering(): boolean
Returns boolean
Whether face rendering is currently enabled
- Defined in viewer3d.d.ts:233

isForceTwoSidedRendering

isForceTwoSidedRendering(): boolean
Returns boolean
Whether forced two-sided rendering is currently enabled
- Defined in viewer3d.d.ts:253

isIfcLineRendering

isIfcLineRendering(): boolean
Returns boolean
Whether IFC line rendering is currently enabled
- Defined in viewer3d.d.ts:243

isShowType

isShowType(type): boolean
Parameters
- type: string
Returns boolean
Whether the given type is currently visible, see also setShowType and resetTypes
- Defined in viewer3d.d.ts:108

isVertexRendering

isVertexRendering(): boolean
Returns boolean
Whether vertex rendering is currently enabled
- Defined in viewer3d.d.ts:238

isWireframeRendering

isWireframeRendering(): boolean
Returns boolean
Whether wireframe rendering is currently enabled
- Defined in viewer3d.d.ts:228

modelsHidden

modelsHidden(versionUuids): unknown
Parameters
- versionUuids: Iterable<string>
Returns unknown
- Defined in viewer3d.d.ts:156

modelsShown

modelsShown(versionUuids): unknown
Parameters
- versionUuids: Iterable<string>
Returns unknown
- Defined in viewer3d.d.ts:155

primarySelectionChanged

primarySelectionChanged(qid): void | Promise<void>
{@inheritDoc @bimworks/viewercommon!ObjectStateListener.primarySelectionChanged}
Parameters
- qid: string
Returns void | Promise<void>
Implementation of ObjectStateListener.primarySelectionChanged
- Defined in viewer3d.d.ts:142

removeModeChangeListener

removeModeChangeListener(listener): void
Remove listener for mode updates
Parameters
- listener: ((mode: ViewerMode) => void)
  - - (mode): void
    - Parameters
      mode: ViewerMode
      Returns void
Returns void
- Defined in viewer3d.d.ts:304

removeModels

removeModels(versions): unknown
Parameters
- versions: Iterable<string>
Returns unknown
- Defined in viewer3d.d.ts:145

removedFromSelectionSet

removedFromSelectionSet(qids, type): void | Promise<void>
{@inheritDoc @bimworks/viewercommon!ObjectStateListener.removedFromSelectionSet}
Parameters
- qids: Iterable<string>
- type: string
Returns void | Promise<void>
Implementation of ObjectStateListener.removedFromSelectionSet
- Defined in viewer3d.d.ts:121

removedFromVisibleSet

removedFromVisibleSet(qids): void | Promise<void>
{@inheritDoc @bimworks/viewercommon!ObjectStateListener.removedFromVisibleSet}
Parameters
- qids: Iterable<string>
Returns void | Promise<void>
Implementation of ObjectStateListener.removedFromVisibleSet
- Defined in viewer3d.d.ts:133

render

render(): void
Request the viewer to re-render the content

Returns void
- Defined in viewer3d.d.ts:280

resetTypes

resetTypes(): void
Reset the information about shown/hidden types which can be changed with setShowType

Returns void
- Defined in viewer3d.d.ts:314

resize

resize(width, height): unknown
Resize the viewer. This should only ever be called when autoresizing is off. It is higly recommended to let the Viewer3d manage it's own size based on it's position within the document
Parameters
- width: number
- height: number
Returns unknown
- Defined in viewer3d.d.ts:99

screenshot

screenshot(options?): Promise<Blob>
Will take a screenshot of the contents of the Viewer3d.
Parameters
- Optionaloptions: ScreenshotOptions
  Optional options object
Returns Promise<Blob>
A Blob
Example
The returned Blob can for example be downloaded by the user, using the following example
```
 const width = viewer3d.width;
	const height = viewer3d.height;
	const filename = `screencapture-${width}x${height}.png`;
	Utils.downloadBlob(blob, filename);
```
- Defined in viewer3d.d.ts:183

setBuildingStoreyVisibleExclusive

setBuildingStoreyVisibleExclusive(qid): void | Promise<void>
Parameters
- qid: string
Returns void | Promise<void>
Implementation of ObjectStateListener.setBuildingStoreyVisibleExclusive
- Defined in viewer3d.d.ts:149

setBuildingStoreysVisibleExclusive

setBuildingStoreysVisibleExclusive(buildingStoreyQids, hideOpenings): void | Promise<void>
Parameters
- buildingStoreyQids: Iterable<string>
- hideOpenings: boolean
Returns void | Promise<void>
Implementation of ObjectStateListener.setBuildingStoreysVisibleExclusive
- Defined in viewer3d.d.ts:150

setHoverFaceColor

setHoverFaceColor(color): void
Set the face color for hovering. This color is mixed with the current color of the object (either original or overridden by user). Using a transparency component is currently not supported and results in undefined behaviour.
Parameters
- color: string
Returns void
- Defined in viewer3d.d.ts:335

setHoverWireframeColor

setHoverWireframeColor(color): void
Set the wireframe color for hovering. This color is mixed with the default wireframe color. Using a transparency component is currently not supported and results in undefined behaviour.
Parameters
- color: string
Returns void
- Defined in viewer3d.d.ts:341

setMode

setMode(mode): boolean
Set the current viewer mode, either LOCAL (Using local coordinates) or GEO (Using geo coordinates)
Parameters
- mode: ViewerMode
Returns boolean
A boolean indicating whether the mode was changed. Note that you can only switch to GEO mode if all loaded models are georeferenced. Also note than when nothing was changed as the result of calling this method, it also returns false
- Defined in viewer3d.d.ts:58

setMultiSelectMode

setMultiSelectMode(mode): void
Change the way multiselection is done (only applicable when ObjectStateManager's multiSelect is on). The default mode is SHIFT
Parameters
- mode: MultiSelectMode
  The new multiselection mode
Returns void
- Defined in viewer3d.d.ts:354

setSelectionMode

setSelectionMode(mode): void
Set the selection mode. Currently there are 2 modes, the default mode is SELECTION_DIRECT_PICKING.
Parameters
- mode: SelectionMode
  The new selection mode
Returns void
- Defined in viewer3d.d.ts:379

setSelectionVisualization

setSelectionVisualization(visualization): void
Change how the selection state is visualized
Parameters
- visualization: SelectionVisualization
  The type of visualization to use for selection, currently this can be either WireframeSelectionVisualization or NoneSelectionVisualization
Returns void
- Defined in viewer3d.d.ts:360

setShowType

setShowType(type, show): void
Show/hide a specific type, this overrules any visibility state of objects in the ObjectStateManager. The main reason for this method to exist is to hide common types such as IFCOPENINGELEMENT by default

To reset these to the defaults, see resetTypes
Parameters
- type: string
  The (IFC) type in all uppercase, examples: "IFCSPACE", "IFCOPENINGELEMENT"
- show: boolean
  Whether to enable/disable the given type
Returns void
- Defined in viewer3d.d.ts:73

setToSelectionSet

setToSelectionSet(qids, qidsToUnselect, type): void | Promise<void>
This method will get called when the set of selected objects has been
Parameters
- qids: Iterable<string>
- qidsToUnselect: Iterable<string>
- type: string
Returns void | Promise<void>
Implementation of ObjectStateListener.setToSelectionSet
- Defined in viewer3d.d.ts:124

setVisibleSet

setVisibleSet(shown, hidden, force): void | Promise<void>
{@inheritDoc @bimworks/viewercommon!ObjectStateListener.setVisibleSet}
Parameters
- shown: Iterable<string>
- hidden: Iterable<string>
- force: boolean
Returns void | Promise<void>
Implementation of ObjectStateListener.setVisibleSet
- Defined in viewer3d.d.ts:130

sideView

sideView(): void
View the set of loaded models from the side

Returns void
- Defined in viewer3d.d.ts:88

start

start(): void
Starts the viewer. The viewer will only redraw when needed.

Returns void
- Defined in viewer3d.d.ts:264

stop

stop(): void
Stops the viewer. When the viewer is stopped, the view is not updated anymore. Any changes to the viewer will be accumulated and become visible as soon as the viewer is started again The main reason for stopping the viewer would be for performance, for example when the viewer is currently hidden

Returns void
- Defined in viewer3d.d.ts:270

toggleAnimationEnabled

toggleAnimationEnabled(): unknown
Toggles the default animation, which is an animation that continously rotates the building along the Z-Axis

Returns unknown
- Defined in viewer3d.d.ts:94

toggleDoorOpeningRendering

toggleDoorOpeningRendering(enabled): void
Toggle whether (generated) door openings are rendered. This only works for models that have been processed when the repository setting features.generate_door_openings had been enabled. Some models contains door opening direction geometry as IFC lines, in those cases it's best to disabled rendering generated door openings.
Parameters
- enabled: boolean
  True when enabled
Returns void
- Defined in viewer3d.d.ts:217

toggleFaceRendering

toggleFaceRendering(enabled): void
Toggle whether faces are rendered.
Parameters
- enabled: boolean
  True when enabled
Returns void
- Defined in viewer3d.d.ts:198

toggleForceTwoSidedRendering

toggleForceTwoSidedRendering(enabled): void
Toggle whether to force always rendering faces two-sided (e.a. no back face culling). This overrules whatever BIM.works Repository has decided should happen.
Parameters
- enabled: boolean
  True when enabled
Returns void
- Defined in viewer3d.d.ts:223

toggleFullScreen

toggleFullScreen(enable?): void
Toggle whether the viewer is in fullscreen mode
Parameters
- Optionalenable: boolean
Returns void
- Defined in viewer3d.d.ts:259

toggleGisLayer

toggleGisLayer(id, show): void
Toggle a specific GIS Layer on or off
Parameters
- id: string
- show: boolean
Returns void
- Defined in viewer3d.d.ts:82

toggleIfcLineRendering

toggleIfcLineRendering(enabled): void
Toggle whether ifc lines are rendered. IFC Lines are all lines that have been defined in the original IFC file, such as Axis and FootPrint representations.
Parameters
- enabled: boolean
  True when enabled
Returns void
- Defined in viewer3d.d.ts:210

toggleVertexRendering

toggleVertexRendering(enabled): void
Toggle whether vertices are rendered. Currently this does not have much use, in the future it will be used for snapping.
Parameters
- enabled: boolean
  True when enabled
Returns void
- Defined in viewer3d.d.ts:204

toggleWireframeRendering

toggleWireframeRendering(enabled): void
Toggle whether wireframes are rendered. Wireframes are usually drawn to emphesize the edges and generally make the model look better
Parameters
- enabled: boolean
  True when enabled
Returns void
- Defined in viewer3d.d.ts:192

topView

topView(): void
View the set of loaded models from the top

Returns void
- Defined in viewer3d.d.ts:91

unloaded

unloaded(qids): void | Promise<void>
Parameters
- qids: Iterable<string>
Returns void | Promise<void>
Implementation of ObjectStateListener.unloaded
- Defined in viewer3d.d.ts:144

updateCameraTargetToAabbOf

updateCameraTargetToAabbOf(qids): unknown
Parameters
- qids: Iterable<string>
Returns unknown
- Defined in viewer3d.d.ts:109

viewFit

viewFit(qids, options?): void
Fit the given object into view.
Parameters
- qids: Iterable<string>
  The Qids of the objects to fit
- Optionaloptions: ViewFitOptions
  To provide a buffer around the objects. A percentage, where 0 means no buffer and 100 means only buffer
Returns void
Implementation of ObjectStateListener.viewFit
- Defined in viewer3d.d.ts:112

viewFitModels

viewFitModels(versionUuids, options?): void | Promise<void>
Fit the given models into view.
Parameters
- versionUuids: Iterable<string>
  The models to fit
- Optionaloptions: ViewFitOptions
  To provide a buffer around the objects. A percentage, where 0 means no buffer and 100 means only buffer
Returns void | Promise<void>
Implementation of ObjectStateListener.viewFitModels
- Defined in viewer3d.d.ts:115

zoom

zoom(value): unknown
Parameters
- value: number
Returns unknown
- Defined in viewer3d.d.ts:153

Class Viewer3d

Example

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Viewer3d

Properties

ReadonlybimSurfer

Readonlyclient

Readonlycontainer

ReadonlymodelManager

ReadonlyobjectStateManager

Readonlysettings

Methods

activateHistory

Parameters

Returns unknown

addGisLayer

Parameters

Returns void

addModeChangeListener

Parameters

Parameters

Returns void

Returns void

addModels

Parameters

Returns unknown

addVertexClickListener

Parameters

Parameters

Returns void

Returns void

addedToSelectionSet

Parameters

Returns void | Promise<void>

addedToVisibleSet

Parameters

Returns void | Promise<void>

colorChanged

Parameters

Returns void | Promise<void>

colorReset

Parameters

Returns void | Promise<void>

createDefaultRenderLayer

Returns unknown

destroy

Returns void

disableSectionPlanes

Returns void

focus

Returns void

frontView

Returns void

getCamera

Returns unknown

getCanvas

Returns unknown

getFocusAabb

Returns unknown

getHeight

Returns number

getHistoryItem

Returns unknown

getMeasuring

Returns Measuring

getMode

Returns ViewerMode

getName

Returns unknown

getSectionPlanes

Returns SectionPlanes

getSelectionMode

Returns SelectionMode

`Readonly`bimSurfer

`Readonly`client

`Readonly`container

`Readonly`modelManager

`Readonly`objectStateManager

`Readonly`settings