Class PanelAbstract

constructor

• new Panel(parentGui: GUI, instance: Instance, name: string): Panel

  Parameters

  • parentGui: GUI

    The parent GUI.

  • instance: Instance

    The Giro3D instance.

  • name: string

    The name of the panel.

  Returns Panel

gui

instance

addColorController

• addColorController<T extends object, K extends string>(
      obj: T,
      prop: K,
  ): TypedController<T[K]>

  Adds a color controller to the panel.

  Type Parameters

  • T extends object
  • K extends string

  Parameters

  • obj: T

    The object.

  • prop: K

    The name of the property.

  Returns TypedController<T[K]>

  The created controller.

addController

• addController<T extends object, K extends string>(
      obj: T,
      prop: K,
      $1?: number | object | unknown[],
      max?: number,
      step?: number,
  ): TypedController<T[K]>

  Adds a (non-color) controller to the panel. See the lil-gui API for more information.

  Type Parameters

  • T extends object
  • K extends string

  Parameters

  • obj: T

    The object.

  • prop: K

    The name of the property.

  • Optional$1: number | object | unknown[]

    Minimum value for number controllers, or the set of selectable values for a dropdown.

  • Optionalmax: number

    Maximum value for number controllers.

  • Optionalstep: number

    Step value for number controllers.

  Returns TypedController<T[K]>

  The created controller.

collapse

• collapse(): void

  Returns void

dispose

• dispose(): void

  Removes this panel from its parent GUI.

  Returns void

isClosed

• isClosed(): boolean

  Returns boolean

notify

• notify(source?: unknown): void

  Parameters

  • source: unknown = undefined

  Returns void

removeController

• removeController(controller: Controller): void

  Parameters

  • controller: Controller

  Returns void

update

• update(): void

  Updates the panel. You may override this function if the panel has additional work to do. However, updateControllers should still be called to ensure they are up to date.

  Returns void

updateControllers

• updateControllers(): void

  Updates all controllers in this panel with the observed values. This is useful if the value changes from outside the GUI.

  Returns void

updateValues

• updateValues(): void

  Updates the values of the controller sources.

  Returns void