Class: TweakpaneWrapper
UI-Plugins.TweakpaneWrapper
Hierarchy
SimpleEventDispatcher
<"postFrame"
>↳
TweakpaneWrapper
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
Defined in
webgi/src/ui/TweakpaneWrapper.ts:22
Methods
refreshQueue
▸ refreshQueue(mode
): void
Parameters
Name | Type |
---|---|
mode | TUiRefreshModes |
Returns
void
Defined in
webgi/src/ui/TweakpaneWrapper.ts:52
addToRefreshQueue
▸ addToRefreshQueue(mode
, params
): void
Parameters
Name | Type |
---|---|
mode | TUiRefreshModes |
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
Name | Type |
---|---|
p? | IUiConfigContainer <any , string > |
parent? | FolderApi |
Returns
void
Defined in
webgi/src/ui/TweakpaneWrapper.ts:90
removeUiObject
▸ removeUiObject(objectMain?
): void
Parameters
Name | Type |
---|---|
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
Name | Type |
---|---|
uiConfig? | UiObjectConfig <any , string > |
Returns
void
Defined in
webgi/src/ui/TweakpaneWrapper.ts:155
alert
▸ alert(message?
): Promise
<void
>
Parameters
Name | Type |
---|---|
message? | string |
Returns
Promise
<void
>
Defined in
webgi/src/ui/TweakpaneWrapper.ts:214
confirm
▸ confirm(message?
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
message? | string |
Returns
Promise
<boolean
>
Defined in
webgi/src/ui/TweakpaneWrapper.ts:215
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
>
Defined in
webgi/src/ui/TweakpaneWrapper.ts:216
_appendUiObject
▸ Protected
_appendUiObject(objectMain?
, parent?
): void
Parameters
Name | Type |
---|---|
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