ThreePipe
    Preparing search index...

    Interface IMaterialUserData

    interface IMaterialUserData {
        __importData?: any;
        __isVariation?: boolean;
        __needsSourceBuffer?: boolean;
        __sourceBlob?: IFile;
        __sourceBuffer?: ArrayBuffer;
        _clearcoatTint?: {
            enableTint?: boolean;
            ior?: number;
            thickness?: number;
            tintColor?: string | number | Color;
        };
        _customBumpMap?: null
        | ITexture<TextureEventMap>;
        _customBumpScale?: number;
        _fragmentClippingExt?: {
            clipEnabled?: boolean;
            clipInvert?: boolean;
            clipMode?: FragmentClippingMode;
            clipParams?: Vector4 | Vector4Tuple;
            clipPosition?: Vector4 | Vector4Tuple;
        };
        _hasCustomBump?: boolean;
        _noiseBumpMat?: {
            bumpNoiseParams?: Vector2
            | Vector2Tuple;
            bumpScale?: number;
            flakeClamp?: number;
            flakeFallOffParams?: Vector3 | Vector3Tuple;
            flakeParams?: Vector4 | Vector4Tuple;
            flakeRadius?: number;
            flakeScale?: number;
            hasBump?: boolean;
            useColorFlakes?: boolean;
        };
        animationObjects?: AnimationObject<any>[];
        autoRegisterInManager?: boolean;
        cloneCount?: number;
        cloneId?: string;
        constraints?: ObjectConstraint<keyof ConstraintPropsTypes>[];
        disposeOnIdle?: boolean;
        envMapSlotKey?: string;
        forcedLinearDepth?: number;
        gBufferData?: {
            materialId?: number;
            tonemapEnabled?: boolean;
            [key: string]: any;
        };
        inverseAlphaMap?: boolean;
        isPlaceholder?: boolean;
        pluginsDisabled?: boolean;
        postTonemap?: boolean;
        renderToDepth?: boolean;
        renderToGBuffer?: boolean;
        rootPath?: string;
        rootPathOptions?: Record<string, any>;
        rootPathRefresh?: boolean;
        runtimeMaterial?: boolean;
        separateEnvMapIntensity?: boolean;
        setDirty?: (options?: IMaterialSetDirtyOptions) => void;
        sProperties?: string[];
        ssaoCastDisabled?: boolean;
        ssaoDisabled?: boolean;
        sscsDisabled?: boolean;
        ssreflDisabled?: boolean;
        ssreflNonPhysical?: boolean;
        uuid?: string;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    __importData? __isVariation? __needsSourceBuffer? __sourceBlob? __sourceBuffer? _clearcoatTint? _customBumpMap? _customBumpScale? _fragmentClippingExt? _hasCustomBump? _noiseBumpMat? animationObjects? autoRegisterInManager? cloneCount? cloneId? constraints? disposeOnIdle? envMapSlotKey? forcedLinearDepth? gBufferData? inverseAlphaMap? isPlaceholder? pluginsDisabled? postTonemap? renderToDepth? renderToGBuffer? rootPath? rootPathOptions? rootPathRefresh? runtimeMaterial? separateEnvMapIntensity? setDirty? sProperties? ssaoCastDisabled? ssaoDisabled? sscsDisabled? ssreflDisabled? ssreflNonPhysical? uuid?

    Properties

    Optional__importData

    __importData?: any

    extra arbitrary data saved by the importer that can be used by the plugins (like gltf material variants)

    Optional__isVariation

    __isVariation?: boolean

    Optional__needsSourceBuffer

    __needsSourceBuffer?: boolean

    This can be set to true in the importer to indicate that the source buffer should be loaded and cached in the userdata during processRaw

    Optional__sourceBlob

    __sourceBlob?: IFile

    Cached source blob for the asset

    Optional__sourceBuffer

    __sourceBuffer?: ArrayBuffer

    Cached source buffer for the asset (only cached when __needsSourceBuffer is set)

    Optional_clearcoatTint

    _clearcoatTint?: {
        enableTint?: boolean;
        ior?: number;
        thickness?: number;
        tintColor?: string | number | Color;
    }

    Optional_customBumpMap

    _customBumpMap?: null | ITexture<TextureEventMap>

    Optional_customBumpScale

    _customBumpScale?: number

    Optional_fragmentClippingExt

    _fragmentClippingExt?: {
        clipEnabled?: boolean;
        clipInvert?: boolean;
        clipMode?: FragmentClippingMode;
        clipParams?: Vector4 | Vector4Tuple;
        clipPosition?: Vector4 | Vector4Tuple;
    }

    Optional_hasCustomBump

    _hasCustomBump?: boolean

    Optional_noiseBumpMat

    _noiseBumpMat?: {
        bumpNoiseParams?: Vector2 | Vector2Tuple;
        bumpScale?: number;
        flakeClamp?: number;
        flakeFallOffParams?: Vector3 | Vector3Tuple;
        flakeParams?: Vector4 | Vector4Tuple;
        flakeRadius?: number;
        flakeScale?: number;
        hasBump?: boolean;
        useColorFlakes?: boolean;
    }
    animationObjects?: AnimationObject<any>[]
    autoRegisterInManager?: boolean

    Automatically register this material in the MaterialManager when added to the scene. This provides hook to other plugins to extend the material, add uiconfig etc.

    true
    cloneCount?: number
    cloneId?: string
    constraints?: ObjectConstraint<keyof ConstraintPropsTypes>[]
    disposeOnIdle?: boolean

    Automatically dispose material when not used by any object in the scene

    true
    envMapSlotKey?: string

    The environment map to use in the RootScene. To use this, object with the material must be in the RootScene, and the key should exist in the RootScene's textureSlots.

    only for materials that have envMap

    forcedLinearDepth?: number

    Force a depth value in GBuffer. This is useful to force center values like 0 to the depth.

    gBufferData?: {
        materialId?: number;
        tonemapEnabled?: boolean;
        [key: string]: any;
    }

    See GBufferPlugin

    Type declaration

    • [key: string]: any
    • OptionalmaterialId?: number
    • OptionaltonemapEnabled?: boolean
      true
    inverseAlphaMap?: boolean
    isPlaceholder?: boolean

    If this is a placeholder/dummy material. These materials are not saved in asset/glTF files.

    pluginsDisabled?: boolean

    General flag to disable multiple plugins on the material at once, like SSAO, SSR, Bloom etc.

    postTonemap?: boolean

    Use postTonemap.tonemapEnabled instead. This is kept because used in old files.

    renderToDepth?: boolean

    Same as renderToGBuffer but for depth only, not normal or flags etc

    renderToGBuffer?: boolean
    rootPath?: string

    The path from which the asset was downloaded/imported.

    rootPathOptions?: Record<string, any>

    Incase files are loaded as different extensions(like for json), this will be set.

    rootPathRefresh?: boolean

    Whether to refresh this object from the asset manager when its loaded as an embedded object

    runtimeMaterial?: boolean

    See MaterialManager.dispose as BaseGroundPlugin._refreshMaterial

    separateEnvMapIntensity?: boolean

    Flag to tell the scene to prefer material.envMapIntensity over scene.environmentIntensity only for materials that have envMapIntensity

    setDirty?: (options?: IMaterialSetDirtyOptions) => void
    sProperties?: string[]

    List of properties that will be saved in the glb/material files when this material is saved. The other properties are expected to be loaded/filled at runtime by default values or from an external material loaded from IImportResultUserData.rootPath.

    ssaoCastDisabled?: boolean

    Cast SSAO on other objects. if casting is not working when this is false, ensure render to depth is true, like for transparent objects

    ssaoDisabled?: boolean

    Disable SSAOPlugin for this material.

    sscsDisabled?: boolean

    For SSCSPlugin

    ssreflDisabled?: boolean

    For SSRPlugin

    ssreflNonPhysical?: boolean

    For SSRPlugin

    uuid?: string

    Settings

    Member Visibility

    On This Page

    Properties