Class: TweakpaneWrapper
UI-Plugins.TweakpaneWrapper
Hierarchy
SimpleEventDispatcher<"postFrame">↳
TweakpaneWrapper
Properties
undoManager
• Optional Readonly undoManager: JSUndoManager
_pane
• Protected Optional _pane: Pane
_container
• Protected Readonly _container: HTMLElement
_refreshQueue
• Protected _refreshQueue: Record<TUiRefreshModes, [undefined | IUiConfigContainer<any, string>, undefined | FolderApi, number, undefined | string][]>
_typeGenerators
• Protected _typeGenerators: any
Constructors
constructor
• new TweakpaneWrapper(expanded?, bigTheme?, limitedOptions?, autoPostFrame?, container?)
Parameters
| Name | Type | Default value |
|---|---|---|
expanded | boolean | false |
bigTheme | boolean | false |
limitedOptions | boolean | false |
autoPostFrame | boolean | true |
container | HTMLElement | document.body |
Overrides
SimpleEventDispatcher<'postFrame'\>.constructor
Methods
refreshQueue
▸ refreshQueue(mode): void
Parameters
| Name | Type |
|---|---|
mode | TUiRefreshModes |
Returns
void
addToRefreshQueue
▸ addToRefreshQueue(mode, params): void
Parameters
| Name | Type |
|---|---|
mode | TUiRefreshModes |
params | [undefined | IUiConfigContainer<any, string>, undefined | FolderApi, number] |
Returns
void
dispose
▸ dispose(): void
Returns
void
appendUiObject
▸ appendUiObject(p?, parent?): void
Parameters
| Name | Type |
|---|---|
p? | IUiConfigContainer<any, string> |
parent? | FolderApi |
Returns
void
appendChild
▸ appendChild(ui): void
Parameters
| Name | Type |
|---|---|
ui | UiObjectConfig<any, string> |
Returns
void
removeUiObject
▸ removeUiObject(objectMain?): void
Parameters
| Name | Type |
|---|---|
objectMain? | IUiConfigContainer<any, string> |
Returns
void
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
alert
▸ alert(message?): Promise<void>
Parameters
| Name | Type |
|---|---|
message? | string |
Returns
Promise<void>
confirm
▸ confirm(message?): Promise<boolean>
Parameters
| Name | Type |
|---|---|
message? | string |
Returns
Promise<boolean>
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>
_appendUiObject
▸ Protected _appendUiObject(objectMain?, parent?): void
Parameters
| Name | Type |
|---|---|
objectMain? | IUiConfigContainer<any, string> |
parent? | FolderApi |
Returns
void