Skip to content

editor › Globals › FakeBurntEdgesMaterial

Class: FakeBurntEdgesMaterial

Same as MixMapEngravingShadedEngravingMaterial, but only renders as a single color (with transparency applied where ornaments are). Used to colorize the layers that create the illusion of the burnt edges.

Hierarchy

  • ShaderMaterial

↳ FakeBurntEdgesMaterial

Index

Constructors

Properties

Methods

Constructors

constructor

+ new FakeBurntEdgesMaterial(frontColor: Color, backColor: Color, ...params: any[]): FakeBurntEdgesMaterial

Overrides void

Defined in src/model/visualization/materials/shaderMaterials/FakeBurntEdgesMaterial.ts:89

Parameters:

Name Type
frontColor Color
backColor Color
...params any[]

Returns: FakeBurntEdgesMaterial

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.

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.

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.

Private cutoutStrength

• cutoutStrength: number = 1

Defined in src/model/visualization/materials/shaderMaterials/FakeBurntEdgesMaterial.ts:89

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.

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.

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.

Private textureLookupTransforms

• textureLookupTransforms: Matrix3[] = Array(MAX_TEXTURE_COUNT * MAX_USES_PER_TEXTURE).fill(new Matrix3())

Defined in src/model/visualization/materials/shaderMaterials/FakeBurntEdgesMaterial.ts:86

Private textureRepeat

• textureRepeat: boolean[] = Array(MAX_TEXTURE_COUNT).fill(false)

Defined in src/model/visualization/materials/shaderMaterials/FakeBurntEdgesMaterial.ts:85

Private textureUsed

• textureUsed: boolean[] = Array(MAX_TEXTURE_COUNT).fill(false)

Defined in src/model/visualization/materials/shaderMaterials/FakeBurntEdgesMaterial.ts:87

Private textures

• textures: Texture[] = Array(MAX_TEXTURE_COUNT).fill(new Texture())

Defined in src/model/visualization/materials/shaderMaterials/FakeBurntEdgesMaterial.ts:84

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 _getUsageInformationPerTexture

▸ _getUsageInformationPerTexture(plate: Plate): Map‹Texture, ICutoutUsageInformation[]›

Defined in src/model/visualization/materials/shaderMaterials/FakeBurntEdgesMaterial.ts:132

Parameters:

Name Type
plate Plate

Returns: Map‹Texture, ICutoutUsageInformation[]›

Protected _updateMetaUniformsFromUsageInformation

▸ _updateMetaUniformsFromUsageInformation(usageInformationPerTexture: Map‹Texture, ICutoutUsageInformation[]›): void

Defined in src/model/visualization/materials/shaderMaterials/FakeBurntEdgesMaterial.ts:157

Parameters:

Name Type
usageInformationPerTexture Map‹Texture, ICutoutUsageInformation[]›

Returns: void

Protected _updateTextureUniformsFromUsageInformation

▸ _updateTextureUniformsFromUsageInformation(usageInformationPerTexture: Map‹Texture, ICutoutUsageInformation[]›): void

Defined in src/model/visualization/materials/shaderMaterials/FakeBurntEdgesMaterial.ts:171

Parameters:

Name Type
usageInformationPerTexture Map‹Texture, ICutoutUsageInformation[]›

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

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

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

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

setCutoutsFromPlate

▸ setCutoutsFromPlate(plate: Plate, polygon: MultiPolygon): void

Defined in src/model/visualization/materials/shaderMaterials/FakeBurntEdgesMaterial.ts:116

Adds the cutouts from the plate to this material so they will be rendered from the next frame on.

Parameters:

Name Type
plate Plate
polygon MultiPolygon

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