Class TweakpaneUiPlugin

constructor

• new TweakpaneUiPlugin(
      expanded?: boolean,
      bigTheme?: boolean,
      container?: HTMLElement,
      colorMode?: "black" | "white" | "blue" | "light" | "dark",
  ): TweakpaneUiPlugin

  Parameters

  • expanded: boolean = ...
  • bigTheme: boolean = true
  • Optionalcontainer: HTMLElement
  • OptionalcolorMode: "black" | "white" | "blue" | "light" | "dark"

  Returns TweakpaneUiPlugin

colorMode

constructor

enabled

StaticCONTAINER_SLOT

Static ReadonlyPluginType

alert

• alert(message?: string): Promise<void>

  Parameters

  • Optionalmessage: string

  Returns Promise<void>

confirm

• confirm(message?: string): Promise<boolean>

  Parameters

  • Optionalmessage: string

  Returns Promise<boolean>

dispose

• dispose(): void

  Returns void

onAdded

• onAdded(viewer: ThreeViewer): void

  Parameters

  • viewer: ThreeViewer

  Returns void

onRemove

• onRemove(viewer: ThreeViewer): void

  Parameters

  • viewer: ThreeViewer

  Returns void

prompt

• prompt(
      message?: string,
      _default?: string,
      cancel?: boolean,
  ): Promise<null | string>

  Parameters

  • Optionalmessage: string
  • Optional_default: string
  • cancel: boolean = true

  Returns Promise<null | string>

refreshPluginsEnabled

• refreshPluginsEnabled(): void

  Returns void

setupPlugins

• setupPlugins(...plugins: Class<IViewerPlugin<ThreeViewer, boolean>>[]): void

  Parameters

  • ...plugins: Class<IViewerPlugin<ThreeViewer, boolean>>[]

  Returns void

setupPluginUi

• setupPluginUi<T extends IViewerPlugin<ThreeViewer, boolean>>(
      plugin: T | Class<T>,
      params?: Partial<UiObjectConfig<any, string, any>>,
  ): undefined | UiObjectConfig<any, string, any>

  Type Parameters

  • T extends IViewerPlugin<ThreeViewer, boolean>

  Parameters

  • plugin: T | Class<T>
  • Optionalparams: Partial<UiObjectConfig<any, string, any>>

  Returns undefined | UiObjectConfig<any, string, any>