Skip to main content

Class: TweakpaneUiPlugin

UI-Plugins.TweakpaneUiPlugin

Hierarchy

Implements

Properties

PluginType

Static Readonly PluginType: "TweakpaneUi"

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:13


dependencies

dependencies: typeof AssetManagerPlugin[]

Implementation of

IViewerPlugin.dependencies

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:16


colorMode

colorMode: "black" | "white" | "blue"

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:19


_pane

Protected Optional _pane: Pane

Inherited from

TweakpaneWrapper._pane

Defined in

webgi/src/ui/TweakpaneWrapper.ts:17


_container

Protected Readonly _container: HTMLElement

Inherited from

TweakpaneWrapper._container

Defined in

webgi/src/ui/TweakpaneWrapper.ts:20


_refreshQueue

Protected _refreshQueue: Record<TUiRefreshModes, [undefined | IUiConfigContainer<any, string>, undefined | FolderApi, number, undefined | string][]>

Inherited from

TweakpaneWrapper._refreshQueue

Defined in

webgi/src/ui/TweakpaneWrapper.ts:41


_typeGenerators

Protected _typeGenerators: any

Inherited from

TweakpaneWrapper._typeGenerators

Defined in

webgi/src/ui/TweakpaneWrapper.ts:97

Constructors

constructor

new TweakpaneUiPlugin(expanded?, bigTheme?, limitedOptions?, container?, colorMode?)

Parameters

NameTypeDefault value
expandedbooleanfalse
bigThemebooleanfalse
limitedOptionsbooleanfalse
container?HTMLElementundefined
colorMode?"black" | "white" | "blue"undefined

Overrides

TweakpaneWrapper.constructor

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:21

Methods

onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:28


onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:37


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:42


setupPluginUi

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

Type parameters

NameType
Textends IViewerPlugin<IViewerApp, boolean, T>

Parameters

NameType
pluginClass<T>

Returns

undefined | UiObjectConfig<any, string>

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:60


setupPlugins

setupPlugins<T>(...plugins): void

Type parameters

NameType
Textends IViewerPlugin<IViewerApp, boolean, T>

Parameters

NameType
...pluginsClass<T>[]

Returns

void

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:118


refreshPluginsEnabled

refreshPluginsEnabled(): void

Returns

void

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:123


alert

alert(message?): Promise<void>

Parameters

NameType
message?string

Returns

Promise<void>

Overrides

TweakpaneWrapper.alert

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:140


confirm

confirm(message?): Promise<boolean>

Parameters

NameType
message?string

Returns

Promise<boolean>

Overrides

TweakpaneWrapper.confirm

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:141


prompt

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

Parameters

NameTypeDefault value
message?stringundefined
_default?stringundefined
cancelbooleantrue

Returns

Promise<null | string>

Overrides

TweakpaneWrapper.prompt

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:142


refreshQueue

refreshQueue(mode): void

Parameters

NameType
modeTUiRefreshModes

Returns

void

Inherited from

TweakpaneWrapper.refreshQueue

Defined in

webgi/src/ui/TweakpaneWrapper.ts:54


addToRefreshQueue

addToRefreshQueue(mode, params): void

Parameters

NameType
modeTUiRefreshModes
params[undefined | IUiConfigContainer<any, string>, undefined | FolderApi, number]

Returns

void

Inherited from

TweakpaneWrapper.addToRefreshQueue

Defined in

webgi/src/ui/TweakpaneWrapper.ts:70


dispose

dispose(): void

Returns

void

Inherited from

TweakpaneWrapper.dispose

Defined in

webgi/src/ui/TweakpaneWrapper.ts:87


appendUiObject

appendUiObject(p?, parent?): void

Parameters

NameType
p?IUiConfigContainer<any, string>
parent?FolderApi

Returns

void

Inherited from

TweakpaneWrapper.appendUiObject

Defined in

webgi/src/ui/TweakpaneWrapper.ts:92


removeUiObject

removeUiObject(objectMain?): void

Parameters

NameType
objectMain?IUiConfigContainer<any, string>

Returns

void

Inherited from

TweakpaneWrapper.removeUiObject

Defined in

webgi/src/ui/TweakpaneWrapper.ts:149


removeUiConfig

removeUiConfig(uiConfig?): void

Dispose and removes the UI associated with a config, doesn't makes change to the object or its parent.

Parameters

NameType
uiConfig?UiObjectConfig<any, string>

Returns

void

Inherited from

TweakpaneWrapper.removeUiConfig

Defined in

webgi/src/ui/TweakpaneWrapper.ts:157


_colorModeChanged

Protected _colorModeChanged(): void

Returns

void

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:145


_appendUiObject

Protected _appendUiObject(objectMain?, parent?): void

Parameters

NameType
objectMain?IUiConfigContainer<any, string>
parent?FolderApi

Returns

void

Inherited from

TweakpaneWrapper._appendUiObject

Defined in

webgi/src/ui/TweakpaneWrapper.ts:121