Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SkyboxPlugin

Skybox plugin. It is mainly used by BimViewer, while can also be used by DxfViewer and VRViewer. You can set skybox in several means:

  1. Single color, by using setSkyboxByColor().
  2. Gradient colors, by using setSkyboxByGradientColors().
  3. Cube texture, by using setSkyboxByCubeTexture().

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly id

id: string

Methods

destroy

  • destroy(): void

  • Destroys this Plugin and removes it from its viewer.

    Returns void

setSkyboxByColor

  • setSkyboxByColor(color?: number[]): void

  • Set skybox by a single color.

    Parameters

    • color: number[] = ...

      rgb number array, each value is between 0 and 1. e.g. [0.92, 0.95, 0.96]

    Returns void

setSkyboxByCubeTexture

  • setSkyboxByCubeTexture(urls: string[]): void

  • Sets skybox by cube texture (6 images).

    Parameters

    • urls: string[]

    Returns void

setSkyboxByGradientColors

  • setSkyboxByGradientColors(topColor?: number[], skylineColor?: number[], bottomColor?: number[]): void

  • Sets skybox by 3 gradient colors (top, skyline, bottom).

    Parameters

    • topColor: number[] = ...
    • skylineColor: number[] = ...
    • bottomColor: number[] = ...

    Returns void

Generated using TypeDoc