Class GUI

Hierarchy

Constructors

constructor

new GUI(option?): GUI
Parameters
- Optional option: GUIParams
Returns GUI
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:62

Properties

__controllers

__controllers: GUIController<object>[]

__folders

__folders: {
[folderName: string]: GUI;
}

Type declaration

[folderName: string]: GUI

`Readonly` autoPlace

autoPlace: boolean

closed

closed: boolean

domElement

domElement: HTMLElement

`Readonly` load

load: Object

name

name: string

`Readonly` parent

parent: GUI

preset

preset: string

`Readonly` scrollable

scrollable: boolean

useLocalStorage

useLocalStorage: boolean

width

width: number

`Static` CLASS_AUTO_PLACE

CLASS_AUTO_PLACE: string

`Static` CLASS_AUTO_PLACE_CONTAINER

CLASS_AUTO_PLACE_CONTAINER: string

`Static` CLASS_CLOSED

CLASS_CLOSED: string

`Static` CLASS_CLOSE_BOTTOM

CLASS_CLOSE_BOTTOM: string

`Static` CLASS_CLOSE_BUTTON

CLASS_CLOSE_BUTTON: string

`Static` CLASS_CLOSE_TOP

CLASS_CLOSE_TOP: string

`Static` CLASS_CONTROLLER_ROW

CLASS_CONTROLLER_ROW: string

`Static` CLASS_DRAG

CLASS_DRAG: string

`Static` CLASS_MAIN

CLASS_MAIN: string

`Static` CLASS_TOO_TALL

CLASS_TOO_TALL: string

`Static` DEFAULT_WIDTH

DEFAULT_WIDTH: number

`Static` TEXT_CLOSED

TEXT_CLOSED: string

`Static` TEXT_OPEN

TEXT_OPEN: string

Methods

add

add<T>(target, propName, min?, max?, step?): GUIController<object>
Type Parameters
- T extends object
Parameters
- target: T
- propName: keyof T
- Optional min: number
- Optional max: number
- Optional step: number
Returns GUIController<object>
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:68
add<T>(target, propName, status): GUIController<object>
Type Parameters
- T extends object
Parameters
- target: T
- propName: keyof T
- status: boolean
Returns GUIController<object>
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:75
add<T>(target, propName, items): GUIController<object>
Type Parameters
- T extends object
Parameters
- target: T
- propName: keyof T
- items: string[]
Returns GUIController<object>
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:76
add<T>(target, propName, items): GUIController<object>
Type Parameters
- T extends object
Parameters
- target: T
- propName: keyof T
- items: number[]
Returns GUIController<object>
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:77
add<T>(target, propName, items): GUIController<object>
Type Parameters
- T extends object
Parameters
- target: T
- propName: keyof T
- items: Object
Returns GUIController<object>
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:78

addColor

addColor(target, propName): GUIController<object>
Parameters
- target: Object
- propName: string
Returns GUIController<object>
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:80

addFolder

addFolder(propName): GUI
Parameters
- propName: string
Returns GUI
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:85

close

close(): void
Returns void
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:89

destroy

destroy(): void
Returns void
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:83

getRoot

getRoot(): GUI
Returns GUI
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:94

getSaveObject

getSaveObject(): Object
Returns Object
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:96

hide

hide(): void
Returns void
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:90

listen

listen(controller): void
Parameters
- controller: GUIController<object>
Returns void
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:101

open

open(): void
Returns void
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:88

remember

remember(target, ...additionalTargets): void
Parameters
- target: Object
- Rest ...additionalTargets: Object[]
Returns void
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:93

remove

remove(controller): void
Parameters
- controller: GUIController<object>
Returns void
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:82

removeFolder

removeFolder(subFolder): void
Parameters
- subFolder: GUI
Returns void
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:86

revert

revert(gui): void
Parameters
- gui: GUI
Returns void
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:99

save

save(): void
Returns void
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:97

saveAs

saveAs(presetName): void
Parameters
- presetName: string
Returns void
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:98

show

show(): void
Returns void
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:91

updateDisplay

updateDisplay(): void
Returns void
- Defined in common/temp/node_modules/.pnpm/@types+dat.gui@0.7.10/node_modules/@types/dat.gui/index.d.ts:102

Class GUI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional option: GUIParams

Returns GUI

Properties

__controllers

__folders

Type declaration

[folderName: string]: GUI

Readonly autoPlace

closed

domElement

Readonly load

name

Readonly parent

preset

Readonly scrollable

useLocalStorage

width

Static CLASS_AUTO_PLACE

Static CLASS_AUTO_PLACE_CONTAINER

Static CLASS_CLOSED

Static CLASS_CLOSE_BOTTOM

Static CLASS_CLOSE_BUTTON

Static CLASS_CLOSE_TOP

Static CLASS_CONTROLLER_ROW

Static CLASS_DRAG

Static CLASS_MAIN

Static CLASS_TOO_TALL

Static DEFAULT_WIDTH

Static TEXT_CLOSED

Static TEXT_OPEN

Methods

add

Type Parameters

T extends object

Parameters

target: T

propName: keyof T

Optional min: number

Optional max: number

Optional step: number

Returns GUIController<object>

Type Parameters

T extends object

Parameters

target: T

propName: keyof T

status: boolean

Returns GUIController<object>

Type Parameters

T extends object

Parameters

target: T

propName: keyof T

items: string[]

Returns GUIController<object>

Type Parameters

T extends object

Parameters

target: T

propName: keyof T

items: number[]

Returns GUIController<object>

Type Parameters

T extends object

Parameters

target: T

propName: keyof T

items: Object

Returns GUIController<object>

addColor

Parameters

`Optional` option: GUIParams

`Readonly` autoPlace

`Readonly` load

`Readonly` parent

`Readonly` scrollable

`Static` CLASS_AUTO_PLACE

`Static` CLASS_AUTO_PLACE_CONTAINER

`Static` CLASS_CLOSED

`Static` CLASS_CLOSE_BOTTOM

`Static` CLASS_CLOSE_BUTTON

`Static` CLASS_CLOSE_TOP

`Static` CLASS_CONTROLLER_ROW

`Static` CLASS_DRAG

`Static` CLASS_MAIN

`Static` CLASS_TOO_TALL

`Static` DEFAULT_WIDTH

`Static` TEXT_CLOSED

`Static` TEXT_OPEN

`Optional` min: number

`Optional` max: number

`Optional` step: number

`Rest` ...additionalTargets: Object[]