Class Viewer2d

constructor

• new Viewer2d(objectStateManager, settings?): Viewer2d

• Create a new Viewer2d

  Parameters

  • objectStateManager: ObjectStateManager

    The ObjectStateManager manages all object related state such as visibility, color and selection
  • Optionalsettings: Viewer2dSettings

    Optional settings, will use default settings when not provided

  Returns Viewer2d

Readonlycontainer

ReadonlymodelManager

ReadonlyobjectStateManager

addedToSelectionSet

• addedToSelectionSet(qids): void | Promise<void>

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

  Parameters

  • qids: Iterable<Qid, any, any>

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

  Returns void | Promise<void>

addedToVisibleSet

• addedToVisibleSet(qids): Promise<void>

• Objects were added to the set of visible objects

  Parameters

  • qids: Iterable<Qid, any, any>

    An Iterable of all the objects that were added

  Returns Promise<void>

  This method can return a Promise, if it does, subsequent listeners will only be notified after the returned Promise has resolved

addModels

• addModels(newVersions, allVersions): Promise<void>

• TODO: write description

  Parameters

  • newVersions: Iterable<Model, any, any>

    The new versions that were added
  • allVersions: Iterable<Model, any, any>

    A list of all the currently loaded versions

  Returns Promise<void>

colorChanged

• colorChanged(qids, color): void | Promise<void>

• Called when the colors of objects have been changed.

  Parameters

  • qids: Iterable<Qid, any, any>

    The object for which the color was changed
  • color: TinyColor

    The new color for those objects

  Returns void | Promise<void>

colorReset

• colorReset(qids): void | Promise<void>

• Called when the color of the given objects has been reset

  Parameters

  • qids: Iterable<Qid, any, any>

    The Qids of the objects for which the color has been reset

  Returns void | Promise<void>

destroy

• destroy(): void

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

  Returns void

getHeight

• getHeight(): number

• Get the height of the viewer in pixels

  Returns number

getWidth

• getWidth(): number

• Get the width of the viewer in pixels

  Returns number

hoverOff

• hoverOff(qid): void

• Called then the given object is not being hovered on anymore

  Parameters

  • qid: Qid

    The Qid of the object that is not being hovered over anymore

  Returns void

hoverOn

• hoverOn(qid, previousQid, screenspaceLocation): void

• Called then the given object is being hovered on

  Parameters

  • qid: Qid

    The Qid of the object being hovered over
  • previousQid: Qid

    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

init

• init(): Promise<void>

• This method must be called before loading any of the models. Keep in mind that this method is async, and models can only be loaded after the returned Promise has resolved.

  Returns Promise<void>

isDoorOpeningRendering

• isDoorOpeningRendering(): boolean

• Returns boolean

  Whether rendering of generated door opening directions is currently enabled

isFaceRendering

• isFaceRendering(): boolean

• Returns boolean

  Whether face rendering is currently enabled

isIfcLineRendering

• isIfcLineRendering(): boolean

• Returns boolean

  Whether IFC line rendering is currently enabled

isWireframeRendering

• isWireframeRendering(): boolean

• Returns boolean

  Whether wireframe rendering is currently enabled

primarySelectionChanged

• primarySelectionChanged(qid): void | Promise<unknown>

• The primary selection has changed

  Parameters

  • qid: Qid

    The Qid of the newly selected primary object or null if primary selection was unselected

  Returns void | Promise<unknown>

removedFromSelectionSet

• removedFromSelectionSet(qids): void | Promise<void>

• Objects have been removed from the selection set

  Parameters

  • qids: Iterable<Qid, any, any>

    The Qids of the objects that have been removed from the selection set

  Returns void | Promise<void>

removedFromVisibleSet

• removedFromVisibleSet(qids): Promise<void>

• Objects were removed from the set of visible objects

  Parameters

  • qids: Iterable<Qid, any, any>

    An Iterable of all the objects that were removed

  Returns Promise<void>

  This method can return a Promise, if it does, subsequent listeners will only be notified after the returned Promise has resolved

removeModels

• removeModels(versions): Promise<void>

• TODO: write description

  Parameters

  • versions: unknown

  Returns Promise<void>

resize

• resize(width, height): void

• Parameters

  • width: number
  • height: number

  Returns void

screenshot

• screenshot(options?): Promise<Blob>

• Will take a screenshot of the contents of the Viewer2d.

  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 = viewer2d.width;
  	const height = viewer2d.height;
  	const filename = `screencapture-${width}x${height}.png`;
  	Utils.downloadBlob(blob, filename);
  Copy

setBuildingStoreysVisibleExclusive

• setBuildingStoreysVisibleExclusive(buildingStoreyQids): void

• Parameters

  • buildingStoreyQids: Iterable<Qid, any, any>

  Returns void

setBuildingStoreyVisibleExclusive

• setBuildingStoreyVisibleExclusive(buildingStoreyQid): void

• Parameters

  • buildingStoreyQid: unknown

  Returns void

setDirty

• setDirty(): void

• To be called whenever the rendering state has changed and updates need to become visible

  Returns void

setToSelectionSet

• setToSelectionSet(qids, qidsToUnselect): void | Promise<void>

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

  Parameters

  • qids: Iterable<Qid, any, any>

    Iterable<@bimworks/jssdk!Qid> that provides the @bimworks/jssdk!Qids of the objects added to the selection set.
  • qidsToUnselect: Iterable<Qid, any, any>

  Returns void | Promise<void>

setVisibleSet

• setVisibleSet(qids, qidsToHide): void | Promise<unknown>

• The set of visible objects has been replaced to the given set

  Parameters

  • qids: Iterable<Qid, any, any>
  • qidsToHide: Iterable<Qid, any, any>

  Returns void | Promise<unknown>

  This method can return a Promise, if it does, subsequent listeners will only be notified after the returned Promise has resolved

start

• start(): void

• Starts the viewer. The viewer will only redraw when needed.

  Returns void

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

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

toggleFaceRendering

• toggleFaceRendering(enabled): void

• Toggle whether faces are rendered.

  Parameters

  • enabled: boolean

    True when enabled

  Returns void

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

toggleShowText

• toggleShowText(): void

• Toggles whether the text labels are shown

  Returns void

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

viewFit

• viewFit(qids, options?): void

• Fit the given object into view.

  Parameters

  • qids: Iterable<Qid, any, any>

    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

viewFitModels

• viewFitModels(versionUuids, options?): void | Promise<void>

• Fit the given models into view.

  Parameters

  • versionUuids: Iterable<string, any, any>

    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>