Class MeshReflectorMaterial

反射材质

Export

Date

2023.6.20

Author

lyx

Hierarchy

MeshStandardMaterial
- MeshReflectorMaterial

Index

Constructors

constructor

new MeshReflectorMaterial(parameters): MeshReflectorMaterial
Parameters
- parameters: MeshReflectorMaterialParameters
Returns MeshReflectorMaterial

Overrides MeshStandardMaterial.constructor

Properties

alphaHash

alphaHash: boolean

Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

alphaMap

alphaMap: Texture

Default

null

alphaToCoverage

alphaToCoverage: boolean

Enables alpha to coverage. Can only be used with MSAA-enabled rendering contexts (meaning when the renderer was created with antialias parameter set to true). Enabling this will smooth aliasing on clip plane edges and alphaTest-clipped edges.

Default

false

aoMap

aoMap: Texture

Default

null

aoMapIntensity

aoMapIntensity: number

Default

blendAlpha

blendAlpha: number

Represents the alpha value of the constant blend color. This property has only an effect when using custom blending with ConstantAlphaFactor or OneMinusConstantAlphaFactor.

Default

blendColor

blendColor: Color

Represent the RGB values of the constant blend color. This property has only an effect when using custom blending with ConstantColorFactor or OneMinusConstantColorFactor.

Default

0x000000

blendDst

blendDst: BlendingDstFactor

Blending destination. It's one of the blending mode constants defined in Three.js. Default is OneMinusSrcAlphaFactor.

Default

THREE.OneMinusSrcAlphaFactor

blendDstAlpha

blendDstAlpha: number

The tranparency of the .blendDst. Default is null.

Default

null

blendEquation

blendEquation: BlendingEquation

Blending equation to use when applying blending. It's one of the constants defined in Three.js. Default is AddEquation.

Default

THREE.AddEquation

blendEquationAlpha

blendEquationAlpha: number

The tranparency of the .blendEquation. Default is null.

Default

null

blendSrc

blendSrc: 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 211 | 212 | 213 | 214 | 210

Blending source. It's one of the blending mode constants defined in Three.js. Default is SrcAlphaFactor.

Default

THREE.SrcAlphaFactor

blendSrcAlpha

blendSrcAlpha: number

The tranparency of the .blendSrc. Default is null.

Default

null

blending

blending: Blending

Which blending to use when displaying objects with this material. Default is NormalBlending.

Default

THREE.NormalBlending

bumpMap

bumpMap: Texture

Default

null

bumpScale

bumpScale: number

Default

clipIntersection

clipIntersection: boolean

Changes the behavior of clipping planes so that only their intersection is clipped, rather than their union. Default is false.

Default

false

clipShadows

clipShadows: boolean

Defines whether to clip shadows according to the clipping planes specified on this material. Default is false.

Default

false

clippingPlanes

clippingPlanes: Plane[]

User-defined clipping planes specified as THREE.Plane objects in world space. These planes apply to the objects this material is attached to. Points in space whose signed distance to the plane is negative are clipped (not rendered). See the WebGL / clipping /intersection example. Default is null.

Default

null

color

color: Color

Default

new THREE.Color( 0xffffff )

colorWrite

colorWrite: boolean

Whether to render the material's color. This can be used in conjunction with a mesh's .renderOrder property to create invisible objects that occlude other objects. Default is true.

Default

true

defines

defines: {
[key: string]: any;
}

Type declaration

[key: string]: any

Default

{ 'STANDARD': '' }

depthFunc

depthFunc: DepthModes

Which depth function to use. Default is LessEqualDepth. See the depth mode constants for all possible values.

Default

THREE.LessEqualDepth

depthTest

depthTest: boolean

Whether to have depth test enabled when rendering this material. When the depth test is disabled, the depth write will also be implicitly disabled.

Default

true

depthWrite

depthWrite: boolean

Whether rendering this material has any effect on the depth buffer. Default is true. When drawing 2D overlays it can be useful to disable the depth writing in order to layer several things together without creating z-index artifacts.

Default

true

displacementBias

displacementBias: number

Default

displacementMap

displacementMap: Texture

Default

null

displacementScale

displacementScale: number

Default

dithering

dithering: boolean

Whether to apply dithering to the color to remove the appearance of banding. Default is false.

Default

false

emissive

emissive: Color

Default

new THREE.Color( 0x000000 )

emissiveIntensity

emissiveIntensity: number

Default

emissiveMap

emissiveMap: Texture

Default

null

envMap

envMap: Texture

Default

null

envMapIntensity

envMapIntensity: number

Default

envMapRotation

envMapRotation: Euler

The rotation of the environment map in radians. Default is (0,0,0).

flatShading

flatShading: boolean

Define whether the material is rendered with flat shading. Default is false.

Default

false

fog

fog: boolean

Whether the material is affected by fog. Default is true.

Default

fog

forceSinglePass

forceSinglePass: boolean

Default

false

id

id: number

Unique number of this material instance.

`Readonly` isMaterial

isMaterial: true

Read-only flag to check if a given object is of type Material.

Remarks

This is a constant value

Default Value

true

`Readonly` isMeshStandardMaterial

isMeshStandardMaterial: true

Read-only flag to check if a given object is of type MeshStandardMaterial.

Remarks

This is a constant value

Default Value

true

lightMap

lightMap: Texture

Default

null

lightMapIntensity

lightMapIntensity: number

Default

map

map: Texture

Default

null

metalness

metalness: number

Default

metalnessMap

metalnessMap: Texture

Default

null

name

name: string

Material name. Default is an empty string.

Default

''

normalMap

normalMap: Texture

Default

null

normalMapType

normalMapType: NormalMapTypes

Default

THREE.TangentSpaceNormalMap

normalScale

normalScale: Vector2

Default

new THREE.Vector2( 1, 1 )

opacity

opacity: number

Opacity. Default is 1.

Default

polygonOffset

polygonOffset: boolean

Whether to use polygon offset. Default is false. This corresponds to the POLYGON_OFFSET_FILL WebGL feature.

Default

false

polygonOffsetFactor

polygonOffsetFactor: number

Sets the polygon offset factor. Default is 0.

Default

polygonOffsetUnits

polygonOffsetUnits: number

Sets the polygon offset units. Default is 0.

Default

precision

precision: "highp" | "mediump" | "lowp"

Override the renderer's default precision for this material. Can be "highp", "mediump" or "lowp". Defaults is null.

Default

null

premultipliedAlpha

premultipliedAlpha: boolean

Whether to premultiply the alpha (transparency) value. See WebGL / Materials / Transparency for an example of the difference. Default is false.

Default

false

roughness

roughness: number

Default

roughnessMap

roughnessMap: Texture

Default

null

shadowSide

shadowSide: Side

Defines which of the face sides will cast shadows. Default is null. If null, the value is opposite that of side, above.

Default

null

side

side: Side

Defines which of the face sides will be rendered - front, back or both. Default is THREE.FrontSide. Other options are THREE.BackSide and THREE.DoubleSide.

Default

{@link THREE.FrontSide}

stencilFail

stencilFail: StencilOp

Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

Default

THREE.KeepStencilOp

stencilFunc

stencilFunc: StencilFunc

The stencil comparison function to use. Default is AlwaysStencilFunc. See stencil operation constants for all possible values.

Default

THREE.AlwaysStencilFunc

stencilFuncMask

stencilFuncMask: number

The bit mask to use when comparing against the stencil buffer. Default is 0xFF.

Default

0xff

stencilRef

stencilRef: number

The value to use when performing stencil comparisons or stencil operations. Default is 0.

Default

stencilWrite

stencilWrite: boolean

Whether rendering this material has any effect on the stencil buffer. Default is false.

Default

false

stencilWriteMask

stencilWriteMask: number

The bit mask to use when writing to the stencil buffer. Default is 0xFF.

Default

0xff

stencilZFail

stencilZFail: StencilOp

Which stencil operation to perform when the comparison function returns true but the depth test fails. Default is KeepStencilOp. See the stencil operation constants for all possible values.

Default

THREE.KeepStencilOp

stencilZPass

stencilZPass: StencilOp

Which stencil operation to perform when the comparison function returns true and the depth test passes. Default is KeepStencilOp. See the stencil operation constants for all possible values.

Default

THREE.KeepStencilOp

toneMapped

toneMapped: boolean

Defines whether this material is tone mapped according to the renderer's WebGLRenderer.toneMapping toneMapping setting. It is ignored when rendering to a render target or using post processing.

Default

true

transparent

transparent: boolean

Defines whether this material is transparent. This has an effect on rendering as transparent objects need special treatment and are rendered after non-transparent objects. When set to true, the extent to which the material is transparent is controlled by setting it's .opacity property.

Default

false

type

type: string

Value is the string 'Material'. This shouldn't be changed, and can be used to find all objects of this type in a scene.

userData

userData: Record<string, any>

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

{}

uuid

uuid: string

UUID of this material instance. This gets automatically assigned, so this shouldn't be edited.

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

Default

vertexColors

vertexColors: boolean

Defines whether vertex coloring is used. Default is false.

Default

false

visible

visible: boolean

Defines whether this material is visible. Default is true.

Default

true

wireframe

wireframe: boolean

Default

false

wireframeLinecap

wireframeLinecap: string

Default

'round'

wireframeLinejoin

wireframeLinejoin: string

Default

'round'

wireframeLinewidth

wireframeLinewidth: number

Default

Accessors

alphaTest

get alphaTest(): number
Gets the alpha value to be used when running an alpha test. Default is 0.

Returns number
Default
```
0
```
Inherited from MeshStandardMaterial.alphaTest
set alphaTest(value): void
Sets the alpha value to be used when running an alpha test. Default is 0.
Parameters
- value: number
Returns void
Default
```
0
```
Inherited from MeshStandardMaterial.alphaTest

depthMap

get depthMap(): Texture
获取深度贴图

Returns Texture

Memberof
MeshReflectorMaterial
set depthMap(value): void
设置深度贴图
Parameters
- value: Texture
Returns void

Memberof
MeshReflectorMaterial

depthScale

get depthScale(): number
获取深度缩放

Returns number

Memberof
MeshReflectorMaterial
set depthScale(value): void
设置深度缩放
Parameters
- value: number
Returns void

Memberof
MeshReflectorMaterial

depthToBlurRatioBias

get depthToBlurRatioBias(): number
获取深度模糊偏移量

Returns number

Memberof
MeshReflectorMaterial
set depthToBlurRatioBias(value): void
设置深度模糊偏移量
Parameters
- value: number
Returns void

Memberof
MeshReflectorMaterial

distortionIntensity

get distortionIntensity(): number
获取抖动强度

Returns number

Memberof
MeshReflectorMaterial
set distortionIntensity(value): void
设置抖动强度
Parameters
- value: number
Returns void

Memberof
MeshReflectorMaterial

distortionMap

get distortionMap(): Texture
获取抖动贴图

Returns Texture

Memberof
MeshReflectorMaterial
set distortionMap(value): void
设置抖动贴图
Parameters
- value: Texture
Returns void

Memberof
MeshReflectorMaterial

maxDepthThreshold

get maxDepthThreshold(): number
获取最大深度阈值

Returns number

Memberof
MeshReflectorMaterial
set maxDepthThreshold(value): void
设置最大深度阈值
Parameters
- value: number
Returns void

Memberof
MeshReflectorMaterial

minDepthThreshold

get minDepthThreshold(): number
获取最小深度阈值

Returns number

Memberof
MeshReflectorMaterial
set minDepthThreshold(value): void
设置最小深度阈值
Parameters
- value: number
Returns void

Memberof
MeshReflectorMaterial

mirror

get mirror(): number
获取镜像强度

Returns number

Memberof
MeshReflectorMaterial
set mirror(value): void
设置镜像强度
Parameters
- value: number
Returns void

Memberof
MeshReflectorMaterial

needsUpdate

set needsUpdate(value): void
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.
Parameters
- value: boolean
Returns void
Default
```
false
```
Inherited from MeshStandardMaterial.needsUpdate

reflectionBlurIntensity

get reflectionBlurIntensity(): number
获取反射模糊强度

Returns number

Memberof
MeshReflectorMaterial
set reflectionBlurIntensity(value): void
设置反射模糊强度
Parameters
- value: number
Returns void

Memberof
MeshReflectorMaterial

reflectionBlurMap

get reflectionBlurMap(): Texture
获取反射模糊纹理

Returns Texture

Memberof
MeshReflectorMaterial
set reflectionBlurMap(value): void
设置反射模糊纹理
Parameters
- value: Texture
Returns void

Memberof
MeshReflectorMaterial

reflectionContrast

get reflectionContrast(): number
获取反射对比度

Returns number

Memberof
MeshReflectorMaterial
set reflectionContrast(value): void
设置反射对比度
Parameters
- value: number
Returns void

Memberof
MeshReflectorMaterial

reflectionMap

get reflectionMap(): Texture
获取反射贴图

Returns Texture

Memberof
MeshReflectorMaterial
set reflectionMap(value): void
设置反射贴图
Parameters
- value: Texture
Returns void

Memberof
MeshReflectorMaterial

reflectionStrength

get reflectionStrength(): number
获取反射强度

Returns number

Memberof
MeshReflectorMaterial
set reflectionStrength(value): void
设置反射强度
Parameters
- value: number
Returns void

Memberof
MeshReflectorMaterial

textureMatrix

get textureMatrix(): Matrix4
获取反射纹理矩阵

Returns Matrix4

Memberof
MeshReflectorMaterial
set textureMatrix(value): void
设置反射纹理矩阵
Parameters
- value: Matrix4
Returns void

Memberof
MeshReflectorMaterial

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<{
  dispose: {};
  }[T], T, MeshReflectorMaterial>
  
  The function that gets called when the event is fired.
Returns void

Inherited from MeshStandardMaterial.addEventListener

clone

clone(): MeshReflectorMaterial
Return a new material with the same parameters as this material.

Returns MeshReflectorMaterial

Inherited from MeshStandardMaterial.clone

copy

copy(material): MeshReflectorMaterial
Copy the parameters from the passed material into this material.
Parameters
- material: Material
Returns MeshReflectorMaterial

Inherited from MeshStandardMaterial.copy

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 MeshStandardMaterial.customProgramCacheKey

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends "dispose"
Parameters
- event: BaseEvent<T> & {
  dispose: {};
  }[T]
  
  The event that gets fired.
Returns void

Inherited from MeshStandardMaterial.dispatchEvent

dispose

dispose(): void
Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Material textures must be disposed of by the dispose() method of Texture.

Returns void

Inherited from MeshStandardMaterial.dispose

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<{
  dispose: {};
  }[T], T, MeshReflectorMaterial>
  
  The function that gets called when the event is fired.
Returns boolean

Inherited from MeshStandardMaterial.hasEventListener

onBeforeCompile

onBeforeCompile(shader, renderer): void
材质编译回调
Parameters
- shader: WebGLProgramParametersWithUniforms
- renderer: WebGLRenderer
Returns void

Memberof
MeshReflectorMaterial

Overrides MeshStandardMaterial.onBeforeCompile

onBeforeRender

onBeforeRender(renderer, scene, camera, geometry, object, group): void
An optional callback that is executed immediately before the material is used to render a 3D object. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- object: Object3D<Object3DEventMap>
- group: Group<Object3DEventMap>
Returns void

Inherited from MeshStandardMaterial.onBeforeRender

onBuild

onBuild(object, parameters, renderer): void
Parameters
- object: Object3D<Object3DEventMap>
- parameters: WebGLProgramParametersWithUniforms
- renderer: WebGLRenderer
Returns void

Deprecated
onBuild() has been removed.

Inherited from MeshStandardMaterial.onBuild

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  
  The type of the listener that gets removed.
- listener: EventListener<{
  dispose: {};
  }[T], T, MeshReflectorMaterial>
  
  The listener function that gets removed.
Returns void

Inherited from MeshStandardMaterial.removeEventListener

setValues

setValues(parameters): void
Parameters
- parameters: MeshStandardMaterialParameters
Returns void

Inherited from MeshStandardMaterial.setValues

toJSON

toJSON(meta?): MaterialJSON
Convert the material to three.js JSON format.
Parameters
- Optional meta: JSONMeta
  
  Object containing metadata such as textures or images for the material.
Returns MaterialJSON

Inherited from MeshStandardMaterial.toJSON

Class MeshReflectorMaterial

Export

Date

Author

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: MeshReflectorMaterialParameters

Returns MeshReflectorMaterial

Properties

alphaHash

alphaMap

Default

alphaToCoverage

Default

aoMap

Default

aoMapIntensity

Default

blendAlpha

Default

blendColor

Default

blendDst

Default

blendDstAlpha

Default

blendEquation

Default

blendEquationAlpha

Default

blendSrc

Default

blendSrcAlpha

Default

blending

Default

bumpMap

Default

bumpScale

Default

clipIntersection

Default

clipShadows

Default

clippingPlanes

Default

color

Default

colorWrite

Default

defines

Type declaration

[key: string]: any

Default

depthFunc

Default

depthTest

Default

depthWrite

Default

displacementBias

Default

displacementMap

Default

displacementScale

Default

dithering

Default

emissive

Default

emissiveIntensity

Default

emissiveMap

`Readonly` isMaterial

`Readonly` isMeshStandardMaterial