Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SkyboxesPlugin

Viewer plugin that manages skyboxes

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

id

id: string

ID for this Plugin, unique within its Viewer.

viewer

viewer: Viewer

The Viewer that contains this Plugin.

Methods

clear

  • clear(): void

createSkybox

  • createSkybox(id: string, params: { active?: boolean }): any

  • Creates a skybox.

    Parameters

    • id: string

      Unique ID to assign to the skybox.

    • params: { active?: boolean }

      Skybox configuration.

      • Optional active?: boolean

    Returns any

    The new skybox.

destroy

  • destroy(): void

destroySkybox

  • destroySkybox(id: string): void

error

  • 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

  • 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

  • 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

  • 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

  • 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