Skip to content

MeshPhysicalMaterial: .sheen -> .sheenTint #22381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 21, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/api/en/materials/MeshPhysicalMaterial.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,10 +133,9 @@ <h3>[property:Float reflectivity]</h3>
This models the reflectivity of non-metallic materials. It has no effect when [page:MeshStandardMaterial.metalness metalness] is *1.0*
</p>

<h3>[property:Color sheen]</h3>
<h3>[property:Color sheenTint]</h3>
<p>
If a color is assigned to this property, the material will use a special sheen BRDF intended for rendering cloth materials such as velvet.
The sheen color provides the ability to create two-tone specular materials. *null* by default.
Used for rendering materials such as velvet. It has no effect when set to black (0x000000). Default is black.
</p>

<h3>[property:Float transmission]</h3>
Expand Down
3 changes: 3 additions & 0 deletions docs/api/en/math/Color.html
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,9 @@ <h3>[method:Object getHSL]( [param:Object target] )</h3>
<h3>[method:String getStyle]()</h3>
<p>Returns the value of this color as a CSS style string. Example: 'rgb(255,0,0)'.</p>

<h3>[method:Boolean isBlack]() </h3>
<p>Returns true if the [page:.r r], [page:.g g] and [page:.b b] components are zero, false otherwise.</p>

<h3>[method:Color lerp]( [param:Color color], [param:Float alpha] ) </h3>
<p>
[page:Color color] - color to converge on.<br />
Expand Down
2 changes: 1 addition & 1 deletion examples/jsm/nodes/materials/StandardNodeMaterial.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ NodeUtils.addShortcuts( StandardNodeMaterial.prototype, 'fragment', [
'environment',
'mask',
'position',
'sheen'
'sheenTint'
] );

export { StandardNodeMaterial };
12 changes: 6 additions & 6 deletions examples/jsm/nodes/materials/nodes/StandardNode.js
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ class StandardNode extends Node {

}

if ( this.sheen ) this.sheen.analyze( builder );
if ( this.sheenTint ) this.sheenTint.analyze( builder );

// build code

Expand Down Expand Up @@ -230,7 +230,7 @@ class StandardNode extends Node {

const clearcoatEnv = useClearcoat && environment ? this.environment.flow( builder, 'c', { cache: 'clearcoat', context: contextClearcoatEnvironment, slot: 'environment' } ) : undefined;

const sheen = this.sheen ? this.sheen.flow( builder, 'c' ) : undefined;
const sheenTint = this.sheenTint ? this.sheenTint.flow( builder, 'c' ) : undefined;

builder.requires.transparent = alpha !== undefined;

Expand Down Expand Up @@ -368,9 +368,9 @@ class StandardNode extends Node {

}

if ( sheen ) {
if ( sheenTint ) {

output.push( 'material.sheenColor = ' + sheen.result + ';' );
output.push( 'material.sheenTint = ' + sheenTint.result + ';' );

}

Expand Down Expand Up @@ -547,7 +547,7 @@ class StandardNode extends Node {

if ( source.environment ) this.environment = source.environment;

if ( source.sheen ) this.sheen = source.sheen;
if ( source.sheenTint ) this.sheenTint = source.sheenTint;

return this;

Expand Down Expand Up @@ -593,7 +593,7 @@ class StandardNode extends Node {

if ( this.environment ) data.environment = this.environment.toJSON( meta ).uuid;

if ( this.sheen ) data.sheen = this.sheen.toJSON( meta ).uuid;
if ( this.sheenTint ) data.sheenTint = this.sheenTint.toJSON( meta ).uuid;

}

Expand Down
2 changes: 1 addition & 1 deletion src/loaders/MaterialLoader.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ class MaterialLoader extends Loader {
if ( json.color !== undefined && material.color !== undefined ) material.color.setHex( json.color );
if ( json.roughness !== undefined ) material.roughness = json.roughness;
if ( json.metalness !== undefined ) material.metalness = json.metalness;
if ( json.sheen !== undefined ) material.sheen = new Color().setHex( json.sheen );
if ( json.sheenTint !== undefined ) material.sheenTint = new Color().setHex( json.sheenTint );
if ( json.emissive !== undefined && material.emissive !== undefined ) material.emissive.setHex( json.emissive );
if ( json.specular !== undefined && material.specular !== undefined ) material.specular.setHex( json.specular );
if ( json.specularIntensity !== undefined ) material.specularIntensity = json.specularIntensity;
Expand Down
2 changes: 1 addition & 1 deletion src/materials/Material.js
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ class Material extends EventDispatcher {
if ( this.roughness !== undefined ) data.roughness = this.roughness;
if ( this.metalness !== undefined ) data.metalness = this.metalness;

if ( this.sheen && this.sheen.isColor ) data.sheen = this.sheen.getHex();
if ( this.sheenTint && this.sheenTint.isColor ) data.sheenTint = this.sheenTint.getHex();
if ( this.emissive && this.emissive.isColor ) data.emissive = this.emissive.getHex();
if ( this.emissiveIntensity && this.emissiveIntensity !== 1 ) data.emissiveIntensity = this.emissiveIntensity;

Expand Down
14 changes: 3 additions & 11 deletions src/materials/MeshPhysicalMaterial.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import * as MathUtils from '../math/MathUtils.js';
* ior: <float>,
* reflectivity: <float>,
*
* sheen: <Color>,
* sheenTint: <Color>,
*
* transmission: <float>,
* transmissionMap: new THREE.Texture( <Image> ),
Expand Down Expand Up @@ -69,7 +69,7 @@ class MeshPhysicalMaterial extends MeshStandardMaterial {
}
} );

this.sheen = null; // null will disable sheen bsdf
this.sheenTint = new Color( 0x000000 );

this.transmission = 0.0;
this.transmissionMap = null;
Expand Down Expand Up @@ -108,15 +108,7 @@ class MeshPhysicalMaterial extends MeshStandardMaterial {

this.ior = source.ior;

if ( source.sheen ) {

this.sheen = ( this.sheen || new Color() ).copy( source.sheen );

} else {

this.sheen = null;

}
this.sheenTint.copy( source.sheenTint );

this.transmission = source.transmission;
this.transmissionMap = source.transmissionMap;
Expand Down
6 changes: 6 additions & 0 deletions src/math/Color.js
Original file line number Diff line number Diff line change
Expand Up @@ -546,6 +546,12 @@ class Color {

}

isBlack() {

return ( this.r === 0 ) && ( this.g === 0 ) && ( this.b === 0 );

}

fromArray( array, offset = 0 ) {

this.r = array[ offset ];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ material.roughness = min( material.roughness, 1.0 );

#ifdef USE_SHEEN

material.sheenColor = sheen;
material.sheenTint = sheenTint;

#endif
`;
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ struct PhysicalMaterial {
float clearcoatRoughness;
#endif
#ifdef USE_SHEEN
vec3 sheenColor;
vec3 sheenTint;
#endif

};
Expand Down Expand Up @@ -157,7 +157,7 @@ void RE_Direct_Physical( const in IncidentLight directLight, const in GeometricC
material.roughness,
directLight.direction,
geometry,
material.sheenColor
material.sheenTint
);

#else
Expand Down
2 changes: 1 addition & 1 deletion src/renderers/shaders/ShaderLib.js
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ ShaderLib.physical = {
clearcoatRoughnessMap: { value: null },
clearcoatNormalScale: { value: new Vector2( 1, 1 ) },
clearcoatNormalMap: { value: null },
sheen: { value: new Color( 0x000000 ) },
sheenTint: { value: new Color( 0x000000 ) },
transmission: { value: 0 },
transmissionMap: { value: null },
transmissionSamplerSize: { value: new Vector2() },
Expand Down
2 changes: 1 addition & 1 deletion src/renderers/shaders/ShaderLib/meshphysical_frag.glsl.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ uniform float opacity;
#endif

#ifdef USE_SHEEN
uniform vec3 sheen;
uniform vec3 sheenTint;
#endif

varying vec3 vViewPosition;
Expand Down
2 changes: 1 addition & 1 deletion src/renderers/webgl/WebGLMaterials.js
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,7 @@ function WebGLMaterials( properties ) {
uniforms.clearcoat.value = material.clearcoat;
uniforms.clearcoatRoughness.value = material.clearcoatRoughness;

if ( material.sheen ) uniforms.sheen.value.copy( material.sheen );
if ( material.sheenTint ) uniforms.sheenTint.value.copy( material.sheenTint );

if ( material.clearcoatMap ) {

Expand Down
2 changes: 1 addition & 1 deletion src/renderers/webgl/WebGLProgram.js
Original file line number Diff line number Diff line change
Expand Up @@ -621,7 +621,7 @@ function WebGLProgram( renderer, cacheKey, parameters, bindingStates ) {
parameters.metalnessMap ? '#define USE_METALNESSMAP' : '',
parameters.alphaMap ? '#define USE_ALPHAMAP' : '',

parameters.sheen ? '#define USE_SHEEN' : '',
parameters.sheenTint ? '#define USE_SHEEN' : '',
parameters.transmission ? '#define USE_TRANSMISSION' : '',
parameters.transmissionMap ? '#define USE_TRANSMISSIONMAP' : '',
parameters.thicknessMap ? '#define USE_THICKNESSMAP' : '',
Expand Down
4 changes: 2 additions & 2 deletions src/renderers/webgl/WebGLPrograms.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ function WebGLPrograms( renderer, cubemaps, cubeuvmaps, extensions, capabilities
'numDirLightShadows', 'numPointLightShadows', 'numSpotLightShadows',
'shadowMapEnabled', 'shadowMapType', 'toneMapping', 'physicallyCorrectLights',
'alphaTest', 'doubleSided', 'flipSided', 'numClippingPlanes', 'numClipIntersection', 'depthPacking', 'dithering',
'sheen', 'transmission', 'transmissionMap', 'thicknessMap'
'sheenTint', 'transmission', 'transmissionMap', 'thicknessMap'
];

function getMaxBones( object ) {
Expand Down Expand Up @@ -204,7 +204,7 @@ function WebGLPrograms( renderer, cubemaps, cubeuvmaps, extensions, capabilities

gradientMap: !! material.gradientMap,

sheen: !! material.sheen,
sheenTint: ( !! material.sheenTint && ! material.sheenTint.isBlack() ),

transmission: material.transmission > 0,
transmissionMap: !! material.transmissionMap,
Expand Down