Class UI

Hierarchy (View Summary)

Constructors

constructor

Properties

_autoFrameEvents _refreshQueue _root? config methods raf THREE typeGenerators

Accessors

undoManager

Methods

_createUiContainer _refreshUiConfigObject addEventListener addToRefreshQueue appendChild dispatchEvent disposeUiConfig hasEventListener refreshQueue refreshRoot removeChild removeEventListener renderUiConfig renderUiObject start stop unmount

Constructors

constructor

  • new UI(
        container?: HTMLElement,
        __namedParameters?: { autoPostFrame?: boolean; expanded?: boolean },
        undoManager?: false | JSUndoManager,
    ): UI

  • Parameters

    • container: HTMLElement = document.body
    • __namedParameters: { autoPostFrame?: boolean; expanded?: boolean } = {}
    • OptionalundoManager: false | JSUndoManager

    Returns UI

Properties

Protected_autoFrameEvents

_autoFrameEvents: boolean

Protected_refreshQueue

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

Protected Optional_root

_root?: Pane

Readonlyconfig

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

Readonlymethods

methods: UiConfigMethods

raf

raf: () => void

THREE

THREE: undefined | THREE = ...

ReadonlytypeGenerators

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 = ...

Accessors

undoManager

  • get undoManager(): undefined | JSUndoManager

  • Returns undefined | JSUndoManager

  • set undoManager(value: undefined | JSUndoManager): void

  • Parameters

    • value: undefined | JSUndoManager

    Returns void

Methods

Protected_createUiContainer

Protected_refreshUiConfigObject

addEventListener

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

  • Adds a listener to an event type.

    Parameters

    • type: "preFrame" | "preRender" | "postRender" | "postFrame"

      The type of event to listen to.

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

      The function that gets called when the event is fired.

    Returns void

addToRefreshQueue

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

  • Parameters

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

    Returns void

appendChild

dispatchEvent

  • dispatchEvent(
        event: IEvent<"preFrame" | "preRender" | "postRender" | "postFrame">,
    ): void

  • Fire an event type.

    Parameters

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

        The type of event that gets fired.

    Returns void

disposeUiConfig

  • disposeUiConfig(
        config?: UiObjectConfig<any, string, any>,
        performDispose?: boolean,
    ): void

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

    Parameters

    • Optionalconfig: UiObjectConfig<any, string, any>
    • OptionalperformDispose: boolean

    Returns void

hasEventListener

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

  • Checks if listener is added to an event type.

    Parameters

    • type: "preFrame" | "preRender" | "postRender" | "postFrame"

      The type of event to listen to.

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

      The function that gets called when the event is fired.

    Returns boolean

refreshQueue

  • refreshQueue(mode: TUiRefreshModes): void

  • Parameters

    • mode: TUiRefreshModes

    Returns void

refreshRoot

  • refreshRoot(
        deep?: boolean,
        mode?: TUiRefreshModes | "immediate",
        delay?: number,
    ): void

  • Parameters

    • Optionaldeep: boolean
    • Optionalmode: TUiRefreshModes | "immediate"
    • Optionaldelay: number

    Returns void

removeChild

  • removeChild(config: UiObjectConfig<any, string, any>): void

  • Parameters

    • config: UiObjectConfig<any, string, any>

    Returns void

removeEventListener

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

  • Removes a listener from an event type.

    Parameters

    • type: "preFrame" | "preRender" | "postRender" | "postFrame"

      The type of the listener that gets removed.

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

      The listener function that gets removed.

    Returns void

renderUiConfig

renderUiObject

start

stop

unmount

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods