Hierarchy

  • Viewer

Implements

Constructors

Properties

eventAfterRender: ListenableEvent<void, Viewer> = ...
eventBeforeRender: ListenableEvent<void, Viewer> = ...
eventResize: ListenableEvent<void, Viewer> = ...
handleWheelEvent: boolean

If false the wheel event will not be handled. Camera zoom in/out will be disabled in this case and default page scrolling will be performed instead. (default: true)

onDemandRenderingEnabled: boolean

Can be used to enable permanent rendering (mainly for debugging purpose). Disabling the on-demand rendering will also disable MSAA.

showPointerFeedback: boolean
MAX_DOUBLE_CLICK_DELAY: 300 = 300
POINTER_MOVE_TOLERANCE: number = ...

Accessors

  • get antiAliasingQuality(): number
  • defines the antialiasing quality, higher is better.

    Value Range

    [0, 32]

    Default Value

    32

    Returns number

  • set antiAliasingQuality(pQuality: number): void
  • Parameters

    • pQuality: number

    Returns void

  • get backgroundColor(): Color4
  • Returns Color4

  • set backgroundColor(pColor: Color4): void
  • Parameters

    • pColor: Color4

    Returns void

  • get canvas(): HTMLCanvasElement
  • Returns HTMLCanvasElement

  • get container(): HTMLDivElement
  • Returns HTMLDivElement

  • get fxaaEnabled(): boolean
  • Enables/disables FXAA. FXAA is used during user interaction to reduce aliasing. Note: It is not recommended to use FXAA in combination with a transparent background because this leads to artifacts in some cases.

    Default Value

    false

    Returns boolean

  • set fxaaEnabled(pValue: boolean): void
  • Parameters

    • pValue: boolean

    Returns void

  • get height(): number
  • Returns number

  • get isCreatingScreenshot(): boolean
  • true if the viewer is currently creating a screenshot

    Returns boolean

  • get renderingEnabled(): boolean
  • Returns boolean

  • get scene(): Scene
  • Returns Scene

  • get width(): number
  • Returns number

Methods

  • Can be used to disable the rendering. Nested calls are supported.

    Returns void

  • Parameters

    • pCoords: Vector3 | Vector2

    Returns Vector2

  • Parameters

    • pCoords: Vector3 | Vector2
    • pTarget: Vector3 | Vector2

    Returns void

  • Creates a screenshot and returns it as data uri or blob.

    Parameters

    Returns Promise<string>

  • Parameters

    Returns Promise<string>

  • Parameters

    Returns Promise<Blob>

  • Parameters

    Returns Promise<string | Blob>

  • Returns void

  • Can be used to re-enable the rendering. Nested calls are supported.

    Returns void

  • Forces immediate/synchronous rendering of the scene. This function should be used with care. Under normal circumstances requestRenderFrame() should be used instead.

    Returns void

  • Parameters

    • pAutoResize: boolean

    Returns boolean

  • Has to be called if the viewer should render the scene. (e.g. after the camera has changed)

    Returns void

  • Resets the camera settings of the view.

    Returns void

  • Resizes the gl context to fit the current container/canvas size.

    Parameters

    • pImmediateResize: boolean = false

      If true the resize will be performed immediately otherwise it will be delayed in order to merge consecutive resize() calls. (default: false)

    Returns void

  • Parameters

    • pCoords: Vector3 | Vector2

    Returns Vector2

  • Parameters

    • pCoords: Vector3 | Vector2
    • pTarget: Vector3 | Vector2

    Returns void

Generated using TypeDoc