Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BimViewer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional container

container?: HTMLElement

enableFastOperation

enableFastOperation: boolean = true

enableSelection

enableSelection: boolean = true

Methods

activateMeasurement

  • Activates one of "Distance", "Area" or "Angle" measurement

    deprecated

    use MeasurePlugin instead

    Parameters

    Returns void

activateSection

  • Enable section. Currently, it only implemented local(object) box section.

    deprecated

    use SectionPlugin instead

    Parameters

    Returns void

addModel

  • description

    Add model data to viewer.

    Parameters

    Returns void

addPlugin

  • addPlugin(plugin: Plugin<{}>): void

  • Installs a Plugin.

    Parameters

    Returns void

clearMeasurements

  • clearMeasurements(): void

  • Clears all measurement results

    deprecated

    use MeasurePlugin instead

    Returns void

clearPlugins

  • clearPlugins(): void

  • Clears all plugins. A plugin is not created by viewer, thus, won't be destroyed by viewer.

    Returns void

clearSelection

  • clearSelection(): void

  • Clears the current selection

    Returns void

deactivateMeasurement

  • deactivateMeasurement(): void

  • Deactivates measurement

    deprecated

    use MeasurePlugin instead

    Returns void

deactivateSection

  • deactivateSection(): void

  • Deactivates section

    deprecated

    use SectionPlugin instead

    Returns void

destroy

  • destroy(): void

enableModelEdges

  • enableModelEdges(enable: boolean, onProgress?: ((event: ProgressEvent<EventTarget>) => void)): Promise<void>

  • Enables/disables model edges.

    Parameters

    • enable: boolean
    • Optional onProgress: ((event: ProgressEvent<EventTarget>) => void)
        • (event: ProgressEvent<EventTarget>): void

        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    Returns Promise<void>

findPlugin

  • findPlugin(id: string): undefined | Plugin<{}>

  • Finds a Plugin.

    Parameters

    • id: string

    Returns undefined | Plugin<{}>

flyTo

  • flyTo(position: Vector3, lookAt: Vector3): void

  • Make camera fly to target position with given lookAt position

    Parameters

    • position: Vector3

      camera's target position

    • lookAt: Vector3

      camera's new lookAt position

    Returns void

getCameraPositionAndDirection

  • getCameraPositionAndDirection(): undefined | { direction: Vector3; position: Vector3 }

  • Gets camera position and direction.

    Returns undefined | { direction: Vector3; position: Vector3 }

goToHomeView

  • goToHomeView(): void

  • Goes to home view

    Returns void

loadModel

  • loadModel(modelCfg: ModelConfig, onProgress?: ((event: ProgressEvent<EventTarget>) => void)): Promise<void>

  • Loads a 3d model

    Parameters

    • modelCfg: ModelConfig
    • Optional onProgress: ((event: ProgressEvent<EventTarget>) => void)
        • (event: ProgressEvent<EventTarget>): void

        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    Returns Promise<void>

removePlugin

  • removePlugin(plugin: Plugin<{}>): void

  • Uninstalls a Plugin, clearing content from it first.

    Parameters

    Returns void

setEnvironment

  • setEnvironment(hdrUrl: string): void

  • Sets environment for the scene.

    Parameters

    • hdrUrl: string

      Full path of picture url in hdr format

    Returns void

setFont

  • setFont(urls: string[]): Promise<void>

  • Sets font. This needs to be called before loading a dxf, it won't affect any loaded text. It accepts shx or typeface formats. For typeface, it only support passing in 1 font file in the array for now.

    Parameters

    • urls: string[]

      font file urls

    Returns Promise<void>

setToOrthographicCamera

  • setToOrthographicCamera(toOrtho?: boolean): void

  • Sets to orthographic or perspective camera.

    Parameters

    • toOrtho: boolean = false

      Set to orthographic camera if true.

    Returns void

viewFitAll

  • viewFitAll(): void

  • Fits the camera to view all objects in scene

    Returns void

zoomToBBox

  • zoomToBBox(bbox: Box3): void

  • Parameters

    • bbox: Box3

    Returns void

zoomToRect

  • zoomToRect(): void

  • Zooms to selected box area.

    Returns void

Generated using TypeDoc