Skip to main content

Class: TweakpaneWrapper

UI-Plugins.TweakpaneWrapper

Hierarchy

Constructors

constructor

new TweakpaneWrapper(expanded?, bigTheme?, limitedOptions?, autoPostFrame?, container?)

Parameters

NameTypeDefault value
expandedbooleanfalse
bigThemebooleanfalse
limitedOptionsbooleanfalse
autoPostFramebooleantrue
containerHTMLElementdocument.body

Overrides

SimpleEventDispatcher<'postFrame'\>.constructor

Defined in

webgi/src/ui/TweakpaneWrapper.ts:22

Methods

refreshQueue

refreshQueue(mode): void

Parameters

NameType
modeTUiRefreshModes

Returns

void

Defined in

webgi/src/ui/TweakpaneWrapper.ts:52


addToRefreshQueue

addToRefreshQueue(mode, params): void

Parameters

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

Returns

void

Defined in

webgi/src/ui/TweakpaneWrapper.ts:68


dispose

dispose(): void

Returns

void

Defined in

webgi/src/ui/TweakpaneWrapper.ts:85


appendUiObject

appendUiObject(p?, parent?): void

Parameters

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

Returns

void

Defined in

webgi/src/ui/TweakpaneWrapper.ts:90


removeUiObject

removeUiObject(objectMain?): void

Parameters

NameType
objectMain?IUiConfigContainer<any, string>

Returns

void

Defined in

webgi/src/ui/TweakpaneWrapper.ts:147


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

Defined in

webgi/src/ui/TweakpaneWrapper.ts:155


alert

alert(message?): Promise<void>

Parameters

NameType
message?string

Returns

Promise<void>

Defined in

webgi/src/ui/TweakpaneWrapper.ts:214


confirm

confirm(message?): Promise<boolean>

Parameters

NameType
message?string

Returns

Promise<boolean>

Defined in

webgi/src/ui/TweakpaneWrapper.ts:215


prompt

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

Parameters

NameTypeDefault value
message?stringundefined
_default?stringundefined
cancelbooleantrue

Returns

Promise<null | string>

Defined in

webgi/src/ui/TweakpaneWrapper.ts:216


_appendUiObject

Protected _appendUiObject(objectMain?, parent?): void

Parameters

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

Returns

void

Defined in

webgi/src/ui/TweakpaneWrapper.ts:119

Properties

_pane

Protected Optional _pane: Pane

Defined in

webgi/src/ui/TweakpaneWrapper.ts:17


_refreshQueue

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

Defined in

webgi/src/ui/TweakpaneWrapper.ts:39


_typeGenerators

Protected _typeGenerators: any

Defined in

webgi/src/ui/TweakpaneWrapper.ts:95