ThreePipe
    Preparing search index...

    Interface IObjectExtension

    interface IObjectExtension {
        getUiConfig?: (
            material: IObject3D,
            refreshUi?: (
                deep?: boolean,
                mode?: TUiRefreshModes | "immediate",
                delay?: number,
            ) => void,
        ) =>
            | undefined
            | (
                | UiObjectConfig<any, string, any>
                | Fof<ValOrArrOp<UiObjectConfig<any, string, any>>>
            )[];
        isCompatible?: (object: IObject3D) => undefined | boolean;
        onRegister?: (object: IObject3D) => void;
        uuid: string;
    }
    Index

    Properties

    getUiConfig? isCompatible? onRegister? uuid

    Properties

    getUiConfig?: (
        material: IObject3D,
        refreshUi?: (
            deep?: boolean,
            mode?: TUiRefreshModes | "immediate",
            delay?: number,
        ) => void,
    ) =>
        | undefined
        | (
            | UiObjectConfig<any, string, any>
            | Fof<ValOrArrOp<UiObjectConfig<any, string, any>>>
        )[]

    Function to return the UI config for this material extension. This is called once when the material extension is registered.

    isCompatible?: (object: IObject3D) => undefined | boolean

    Function to check if this object extension is compatible with the given object. If not compatible, the object extension will not be added to the object. This is only checked when the extension is registered.

    The extension is assumed to be compatible if this function is not defined

    onRegister?: (object: IObject3D) => void

    Function to be called when the object the extension is added on the object. This generally happens when either the object is registered or extnsion is added

    uuid: string

    Settings

    Member Visibility

    On This Page

    Properties