ThreePipe
    Preparing search index...

    Interface IMaterial<TE>

    interface IMaterial<TE extends IMaterialEventMap = IMaterialEventMap> {
        __exportState?: {
            savedMaps: null | Record<string, ITexture<TextureEventMap>>;
        };
        __matExtUiConfigs?: Record<
            string,
            undefined
            | UiObjectConfig<any, string, any>,
        >;
        __textureUpdate?: (e: Event<"update", Texture<TextureEventMap>>) => void;
        _loadingPromise?: Promise<any>;
        _mapRefs?: Set<ITexture<TextureEventMap>>;
        alphaMap?: null | ITexture<TextureEventMap>;
        aoMap?: null | ITexture<TextureEventMap>;
        aoMapIntensity?: number;
        appliedMeshes: Set<
            IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
                undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
            >,
        >;
        assetType: "material";
        bumpMap?: null | ITexture<TextureEventMap>;
        color?: Color;
        constructor: {
            InterpolateProperties?: string[];
            MapProperties?: string[];
            MaterialProperties?: Record<string, any>;
            TYPE: string;
            TypeAlias?: string[];
            TypeSlug: string;
            new (...args: any[]): IMaterial;
        };
        displacementMap?: null
        | ITexture<TextureEventMap>;
        emissive?: Color;
        emissiveIntensity?: number;
        emissiveMap?: null | ITexture<TextureEventMap>;
        envMap?: null | ITexture<TextureEventMap>;
        envMapIntensity?: number;
        extraUniformsToUpload: Record<string, IUniform>;
        flatShading?: boolean;
        isGBufferMaterial?: boolean;
        isLineBasicMaterial?: boolean;
        isLineMaterial?: boolean;
        isLineMaterial2?: boolean;
        isPhysicalMaterial?: boolean;
        isRawShaderMaterial?: boolean;
        isUnlitLineMaterial?: boolean;
        isUnlitMaterial?: boolean;
        lastShader?: WebGLProgramParametersWithUniforms;
        lightMap?: null | ITexture<TextureEventMap>;
        lightMapIntensity?: number;
        linewidth?: number;
        map?: null | ITexture<TextureEventMap>;
        materialExtensions: MaterialExtension[];
        metalness?: number;
        metalnessMap?: null | ITexture<TextureEventMap>;
        needsUpdate: boolean;
        normalMap?: null | ITexture<TextureEventMap>;
        registerMaterialExtensions: (
            customMaterialExtensions: MaterialExtension[],
        ) => void;
        roughness?: number;
        roughnessMap?: null | ITexture<TextureEventMap>;
        transmission?: number;
        transmissionMap?: null | ITexture<TextureEventMap>;
        unregisterMaterialExtensions: (
            customMaterialExtensions: MaterialExtension[],
        ) => void;
        userData: IMaterialUserData;
        wireframe?: boolean;
        clone(track?: boolean): any;
        dispose(force?: boolean): void;
        fromJSON(json: any, meta?: SerializationMetaType, _internal?: boolean): any;
        setDirty(options?: IMaterialSetDirtyOptions): void;
        setValues(
            parameters:
                | Material<MaterialEventMap>
                | MaterialParameters & { type?: string },
            allowInvalidType?: boolean,
            clearCurrentUserData?: boolean,
            time?: AnimateTimeMaterial,
        ): void;
        toJSON(meta?: SerializationMetaType, _internal?: boolean): any;
    }

    Type Parameters

    Hierarchy

    Implemented by

    Index

    Properties

    __exportState? __matExtUiConfigs? __textureUpdate? _loadingPromise? _mapRefs? alphaMap? aoMap? aoMapIntensity? appliedMeshes assetType bumpMap? color? constructor displacementMap? emissive? emissiveIntensity? emissiveMap? envMap? envMapIntensity? extraUniformsToUpload flatShading? isGBufferMaterial? isLineBasicMaterial? isLineMaterial? isLineMaterial2? isPhysicalMaterial? isRawShaderMaterial? isUnlitLineMaterial? isUnlitMaterial? lastShader? lightMap? lightMapIntensity? linewidth? map? materialExtensions metalness? metalnessMap? needsUpdate normalMap? registerMaterialExtensions roughness? roughnessMap? transmission? transmissionMap? unregisterMaterialExtensions userData wireframe?

    Methods

    clone dispose fromJSON setDirty setValues toJSON

    Properties

    Optional__exportState

    __exportState?: { savedMaps: null | Record<string, ITexture<TextureEventMap>> }

    Optional__matExtUiConfigs

    __matExtUiConfigs?: Record<string, undefined | UiObjectConfig<any, string, any>>

    Optional Internal__textureUpdate

    __textureUpdate?: (e: Event<"update", Texture<TextureEventMap>>) => void

    Optional_loadingPromise

    _loadingPromise?: Promise<any>

    A promise can be set by the object to indicate that the material(or any of its properties) is loading. This can be used by the scene, viewer, plugins to defer actions until the material is loaded.

    Optional Internal_mapRefs

    _mapRefs?: Set<ITexture<TextureEventMap>>
    alphaMap?: null | ITexture<TextureEventMap>
    aoMap?: null | ITexture<TextureEventMap>
    aoMapIntensity?: number
    appliedMeshes: Set<
        IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
    >

    Objects in the scene that are using this material. This is set in the Object3DManager when the objects are added/removed from the scene. Do not modify this set directly.

    assetType: "material"
    bumpMap?: null | ITexture<TextureEventMap>
    color?: Color
    constructor: {
        InterpolateProperties?: string[];
        MapProperties?: string[];
        MaterialProperties?: Record<string, any>;
        TYPE: string;
        TypeAlias?: string[];
        TypeSlug: string;
        new (...args: any[]): IMaterial;
    }

    The initial value of Object.prototype.constructor is the standard built-in Object constructor.

    displacementMap?: null | ITexture<TextureEventMap>
    emissive?: Color
    emissiveIntensity?: number
    emissiveMap?: null | ITexture<TextureEventMap>
    envMap?: null | ITexture<TextureEventMap>
    envMapIntensity?: number
    extraUniformsToUpload: Record<string, IUniform>
    flatShading?: boolean
    isGBufferMaterial?: boolean
    isLineBasicMaterial?: boolean
    isLineMaterial?: boolean
    isLineMaterial2?: boolean
    isPhysicalMaterial?: boolean
    isRawShaderMaterial?: boolean
    isUnlitLineMaterial?: boolean
    isUnlitMaterial?: boolean
    lastShader?: WebGLProgramParametersWithUniforms
    lightMap?: null | ITexture<TextureEventMap>
    lightMapIntensity?: number
    linewidth?: number
    map?: null | ITexture<TextureEventMap>
    materialExtensions: MaterialExtension[]
    metalness?: number
    metalnessMap?: null | ITexture<TextureEventMap>
    needsUpdate: boolean

    Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

    false
    normalMap?: null | ITexture<TextureEventMap>
    registerMaterialExtensions: (
        customMaterialExtensions: MaterialExtension[],
    ) => void
    roughness?: number
    roughnessMap?: null | ITexture<TextureEventMap>
    transmission?: number
    transmissionMap?: null | ITexture<TextureEventMap>
    unregisterMaterialExtensions: (
        customMaterialExtensions: MaterialExtension[],
    ) => void
    userData: IMaterialUserData

    An object that can be used to store custom data about the Material. It should not hold references to functions as these will not be cloned.

    {}
    wireframe?: boolean

    Methods

    • Clones the Material. This is a shallow clone, so the properties are copied by reference.

      Parameters

      • Optionaltrack: boolean

        if true, the clone id and count will be tracked in the userData and a suffix will be appended to the name. default - false

      Returns any

    • Disposes the material from the GPU. Set force to false if not sure the material is used by any object in the scene. // todo add check for visible in scene also? or is that overkill

      Parameters

      • Optionalforce: boolean

        when true, same as three.js dispose. when false, only disposes if disposeOnIdle not false and not used by any object in the scene. default: true

      Returns void

    • Parameters

      • parameters: Material<MaterialEventMap> | MaterialParameters & { type?: string }

        An existing Material object or a plain JavaScript object with properties that will be copied to the material.

      • OptionalallowInvalidType: boolean

        Copy properties even if the type is different. Not used by default, but implemented in some material classes.

      • OptionalclearCurrentUserData: boolean

        clears the userData instead of merging first level. Default - true if Material object is passed, false if parameters object is passed

      • Optionaltime: AnimateTimeMaterial

        parameters to animate the setting of properties

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods