Class TweakpaneUiPlugin

constructor

• new TweakpaneUiPlugin(expanded?, bigTheme?, container?, colorMode?): TweakpaneUiPlugin

• Parameters

  • expanded: boolean = false

  • bigTheme: boolean = true

  • container: HTMLElement = document.body

  • Optional colorMode: "black" | "white" | "blue"

  Returns TweakpaneUiPlugin

colorMode

constructor

enabled

Static Readonly PluginType

alert

• alert(message?): Promise<void>

• Parameters

  • Optional message: string

  Returns Promise<void>

confirm

• confirm(message?): Promise<boolean>

• Parameters

  • Optional message: string

  Returns Promise<boolean>

onAdded

• onAdded(viewer): void

• Parameters

  • viewer: ThreeViewer

  Returns void

onRemove

• onRemove(viewer): void

• Parameters

  • viewer: ThreeViewer

  Returns void

prompt

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

• Parameters

  • Optional message: string

  • Optional _default: string

  • cancel: boolean = true

  Returns Promise<null | string>

refreshPluginsEnabled

• refreshPluginsEnabled(): void

• Returns void

setupPluginUi

• setupPluginUi<T>(plugin, params?): undefined | UiObjectConfig<any, string, any>

• Type Parameters

  • T extends IViewerPlugin<ThreeViewer, boolean>

  Parameters

  • plugin: T | Class<T>

  • Optional params: Partial<UiObjectConfig<any, string, any>>

  Returns undefined | UiObjectConfig<any, string, any>

setupPlugins

• setupPlugins(...plugins): void

• Parameters

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

  Returns void