uiconfig.js API
    Preparing search index...

    Class UiConfigRendererTweakpane

    Hierarchy (View Summary)

    • UiConfigRenderer
      • UiConfigRendererTweakpane
    Index
    constructor
    _autoFrameEvents _container? _refreshQueue _root? config methods raf THREE typeGenerators
    undoManager
    _createUiContainer _refreshUiConfigObject addEventListener addToRefreshQueue appendChild dispatchEvent disposeUiConfig hasEventListener refreshQueue refreshRoot removeChild removeEventListener renderUiConfig renderUiObject setTheme start stop unmount

    Protected_autoFrameEvents

    _autoFrameEvents: boolean

    Protected Optional_container

    _container?: HTMLDivElement

    Protected_refreshQueue

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

    Protected Optional_root

    _root?: Pane
    config: UiObjectConfig<any, "panel">
    methods: UiConfigMethods
    raf: () => void
    THREE: THREE | undefined = ...
    typeGenerators: {
        button: (
            parent: FolderApi,
            config: UiObjectConfig,
            plugin: UiConfigRendererTweakpane,
            _?: any,
        ) => ButtonApi;
        checkbox: (
            parent: FolderApi,
            config: UiObjectConfig,
            renderer: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        color: (
            parent: FolderApi,
            config: UiObjectConfig,
            renderer: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        divider: (
            parent: FolderApi,
            config: UiObjectConfig,
            _plugin: UiConfigRendererTweakpane,
            _params?: any,
        ) => any;
        dropdown: (
            parent: FolderApi,
            config: UiObjectConfig,
            plugin: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        dummy: (
            parent: FolderApi,
            config: UiObjectConfig,
            plugin: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        folder: (
            parent: FolderApi,
            config: UiObjectConfig,
            plugin: UiConfigRendererTweakpane,
            _?: any,
        ) => FolderApi;
        input: (
            parent: FolderApi,
            config: UiObjectConfig,
            renderer: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        monitor: (
            parent: FolderApi,
            config: UiObjectConfig,
            plugin: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        multiline: (
            parent: FolderApi,
            config: UiObjectConfig,
            plugin: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        number: (
            parent: FolderApi,
            config: UiObjectConfig,
            renderer: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        panel: (
            parent: FolderApi,
            config: UiObjectConfig,
            plugin: UiConfigRendererTweakpane,
            _?: any,
        ) => FolderApi;
        select: (
            parent: FolderApi,
            config: UiObjectConfig,
            plugin: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        separator: (
            parent: FolderApi,
            config: UiObjectConfig,
            _plugin: UiConfigRendererTweakpane,
            _params?: any,
        ) => any;
        slider: (
            parent: FolderApi,
            config: UiObjectConfig,
            plugin: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        tab: (
            parent: FolderApi,
            config: UiObjectConfig,
            plugin: UiConfigRendererTweakpane,
            _?: any,
        ) => TabApi;
        tabs: (
            parent: FolderApi,
            config: UiObjectConfig,
            plugin: UiConfigRendererTweakpane,
            _?: any,
        ) => TabApi;
        textarea: (
            parent: FolderApi,
            config: UiObjectConfig,
            plugin: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        textArea: (
            parent: FolderApi,
            config: UiObjectConfig,
            plugin: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        toggle: (
            parent: FolderApi,
            config: UiObjectConfig,
            renderer: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        vec: (
            parent: FolderApi,
            config: UiObjectConfig,
            renderer: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        vec2: (
            parent: FolderApi,
            config: UiObjectConfig,
            renderer: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        vec3: (
            parent: FolderApi,
            config: UiObjectConfig,
            renderer: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        vec4: (
            parent: FolderApi,
            config: UiObjectConfig,
            renderer: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
        vector: (
            parent: FolderApi,
            config: UiObjectConfig,
            renderer: UiConfigRendererTweakpane,
            params?: any,
        ) => InputBindingApi<any, any> | MonitorBindingApi<any> | undefined;
    } & AnyOptions = ...
    • get undoManager(): JSUndoManager | undefined

      Returns JSUndoManager | undefined

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

      Parameters

      • value: JSUndoManager | undefined

      Returns void

    Protected_createUiContainer

    Protected_refreshUiConfigObject

    • 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

    • Parameters

      • mode: TUiRefreshModes | "immediate"
      • uiConfig: UiObjectConfig
      • deep: boolean
      • delay: number

      Returns void

    • Parameters

      • Optionalconfig: UiObjectConfig<any, string, any>
      • Optionalparams: UiObjectConfig<any, string, any>

      Returns void

    • Fire an event type.

      Parameters

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

          The type of event that gets fired.

      Returns 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

    • 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

    • Parameters

      • mode: TUiRefreshModes

      Returns void

    • Parameters

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

      Returns void

    • Parameters

      • config: UiObjectConfig

      Returns 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

    • Applies a color mode of the theme in uiconfig-tweakpane/theme.css to this renderer's panel; null removes it. Import the stylesheet once (import 'uiconfig-tweakpane/theme.css').

      Parameters

      • mode: "light" | "dark" | "blue" | "white" | "black" | null

      Returns void

    • Returns void

    • Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods