Interface IMaterial<E, ET>

interface IMaterial<E, ET> {
    __matExtUiConfigs?: Record<string, undefined | UiObjectConfig<any, string, any>>;
    alphaMap?: null | ITexture;
    aoMap?: null | ITexture;
    aoMapIntensity?: number;
    appliedMeshes: Set<IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>>;
    assetType: "material";
    bumpMap?: null | ITexture;
    color?: Color;
    constructor: {
        MaterialProperties?: Record<string, any>;
        MaterialTemplate?: IMaterialTemplate<IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>, any>;
        TYPE: string;
        TypeSlug: string;
    };
    displacementMap?: null | ITexture;
    envMap?: null | ITexture;
    envMapIntensity?: number;
    extraUniformsToUpload: Record<string, IUniform<any>>;
    flatShading?: boolean;
    generator?: IMaterialGenerator<IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>>;
    isGBufferMaterial?: boolean;
    isPhysicalMaterial?: boolean;
    isRawShaderMaterial?: boolean;
    isUnlitMaterial?: boolean;
    lastShader?: Shader;
    lightMap?: null | ITexture;
    lightMapIntensity?: number;
    linewidth?: number;
    map?: null | ITexture;
    materialExtensions: MaterialExtension[];
    metalness?: number;
    metalnessMap?: null | ITexture;
    needsUpdate: boolean;
    normalMap?: null | ITexture;
    registerMaterialExtensions: ((customMaterialExtensions) => void);
    roughness?: number;
    roughnessMap?: null | ITexture;
    transmission?: number;
    transmissionMap?: null | ITexture;
    unregisterMaterialExtensions: ((customMaterialExtensions) => void);
    userData: IMaterialUserData;
    wireframe?: boolean;
    dispose(force?): void;
    fromJSON(json, meta?, _internal?): null | IMaterial<E, ET>;
    setDirty(options?): void;
    setValues(parameters, allowInvalidType?, clearCurrentUserData?): this;
    toJSON(meta?, _internal?): any;
}

Type Parameters

Hierarchy

Implemented by

Properties

__matExtUiConfigs? alphaMap? aoMap? aoMapIntensity? appliedMeshes assetType bumpMap? color? constructor displacementMap? envMap? envMapIntensity? extraUniformsToUpload flatShading? generator? isGBufferMaterial? isPhysicalMaterial? isRawShaderMaterial? isUnlitMaterial? lastShader? lightMap? lightMapIntensity? linewidth? map? materialExtensions metalness? metalnessMap? needsUpdate normalMap? registerMaterialExtensions roughness? roughnessMap? transmission? transmissionMap? unregisterMaterialExtensions userData wireframe?

Methods

dispose fromJSON setDirty setValues toJSON

Properties

Optional __matExtUiConfigs

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

Optional alphaMap

alphaMap?: null | ITexture

Optional aoMap

aoMap?: null | ITexture

Optional aoMapIntensity

aoMapIntensity?: number

appliedMeshes

appliedMeshes: Set<IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>>

Managed internally, do not change manually

assetType

assetType: "material"

Optional bumpMap

bumpMap?: null | ITexture

Optional color

color?: Color

constructor

constructor: {
    MaterialProperties?: Record<string, any>;
    MaterialTemplate?: IMaterialTemplate<IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>, any>;
    TYPE: string;
    TypeSlug: string;
}

Type declaration

Optional displacementMap

displacementMap?: null | ITexture

Optional envMap

envMap?: null | ITexture

Optional envMapIntensity

envMapIntensity?: number

extraUniformsToUpload

extraUniformsToUpload: Record<string, IUniform<any>>

Optional flatShading

flatShading?: boolean

Optional generator

generator?: IMaterialGenerator<IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>>

Managed internally, do not change manually

Optional isGBufferMaterial

isGBufferMaterial?: boolean

Optional isPhysicalMaterial

isPhysicalMaterial?: boolean

Optional isRawShaderMaterial

isRawShaderMaterial?: boolean

Optional isUnlitMaterial

isUnlitMaterial?: boolean

Optional lastShader

lastShader?: Shader

Optional lightMap

lightMap?: null | ITexture

Optional lightMapIntensity

lightMapIntensity?: number

Optional linewidth

linewidth?: number

Optional map

map?: null | ITexture

materialExtensions

materialExtensions: MaterialExtension[]

Optional metalness

metalness?: number

Optional metalnessMap

metalnessMap?: null | ITexture

needsUpdate

needsUpdate: boolean

Optional normalMap

normalMap?: null | ITexture

registerMaterialExtensions

registerMaterialExtensions: ((customMaterialExtensions) => void)

Type declaration

    • (customMaterialExtensions): void

    • Parameters

      Returns void

Optional roughness

roughness?: number

Optional roughnessMap

roughnessMap?: null | ITexture

Optional transmission

transmission?: number

Optional transmissionMap

transmissionMap?: null | ITexture

unregisterMaterialExtensions

unregisterMaterialExtensions: ((customMaterialExtensions) => void)

Type declaration

    • (customMaterialExtensions): void

    • Parameters

      Returns void

userData

userData: IMaterialUserData

Optional wireframe

wireframe?: boolean

Methods

dispose

  • dispose(force?): void

  • 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

    • Optional force: 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

fromJSON

setDirty

setValues

  • setValues(parameters, allowInvalidType?, clearCurrentUserData?): this

  • Parameters

    • parameters: Material<Event, string> | MaterialParameters & {
          type?: string;
      }
    • Optional allowInvalidType: boolean
    • Optional clearCurrentUserData: boolean

    Returns this

toJSON

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc