editor › Globals › MixMapEngravingMaterial
Class: MixMapEngravingMaterial
Hierarchy
- ShaderMaterial
↳ MixMapEngravingMaterial
↳ MixMapShadedEngravingMaterial
Index
Constructors
Properties
- alphaTest
- baseShaderName
- blendDst
- blendDstAlpha
- blendEquation
- blendEquationAlpha
- blendSrc
- blendSrcAlpha
- blending
- clipIntersection
- clipShadows
- clipping
- clippingPlanes
- clones
- colorWrite
- defaultAttributeValues
- defines
- depthFunc
- depthTest
- depthWrite
- derivatives
- dithering
- extensions
- flatShading
- fog
- fragmentShader
- id
- index0AttributeName
- isMaterial
- lights
- linewidth
- morphNormals
- morphTargets
- name
- needsUpdate
- opacity
- parameters
- polygonOffset
- polygonOffsetFactor
- polygonOffsetUnits
- precision
- premultipliedAlpha
- previousTransparency
- side
- skinning
- stencilFail
- stencilFunc
- stencilMask
- stencilRef
- stencilWrite
- stencilZFail
- stencilZPass
- toneMapped
- transparent
- type
- uniforms
- userData
- uuid
- version
- vertexColors
- vertexShader
- vertexTangents
- visible
- wireframe
- wireframeLinewidth
Methods
- _addColorizeFragment
- _addMapFragment
- _addOverlayFragment
- _addRoughnessMapFragment
- _clearColorizeColor
- _getFragmentShader
- _getVertexShader
- _setColorizeColor
- _updateEngravingStrength
- _updateTextures
- _updateTexturesInClones
- addEventListener
- clearCutoutTexture
- clearEngravingTexture
- clearEnvMap
- clearHighlightColor
- clearMap
- clone
- copy
- dispatchEvent
- dispose
- getCloneWithPolygonOffset
- getCutoutCanvas
- getEngravingCanvas
- getEngravingTexture
- hasCutoutTexture
- hasEngravingTexture
- hasEventListener
- hasOverlayTexture
- onBeforeCompile
- removeEventListener
- setCutoutTexture
- setEngravingTexture
- setEnvMap
- setHighlightColor
- setMap
- setValues
- toJSON
Constructors
constructor
+ new MixMapEngravingMaterial(parameters: BaseEngravingMaterialParameters, baseShaderName: string): MixMapEngravingMaterial
Overrides void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:148
Parameters:
| Name | Type | Default |
|---|---|---|
parameters |
BaseEngravingMaterialParameters | {} |
baseShaderName |
string | "phong" |
Returns: MixMapEngravingMaterial
Properties
alphaTest
• alphaTest: number
Inherited from MixMapEngravingMaterial.alphaTest
Defined in node_modules/three/src/materials/Material.d.ts:73
Sets the alpha value to be used when running an alpha test. Default is 0.
Private Readonly baseShaderName
• baseShaderName: string
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:148
blendDst
• blendDst: BlendingDstFactor
Inherited from MixMapEngravingMaterial.blendDst
Defined in node_modules/three/src/materials/Material.d.ts:78
Blending destination. It's one of the blending mode constants defined in Three.js. Default is {@link OneMinusSrcAlphaFactor}.
blendDstAlpha
• blendDstAlpha: number | null
Inherited from MixMapEngravingMaterial.blendDstAlpha
Defined in node_modules/three/src/materials/Material.d.ts:83
The tranparency of the .blendDst. Default is null.
blendEquation
• blendEquation: BlendingEquation
Inherited from MixMapEngravingMaterial.blendEquation
Defined in node_modules/three/src/materials/Material.d.ts:88
Blending equation to use when applying blending. It's one of the constants defined in Three.js. Default is {@link AddEquation}.
blendEquationAlpha
• blendEquationAlpha: number | null
Inherited from MixMapEngravingMaterial.blendEquationAlpha
Defined in node_modules/three/src/materials/Material.d.ts:93
The tranparency of the .blendEquation. Default is null.
blendSrc
• blendSrc: BlendingSrcFactor | BlendingDstFactor
Inherited from MixMapEngravingMaterial.blendSrc
Defined in node_modules/three/src/materials/Material.d.ts:103
Blending source. It's one of the blending mode constants defined in Three.js. Default is {@link SrcAlphaFactor}.
blendSrcAlpha
• blendSrcAlpha: number | null
Inherited from MixMapEngravingMaterial.blendSrcAlpha
Defined in node_modules/three/src/materials/Material.d.ts:108
The tranparency of the .blendSrc. Default is null.
blending
• blending: Blending
Inherited from MixMapEngravingMaterial.blending
Defined in node_modules/three/src/materials/Material.d.ts:98
Which blending to use when displaying objects with this material. Default is {@link NormalBlending}.
clipIntersection
• clipIntersection: boolean
Inherited from MixMapEngravingMaterial.clipIntersection
Defined in node_modules/three/src/materials/Material.d.ts:113
Changes the behavior of clipping planes so that only their intersection is clipped, rather than their union. Default is false.
clipShadows
• clipShadows: boolean
Inherited from MixMapEngravingMaterial.clipShadows
Defined in node_modules/three/src/materials/Material.d.ts:123
Defines whether to clip shadows according to the clipping planes specified on this material. Default is false.
clipping
• clipping: boolean
Inherited from MixMapEngravingMaterial.clipping
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:45
clippingPlanes
• clippingPlanes: any
Inherited from MixMapEngravingMaterial.clippingPlanes
Defined in node_modules/three/src/materials/Material.d.ts:118
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.
Private clones
• clones: Map‹string, this› = new Map()
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:146
colorWrite
• colorWrite: boolean
Inherited from MixMapEngravingMaterial.colorWrite
Defined in node_modules/three/src/materials/Material.d.ts:128
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.
defaultAttributeValues
• defaultAttributeValues: any
Inherited from MixMapEngravingMaterial.defaultAttributeValues
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:59
defines
• defines: any
Inherited from MixMapEngravingMaterial.defines
Defined in node_modules/three/src/materials/Material.d.ts:134
Custom defines to be injected into the shader. These are passed in form of an object literal, with key/value pairs. { MY_CUSTOM_DEFINE: '' , PI2: Math.PI * 2 }. The pairs are defined in both vertex and fragment shaders. Default is undefined.
depthFunc
• depthFunc: DepthModes
Inherited from MixMapEngravingMaterial.depthFunc
Defined in node_modules/three/src/materials/Material.d.ts:139
Which depth function to use. Default is {@link LessEqualDepth}. See the depth mode constants for all possible values.
depthTest
• depthTest: boolean
Inherited from MixMapEngravingMaterial.depthTest
Defined in node_modules/three/src/materials/Material.d.ts:144
Whether to have depth test enabled when rendering this material. Default is true.
depthWrite
• depthWrite: boolean
Inherited from MixMapEngravingMaterial.depthWrite
Defined in node_modules/three/src/materials/Material.d.ts:150
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.
derivatives
• derivatives: any
Inherited from MixMapEngravingMaterial.derivatives
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:52
deprecated Use {@link ShaderMaterial#extensions.derivatives extensions.derivatives} instead.
dithering
• dithering: boolean
Inherited from MixMapEngravingMaterial.dithering
Defined in node_modules/three/src/materials/Material.d.ts:247
Whether to apply dithering to the color to remove the appearance of banding. Default is false.
extensions
• extensions: object
Inherited from MixMapEngravingMaterial.extensions
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:53
Type declaration:
-
derivatives: boolean
-
drawBuffers: boolean
-
fragDepth: boolean
-
shaderTextureLOD: boolean
flatShading
• flatShading: boolean
Inherited from MixMapEngravingMaterial.flatShading
Defined in node_modules/three/src/materials/Material.d.ts:252
Define whether the material is rendered with flat shading. Default is false.
fog
• fog: boolean
Inherited from MixMapEngravingMaterial.fog
Defined in node_modules/three/src/materials/Material.d.ts:155
Whether the material is affected by fog. Default is true.
fragmentShader
• fragmentShader: string
Inherited from MixMapEngravingMaterial.fragmentShader
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:40
id
• id: number
Inherited from MixMapEngravingMaterial.id
Defined in node_modules/three/src/materials/Material.d.ts:160
Unique number of this material instance.
index0AttributeName
• index0AttributeName: string | undefined
Inherited from MixMapEngravingMaterial.index0AttributeName
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:60
isMaterial
• isMaterial: boolean
Inherited from MixMapEngravingMaterial.isMaterial
Defined in node_modules/three/src/materials/Material.d.ts:201
Used to check whether this or derived classes are materials. Default is true. You should not change this, as it used internally for optimisation.
lights
• lights: boolean
Inherited from MixMapEngravingMaterial.lights
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:44
linewidth
• linewidth: number
Inherited from MixMapEngravingMaterial.linewidth
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:41
morphNormals
• morphNormals: boolean
Inherited from MixMapEngravingMaterial.morphNormals
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:48
morphTargets
• morphTargets: boolean
Inherited from MixMapEngravingMaterial.morphTargets
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:47
name
• name: string
Inherited from MixMapEngravingMaterial.name
Defined in node_modules/three/src/materials/Material.d.ts:206
Material name. Default is an empty string.
needsUpdate
• needsUpdate: boolean
Inherited from MixMapEngravingMaterial.needsUpdate
Defined in node_modules/three/src/materials/Material.d.ts:212
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.
opacity
• opacity: number
Inherited from MixMapEngravingMaterial.opacity
Defined in node_modules/three/src/materials/Material.d.ts:217
Opacity. Default is 1.
Protected Readonly parameters
• parameters: BaseEngravingMaterialParameters
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:144
polygonOffset
• polygonOffset: boolean
Inherited from MixMapEngravingMaterial.polygonOffset
Defined in node_modules/three/src/materials/Material.d.ts:222
Whether to use polygon offset. Default is false. This corresponds to the POLYGON_OFFSET_FILL WebGL feature.
polygonOffsetFactor
• polygonOffsetFactor: number
Inherited from MixMapEngravingMaterial.polygonOffsetFactor
Defined in node_modules/three/src/materials/Material.d.ts:227
Sets the polygon offset factor. Default is 0.
polygonOffsetUnits
• polygonOffsetUnits: number
Inherited from MixMapEngravingMaterial.polygonOffsetUnits
Defined in node_modules/three/src/materials/Material.d.ts:232
Sets the polygon offset units. Default is 0.
precision
• precision: "highp" | "mediump" | "lowp" | null
Inherited from MixMapEngravingMaterial.precision
Defined in node_modules/three/src/materials/Material.d.ts:237
Override the renderer's default precision for this material. Can be "highp", "mediump" or "lowp". Defaults is null.
premultipliedAlpha
• premultipliedAlpha: boolean
Inherited from MixMapEngravingMaterial.premultipliedAlpha
Defined in node_modules/three/src/materials/Material.d.ts:242
Whether to premultiply the alpha (transparency) value. See WebGL / Materials / Transparency for an example of the difference. Default is false.
Private previousTransparency
• previousTransparency: boolean
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:147
side
• side: Side
Inherited from MixMapEngravingMaterial.side
Defined in node_modules/three/src/materials/Material.d.ts:258
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.
skinning
• skinning: boolean
Inherited from MixMapEngravingMaterial.skinning
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:46
stencilFail
• stencilFail: StencilOp
Inherited from MixMapEngravingMaterial.stencilFail
Defined in node_modules/three/src/materials/Material.d.ts:185
Which stencil operation to perform when the comparison function returns false. Default is {@link KeepStencilOp}. See the stencil operation constants for all possible values.
stencilFunc
• stencilFunc: StencilFunc
Inherited from MixMapEngravingMaterial.stencilFunc
Defined in node_modules/three/src/materials/Material.d.ts:170
The stencil comparison function to use. Default is {@link AlwaysStencilFunc}. See stencil operation constants for all possible values.
stencilMask
• stencilMask: number
Inherited from MixMapEngravingMaterial.stencilMask
Defined in node_modules/three/src/materials/Material.d.ts:180
The bit mask to use when comparing against or writing to the stencil buffer. Default is 0xFF.
stencilRef
• stencilRef: number
Inherited from MixMapEngravingMaterial.stencilRef
Defined in node_modules/three/src/materials/Material.d.ts:175
The value to use when performing stencil comparisons or stencil operations. Default is 0.
stencilWrite
• stencilWrite: boolean
Inherited from MixMapEngravingMaterial.stencilWrite
Defined in node_modules/three/src/materials/Material.d.ts:165
Whether rendering this material has any effect on the stencil buffer. Default is false.
stencilZFail
• stencilZFail: StencilOp
Inherited from MixMapEngravingMaterial.stencilZFail
Defined in node_modules/three/src/materials/Material.d.ts:190
Which stencil operation to perform when the comparison function returns true but the depth test fails. Default is {@link KeepStencilOp}. See the stencil operation constants for all possible values.
stencilZPass
• stencilZPass: StencilOp
Inherited from MixMapEngravingMaterial.stencilZPass
Defined in node_modules/three/src/materials/Material.d.ts:195
Which stencil operation to perform when the comparison function returns true and the depth test passes. Default is {@link KeepStencilOp}. See the stencil operation constants for all possible values.
toneMapped
• toneMapped: boolean
Inherited from MixMapEngravingMaterial.toneMapped
Defined in node_modules/three/src/materials/Material.d.ts:264
Defines whether this material is tone mapped according to the renderer's toneMapping setting. Default is true.
transparent
• transparent: boolean
Inherited from MixMapEngravingMaterial.transparent
Defined in node_modules/three/src/materials/Material.d.ts:271
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 is false.
type
• type: string
Inherited from MixMapEngravingMaterial.type
Defined in node_modules/three/src/materials/Material.d.ts:276
Value is the string 'Material'. This shouldn't be changed, and can be used to find all objects of this type in a scene.
uniforms
• uniforms: object
Inherited from MixMapEngravingMaterial.uniforms
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:38
Type declaration:
- [ uniform: string]: IUniform
userData
• userData: any
Inherited from MixMapEngravingMaterial.userData
Defined in node_modules/three/src/materials/Material.d.ts:301
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.
uuid
• uuid: string
Inherited from MixMapEngravingMaterial.uuid
Defined in node_modules/three/src/materials/Material.d.ts:281
UUID of this material instance. This gets automatically assigned, so this shouldn't be edited.
version
• version: number
Inherited from MixMapEngravingMaterial.version
Defined in node_modules/three/src/materials/Material.d.ts:306
This starts at 0 and counts how many times .needsUpdate is set to true.
vertexColors
• vertexColors: Colors
Inherited from MixMapEngravingMaterial.vertexColors
Defined in node_modules/three/src/materials/Material.d.ts:286
Defines whether vertex coloring is used. Default is THREE.NoColors. Other options are THREE.VertexColors and THREE.FaceColors.
vertexShader
• vertexShader: string
Inherited from MixMapEngravingMaterial.vertexShader
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:39
vertexTangents
• vertexTangents: boolean
Inherited from MixMapEngravingMaterial.vertexTangents
Defined in node_modules/three/src/materials/Material.d.ts:291
Defines whether precomputed vertex tangents are used. Default is false.
visible
• visible: boolean
Inherited from MixMapEngravingMaterial.visible
Defined in node_modules/three/src/materials/Material.d.ts:296
Defines whether this material is visible. Default is true.
wireframe
• wireframe: boolean
Inherited from MixMapEngravingMaterial.wireframe
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:42
wireframeLinewidth
• wireframeLinewidth: number
Inherited from MixMapEngravingMaterial.wireframeLinewidth
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:43
Methods
Protected _addColorizeFragment
▸ _addColorizeFragment(fragmentShader: string): string
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:428
Parameters:
| Name | Type |
|---|---|
fragmentShader |
string |
Returns: string
Protected _addMapFragment
▸ _addMapFragment(fragmentShader: string): string
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:403
Parameters:
| Name | Type |
|---|---|
fragmentShader |
string |
Returns: string
Protected _addOverlayFragment
▸ _addOverlayFragment(fragmentShader: string): string
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:415
Parameters:
| Name | Type |
|---|---|
fragmentShader |
string |
Returns: string
Protected _addRoughnessMapFragment
▸ _addRoughnessMapFragment(fragmentShader: string): string
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:423
Parameters:
| Name | Type |
|---|---|
fragmentShader |
string |
Returns: string
Protected _clearColorizeColor
▸ _clearColorizeColor(): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:382
Returns: void
Protected _getFragmentShader
▸ _getFragmentShader(baseShader: string): string
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:394
Parameters:
| Name | Type |
|---|---|
baseShader |
string |
Returns: string
Protected _getVertexShader
▸ _getVertexShader(baseShader: string): string
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:388
Parameters:
| Name | Type |
|---|---|
baseShader |
string |
Returns: string
Protected _setColorizeColor
▸ _setColorizeColor(color: Color, strength: number, engravingFalloff: number): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:376
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
color |
Color | - | the color of the material |
strength |
number | 0.5 | how intense the color should be (0..1) |
engravingFalloff |
number | 1 | how fast the color should disappear with increasing engraving alpha 1 / engravingFalloff is the engraving alpha value for which no color is visible anymore |
Returns: void
_updateEngravingStrength
▸ _updateEngravingStrength(): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:286
Returns: void
Protected _updateTextures
▸ _updateTextures(otherMaterial: any): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:438
Parameters:
| Name | Type |
|---|---|
otherMaterial |
any |
Returns: void
Protected _updateTexturesInClones
▸ _updateTexturesInClones(): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:434
Returns: void
addEventListener
▸ addEventListener(type: string, listener: function): void
Inherited from MixMapEngravingMaterial.addEventListener
Defined in node_modules/three/src/core/EventDispatcher.d.ts:20
Adds a listener to an event type.
Parameters:
▪ type: string
The type of event to listen to.
▪ listener: function
The function that gets called when the event is fired.
▸ (event: Event): void
Parameters:
| Name | Type |
|---|---|
event |
Event |
Returns: void
clearCutoutTexture
▸ clearCutoutTexture(): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:321
Returns: void
clearEngravingTexture
▸ clearEngravingTexture(): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:299
Returns: void
clearEnvMap
▸ clearEnvMap(): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:259
Returns: void
clearHighlightColor
▸ clearHighlightColor(): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:365
Returns: void
clearMap
▸ clearMap(): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:235
Returns: void
clone
▸ clone(): this
Inherited from MixMapEngravingMaterial.clone
Defined in node_modules/three/src/materials/Material.d.ts:311
Return a new material with the same parameters as this material.
Returns: this
copy
▸ copy(material: Material): this
Inherited from MixMapEngravingMaterial.copy
Defined in node_modules/three/src/materials/Material.d.ts:317
Copy the parameters from the passed material into this material.
Parameters:
| Name | Type | Description |
|---|---|---|
material |
Material |
Returns: this
dispatchEvent
▸ dispatchEvent(event: object): void
Inherited from MixMapEngravingMaterial.dispatchEvent
Defined in node_modules/three/src/core/EventDispatcher.d.ts:40
Fire an event type.
Parameters:
▪ event: object
| Name | Type |
|---|---|
type |
string |
Returns: void
dispose
▸ dispose(): void
Inherited from MixMapEngravingMaterial.dispose
Defined in node_modules/three/src/materials/Material.d.ts:322
This disposes the material. Textures of a material don't get disposed. These needs to be disposed by {@link Texture}.
Returns: void
getCloneWithPolygonOffset
▸ getCloneWithPolygonOffset(polygonOffsetFactor: any, polygonOffsetUnits: any): any
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:339
Returns a clone of this material with the zOffset set. Changes to textures in this material will be propagated to all clones. The cloned material should be regarded as immutable, as it may be shared. See https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/polygonOffset for what the parameters do. Note, that it requires a lot of tweaking until you get these parameters right.
Parameters:
| Name | Type |
|---|---|
polygonOffsetFactor |
any |
polygonOffsetUnits |
any |
Returns: any
getCutoutCanvas
▸ getCutoutCanvas(): any
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:313
Returns: any
getEngravingCanvas
▸ getEngravingCanvas(): any
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:291
Returns: any
getEngravingTexture
▸ getEngravingTexture(): any
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:282
Returns: any
hasCutoutTexture
▸ hasCutoutTexture(): boolean
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:317
Returns: boolean
hasEngravingTexture
▸ hasEngravingTexture(): boolean
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:295
Returns: boolean
hasEventListener
▸ hasEventListener(type: string, listener: function): boolean
Inherited from MixMapEngravingMaterial.hasEventListener
Defined in node_modules/three/src/core/EventDispatcher.d.ts:27
Checks if listener is added to an event type.
Parameters:
▪ type: string
The type of event to listen to.
▪ listener: function
The function that gets called when the event is fired.
▸ (event: Event): void
Parameters:
| Name | Type |
|---|---|
event |
Event |
Returns: boolean
hasOverlayTexture
▸ hasOverlayTexture(): boolean
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:267
Returns: boolean
onBeforeCompile
▸ onBeforeCompile(shader: Shader, renderer: WebGLRenderer): void
Inherited from MixMapEngravingMaterial.onBeforeCompile
Defined in node_modules/three/src/materials/Material.d.ts:329
An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials.
Parameters:
| Name | Type | Description |
|---|---|---|
shader |
Shader | Source code of the shader |
renderer |
WebGLRenderer | WebGLRenderer Context that is initializing the material |
Returns: void
removeEventListener
▸ removeEventListener(type: string, listener: function): void
Inherited from MixMapEngravingMaterial.removeEventListener
Defined in node_modules/three/src/core/EventDispatcher.d.ts:34
Removes a listener from an event type.
Parameters:
▪ type: string
The type of the listener that gets removed.
▪ listener: function
The listener function that gets removed.
▸ (event: Event): void
Parameters:
| Name | Type |
|---|---|
event |
Event |
Returns: void
setCutoutTexture
▸ setCutoutTexture(texture: any): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:304
Parameters:
| Name | Type |
|---|---|
texture |
any |
Returns: void
setEngravingTexture
▸ setEngravingTexture(texture: any): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:271
Parameters:
| Name | Type |
|---|---|
texture |
any |
Returns: void
setEnvMap
▸ setEnvMap(cubeTexture: CubeTexture): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:247
Set a cube texture as environment texture for this material. Environment textures are used for fast reflections.
Parameters:
| Name | Type | Description |
|---|---|---|
cubeTexture |
CubeTexture | cube environment texture to use |
Returns: void
setHighlightColor
▸ setHighlightColor(color: Color, strength: number): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:360
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
color |
Color | - | the highlight color |
strength |
number | 0.5 | the alpha value of the color overlay |
Returns: void
setMap
▸ setMap(textures: Texture[]): void
Defined in src/model/visualization/materials/shaderMaterials/MixMapEngravingMaterial.ts:214
Set one or two textures, to be used as mixmap components See http://www.neilblevins.com/cg_education/tiling_trick/tiling_trick.htm for an explanation of mixmaps
Parameters:
| Name | Type | Description |
|---|---|---|
textures |
Texture[] | array of textures to be loaded |
Returns: void
setValues
▸ setValues(parameters: ShaderMaterialParameters): void
Inherited from MixMapEngravingMaterial.setValues
Overrides void
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:62
Parameters:
| Name | Type |
|---|---|
parameters |
ShaderMaterialParameters |
Returns: void
toJSON
▸ toJSON(meta: any): any
Inherited from MixMapEngravingMaterial.toJSON
Overrides void
Defined in node_modules/three/src/materials/ShaderMaterial.d.ts:63
Parameters:
| Name | Type |
|---|---|
meta |
any |
Returns: any