MeshLambertMaterial.html

<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<base href="../../" />
		<script src="list.js"></script>
		<script src="page.js"></script>
		<link type="text/css" rel="stylesheet" href="page.css" />
	</head>
	<body>
		[page:Material] &rarr;

		<h1>[name]</h1>

		<div class="desc">
			A material for non-shiny surfaces, without specular highlights.<br /><br />

			The uses a non-physically based [link:https://en.wikipedia.org/wiki/Lambertian_reflectance Lambertian]
			model	for calculating reflectance. This can simulate some surfaces (such as untreated wood or stone) well,
			but cannot simulate shiny surfaces with specular highlights (such as varnished wood).<br /><br />


			Shading is calculated using a [link:https://en.wikipedia.org/wiki/Gouraud_shading Gouraud] shading model.
			This calculates shading per vertex (i.e. in the [link:https://en.wikipedia.org/wiki/Shader#Vertex_shaders vertex shader])
			and interpolates the results over the polygon's faces.<br /><br />

			Due to the simplicity of the reflectance and illumination models, performance will be greater
			when using this material over the [page:MeshPhongMaterial],	[page:MeshStandardMaterial] or [page:MeshPhysicalMaterial],
			at the cost of some graphical accuracy.
		</div>

		<iframe id="scene" src="scenes/material-browser.html#MeshLambertMaterial"></iframe>

		<script>

		// iOS iframe auto-resize workaround

		if ( /(iPad|iPhone|iPod)/g.test( navigator.userAgent ) ) {

			var scene = document.getElementById( 'scene' );

			scene.style.width = getComputedStyle( scene ).width;
			scene.style.height = getComputedStyle( scene ).height;
			scene.setAttribute( 'scrolling', 'no' );

		}

		</script>

		<h2>Constructor</h2>

		<h3>[name]( [page:Object parameters] )</h3>
		<div>
			[page:Object parameters] - (optional) an object with one or more properties defining the material's appearance.
			Any property of the material (including any property inherited from [page:Material]) can be passed in here.<br /><br />

			The exception is the property [page:Hexadecimal color], which can be passed in as a hexadecimal
			string and is *0xffffff* (white) by default. [page:Color.set]( color ) is called internally.
		</div>

		<h2>Properties</h2>
		<div>See the base [page:Material] class for common properties.</div>

		<h3>[property:Texture alphaMap]</h3>
		<div>The alpha map is a grayscale texture that controls the opacity across the surface
			(black: fully transparent; white: fully opaque). Default is null.<br /><br />

			Only the color of the texture is used, ignoring the alpha channel if one exists.
			For RGB and RGBA textures, the [page:WebGLRenderer WebGL] renderer will use the
			green channel when sampling this texture due to the extra bit of precision provided
			for green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
			luminance/alpha textures will also still work as expected.
		</div>

		<h3>[property:Texture aoMap]</h3>
		<div>The red channel of this texture is used as the ambient occlusion map. Default is null. 
		The aoMap requires a second set of UVs, and consequently will ignore the [page:Texture repeat]
		and [page:Texture offset] Texture properties.</div>

		<h3>[property:Float aoMapIntensity]</h3>
		<div>Intensity of the ambient occlusion effect. Default is 1. Zero is no occlusion effect.</div>

		<h3>[property:Color color]</h3>
		<div>[page:Color] of the material, by default set to white (0xffffff).</div>

		<h3>[property:Integer combine]</h3>
		<div>
			How to combine the result of the surface's color with the environment map, if any.<br /><br />

			Options are [page:Materials THREE.Multiply] (default), [page:Materials THREE.MixOperation],
			[page:Materials THREE.AddOperation]. If mix is chosen, the [page:.reflectivity] is used to
			blend between the two colors.
		</div>

		<h3>[property:Color emissive]</h3>
		<div>
		Emissive (light) color of the material, essentially a solid color unaffected by other lighting.
		Default is black.
		</div>

		<h3>[property:Texture emissiveMap]</h3>
		<div>
		Set emisssive (glow) map. Default is null. The emissive map color is modulated by
		the emissive color and the emissive intensity. If you have an emissive map, be sure to
		set the emissive color to something other than black.
		</div>

		<h3>[property:Float emissiveIntensity]</h3>
		<div>Intensity of the emissive light. Modulates the emissive color. Default is 1.</div>

		<h3>[property:TextureCube envMap]</h3>
		<div>The environment map. Default is null.</div>

		<h3>[property:Boolean isMeshLambertMaterial]</h3>
		<div>
			Used to check whether this or derived classes are mesh Lambert materials. Default is *true*.<br /><br />

			You should not change this, as it used internally for optimisation.
		</div>

		<h3>[property:Texture lightMap]</h3>
		<div>The light map. Default is null. The lightMap requires a second set of UVs, 
		and consequently will ignore the [page:Texture repeat] and [page:Texture offset] 
		Texture properties.</div>

		<h3>[property:Float lightMapIntensity]</h3>
		<div>Intensity of the baked light. Default is 1.</div>

		<h3>[property:Texture map]</h3>
		<div>The color map. Default is  null.</div>

		<h3>[property:boolean morphNormals]</h3>
		<div>
			Defines whether the material uses morphNormals. Set as true to pass morphNormal
			attributes from the [page:Geometry]	to the shader. Default is *false*.
		</div>

		<h3>[property:Boolean morphTargets]</h3>
		<div>Define whether the material uses morphTargets. Default is false.</div>

		<h3>[property:Float reflectivity]</h3>
		<div>How much the environment map affects the surface; also see [page:.combine].</div>

		<h3>[property:Float refractionRatio]</h3>
		<div>The index of refraction for an environment map using [page:Textures THREE.CubeRefractionMapping]. Default is *0.98*.</div>

		<h3>[property:Boolean skinning]</h3>
		<div>Define whether the material uses skinning. Default is false.</div>

		<h3>[property:Texture specularMap]</h3>
		<div>Specular map used by the material. Default is null.</div>

		<h3>[property:Boolean wireframe]</h3>
		<div>Render geometry as wireframe. Default is *false* (i.e. render as flat polygons).</div>

		<h3>[property:String wireframeLinecap]</h3>
		<div>
			Define appearance of line ends. Possible values are "butt", "round" and "square". Default is 'round'.<br /><br />

			This corresponds to the [link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap 2D Canvas lineCap]
			property and it is ignored by the [page:WebGLRenderer WebGL] renderer.
		</div>

		<h3>[property:String wireframeLinejoin]</h3>
		<div>
			Define appearance of line joints. Possible values are "round", "bevel" and "miter". Default is 'round'.<br /><br />

			This corresponds to the [link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineJoin 2D Canvas lineJoin]
			property and it is ignored by the [page:WebGLRenderer WebGL] renderer.
		</div>

		<h3>[property:Float wireframeLinewidth]</h3>
		<div>Controls wireframe thickness. Default is 1.<br /><br />

		Due to limitations in the [link:https://code.google.com/p/angleproject ANGLE layer],
		on Windows platforms linewidth will always be 1 regardless of the set value.
		</div>

		<h2>Methods</h2>
		<div>See the base [page:Material] class for common methods.</div>

		<h2>Source</h2>

		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
	</body>
</html>