src/viewer/scene/materials/SpecularMaterial.js
import {Material} from './Material.js';
import {RenderState} from '../webgl/RenderState.js';
import {math} from '../math/math.js';
const alphaModes = {"opaque": 0, "mask": 1, "blend": 2};
const alphaModeNames = ["opaque", "mask", "blend"];
/**
* @desc Configures the normal rendered appearance of {@link Mesh}es using the physically-accurate *specular-glossiness* shading model.
*
* * Useful for insulators, such as wood, ceramics and plastic.
* * {@link MetallicMaterial} is best for conductive materials, such as metal.
* * {@link PhongMaterial} is appropriate for non-realistic objects.
* * {@link LambertMaterial} is appropriate for high-detail models that need to render as efficiently as possible.
*
* ## Usage
*
* In the example below we'll create a {@link Mesh} with a {@link buildTorusGeometry} and a SpecularMaterial.
*
* Note that in this example we're providing separate {@link Texture} for the {@link SpecularMaterial#specular} and {@link SpecularMaterial#glossiness}
* channels, which allows us a little creative flexibility. Then, in the next example further down, we'll combine those channels
* within the same {@link Texture} for efficiency.
*
* ````javascript
* import {Viewer, Mesh, buildTorusGeometry, SpecularMaterial, Texture} from "xeokit-sdk.es.js";
*
* const viewer = new Viewer({ canvasId: "myCanvas" });
*
* const myMesh = new Mesh(viewer.scene,{
*
* geometry: new ReadableGeometry(viewer.scene, buildTorusGeometry()),
*
* material: new SpecularMaterial(viewer.scene,{
*
* // Channels with default values, just to show them
*
* diffuse: [1.0, 1.0, 1.0],
* specular: [1.0, 1.0, 1.0],
* glossiness: 1.0,
* emissive: [0.0, 0.0, 0.0]
* alpha: 1.0,
*
* // Textures to multiply some of the channels
*
* diffuseMap: new Texture(viewer.scene, { // RGB components multiply by diffuse
* src: "textures/diffuse.jpg"
* }),
* specularMap: new Texture(viewer.scene, { // RGB component multiplies by specular
* src: "textures/specular.jpg"
* }),
* glossinessMap: new Texture(viewer.scene, { // R component multiplies by glossiness
* src: "textures/glossiness.jpg"
* }),
* normalMap: new Texture(viewer.scene, {
* src: "textures/normalMap.jpg"
* })
* })
* });
* ````
*
* ## Combining Channels Within the Same Textures
*
* In the previous example we provided separate {@link Texture} for the {@link SpecularMaterial#specular} and
* {@link SpecularMaterial#glossiness} channels, but we can combine those channels into the same {@link Texture} to reduce
* download time, memory footprint and rendering time (and also for glTF compatibility).
*
* Here's our SpecularMaterial again with those channels combined in the {@link SpecularMaterial#specularGlossinessMap}
* {@link Texture}, where the *RGB* component multiplies by {@link SpecularMaterial#specular} and *A* multiplies by {@link SpecularMaterial#glossiness}.
*
* ````javascript
* const myMesh = new Mesh(viewer.scene,{
*
* geometry: new ReadableGeometry(viewer.scene, buildTorusGeometry()),
*
* material: new SpecularMaterial(viewer.scene,{
*
* // Channels with default values, just to show them
*
* diffuse: [1.0, 1.0, 1.0],
* specular: [1.0, 1.0, 1.0],
* glossiness: 1.0,
* emissive: [0.0, 0.0, 0.0]
* alpha: 1.0,
*
* diffuseMap: new Texture(viewer.scene, {
* src: "textures/diffuse.jpg"
* }),
* specularGlossinessMap: new Texture(viewer.scene, { // RGB multiplies by specular, A by glossiness
* src: "textures/specularGlossiness.jpg"
* }),
* normalMap: new Texture(viewer.scene, {
* src: "textures/normalMap.jpg"
* })
* })
* });
* ````
*
* Although not shown in this example, we can also texture {@link SpecularMaterial#alpha} with
* the *A* component of {@link SpecularMaterial#diffuseMap}'s {@link Texture}, if required.
*
* ## Alpha Blending
*
* Let's make our {@link Mesh} transparent. We'll redefine {@link SpecularMaterial#alpha}
* and {@link SpecularMaterial#alphaMode}, causing it to blend 50% with the background:
*
* ````javascript
* const myMesh = new Mesh(viewer.scene,{
*
* geometry: new ReadableGeometry(viewer.scene, buildTorusGeometry()),
*
* material: new SpecularMaterial(viewer.scene,{
*
* // Channels with default values, just to show them
*
* diffuse: [1.0, 1.0, 1.0],
* specular: [1.0, 1.0, 1.0],
* glossiness: 1.0,
* emissive: [0.0, 0.0, 0.0]
* alpha: 0.5, // <<----------- Changed
* alphaMode: "blend", // <<----------- Added
*
* diffuseMap: new Texture(viewer.scene, {
* src: "textures/diffuse.jpg"
* }),
* specularGlossinessMap: new Texture(viewer.scene, { // RGB multiplies by specular, A by glossiness
* src: "textures/specularGlossiness.jpg"
* }),
* normalMap: new Texture(viewer.scene, {
* src: "textures/normalMap.jpg"
* })
* })
* });
* ````
*
* ## Alpha Masking
*
* Now let's make holes in our {@link Mesh}. We'll give its SpecularMaterial an {@link SpecularMaterial#alphaMap}
* and configure {@link SpecularMaterial#alpha}, {@link SpecularMaterial#alphaMode},
* and {@link SpecularMaterial#alphaCutoff} to treat it as an alpha mask:
*
* ````javascript
* const myMesh = new Mesh(viewer.scene,{
*
* geometry: buildTorusGeometry(viewer.scene, ReadableGeometry, {}),
*
* material: new SpecularMaterial(viewer.scene, {
*
* // Channels with default values, just to show them
*
* diffuse: [1.0, 1.0, 1.0],
* specular: [1.0, 1.0, 1.0],
* glossiness: 1.0,
* emissive: [0.0, 0.0, 0.0]
* alpha: 1.0, // <<----------- Changed
* alphaMode: "mask", // <<----------- Changed
* alphaCutoff: 0.2, // <<----------- Added
*
* alphaMap: new Texture(viewer.scene, { // <<---------- Added
* src: "textures/diffuse/crossGridColorMap.jpg"
* }),
* diffuseMap: new Texture(viewer.scene, {
* src: "textures/diffuse.jpg"
* }),
* specularGlossinessMap: new Texture(viewer.scene, { // RGB multiplies by specular, A by glossiness
* src: "textures/specularGlossiness.jpg"
* }),
* normalMap: new Texture(viewer.scene, {
* src: "textures/normalMap.jpg"
* })
* })
* });
* ````
*
* ## Background Theory
*
* For an introduction to physically-based rendering (PBR) concepts, try these articles:
*
* * Joe Wilson's [Basic Theory of Physically-Based Rendering](https://www.marmoset.co/posts/basic-theory-of-physically-based-rendering/)
* * Jeff Russel's [Physically-based Rendering, and you can too!](https://www.marmoset.co/posts/physically-based-rendering-and-you-can-too/)
* * Sebastien Legarde's [Adapting a physically-based shading model](http://seblagarde.wordpress.com/tag/physically-based-rendering/)
*
* ## SpecularMaterial Properties
*
* The following table summarizes SpecularMaterial properties:
*
* | Property | Type | Range | Default Value | Space | Description |
* |:--------:|:----:|:-----:|:-------------:|:-----:|:-----------:|
* | {@link SpecularMaterial#diffuse} | Array | [0, 1] for all components | [1,1,1,1] | linear | The RGB components of the diffuse color of the material. |
* | {@link SpecularMaterial#specular} | Array | [0, 1] for all components | [1,1,1,1] | linear | The RGB components of the specular color of the material. |
* | {@link SpecularMaterial#glossiness} | Number | [0, 1] | 1 | linear | The glossiness the material. |
* | {@link SpecularMaterial#specularF0} | Number | [0, 1] | 1 | linear | The specularF0 of the material surface. |
* | {@link SpecularMaterial#emissive} | Array | [0, 1] for all components | [0,0,0] | linear | The RGB components of the emissive color of the material. |
* | {@link SpecularMaterial#alpha} | Number | [0, 1] | 1 | linear | The transparency of the material surface (0 fully transparent, 1 fully opaque). |
* | {@link SpecularMaterial#diffuseMap} | {@link Texture} | | null | sRGB | Texture RGB components multiplying by {@link SpecularMaterial#diffuse}. If the fourth component (A) is present, it multiplies by {@link SpecularMaterial#alpha}. |
* | {@link SpecularMaterial#specularMap} | {@link Texture} | | null | sRGB | Texture RGB components multiplying by {@link SpecularMaterial#specular}. If the fourth component (A) is present, it multiplies by {@link SpecularMaterial#alpha}. |
* | {@link SpecularMaterial#glossinessMap} | {@link Texture} | | null | linear | Texture with first component multiplying by {@link SpecularMaterial#glossiness}. |
* | {@link SpecularMaterial#specularGlossinessMap} | {@link Texture} | | null | linear | Texture with first three components multiplying by {@link SpecularMaterial#specular} and fourth component multiplying by {@link SpecularMaterial#glossiness}. |
* | {@link SpecularMaterial#emissiveMap} | {@link Texture} | | null | linear | Texture with RGB components multiplying by {@link SpecularMaterial#emissive}. |
* | {@link SpecularMaterial#alphaMap} | {@link Texture} | | null | linear | Texture with first component multiplying by {@link SpecularMaterial#alpha}. |
* | {@link SpecularMaterial#occlusionMap} | {@link Texture} | | null | linear | Ambient occlusion texture multiplying by surface's reflected diffuse and specular light. |
* | {@link SpecularMaterial#normalMap} | {@link Texture} | | null | linear | Tangent-space normal map. |
* | {@link SpecularMaterial#alphaMode} | String | "opaque", "blend", "mask" | "blend" | | Alpha blend mode. |
* | {@link SpecularMaterial#alphaCutoff} | Number | [0..1] | 0.5 | | Alpha cutoff value. |
* | {@link SpecularMaterial#backfaces} | Boolean | | false | | Whether to render {@link Geometry} backfaces. |
* | {@link SpecularMaterial#frontface} | String | "ccw", "cw" | "ccw" | | The winding order for {@link Geometry} frontfaces - "cw" for clockwise, or "ccw" for counter-clockwise. |
*
*/
class SpecularMaterial extends Material {
/**
@private
*/
get type() {
return "SpecularMaterial";
}
/**
*
* @constructor
* @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.
* @param {*} [cfg] The SpecularMaterial configuration
* @param {String} [cfg.id] Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted.
* @param {Number[]} [cfg.diffuse=[1,1,1]] RGB diffuse color of this SpecularMaterial. Multiplies by the RGB components of {@link SpecularMaterial#diffuseMap}.
* @param {Texture} [cfg.diffuseMap=undefined] RGBA {@link Texture} containing the diffuse color of this SpecularMaterial, with optional *A* component for alpha. The RGB components multiply by {@link SpecularMaterial#diffuse}, while the *A* component, if present, multiplies by {@link SpecularMaterial#alpha}.
* @param {Number} [cfg.specular=[1,1,1]] RGB specular color of this SpecularMaterial. Multiplies by the {@link SpecularMaterial#specularMap} and the *RGB* components of {@link SpecularMaterial#specularGlossinessMap}.
* @param {Texture} [cfg.specularMap=undefined] RGB texture containing the specular color of this SpecularMaterial. Multiplies by the {@link SpecularMaterial#specular} property. Must be within the same {@link Scene} as this SpecularMaterial.
* @param {Number} [cfg.glossiness=1.0] Factor in the range [0..1] indicating how glossy this SpecularMaterial is. 0 is no glossiness, 1 is full glossiness. Multiplies by the *R* component of {@link SpecularMaterial#glossinessMap} and the *A* component of {@link SpecularMaterial#specularGlossinessMap}.
* @param {Texture} [cfg.specularGlossinessMap=undefined] RGBA {@link Texture} containing this SpecularMaterial's specular color in its *RGB* component and glossiness in its *A* component. Its *RGB* components multiply by {@link SpecularMaterial#specular}, while its *A* component multiplies by {@link SpecularMaterial#glossiness}. Must be within the same {@link Scene} as this SpecularMaterial.
* @param {Number} [cfg.specularF0=0.0] Factor in the range 0..1 indicating how reflective this SpecularMaterial is.
* @param {Number[]} [cfg.emissive=[0,0,0]] RGB emissive color of this SpecularMaterial. Multiplies by the RGB components of {@link SpecularMaterial#emissiveMap}.
* @param {Texture} [cfg.emissiveMap=undefined] RGB {@link Texture} containing the emissive color of this SpecularMaterial. Multiplies by the {@link SpecularMaterial#emissive} property. Must be within the same {@link Scene} as this SpecularMaterial.
* @param {Texture} [cfg.occlusionMap=undefined] RGB ambient occlusion {@link Texture}. Within shaders, multiplies by the specular and diffuse light reflected by surfaces. Must be within the same {@link Scene} as this SpecularMaterial.
* @param {Texture} [cfg.normalMap=undefined] {Texture} RGB tangent-space normal {@link Texture}. Must be within the same {@link Scene} as this SpecularMaterial.
* @param {Number} [cfg.alpha=1.0] Factor in the range 0..1 indicating how transparent this SpecularMaterial is. A value of 0.0 indicates fully transparent, 1.0 is fully opaque. Multiplies by the *R* component of {@link SpecularMaterial#alphaMap} and the *A* component, if present, of {@link SpecularMaterial#diffuseMap}.
* @param {Texture} [cfg.alphaMap=undefined] RGB {@link Texture} containing this SpecularMaterial's alpha in its *R* component. The *R* component multiplies by the {@link SpecularMaterial#alpha} property. Must be within the same {@link Scene} as this SpecularMaterial.
* @param {String} [cfg.alphaMode="opaque"] The alpha blend mode - accepted values are "opaque", "blend" and "mask". See the {@link SpecularMaterial#alphaMode} property for more info.
* @param {Number} [cfg.alphaCutoff=0.5] The alpha cutoff value. See the {@link SpecularMaterial#alphaCutoff} property for more info.
* @param {Boolean} [cfg.backfaces=false] Whether to render {@link Geometry} backfaces.
* @param {Boolean} [cfg.frontface="ccw"] The winding order for {@link Geometry} front faces - "cw" for clockwise, or "ccw" for counter-clockwise.
* @param {Number} [cfg.lineWidth=1] Scalar that controls the width of {@link Geometry lines.
* @param {Number} [cfg.pointSize=1] Scalar that controls the size of {@link Geometry} points.
*/
constructor(owner, cfg = {}) {
super(owner, cfg);
this._state = new RenderState({
type: "SpecularMaterial",
diffuse: math.vec3([1.0, 1.0, 1.0]),
emissive: math.vec3([0.0, 0.0, 0.0]),
specular: math.vec3([1.0, 1.0, 1.0]),
glossiness: null,
specularF0: null,
alpha: null,
alphaMode: null,
alphaCutoff: null,
lineWidth: null,
pointSize: null,
backfaces: null,
frontface: null, // Boolean for speed; true == "ccw", false == "cw"
hash: null
});
this.diffuse = cfg.diffuse;
this.specular = cfg.specular;
this.glossiness = cfg.glossiness;
this.specularF0 = cfg.specularF0;
this.emissive = cfg.emissive;
this.alpha = cfg.alpha;
if (cfg.diffuseMap) {
this._diffuseMap = this._checkComponent("Texture", cfg.diffuseMap);
}
if (cfg.emissiveMap) {
this._emissiveMap = this._checkComponent("Texture", cfg.emissiveMap);
}
if (cfg.specularMap) {
this._specularMap = this._checkComponent("Texture", cfg.specularMap);
}
if (cfg.glossinessMap) {
this._glossinessMap = this._checkComponent("Texture", cfg.glossinessMap);
}
if (cfg.specularGlossinessMap) {
this._specularGlossinessMap = this._checkComponent("Texture", cfg.specularGlossinessMap);
}
if (cfg.occlusionMap) {
this._occlusionMap = this._checkComponent("Texture", cfg.occlusionMap);
}
if (cfg.alphaMap) {
this._alphaMap = this._checkComponent("Texture", cfg.alphaMap);
}
if (cfg.normalMap) {
this._normalMap = this._checkComponent("Texture", cfg.normalMap);
}
this.alphaMode = cfg.alphaMode;
this.alphaCutoff = cfg.alphaCutoff;
this.backfaces = cfg.backfaces;
this.frontface = cfg.frontface;
this.lineWidth = cfg.lineWidth;
this.pointSize = cfg.pointSize;
this._makeHash();
}
_makeHash() {
const state = this._state;
const hash = ["/spe"];
if (this._diffuseMap) {
hash.push("/dm");
if (this._diffuseMap.hasMatrix) {
hash.push("/mat");
}
hash.push("/" + this._diffuseMap.encoding);
}
if (this._emissiveMap) {
hash.push("/em");
if (this._emissiveMap.hasMatrix) {
hash.push("/mat");
}
}
if (this._glossinessMap) {
hash.push("/gm");
if (this._glossinessMap.hasMatrix) {
hash.push("/mat");
}
}
if (this._specularMap) {
hash.push("/sm");
if (this._specularMap.hasMatrix) {
hash.push("/mat");
}
}
if (this._specularGlossinessMap) {
hash.push("/sgm");
if (this._specularGlossinessMap.hasMatrix) {
hash.push("/mat");
}
}
if (this._occlusionMap) {
hash.push("/ocm");
if (this._occlusionMap.hasMatrix) {
hash.push("/mat");
}
}
if (this._normalMap) {
hash.push("/nm");
if (this._normalMap.hasMatrix) {
hash.push("/mat");
}
}
if (this._alphaMap) {
hash.push("/opm");
if (this._alphaMap.hasMatrix) {
hash.push("/mat");
}
}
hash.push(";");
state.hash = hash.join("");
}
/**
* Sets the RGB diffuse color of this SpecularMaterial.
*
* Multiplies by the *RGB* components of {@link SpecularMaterial#diffuseMap}.
*
* Default value is ````[1.0, 1.0, 1.0]````.
* @type {Number[]}
*/
set diffuse(value) {
let diffuse = this._state.diffuse;
if (!diffuse) {
diffuse = this._state.diffuse = new Float32Array(3);
} else if (value && diffuse[0] === value[0] && diffuse[1] === value[1] && diffuse[2] === value[2]) {
return;
}
if (value) {
diffuse[0] = value[0];
diffuse[1] = value[1];
diffuse[2] = value[2];
} else {
diffuse[0] = 1;
diffuse[1] = 1;
diffuse[2] = 1;
}
this.glRedraw();
}
/**
* Gets the RGB diffuse color of this SpecularMaterial.
*
* @type {Number[]}
*/
get diffuse() {
return this._state.diffuse;
}
/**
* Gets the RGB {@link Texture} containing the diffuse color of this SpecularMaterial, with optional *A* component for alpha.
*
* The *RGB* components multipliues by the {@link SpecularMaterial#diffuse} property, while the *A* component, if present, multiplies by the {@link SpecularMaterial#alpha} property.
*
* @type {Texture}
*/
get diffuseMap() {
return this._diffuseMap;
}
/**
* Sets the RGB specular color of this SpecularMaterial.
*
* Multiplies by {@link SpecularMaterial#specularMap} and the *A* component of {@link SpecularMaterial#specularGlossinessMap}.
*
* Default value is ````[1.0, 1.0, 1.0]````.
*
* @type {Number[]}
*/
set specular(value) {
let specular = this._state.specular;
if (!specular) {
specular = this._state.specular = new Float32Array(3);
} else if (value && specular[0] === value[0] && specular[1] === value[1] && specular[2] === value[2]) {
return;
}
if (value) {
specular[0] = value[0];
specular[1] = value[1];
specular[2] = value[2];
} else {
specular[0] = 1;
specular[1] = 1;
specular[2] = 1;
}
this.glRedraw();
}
/**
* Gets the RGB specular color of this SpecularMaterial.
*
* @type {Number[]}
*/
get specular() {
return this._state.specular;
}
/**
* Gets the RGB texture containing the specular color of this SpecularMaterial.
*
* Multiplies by {@link SpecularMaterial#specular}.
*
* @type {Texture}
*/
get specularMap() {
return this._specularMap;
}
/**
* Gets the RGBA texture containing this SpecularMaterial's specular color in its *RGB* components and glossiness in its *A* component.
*
* The *RGB* components multiplies {@link SpecularMaterial#specular}, while the *A* component multiplies by {@link SpecularMaterial#glossiness}.
*
* @type {Texture}
*/
get specularGlossinessMap() {
return this._specularGlossinessMap;
}
/**
* Sets the Factor in the range [0..1] indicating how glossy this SpecularMaterial is.
*
* ````0```` is no glossiness, ````1```` is full glossiness.
*
* Multiplies by the *R* component of {@link SpecularMaterial#glossinessMap} and the *A* component of {@link SpecularMaterial#specularGlossinessMap}.
*
* Default value is ````1.0````.
*
* @type {Number}
*/
set glossiness(value) {
value = (value !== undefined && value !== null) ? value : 1.0;
if (this._state.glossiness === value) {
return;
}
this._state.glossiness = value;
this.glRedraw();
}
/**
* Gets the Factor in the range ````[0..1]```` indicating how glossy this SpecularMaterial is.
* @type {Number}
*/
get glossiness() {
return this._state.glossiness;
}
/**
* Gets the RGB texture containing this SpecularMaterial's glossiness in its *R* component.
*
* The *R* component multiplies by {@link SpecularMaterial#glossiness}.
** @type {Texture}
*/
get glossinessMap() {
return this._glossinessMap;
}
/**
* Sets the factor in the range ````[0..1]```` indicating amount of specular Fresnel.
*
* Default value is ````0.0````.
*
* @type {Number}
*/
set specularF0(value) {
value = (value !== undefined && value !== null) ? value : 0.0;
if (this._state.specularF0 === value) {
return;
}
this._state.specularF0 = value;
this.glRedraw();
}
/**
* Gets the factor in the range ````[0..1]```` indicating amount of specular Fresnel.
*
* @type {Number}
*/
get specularF0() {
return this._state.specularF0;
}
/**
* Sets the RGB emissive color of this SpecularMaterial.
*
* Multiplies by {@link SpecularMaterial#emissiveMap}.
* Default value is ````[0.0, 0.0, 0.0]````.
*
* @type {Number[]}
*/
set emissive(value) {
let emissive = this._state.emissive;
if (!emissive) {
emissive = this._state.emissive = new Float32Array(3);
} else if (value && emissive[0] === value[0] && emissive[1] === value[1] && emissive[2] === value[2]) {
return;
}
if (value) {
emissive[0] = value[0];
emissive[1] = value[1];
emissive[2] = value[2];
} else {
emissive[0] = 0;
emissive[1] = 0;
emissive[2] = 0;
}
this.glRedraw();
}
/**
* Gets the RGB emissive color of this SpecularMaterial.
*
* @type {Number[]}
*/
get emissive() {
return this._state.emissive;
}
/**
* Gets the RGB texture containing the emissive color of this SpecularMaterial.
*
* Multiplies by {@link SpecularMaterial#emissive}.
*
* @type {Texture}
*/
get emissiveMap() {
return this._emissiveMap;
}
/**
* Sets the factor in the range [0..1] indicating how transparent this SpecularMaterial is.
*
* A value of ````0.0```` is fully transparent, while ````1.0```` is fully opaque.
*
* Multiplies by the *R* component of {@link SpecularMaterial#alphaMap} and the *A* component, if present, of {@link SpecularMaterial#diffuseMap}.
*
* Default value is ````1.0````.
*
* @type {Number}
*/
set alpha(value) {
value = (value !== undefined && value !== null) ? value : 1.0;
if (this._state.alpha === value) {
return;
}
this._state.alpha = value;
this.glRedraw();
}
/**
* Gets the factor in the range [0..1] indicating how transparent this SpecularMaterial is.
*
* @type {Number}
*/
get alpha() {
return this._state.alpha;
}
/**
* Gets the RGB {@link Texture} with alpha in its *R* component.
*
* The *R* component multiplies by the {@link SpecularMaterial#alpha} property.
*
* @type {Texture}
*/
get alphaMap() {
return this._alphaMap;
}
/**
* Gets the RGB tangent-space normal {@link Texture} attached to this SpecularMaterial.
*
* @type {Texture}
*/
get normalMap() {
return this._normalMap;
}
/**
* Gets the RGB ambient occlusion {@link Texture} attached to this SpecularMaterial.
*
* Multiplies by the specular and diffuse light reflected by surfaces.
*
* @type {Texture}
*/
get occlusionMap() {
return this._occlusionMap;
}
/**
* Sets the alpha rendering mode.
*
* This governs how alpha is treated. Alpha is the combined result of the {@link SpecularMaterial#alpha} and {@link SpecularMaterial#alphaMap} properties.
*
* Accepted values are:
*
* * "opaque" - The alpha value is ignored and the rendered output is fully opaque (default).
* * "mask" - The rendered output is either fully opaque or fully transparent depending on the alpha value and the specified alpha cutoff value.
* * "blend" - The alpha value is used to composite the source and destination areas. The rendered output is combined with the background using the normal painting operation (i.e. the Porter and Duff over operator)
*
* @type {String}
*/
set alphaMode(alphaMode) {
alphaMode = alphaMode || "opaque";
let value = alphaModes[alphaMode];
if (value === undefined) {
this.error("Unsupported value for 'alphaMode': " + alphaMode + " defaulting to 'opaque'");
value = "opaque";
}
if (this._state.alphaMode === value) {
return;
}
this._state.alphaMode = value;
this.glRedraw();
}
get alphaMode() {
return alphaModeNames[this._state.alphaMode];
}
/**
* Sets the alpha cutoff value.
*
* Specifies the cutoff threshold when {@link SpecularMaterial#alphaMode} equals "mask". If the alpha is greater than or equal to this value then it is rendered as fully opaque, otherwise, it is rendered as fully transparent. A value greater than 1.0 will render the entire material as fully transparent. This value is ignored for other modes.
*
* Alpha is the combined result of the {@link SpecularMaterial#alpha} and {@link SpecularMaterial#alphaMap} properties.
*
* Default value is ````0.5````.
*
* @type {Number}
*/
set alphaCutoff(alphaCutoff) {
if (alphaCutoff === null || alphaCutoff === undefined) {
alphaCutoff = 0.5;
}
if (this._state.alphaCutoff === alphaCutoff) {
return;
}
this._state.alphaCutoff = alphaCutoff;
}
/**
* Gets the alpha cutoff value.
* @type {Number}
*/
get alphaCutoff() {
return this._state.alphaCutoff;
}
/**
* Sets whether backfaces are visible on attached {@link Mesh}es.
*
* The backfaces will belong to {@link ReadableGeometry} compoents that are also attached to the {@link Mesh}es.
*
* Default is ````false````.
*
* @type {Boolean}
*/
set backfaces(value) {
value = !!value;
if (this._state.backfaces === value) {
return;
}
this._state.backfaces = value;
this.glRedraw();
}
/**
* Gets whether backfaces are visible on attached {@link Mesh}es.
*
* @type {Boolean}
*/
get backfaces() {
return this._state.backfaces;
}
/**
* Sets the winding direction of front faces of {@link Geometry} of attached {@link Mesh}es.
*
* Default value is ````"ccw"````.
*
* @type {String}
*/
set frontface(value) {
value = value !== "cw";
if (this._state.frontface === value) {
return;
}
this._state.frontface = value;
this.glRedraw();
}
/**
* Gets the winding direction of front faces of {@link Geometry} of attached {@link Mesh}es.
*
* @type {String}
*/
get frontface() {
return this._state.frontface ? "ccw" : "cw";
}
/**
* Sets the SpecularMaterial's line width.
*
* This is not supported by WebGL implementations based on DirectX [2019].
*
* Default value is ````1.0````.
*
* @type {Number}
*/
set lineWidth(value) {
this._state.lineWidth = value || 1.0;
this.glRedraw();
}
/**
* Gets the SpecularMaterial's line width.
*
* @type {Number}
*/
get lineWidth() {
return this._state.lineWidth;
}
/**
* Sets the SpecularMaterial's point size.
*
* Default value is ````1.0````.
*
* @type {Number}
*/
set pointSize(value) {
this._state.pointSize = value || 1;
this.glRedraw();
}
/**
* Sets the SpecularMaterial's point size.
*
* @type {Number}
*/
get pointSize() {
return this._state.pointSize;
}
/**
* Destroys this SpecularMaterial.
*/
destroy() {
super.destroy();
this._state.destroy();
}
}
export {SpecularMaterial};
