Class: DiamondMaterial

Extra-Helpers.DiamondMaterial

Hierarchy

• ShaderMaterial<IMaterialEventMap>

  ↳ DiamondMaterial

Implements

• IMaterial

Properties

TypeSlug

▪ Static Readonly TypeSlug: "dmat"

---

TYPE

▪ Static Readonly TYPE: "DiamondMaterial"

---

typeSlug

• Readonly typeSlug: "dmat"

Implementation of

IMaterial.typeSlug

---

materialExtensions

• materialExtensions: MaterialExtension[]

Implementation of

IMaterial.materialExtensions

---

assetType

• assetType: "material"

Implementation of

IMaterial.assetType

---

isDiamondMaterial

• isDiamondMaterial: true

---

color

• color: Color

---

envMapIntensity

• envMapIntensity: number = 1.

---

envMapRotationOffset

• envMapRotationOffset: number = 0.

---

envMapRotationOffsetX

• envMapRotationOffsetX: number = 0.

---

envMapRotationOffsetY

• envMapRotationOffsetY: number = 0.

---

envMapRotationOffsetZ

• envMapRotationOffsetZ: number = 0.

---

dispersion

• dispersion: number = 0.012

---

absorptionFactor

• absorptionFactor: number = 1

---

refractiveIndex

• refractiveIndex: number = 2.4

---

squashFactor

• squashFactor: number = 0.98

---

geometryFactor

• geometryFactor: number = 0.5

---

gammaFactor

• gammaFactor: number = 1

---

boostFactors

• boostFactors: Vector3

---

transmission

• transmission: number = 0.

---

reflectivity

• reflectivity: number = 0.5

---

rayBounces

• rayBounces: number = 5

---

diamondOrientedEnvMap

• diamondOrientedEnvMap: number = 0

---

normalsCaptureMap

• normalsCaptureMap: null | Texture<TextureEventMap> = null

---

extraUniformsToUpload

• extraUniformsToUpload: Object

Type declaration

Name	Type
inverseModelMatrix	{ value: Matrix4 }
inverseModelMatrix.value	Matrix4
radius	{ value: number = 1 }
radius.value	number
centerOffset	{ value: Vector3 }
centerOffset.value	Vector3
modelOffsetMatrix	{ value: Matrix4 }
modelOffsetMatrix.value	Matrix4
modelOffsetMatrixInv	{ value: Matrix4 }
modelOffsetMatrixInv.value	Matrix4

Implementation of

IMaterial.extraUniformsToUpload

---

envMapIndex

• envMapIndex: number = 0

Accessors

mmMaterial

• get mmMaterial(): this

Returns

this

---

materialObject

• get materialObject(): this

Returns

this

Implementation of

IMaterial.materialObject

---

envMaps

• set envMaps(value): void

Parameters

Name	Type
value	(null | ITexture<any>)[]

Returns

void

---

envMap

• get envMap(): null | ITexture<any>

Returns

null | ITexture<any>

• set envMap(val): void

Parameters

Name	Type
val	null | ITexture<any>

Returns

void

---

uiConfig

• get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Implementation of

IMaterial.uiConfig

Methods

onBeforeRender

▸ onBeforeRender(renderer, scene, camera, geometry, object): void

Parameters

Name	Type
renderer	WebGLRenderer
scene	Scene<Object3DEventMap>
camera	Camera<Object3DEventMap>
geometry	BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>
object	Object3D<Object3DEventMap>

Returns

void

Overrides

ShaderMaterial.onBeforeRender

---

onAfterRender

▸ onAfterRender(renderer, scene, camera, geometry, object): void

Parameters

Name	Type
renderer	WebGLRenderer
scene	Scene<Object3DEventMap>
camera	Camera<Object3DEventMap>
geometry	BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>
object	Object3D<Object3DEventMap>

Returns

void

Overrides

ShaderMaterial.onAfterRender

---

registerMaterialExtensions

▸ registerMaterialExtensions(customMaterialExtensions): void

Parameters

Name	Type
customMaterialExtensions	MaterialExtension[]

Returns

void

Implementation of

IMaterial.registerMaterialExtensions

---

unregisterMaterialExtensions

▸ unregisterMaterialExtensions(customMaterialExtensions): void

Parameters

Name	Type
customMaterialExtensions	MaterialExtension[]

Returns

void

Implementation of

IMaterial.unregisterMaterialExtensions

---

onBeforeCompile

▸ onBeforeCompile(shader, renderer): void

Parameters

Name	Type
shader	Shader
renderer	WebGLRenderer

Returns

void

Overrides

ShaderMaterial.onBeforeCompile

---

customProgramCacheKey

▸ customProgramCacheKey(): string

Returns

string

Overrides

ShaderMaterial.customProgramCacheKey

---

setDirty

▸ setDirty(options?): void

Parameters

Name	Type
options?	AnyOptions

Returns

void

Implementation of

IMaterial.setDirty

---

refreshEnvUniform

▸ refreshEnvUniform(): void

Returns

void

---

clone

▸ clone(): DiamondMaterial

Returns

DiamondMaterial

Implementation of

IMaterial.clone

Overrides

ShaderMaterial.clone

---

toJSON

▸ toJSON(meta?): DiamondMaterialParameters

Parameters

Name	Type
meta?	any

Returns

DiamondMaterialParameters

Implementation of

IMaterial.toJSON

Overrides

ShaderMaterial.toJSON

---

copyProps

▸ copyProps(oldMaterial): DiamondMaterial

Parameters

Name	Type
oldMaterial	DiamondMaterialParameters

Returns

DiamondMaterial

Implementation of

IMaterial.copyProps

---

fromJSON

▸ fromJSON(data, meta?): null | DiamondMaterial

Parameters

Name	Type
data	any
meta?	any

Returns

null | DiamondMaterial

Implementation of

IMaterial.fromJSON

Constructors

constructor

• new DiamondMaterial(parameters)

Parameters

Name	Type
parameters	DiamondMaterialParameters & { customMaterialExtensions?: MaterialExtension[] }

Overrides

ShaderMaterial<IMaterialEventMap\>.constructor