Skip to main content

Class: TweakpaneUiPlugin

UI-Plugins.TweakpaneUiPlugin

Hierarchy

Implements

Properties

PluginType

Static Readonly PluginType: "TweakpaneUi"

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:14


dependencies

dependencies: typeof AssetManagerPlugin[]

Implementation of

IViewerPlugin.dependencies

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:17


_pane

Protected Optional _pane: Pane

Inherited from

TweakpaneWrapper._pane

Defined in

webgi/src/ui/TweakpaneWrapper.ts:19


_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

Methods

addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
type"postFrame"
listener(event: IEvent<"postFrame">) => void

Returns

void

Implementation of

IViewerPlugin.addEventListener

Inherited from

TweakpaneWrapper.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:48


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameType
type"postFrame"
listener(event: IEvent<"postFrame">) => void

Returns

boolean

Implementation of

IViewerPlugin.hasEventListener

Inherited from

TweakpaneWrapper.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:56


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameType
type"postFrame"
listener(event: IEvent<"postFrame">) => void

Returns

void

Implementation of

IViewerPlugin.removeEventListener

Inherited from

TweakpaneWrapper.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"postFrame">

Returns

void

Implementation of

IViewerPlugin.dispatchEvent

Inherited from

TweakpaneWrapper.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:25


onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:34


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:39


setupPluginUi

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

Type parameters

NameType
Textends IViewerPlugin<IViewerApp, T>

Parameters

NameType
pluginClass<T>

Returns

undefined | UiObjectConfig<any, string>

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:57


setupPlugins

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

Type parameters

NameType
Textends IViewerPlugin<IViewerApp, T>

Parameters

NameType
...pluginsClass<T>[]

Returns

void

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:105


refreshPluginsEnabled

refreshPluginsEnabled(): void

Returns

void

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:110


alert

alert(message?): Promise<void>

Parameters

NameType
message?string

Returns

Promise<void>

Overrides

TweakpaneWrapper.alert

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:127


confirm

confirm(message?): Promise<boolean>

Parameters

NameType
message?string

Returns

Promise<boolean>

Overrides

TweakpaneWrapper.confirm

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:128


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:129


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:144


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:152


_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:120

Constructors

constructor

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

Parameters

NameTypeDefault value
expandedbooleanfalse
bigThemebooleanfalse
limitedOptionsbooleanfalse
containerHTMLElementdocument.body

Overrides

TweakpaneWrapper.constructor

Defined in

webgi/src/ui/TweakpaneUiPlugin.ts:19