Class MeshStandardMaterial2

And extension of three.js MeshPhysicalMaterial that can be assigned to objects, and support threepipe features, uiconfig, and serialization.

Hierarchy (View Summary)

PhysicalMaterial
- MeshStandardMaterial2

Constructors

constructor

new MeshStandardMaterial2(
parameters?: MeshPhysicalMaterialParameters,
): MeshStandardMaterial2
Parameters
- Optionalparameters: MeshPhysicalMaterialParameters
Returns MeshStandardMaterial2
Overrides PhysicalMaterial.constructor
- Defined in src/core/material/PhysicalMaterial.ts:404

Properties

alphaMap

alphaMap: null | ITexture<TextureEventMap> = null

Default

null

`Readonly`appliedMeshes

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

assetType: "material" = ...

bumpMap

bumpMap: null | ITexture<TextureEventMap> = null

Default

null

constructor

constructor: typeof PhysicalMaterial

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

displacementMap

displacementMap: null | ITexture<TextureEventMap> = null

Default

null

extraUniformsToUpload

extraUniformsToUpload: Record<string, IUniform> = {}

`Optional`generator

generator?: IMaterialGenerator

Managed internally, do not change manually

`Readonly`isPhysicalMaterial

isPhysicalMaterial: true

map

map: null | ITexture<TextureEventMap> = null

Default

null

materialExtensions

materialExtensions: MaterialExtension[] = []

metalnessMap

metalnessMap: null | ITexture<TextureEventMap> = null

Default

null

normalMap

normalMap: null | ITexture<TextureEventMap> = null

Default

null

registerMaterialExtensions

registerMaterialExtensions: (
this: IMaterial,
customMaterialExtensions: MaterialExtension[],
) => void = iMaterialCommons.registerMaterialExtensions

roughnessMap

roughnessMap: null | ITexture<TextureEventMap> = null

Default

null

`Readonly`setDirty

setDirty: (this: IMaterial, options?: IMaterialSetDirtyOptions) => void = iMaterialCommons.setDirty

uiConfig

uiConfig: UiObjectConfig = ...

unregisterMaterialExtensions

unregisterMaterialExtensions: (
this: IMaterial,
customMaterialExtensions: MaterialExtension[],
) => void = iMaterialCommons.unregisterMaterialExtensions

userData

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.

Default

{}

`Static` `Readonly`InterpolateProperties

InterpolateProperties: string[] = ...

`Static` `Readonly`MapProperties

MapProperties: string[] = ...

`Static` `Readonly`MaterialProperties

MaterialProperties: {
    allowOverride: boolean;
    alphaHash: boolean;
    alphaMap: null;
    alphaTest: number;
    alphaToCoverage: boolean;
    anisotropy: number;
    anisotropyMap: null;
    anisotropyRotation: number;
    aoMap: null;
    aoMapIntensity: number;
    attenuationColor: Color;
    attenuationDistance: number;
    blendAlpha: number;
    blendColor: string;
    blendDst: 205;
    blendDstAlpha: null;
    blendEquation: 100;
    blendEquationAlpha: null;
    blending: 1;
    blendSrc: 204;
    blendSrcAlpha: null;
    bumpMap: null;
    bumpScale: number;
    clearcoat: number;
    clearcoatMap: null;
    clearcoatNormalMap: null;
    clearcoatNormalScale: Vector2;
    clearcoatRoughness: number;
    clearcoatRoughnessMap: null;
    clipIntersection: boolean;
    clippingPlanes: null;
    clipShadows: boolean;
    color: Color;
    colorWrite: boolean;
    depthFunc: 3;
    depthTest: boolean;
    depthWrite: boolean;
    displacementBias: number;
    displacementMap: null;
    displacementScale: number;
    dithering: boolean;
    emissive: string;
    emissiveIntensity: number;
    emissiveMap: null;
    envMap: null;
    envMapIntensity: number;
    flatShading: boolean;
    fog: boolean;
    forceSinglePass: boolean;
    iridescence: number;
    iridescenceIOR: number;
    iridescenceMap: null;
    iridescenceThicknessMap: null;
    iridescenceThicknessRange: number[];
    lightMap: null;
    lightMapIntensity: number;
    map: null;
    metalness: number;
    metalnessMap: null;
    name: string;
    normalMap: null;
    normalMapType: 0;
    normalScale: Vector2;
    opacity: number;
    polygonOffset: boolean;
    polygonOffsetFactor: number;
    polygonOffsetUnits: number;
    precision: null;
    premultipliedAlpha: boolean;
    reflectivity: number;
    roughness: number;
    roughnessMap: null;
    shadowSide: null;
    sheen: number;
    sheenColor: Color;
    sheenColorMap: null;
    sheenRoughness: number;
    sheenRoughnessMap: null;
    side: 0;
    specularColor: Color;
    specularColorMap: null;
    specularIntensity: number;
    specularIntensityMap: null;
    stencilFail: 7680;
    stencilFunc: 519;
    stencilFuncMask: number;
    stencilRef: number;
    stencilWrite: boolean;
    stencilWriteMask: number;
    stencilZFail: 7680;
    stencilZPass: 7680;
    thickness: number;
    thicknessMap: null;
    toneMapped: boolean;
    transmission: number;
    transmissionMap: null;
    transparent: boolean;
    userData: {};
    vertexColors: boolean;
    visible: boolean;
    wireframe: boolean;
    wireframeLinecap: string;
    wireframeLinejoin: string;
    wireframeLinewidth: number;
} = ...

`Static`MaterialTemplate

MaterialTemplate: IMaterialTemplate<
    PhysicalMaterial<IMaterialEventMap>,
    Partial<
        {
            allowOverride: boolean;
            alphaHash: boolean;
            alphaMap: null;
            alphaTest: number;
            alphaToCoverage: boolean;
            anisotropy: number;
            anisotropyMap: null;
            anisotropyRotation: number;
            aoMap: null;
            aoMapIntensity: number;
            attenuationColor: Color;
            attenuationDistance: number;
            blendAlpha: number;
            blendColor: string;
            blendDst: 205;
            blendDstAlpha: null;
            blendEquation: 100;
            blendEquationAlpha: null;
            blending: 1;
            blendSrc: 204;
            blendSrcAlpha: null;
            bumpMap: null;
            bumpScale: number;
            clearcoat: number;
            clearcoatMap: null;
            clearcoatNormalMap: null;
            clearcoatNormalScale: Vector2;
            clearcoatRoughness: number;
            clearcoatRoughnessMap: null;
            clipIntersection: boolean;
            clippingPlanes: null;
            clipShadows: boolean;
            color: Color;
            colorWrite: boolean;
            depthFunc: 3;
            depthTest: boolean;
            depthWrite: boolean;
            displacementBias: number;
            displacementMap: null;
            displacementScale: number;
            dithering: boolean;
            emissive: string;
            emissiveIntensity: number;
            emissiveMap: null;
            envMap: null;
            envMapIntensity: number;
            flatShading: boolean;
            fog: boolean;
            forceSinglePass: boolean;
            iridescence: number;
            iridescenceIOR: number;
            iridescenceMap: null;
            iridescenceThicknessMap: null;
            iridescenceThicknessRange: number[];
            lightMap: null;
            lightMapIntensity: number;
            map: null;
            metalness: number;
            metalnessMap: null;
            name: string;
            normalMap: null;
            normalMapType: 0;
            normalScale: Vector2;
            opacity: number;
            polygonOffset: boolean;
            polygonOffsetFactor: number;
            polygonOffsetUnits: number;
            precision: null;
            premultipliedAlpha: boolean;
            reflectivity: number;
            roughness: number;
            roughnessMap: null;
            shadowSide: null;
            sheen: number;
            sheenColor: Color;
            sheenColorMap: null;
            sheenRoughness: number;
            sheenRoughnessMap: null;
            side: 0;
            specularColor: Color;
            specularColorMap: null;
            specularIntensity: number;
            specularIntensityMap: null;
            stencilFail: 7680;
            stencilFunc: 519;
            stencilFuncMask: number;
            stencilRef: number;
            stencilWrite: boolean;
            stencilWriteMask: number;
            stencilZFail: 7680;
            stencilZPass: 7680;
            thickness: number;
            thicknessMap: null;
            toneMapped: boolean;
            transmission: number;
            transmissionMap: null;
            transparent: boolean;
            userData: {};
            vertexColors: boolean;
            visible: boolean;
            wireframe: boolean;
            wireframeLinecap: string;
            wireframeLinejoin: string;
            wireframeLinewidth: number;
        },
    >,
> = ...

`Static` `Readonly`TYPE

TYPE: "PhysicalMaterial" = 'PhysicalMaterial'

`Static` `Readonly`TypeSlug

TypeSlug: "pmat" = 'pmat'

Methods

clone

clone(track?: boolean): this
Return a new material with the same parameters as this material.
Parameters
- track: boolean = false
Returns this
Inherited from PhysicalMaterial.clone
- Defined in src/core/material/PhysicalMaterial.ts:51

copy

copy(source: any): this
Copy the parameters from the passed material into this material.
Parameters
- source: any
Returns this
Inherited from PhysicalMaterial.copy
- Defined in src/core/material/PhysicalMaterial.ts:196

customProgramCacheKey

customProgramCacheKey(): string
In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

Returns string
Inherited from PhysicalMaterial.customProgramCacheKey
- Defined in src/core/material/PhysicalMaterial.ts:81

dispose

dispose(): this
This disposes the material. Textures of a material don't get disposed. These needs to be disposed by Texture.

Returns this
Inherited from PhysicalMaterial.dispose
- Defined in src/core/material/PhysicalMaterial.ts:50

fromJSON

fromJSON(
    data: any,
    meta?: SerializationMetaType,
    _internal?: boolean,
): null | MeshStandardMaterial2
Deserializes the material from JSON. Note: some properties that are not serialized in Material.toJSON when they are default values (like side, alphaTest, blending, maps), they wont be reverted back if not present in JSON If _internal = true, Textures should be loaded and in meta.textures before calling this method.
Parameters
- data: any
- Optionalmeta: SerializationMetaType
- _internal: boolean = false
Returns null | MeshStandardMaterial2
Inherited from PhysicalMaterial.fromJSON
- Defined in src/core/material/PhysicalMaterial.ts:221

onBeforeCompile

onBeforeCompile(
shader: WebGLProgramParametersWithUniforms,
renderer: WebGLRenderer,
): void
An optional callback that is executed immediately before the shader program is compiled. This function is called with the associated WebGL program parameters and renderer. Useful for the modification of built-in materials.
Parameters
- shader: WebGLProgramParametersWithUniforms
- renderer: WebGLRenderer
  WebGLRenderer context that is initializing the material
Returns void
Inherited from PhysicalMaterial.onBeforeCompile
- Defined in src/core/material/PhysicalMaterial.ts:85

onBeforeRender

onBeforeRender(
    renderer: WebGLRenderer,
    scene: Scene,
    camera: Camera,
    geometry: BufferGeometry,
    object: Object3D,
): void
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry
- object: Object3D
Returns void
Inherited from PhysicalMaterial.onBeforeRender
- Defined in src/core/material/PhysicalMaterial.ts:108

setValues

setValues(
    parameters:
        | Material<MaterialEventMap>
        | MeshPhysicalMaterialParameters & { type?: string },
    allowInvalidType?: boolean,
    clearCurrentUserData?: undefined | boolean,
    time?: AnimateTime,
): this
Sets the values of this material based on the values of the passed material or an object with material properties The input is expected to be a valid material or a deserialized material parameters object(including the deserialized userdata)
Parameters
- parameters: Material<MaterialEventMap> | MeshPhysicalMaterialParameters & { type?: string }
  material or material parameters object
- allowInvalidType: boolean = true
  if true, the type of the oldMaterial is not checked. Objects without type are always allowed.
- clearCurrentUserData: undefined | boolean = undefined
  if undefined, then depends on material.isMaterial. if true, the current userdata is cleared before setting the new values, because it can have data which wont be overwritten if not present in the new material.
- Optionaltime: AnimateTime
  optional data to animate(lerp) from current value to the target value.
Returns this
Inherited from PhysicalMaterial.setValues
- Defined in src/core/material/PhysicalMaterial.ts:175

toJSON

toJSON(meta?: SerializationMetaType, _internal?: boolean): any
Serializes this material to JSON.
Parameters
- Optionalmeta: SerializationMetaType
  metadata for serialization
- _internal: boolean = false
  Calls only super.toJSON, does internal three.js serialization and @serialize tags. Set it to true only if you know what you are doing. This is used in Serialization->serializer->material
Returns any
Inherited from PhysicalMaterial.toJSON
- Defined in src/core/material/PhysicalMaterial.ts:205

Class MeshStandardMaterial2

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MeshStandardMaterial2

Properties

alphaMap

Default

ReadonlyappliedMeshes

assetType

bumpMap

Default

constructor

displacementMap

Default

extraUniformsToUpload

Optionalgenerator

ReadonlyisPhysicalMaterial

map

Default

materialExtensions

metalnessMap

Default

normalMap

Default

registerMaterialExtensions

roughnessMap

Default

ReadonlysetDirty

uiConfig

unregisterMaterialExtensions

userData

Default

Static ReadonlyInterpolateProperties

Static ReadonlyMapProperties

Static ReadonlyMaterialProperties

StaticMaterialTemplate

Static ReadonlyTYPE

Static ReadonlyTypeSlug

Methods

clone

Parameters

Returns this

copy

Parameters

Returns this

customProgramCacheKey

Returns string

dispose

Returns this

fromJSON

Parameters

Returns null | MeshStandardMaterial2

onBeforeCompile

Parameters

Returns void

onBeforeRender

Parameters

Returns void

setValues

Parameters

Returns this

toJSON

Parameters

Returns any

Settings

On This Page

`Readonly`appliedMeshes

`Optional`generator

`Readonly`isPhysicalMaterial

`Readonly`setDirty

`Static` `Readonly`InterpolateProperties

`Static` `Readonly`MapProperties

`Static` `Readonly`MaterialProperties

`Static`MaterialTemplate

`Static` `Readonly`TYPE

`Static` `Readonly`TypeSlug