Class UI

Hierarchy

Constructors

constructor

Properties

THREE _refreshQueue _root? config methods typeGenerators

Methods

_createUiContainer _refreshUiConfigObject addEventListener addToRefreshQueue appendChild dispatchEvent dispose disposeUiConfig hasEventListener refreshQueue refreshRoot removeChild removeEventListener renderUiConfig renderUiObject

Constructors

constructor

  • Parameters

    • container: HTMLElement = document.body
    • __namedParameters: {
          autoPostFrame: undefined | boolean;
          expanded: undefined | boolean;
      } = {}
      • autoPostFrame: undefined | boolean
      • expanded: undefined | boolean

    Returns UI

Properties

THREE

THREE: undefined | THREE = ...

Protected _refreshQueue

_refreshQueue: Record<TUiRefreshModes, [UiObjectConfig<any, string, any>, number, undefined | string][]>

Protected Optional _root

_root?: Pane

Readonly config

config: UiObjectConfig<any, "panel", any>

Readonly methods

methods: UiConfigMethods

Readonly typeGenerators

typeGenerators: {
    button: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, plugin: UiConfigRendererTweakpane, _?: any) => ButtonApi);
    checkbox: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, renderer: UiConfigRendererTweakpane, params?: any) => undefined | InputBindingApi<any, any> | MonitorBindingApi<any>);
    color: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, renderer: UiConfigRendererTweakpane, params?: any) => undefined | InputBindingApi<any, any> | MonitorBindingApi<any>);
    dropdown: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, plugin: UiConfigRendererTweakpane, params?: any) => undefined | InputBindingApi<any, any> | MonitorBindingApi<any>);
    dummy: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, plugin: UiConfigRendererTweakpane, params?: any) => undefined | InputBindingApi<any, any> | MonitorBindingApi<any>);
    folder: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, plugin: UiConfigRendererTweakpane, _?: any) => FolderApi);
    input: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, renderer: UiConfigRendererTweakpane, params?: any) => undefined | InputBindingApi<any, any> | MonitorBindingApi<any>);
    monitor: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, plugin: UiConfigRendererTweakpane, params?: any) => undefined | InputBindingApi<any, any> | MonitorBindingApi<any>);
    number: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, renderer: UiConfigRendererTweakpane, params?: any) => undefined | InputBindingApi<any, any> | MonitorBindingApi<any>);
    panel: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, plugin: UiConfigRendererTweakpane, _?: any) => FolderApi);
    slider: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, plugin: UiConfigRendererTweakpane, params?: any) => undefined | InputBindingApi<any, any> | MonitorBindingApi<any>);
    toggle: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, renderer: UiConfigRendererTweakpane, params?: any) => undefined | InputBindingApi<any, any> | MonitorBindingApi<any>);
    vec: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, renderer: UiConfigRendererTweakpane, params?: any) => undefined | InputBindingApi<any, any> | MonitorBindingApi<any>);
    vec2: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, renderer: UiConfigRendererTweakpane, params?: any) => undefined | InputBindingApi<any, any> | MonitorBindingApi<any>);
    vec3: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, renderer: UiConfigRendererTweakpane, params?: any) => undefined | InputBindingApi<any, any> | MonitorBindingApi<any>);
    vec4: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, renderer: UiConfigRendererTweakpane, params?: any) => undefined | InputBindingApi<any, any> | MonitorBindingApi<any>);
    vector: ((parent: FolderApi, config: UiObjectConfig<any, string, any>, renderer: UiConfigRendererTweakpane, params?: any) => undefined | InputBindingApi<any, any> | MonitorBindingApi<any>);
} & AnyOptions = ...

Methods

Protected _createUiContainer

Protected _refreshUiConfigObject

addEventListener

  • Parameters

    • type: "preRender" | "postRender" | "preFrame" | "postFrame"
    • listener: ((event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">) => void)
        • (event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">): void

        • Parameters

          • event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">

          Returns void

    Returns void

addToRefreshQueue

  • Parameters

    • mode: TUiRefreshModes | "immediate"
    • uiConfig: UiObjectConfig<any, string, any>
    • deep: boolean
    • delay: number

    Returns void

appendChild

dispatchEvent

  • Parameters

    • event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">

    Returns void

dispose

disposeUiConfig

  • Disposes the UI associated with a config, doesn't makes change to the object or its parent.

    Parameters

    • Optional config: UiObjectConfig<any, string, any>
    • Optional performDispose: boolean

    Returns void

hasEventListener

  • Parameters

    • type: "preRender" | "postRender" | "preFrame" | "postFrame"
    • listener: ((event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">) => void)
        • (event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">): void

        • Parameters

          • event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">

          Returns void

    Returns boolean

refreshQueue

  • Parameters

    • mode: TUiRefreshModes

    Returns void

refreshRoot

  • Parameters

    • Optional deep: boolean
    • Optional mode: TUiRefreshModes | "immediate"
    • Optional delay: number

    Returns void

removeChild

  • Parameters

    • config: UiObjectConfig<any, string, any>

    Returns void

removeEventListener

  • Parameters

    • type: "preRender" | "postRender" | "preFrame" | "postFrame"
    • listener: ((event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">) => void)
        • (event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">): void

        • Parameters

          • event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">

          Returns void

    Returns void

renderUiConfig

renderUiObject

Settings

Member Visibility

Theme

Generated using TypeDoc