Class MeshStandardMaterial2

Hierarchy (view full)

PhysicalMaterial
- MeshStandardMaterial2

Constructors

constructor

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

Properties

alphaMap

alphaMap: null | ITexture = null

`Readonly` appliedMeshes

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

Managed internally, do not change manually

assetType

assetType: "material" = ...

bumpMap

bumpMap: null | ITexture = null

constructor

constructor: typeof PhysicalMaterial

displacementMap

displacementMap: null | ITexture = null

extraUniformsToUpload

extraUniformsToUpload: Record<string, IUniform<any>> = {}

`Optional` generator

generator?: IMaterialGenerator

Managed internally, do not change manually

`Readonly` isPhysicalMaterial

isPhysicalMaterial: true = true

map

map: null | ITexture = null

materialExtensions

materialExtensions: MaterialExtension[] = []

metalnessMap

metalnessMap: null | ITexture = null

normalMap

normalMap: null | ITexture = null

onAfterRender

onAfterRender: ((renderer, scene, camera, geometry, object) => void) = ...

Type declaration

- (renderer, scene, camera, geometry, object): void
- Parameters
  - renderer: WebGLRenderer
  - scene: Scene<Event, string>
  - camera: Camera<Event, string>
  - geometry: BufferGeometry<NormalBufferAttributes, Event, string>
  - object: Object3D<Event, string>
  Returns void

registerMaterialExtensions

registerMaterialExtensions: ((this, customMaterialExtensions) => void) = iMaterialCommons.registerMaterialExtensions

Type declaration

- (this, customMaterialExtensions): void
- Parameters
  - this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
  - customMaterialExtensions: MaterialExtension[]
  Returns void

roughnessMap

roughnessMap: null | ITexture = null

`Readonly` setDirty

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

Type declaration

- (this, options?): void
- Parameters
  - this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
  - Optional options: IMaterialSetDirtyOptions
  Returns void

uiConfig

uiConfig: UiObjectConfig<any, string, any> = ...

unregisterMaterialExtensions

unregisterMaterialExtensions: ((this, customMaterialExtensions) => void) = iMaterialCommons.unregisterMaterialExtensions

Type declaration

- (this, customMaterialExtensions): void
- Parameters
  - this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
  - customMaterialExtensions: MaterialExtension[]
  Returns void

userData

userData: IMaterialUserData

`Static` `Readonly` MaterialProperties

MaterialProperties: {
    alphaMap: null;
    alphaTest: number;
    alphaToCoverage: boolean;
    aoMap: null;
    aoMapIntensity: number;
    attenuationColor: Color;
    attenuationDistance: number;
    blendDst: 205;
    blendDstAlpha: null;
    blendEquation: 100;
    blendEquationAlpha: null;
    blendSrc: 204;
    blendSrcAlpha: null;
    blending: 1;
    bumpMap: null;
    bumpScale: number;
    clearcoat: number;
    clearcoatMap: null;
    clearcoatNormalMap: null;
    clearcoatNormalScale: Vector2;
    clearcoatRoughness: number;
    clearcoatRoughnessMap: null;
    clipIntersection: boolean;
    clipShadows: boolean;
    clippingPlanes: null;
    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;
} = ...

Type declaration

alphaMap: null
alphaTest: number
alphaToCoverage: boolean
aoMap: null
aoMapIntensity: number
attenuationColor: Color
attenuationDistance: number
blendDst: 205
blendDstAlpha: null
blendEquation: 100
blendEquationAlpha: null
blendSrc: 204
blendSrcAlpha: null
blending: 1
bumpMap: null
bumpScale: number
clearcoat: number
clearcoatMap: null
clearcoatNormalMap: null
clearcoatNormalScale: Vector2
clearcoatRoughness: number
clearcoatRoughnessMap: null
clipIntersection: boolean
clipShadows: boolean
clippingPlanes: null
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, Partial<{
    alphaMap: null;
    alphaTest: number;
    alphaToCoverage: boolean;
    aoMap: null;
    aoMapIntensity: number;
    attenuationColor: Color;
    attenuationDistance: number;
    blendDst: 205;
    blendDstAlpha: null;
    blendEquation: 100;
    blendEquationAlpha: null;
    blendSrc: 204;
    blendSrcAlpha: null;
    blending: 1;
    bumpMap: null;
    bumpScale: number;
    clearcoat: number;
    clearcoatMap: null;
    clearcoatNormalMap: null;
    clearcoatNormalScale: Vector2;
    clearcoatRoughness: number;
    clearcoatRoughnessMap: null;
    clipIntersection: boolean;
    clipShadows: boolean;
    clippingPlanes: null;
    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(): this
Returns this
Inherited from PhysicalMaterial.clone
- Defined in src/core/material/PhysicalMaterial.ts:48

copy

copy(source): this
Parameters
- source: any
Returns this
Inherited from PhysicalMaterial.copy
- Defined in src/core/material/PhysicalMaterial.ts:183

customProgramCacheKey

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

dispatchEvent

dispatchEvent(event): void
Parameters
- event: IMaterialEvent
Returns void
Inherited from PhysicalMaterial.dispatchEvent
- Defined in src/core/material/PhysicalMaterial.ts:49

dispose

dispose(): this
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

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

fromJSON

fromJSON(data, meta?, _internal?): 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
- Optional meta: SerializationMetaType
- _internal: boolean = false
Returns null | MeshStandardMaterial2
Inherited from PhysicalMaterial.fromJSON
- Defined in src/core/material/PhysicalMaterial.ts:208

onBeforeCompile

onBeforeCompile(shader, renderer): void
Parameters
- shader: Shader & {
  defines: any;
  }
- renderer: WebGLRenderer
Returns void
Inherited from PhysicalMaterial.onBeforeCompile
- Defined in src/core/material/PhysicalMaterial.ts:83

onBeforeRender

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

setValues

setValues(parameters, allowInvalidType?, clearCurrentUserData?): 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<Event, string> | 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.
Returns this
Inherited from PhysicalMaterial.setValues
- Defined in src/core/material/PhysicalMaterial.ts:161

toJSON

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

Class MeshStandardMaterial2

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional parameters: MeshPhysicalMaterialParameters

Returns MeshStandardMaterial2

Properties

alphaMap

Readonly appliedMeshes

assetType

bumpMap

constructor

displacementMap

extraUniformsToUpload

Optional generator

Readonly isPhysicalMaterial

map

materialExtensions

metalnessMap

normalMap

onAfterRender

Type declaration

Parameters

renderer: WebGLRenderer

scene: Scene<Event, string>

camera: Camera<Event, string>

geometry: BufferGeometry<NormalBufferAttributes, Event, string>

object: Object3D<Event, string>

Returns void

registerMaterialExtensions

Type declaration

Parameters

this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

customMaterialExtensions: MaterialExtension[]

Returns void

roughnessMap

Readonly setDirty

Type declaration

Parameters

this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

Optional options: IMaterialSetDirtyOptions

Returns void

uiConfig

unregisterMaterialExtensions

Type declaration

Parameters

this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

customMaterialExtensions: MaterialExtension[]

Returns void

userData

Static Readonly MaterialProperties

Type declaration

alphaMap: null

alphaTest: number

alphaToCoverage: boolean

aoMap: null

aoMapIntensity: number

attenuationColor: Color

attenuationDistance: number

blendDst: 205

blendDstAlpha: null

blendEquation: 100

blendEquationAlpha: null

blendSrc: 204

blendSrcAlpha: null

blending: 1

bumpMap: null

bumpScale: number

clearcoat: number

clearcoatMap: null

clearcoatNormalMap: null

clearcoatNormalScale: Vector2

clearcoatRoughness: number

clearcoatRoughnessMap: null

clipIntersection: boolean

`Optional` parameters: MeshPhysicalMaterialParameters

`Readonly` appliedMeshes

`Optional` generator

`Readonly` isPhysicalMaterial

`Readonly` setDirty

`Optional` options: IMaterialSetDirtyOptions

`Static` `Readonly` MaterialProperties