Class DebugGUI

DebugGUI - Voxel-3D debug gui

lil-gui를 래핑하여 디버그 패널을 제공합니다.

Remarks

lil-gui 동적 load
폴더 구조 지원
다양한 컨트롤 타입
값 변경 추적

Example

const gui = new DebugGUI({ title: 'Voxel-3D Debug' });

// 폴더 추가
const cameraFolder = gui.addFolder('Camera');

// add controls
gui.addNumber(camera.position, 'x', { min: -100, max: 100 }, cameraFolder);
gui.addNumber(camera.position, 'y', { min: -100, max: 100 }, cameraFolder);
gui.addBoolean(settings, 'autoRotate');

// 버튼 추가
gui.addButton('Reset Camera', { onClick: () => resetCamera() });

Implements

IDebugGUI

Index

Accessors

ready

get ready(): Promise<void>
GUI initialization 완료 Promise

Returns Promise<void>
GUI가 준비되면 resolve되는 Promise
Implementation of IDebugGUI.ready
- Defined in debug/debug-gui/DebugGUI.ts:112

isVisible

get isVisible(): boolean
GUI 가시성 state

Returns boolean
Implementation of IDebugGUI.isVisible
- Defined in debug/debug-gui/DebugGUI.ts:158

Constructors

constructor

new DebugGUI(config?: DebugGUIConfig): DebugGUI
Parameters
- config: DebugGUIConfig = {}
Returns DebugGUI
- Defined in debug/debug-gui/DebugGUI.ts:87

Methods

show

show(): void
GUI 표시

Returns void
Implementation of IDebugGUI.show
- Defined in debug/debug-gui/DebugGUI.ts:167

hide

hide(): void
GUI 숨김

Returns void
Implementation of IDebugGUI.hide
- Defined in debug/debug-gui/DebugGUI.ts:176

toggle

toggle(): void
GUI 가시성 토글

Returns void
Implementation of IDebugGUI.toggle
- Defined in debug/debug-gui/DebugGUI.ts:185

addFolder

addFolder(
    name: string,
    options?: Omit<FolderOptions, "name">,
    parentFolderId?: string,
): string
폴더 추가
Parameters
- name: string
- Optionaloptions: Omit<FolderOptions, "name">
- OptionalparentFolderId: string
Returns string
폴더 ID
Implementation of IDebugGUI.addFolder
- Defined in debug/debug-gui/DebugGUI.ts:199

removeFolder

removeFolder(folderId: string): void
폴더 제거
Parameters
- folderId: string
Returns void
Implementation of IDebugGUI.removeFolder
- Defined in debug/debug-gui/DebugGUI.ts:227

openFolder

openFolder(folderId: string): void
폴더 열기
Parameters
- folderId: string
Returns void
Implementation of IDebugGUI.openFolder
- Defined in debug/debug-gui/DebugGUI.ts:239

closeFolder

closeFolder(folderId: string): void
폴더 닫기
Parameters
- folderId: string
Returns void
Implementation of IDebugGUI.closeFolder
- Defined in debug/debug-gui/DebugGUI.ts:249

addNumber

addNumber(
    object: Record<string, unknown>,
    property: string,
    options?: NumberControlOptions,
    folderId?: string,
): string
숫자 add controls
Parameters
- object: Record<string, unknown>
- property: string
- Optionaloptions: NumberControlOptions
- OptionalfolderId: string
Returns string
컨트롤 ID
Implementation of IDebugGUI.addNumber
- Defined in debug/debug-gui/DebugGUI.ts:262

addBoolean

addBoolean(
    object: Record<string, unknown>,
    property: string,
    options?: BaseControlOptions,
    folderId?: string,
): string
불리언 add controls
Parameters
- object: Record<string, unknown>
- property: string
- Optionaloptions: BaseControlOptions
- OptionalfolderId: string
Returns string
컨트롤 ID
Implementation of IDebugGUI.addBoolean
- Defined in debug/debug-gui/DebugGUI.ts:307

addString

addString(
    object: Record<string, unknown>,
    property: string,
    options?: BaseControlOptions,
    folderId?: string,
): string
문자열 add controls
Parameters
- object: Record<string, unknown>
- property: string
- Optionaloptions: BaseControlOptions
- OptionalfolderId: string
Returns string
컨트롤 ID
Implementation of IDebugGUI.addString
- Defined in debug/debug-gui/DebugGUI.ts:349

addColor

addColor(
    object: Record<string, unknown>,
    property: string,
    options?: BaseControlOptions,
    folderId?: string,
): string
색상 add controls
Parameters
- object: Record<string, unknown>
- property: string
- Optionaloptions: BaseControlOptions
- OptionalfolderId: string
Returns string
컨트롤 ID
Implementation of IDebugGUI.addColor
- Defined in debug/debug-gui/DebugGUI.ts:391

addSelect

addSelect(
    object: Record<string, unknown>,
    property: string,
    options: SelectControlOptions,
    folderId?: string,
): string
선택 add controls
Parameters
- object: Record<string, unknown>
- property: string
- options: SelectControlOptions
- OptionalfolderId: string
Returns string
컨트롤 ID
Implementation of IDebugGUI.addSelect
- Defined in debug/debug-gui/DebugGUI.ts:433

addButton

addButton(
    name: string,
    options: ButtonControlOptions,
    folderId?: string,
): string
버튼 add controls
Parameters
- name: string
- options: ButtonControlOptions
- OptionalfolderId: string
Returns string
컨트롤 ID
Implementation of IDebugGUI.addButton
- Defined in debug/debug-gui/DebugGUI.ts:475

removeControl

removeControl(controlId: string): void
컨트롤 제거
Parameters
- controlId: string
Returns void
Implementation of IDebugGUI.removeControl
- Defined in debug/debug-gui/DebugGUI.ts:506

onValueChange

onValueChange(handler: GUIValueChangeHandler): () => void
값 변경 handlers 등록
Parameters
- handler: GUIValueChangeHandler
Returns () => void
unsubscribe 함수
Implementation of IDebugGUI.onValueChange
- Defined in debug/debug-gui/DebugGUI.ts:521

refresh

refresh(): void
모든 컨트롤 새로고침

Returns void
Implementation of IDebugGUI.refresh
- Defined in debug/debug-gui/DebugGUI.ts:531

getItems

getItems(): GUIItem[]
모든 gui items 조회

Returns GUIItem[]
Implementation of IDebugGUI.getItems
- Defined in debug/debug-gui/DebugGUI.ts:545

dispose

dispose(): void
리소스 cleanup

Returns void
Implementation of IDebugGUI.dispose
- Defined in debug/debug-gui/DebugGUI.ts:623

Class DebugGUI

Remarks

Example

Implements

Index

Accessors

Constructors

Methods

Accessors

ready

Returns Promise<void>

isVisible

Returns boolean

Constructors

constructor

Parameters

Returns DebugGUI

Methods

show

Returns void

hide

Returns void

toggle

Returns void

addFolder

Parameters

Returns string

removeFolder

Parameters

Returns void

openFolder

Parameters

Returns void

closeFolder

Parameters

Returns void

addNumber

Parameters

Returns string

addBoolean

Parameters

Returns string

addString

Parameters

Returns string

addColor

Parameters

Returns string

addSelect

Parameters

Returns string

addButton

Parameters

Returns string

removeControl

Parameters

Returns void

onValueChange

Parameters

Returns () => void

refresh

Returns void

getItems

Returns GUIItem[]

dispose

Returns void

Settings

On This Page