Options
All
  • Public
  • Public/Protected
  • All
Menu

Viewer plugin that makes interaction smoother with large models, by temporarily switching the Viewer to faster, lower-quality rendering modes whenever we interact.

Hierarchy

Index

Constructors

Properties

id: string

ID for this Plugin, unique within its Viewer.

viewer: Viewer

The Viewer that contains this Plugin.

Accessors

  • get delayBeforeRestore(): boolean
  • set delayBeforeRestore(value: boolean): void
  • get delayBeforeRestoreSeconds(): number
  • set delayBeforeRestoreSeconds(value: number): void
  • get hideEdges(): boolean
  • set hideEdges(value: boolean): void
  • get hidePBR(): boolean
  • set hidePBR(value: boolean): void
  • Gets whether to temporarily hide physically-based rendering (PBR) whenever we interact with the Viewer.

    Default is true.

    Returns boolean

    true if hiding PBR.

  • Sets whether to temporarily hide physically-based rendering (PBR) whenever we interact with the Viewer.

    Default is true.

    Parameters

    • value: boolean

      true to hide PBR.

    Returns void

  • get hideSAO(): boolean
  • set hideSAO(value: boolean): void
  • Gets whether to temporarily hide scalable ambient shadows (SAO) whenever we interact with the Viewer.

    Default is true.

    Returns boolean

    true if hiding SAO.

  • Sets whether to temporarily hide scalable ambient shadows (SAO) whenever we interact with the Viewer.

    Default is true.

    Parameters

    • value: boolean

      true to hide SAO.

    Returns void

  • get hideTransparentObjects(): boolean
  • set hideTransparentObjects(value: boolean): void
  • Gets whether to temporarily hide transparent objects whenever we interact with the Viewer.

    Does not hide X-rayed, selected, highlighted objects.

    Default is false.

    Returns boolean

    true if hiding transparent objects.

  • Sets whether to temporarily hide transparent objects whenever we interact with the Viewer.

    Does not hide X-rayed, selected, highlighted objects.

    Default is false.

    Parameters

    • value: boolean

      true to hide transparent objects.

    Returns void

  • get scaleCanvasResolution(): boolean
  • set scaleCanvasResolution(value: boolean): void
  • get scaleCanvasResolutionFactor(): number
  • set scaleCanvasResolutionFactor(value: number): void

Methods

  • destroy(): void
  • error(msg: string): void
  • Logs an error message to the JavaScript developer console, prefixed with the ID of this Plugin.

    Parameters

    • msg: string

      The error message

    Returns void

  • fire(event: string, value: any): void
  • Fires an event at this Plugin.

    Parameters

    • event: string

      The event type name

    • value: any

      The event parameters

    Returns void

  • log(msg: string): void
  • Logs a message to the JavaScript developer console, prefixed with the ID of this Plugin.

    Parameters

    • msg: string

      The error message

    Returns void

  • on(event: string, callback: () => void): void
  • Subscribes to an event fired at this Plugin.

    Parameters

    • event: string

      The event

    • callback: () => void

      Callback fired on the event

        • (): void
        • Returns void

    Returns void

  • warn(msg: string): void
  • Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.

    Parameters

    • msg: string

      The error message

    Returns void

Generated using TypeDoc