Class: TweakpaneUiPlugin

UI-Plugins.TweakpaneUiPlugin

Hierarchy

• TweakpaneWrapper

  ↳ TweakpaneUiPlugin

Implements

• IViewerPluginAsync

Properties

PluginType

▪ Static Readonly PluginType: "TweakpaneUi"

---

dependencies

• dependencies: typeof AssetManagerPlugin[]

Implementation of

IViewerPluginAsync.dependencies

---

colorMode

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

---

undoManager

• Optional Readonly undoManager: JSUndoManager

Inherited from

TweakpaneWrapper.undoManager

---

_pane

• Protected Optional _pane: Pane

Inherited from

TweakpaneWrapper._pane

---

_container

• Protected Readonly _container: HTMLElement

Inherited from

TweakpaneWrapper._container

---

_refreshQueue

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

Inherited from

TweakpaneWrapper._refreshQueue

---

_typeGenerators

• Protected _typeGenerators: any

Inherited from

TweakpaneWrapper._typeGenerators

Constructors

constructor

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

Parameters

Name	Type	Default value
expanded	boolean	false
bigTheme	boolean	false
limitedOptions	boolean	false
container?	HTMLElement	undefined
colorMode?	"black" | "white" | "blue"	undefined

Overrides

TweakpaneWrapper.constructor

Methods

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onAdded

---

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onDispose

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onRemove

---

setupPluginUi

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

Type parameters

Name	Type
T	extends IViewerPlugin<boolean, T>

Parameters

Name	Type
plugin	Class<T>

Returns

undefined | UiObjectConfig<any, string>

---

setupPlugins

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

Type parameters

Name	Type
T	extends IViewerPlugin<boolean, T>

Parameters

Name	Type
...plugins	Class<T>[]

Returns

void

---

refreshPluginsEnabled

▸ refreshPluginsEnabled(): void

Returns

void

---

alert

▸ alert(message?): Promise<void>

Parameters

Name	Type
message?	string

Returns

Promise<void>

Overrides

TweakpaneWrapper.alert

---

confirm

▸ confirm(message?): Promise<boolean>

Parameters

Name	Type
message?	string

Returns

Promise<boolean>

Overrides

TweakpaneWrapper.confirm

---

prompt

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

Parameters

Name	Type	Default value
message?	string	undefined
_default?	string	undefined
cancel	boolean	true

Returns

Promise<null | string>

Overrides

TweakpaneWrapper.prompt

---

refreshQueue

▸ refreshQueue(mode): void

Parameters

Name	Type
mode	TUiRefreshModes

Returns

void

Inherited from

TweakpaneWrapper.refreshQueue

---

addToRefreshQueue

▸ addToRefreshQueue(mode, params): void

Parameters

Name	Type
mode	TUiRefreshModes
params	[undefined | IUiConfigContainer<any, string>, undefined | FolderApi, number]

Returns

void

Inherited from

TweakpaneWrapper.addToRefreshQueue

---

dispose

▸ dispose(): void

Returns

void

Inherited from

TweakpaneWrapper.dispose

---

appendUiObject

▸ appendUiObject(p?, parent?): void

Parameters

Name	Type
p?	IUiConfigContainer<any, string>
parent?	FolderApi

Returns

void

Inherited from

TweakpaneWrapper.appendUiObject

---

appendChild

▸ appendChild(ui): void

Parameters

Name	Type
ui	UiObjectConfig<any, string>

Returns

void

Inherited from

TweakpaneWrapper.appendChild

---

removeUiObject

▸ removeUiObject(objectMain?): void

Parameters

Name	Type
objectMain?	IUiConfigContainer<any, string>

Returns

void

Inherited from

TweakpaneWrapper.removeUiObject

---

removeUiConfig

▸ removeUiConfig(uiConfig?): void

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

Parameters

Name	Type
uiConfig?	UiObjectConfig<any, string>

Returns

void

Inherited from

TweakpaneWrapper.removeUiConfig

---

_colorModeChanged

▸ Protected _colorModeChanged(): void

Returns

void

---

_appendUiObject

▸ Protected _appendUiObject(objectMain?, parent?): void

Parameters

Name	Type
objectMain?	IUiConfigContainer<any, string>
parent?	FolderApi

Returns

void

Inherited from

TweakpaneWrapper._appendUiObject