Class Viewer2d

constructor

• new Viewer2d(
      objectStateManager: ObjectStateManager,
      settings?: Viewer2dSettings,
  ): 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: Iterable<Qid>): void | Promise<void>

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

  Parameters

  • qids: Iterable<Qid>

    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: Iterable<Qid>): Promise<void>

  Objects were added to the set of visible objects

  Parameters

  • qids: Iterable<Qid>

    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: Iterable<Model>,
      allVersions: Iterable<Model>,
  ): Promise<void>

  TODO: write description

  Parameters

  • newVersions: Iterable<Model>

    The new versions that were added

  • allVersions: Iterable<Model>

    A list of all the currently loaded versions

  Returns Promise<void>

cameraPoseUpdated

• cameraPoseUpdated(sourceViewer: any, pose: Pose): void

  The pose (eye, pivot, target) of a camera has been updated

  Parameters

  • sourceViewer: any

    A reference to the viewer that initiated the change, this can be used to detect self-calling

  • pose: Pose

    The new Camera pose

  Returns void

colorChanged

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

  Called when the colors of objects have been changed.

  Parameters

  • qids: Iterable<Qid>

    The object for which the color was changed

  • color: TinyColor

    The new color for those objects

  Returns void | Promise<void>

colorReset

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

  Called when the color of the given objects has been reset

  Parameters

  • qids: Iterable<Qid>

    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

getControl

• getControl(): Control

  Get access to the Control object for programmatic viewer manipulation

  Returns Control

getHeight

• getHeight(): number

  Get the height of the viewer in pixels

  Returns number

getModelManager

• getModelManager(): ModelManager

  Returns ModelManager

  The ModelManager connected to this viewer

getWidth

• getWidth(): number

  Get the width of the viewer in pixels

  Returns number

hoverOff

• hoverOff(qid: 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: Qid, previousQid: Qid, screenspaceLocation: vec2): 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: 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: Iterable<Qid>): void | Promise<void>

  Objects have been removed from the selection set

  Parameters

  • qids: Iterable<Qid>

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

  Returns void | Promise<void>

removedFromVisibleSet

• removedFromVisibleSet(qids: Iterable<Qid>): Promise<void>

  Objects were removed from the set of visible objects

  Parameters

  • qids: Iterable<Qid>

    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: unknown): Promise<void>

  TODO: write description

  Parameters

  • versions: unknown

  Returns Promise<void>

resize

• resize(width: number, height: number): void

  Parameters

  • width: number
  • height: number

  Returns void

screenshot

• screenshot(options?: ScreenshotOptions): 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: Iterable<Qid>): void

  Parameters

  • buildingStoreyQids: Iterable<Qid>

  Returns void

setBuildingStoreyVisibleExclusive

• setBuildingStoreyVisibleExclusive(buildingStoreyQid: unknown): void

  Parameters

  • buildingStoreyQid: unknown

  Returns void

setCameraConeDepth

• setCameraConeDepth(depth: number): void

  Set the depth of the camera cone, default is 250px

  Parameters

  • depth: number

    The depth in pixels

  Returns void

setCameraConeVisible

• setCameraConeVisible(visible: boolean): void

  Toggle whether the cone indicating where the 3D camera is (in a Viewer3d) should be visible, default is visible

  Parameters

  • visible: boolean

    Whether it should be visible

  Returns void

setCameraTrackingMode

• setCameraTrackingMode(mode: CameraTrackingMode): void

  Switch how the synced 3D camera indicator behaves inside the 2D viewer. "MAP" keeps the map fixed and lets the cone move through it. "FOLLOW" keeps the cone centered while moving the map, clamping manual interaction so the cone stays inside the viewport.

  Parameters

  • mode: CameraTrackingMode

    The camera tracking mode

  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: Iterable<Qid>,
      qidsToUnselect: Iterable<Qid>,
  ): void | Promise<void>

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

  Parameters

  • qids: Iterable<Qid>

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

  • qidsToUnselect: Iterable<Qid>

  Returns void | Promise<void>

setVisibleSet

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

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

  Parameters

  • qids: Iterable<Qid>

    The objects that have been made visible

  • qidsToHide: Iterable<Qid>

    The objects that have been made invisible

  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: boolean): 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: boolean): void

  Toggle whether faces are rendered.

  Parameters

  • enabled: boolean

    True when enabled

  Returns void

toggleIfcLineRendering

• toggleIfcLineRendering(enabled: boolean): 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

toggleUserPanning

• toggleUserPanning(enabled: boolean): void

  Toggle whether user panning (by mouse or touch device) is enabled or disabled. It is enabled by default

  Parameters

  • enabled: boolean

    Whether it should be enabled

  Returns void

toggleUserRotate

• toggleUserRotate(enabled: boolean): void

  Toggle whether user rotate (by mouse or touch device) is enabled or disabled. It is enabled by default

  Parameters

  • enabled: boolean

    Whether it should be enabled

  Returns void

toggleUserSelection

• toggleUserSelection(enabled: boolean): void

  Toggle whether user selection (by mouse or touch device) is enabled or disabled. It is enabled by default

  Parameters

  • enabled: boolean

    Whether it should be enabled

  Returns void

toggleUserZoom

• toggleUserZoom(enabled: boolean): void

  Toggle whether user zooming (by mouse wheel or touch device) is enabled or disabled. It is enabled by default. Changing this settings also enabled/disabled zoom on double-click

  Parameters

  • enabled: boolean

    Whether it should be enabled

  Returns void

toggleWireframeRendering

• toggleWireframeRendering(enabled: boolean): 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: Iterable<Qid>, options?: ViewFitOptions): void

  Fit the given object into view.

  Parameters

  • qids: Iterable<Qid>

    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: Iterable<string>,
      options?: ViewFitOptions,
  ): 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>