Class: TweakpaneUiPlugin
UI-Plugins.TweakpaneUiPlugin
Hierarchy
↳
TweakpaneUiPlugin
Implements
Properties
PluginType
▪ Static
Readonly
PluginType: "TweakpaneUi"
Defined in
webgi/src/ui/TweakpaneUiPlugin.ts:13
dependencies
• dependencies: typeof AssetManagerPlugin
[]
Implementation of
Defined in
webgi/src/ui/TweakpaneUiPlugin.ts:16
colorMode
• colorMode: "black"
| "white"
| "blue"
Defined in
webgi/src/ui/TweakpaneUiPlugin.ts:19
_pane
• Protected
Optional
_pane: Pane
Inherited from
Defined in
webgi/src/ui/TweakpaneWrapper.ts:17
_container
• Protected
Readonly
_container: HTMLElement
Inherited from
Defined in
webgi/src/ui/TweakpaneWrapper.ts:20
_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
Constructors
constructor
• new TweakpaneUiPlugin(expanded?
, bigTheme?
, limitedOptions?
, container?
, colorMode?
)
Parameters
Name | Type | Default value |
---|---|---|
expanded | boolean | false |
bigTheme | boolean | false |
limitedOptions | boolean | false |
container? | HTMLElement | undefined |
colorMode? | "black" | "white" | "blue" | undefined |
Overrides
Defined in
webgi/src/ui/TweakpaneUiPlugin.ts:21
Methods
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Defined in
webgi/src/ui/TweakpaneUiPlugin.ts:28
onDispose
▸ onDispose(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Defined in
webgi/src/ui/TweakpaneUiPlugin.ts:37
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Defined in
webgi/src/ui/TweakpaneUiPlugin.ts:42
setupPluginUi
▸ setupPluginUi<T
>(plugin
): undefined
| UiObjectConfig
<any
, string
>
Type parameters
Name | Type |
---|---|
T | extends IViewerPlugin <IViewerApp , boolean , T > |
Parameters
Name | Type |
---|---|
plugin | Class <T > |
Returns
undefined
| UiObjectConfig
<any
, string
>
Defined in
webgi/src/ui/TweakpaneUiPlugin.ts:60
setupPlugins
▸ setupPlugins<T
>(...plugins
): void
Type parameters
Name | Type |
---|---|
T | extends IViewerPlugin <IViewerApp , boolean , T > |
Parameters
Name | Type |
---|---|
...plugins | Class <T >[] |
Returns
void
Defined in
webgi/src/ui/TweakpaneUiPlugin.ts:118
refreshPluginsEnabled
▸ refreshPluginsEnabled(): void
Returns
void
Defined in
webgi/src/ui/TweakpaneUiPlugin.ts:123
alert
▸ alert(message?
): Promise
<void
>
Parameters
Name | Type |
---|---|
message? | string |
Returns
Promise
<void
>
Overrides
Defined in
webgi/src/ui/TweakpaneUiPlugin.ts:140
confirm
▸ confirm(message?
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
message? | string |
Returns
Promise
<boolean
>
Overrides
Defined in
webgi/src/ui/TweakpaneUiPlugin.ts:141
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
>
Overrides
Defined in
webgi/src/ui/TweakpaneUiPlugin.ts:142
refreshQueue
▸ refreshQueue(mode
): void
Parameters
Name | Type |
---|---|
mode | TUiRefreshModes |
Returns
void
Inherited from
Defined in
webgi/src/ui/TweakpaneWrapper.ts:54
addToRefreshQueue
▸ addToRefreshQueue(mode
, params
): void
Parameters
Name | Type |
---|---|
mode | TUiRefreshModes |
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
Defined in
webgi/src/ui/TweakpaneWrapper.ts:87
appendUiObject
▸ appendUiObject(p?
, parent?
): void
Parameters
Name | Type |
---|---|
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
Name | Type |
---|---|
objectMain? | IUiConfigContainer <any , string > |
Returns
void
Inherited from
TweakpaneWrapper.removeUiObject
Defined in
webgi/src/ui/TweakpaneWrapper.ts:149
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
Inherited from
TweakpaneWrapper.removeUiConfig
Defined in
webgi/src/ui/TweakpaneWrapper.ts:157
_colorModeChanged
▸ Protected
_colorModeChanged(): void
Returns
void
Defined in
webgi/src/ui/TweakpaneUiPlugin.ts:145
_appendUiObject
▸ Protected
_appendUiObject(objectMain?
, parent?
): void
Parameters
Name | Type |
---|---|
objectMain? | IUiConfigContainer <any , string > |
parent? | FolderApi |
Returns
void
Inherited from
TweakpaneWrapper._appendUiObject