Skip to main content

Class: TweakpaneWrapper

UI-Plugins.TweakpaneWrapper

Hierarchy

Methods

addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

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

Returns

void

Inherited from

SimpleEventDispatcher.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

Inherited from

SimpleEventDispatcher.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

Inherited from

SimpleEventDispatcher.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"postFrame">

Returns

void

Inherited from

SimpleEventDispatcher.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


refreshQueue

refreshQueue(mode): void

Parameters

NameType
modeTUiRefreshModes

Returns

void

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

Defined in

webgi/src/ui/TweakpaneWrapper.ts:70


dispose

dispose(): void

Returns

void

Defined in

webgi/src/ui/TweakpaneWrapper.ts:87


appendUiObject

appendUiObject(p?, parent?): void

Parameters

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

Returns

void

Defined in

webgi/src/ui/TweakpaneWrapper.ts:92


removeUiObject

removeUiObject(objectMain?): void

Parameters

NameType
objectMain?IUiConfigContainer<any, string>

Returns

void

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

Defined in

webgi/src/ui/TweakpaneWrapper.ts:152


alert

alert(message?): Promise<void>

Parameters

NameType
message?string

Returns

Promise<void>

Defined in

webgi/src/ui/TweakpaneWrapper.ts:211


confirm

confirm(message?): Promise<boolean>

Parameters

NameType
message?string

Returns

Promise<boolean>

Defined in

webgi/src/ui/TweakpaneWrapper.ts:212


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


_appendUiObject

Protected _appendUiObject(objectMain?, parent?): void

Parameters

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

Returns

void

Defined in

webgi/src/ui/TweakpaneWrapper.ts:120

Constructors

constructor

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

Parameters

NameTypeDefault value
expandedbooleanfalse
bigThemebooleanfalse
limitedOptionsbooleanfalse
autoPostFramebooleantrue
containerHTMLElementdocument.body

Overrides

SimpleEventDispatcher.constructor

Defined in

webgi/src/ui/TweakpaneWrapper.ts:24

Properties

_pane

Protected Optional _pane: Pane

Defined in

webgi/src/ui/TweakpaneWrapper.ts:19


_refreshQueue

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

Defined in

webgi/src/ui/TweakpaneWrapper.ts:41


_typeGenerators

Protected _typeGenerators: any

Defined in

webgi/src/ui/TweakpaneWrapper.ts:97