MeshLambertMaterial.html 6.4 KB
Newer Older
1 2 3
<!DOCTYPE html>
<html lang="en">
	<head>
4
		<meta charset="utf-8" />
5 6 7 8 9
		<script src="../../list.js"></script>
		<script src="../../page.js"></script>
		<link type="text/css" rel="stylesheet" href="../../page.css" />
	</head>
	<body>
C
cjshannon 已提交
10
		[page:Material] &rarr;
M
Mr.doob 已提交
11

12
		<h1>[name]</h1>
M
Mr.doob 已提交
13

E
Eric Haines 已提交
14
		<div class="desc">A material for non-shiny (Lambertian) surfaces, evaluated per vertex.</div>
15 16
		
		<iframe src='../../scenes/material-browser.html#MeshLambertMaterial'></iframe>
M
Mr.doob 已提交
17

18
		<h2>Constructor</h2>
M
Mr.doob 已提交
19

C
cjshannon 已提交
20

G
Greg Tatum 已提交
21
		<h3>[name]([page:Object parameters])</h3>
C
cjshannon 已提交
22
		<div>
G
Greg Tatum 已提交
23
		parameters -- parameters is an object with one or more properties defining the material's appearance.
C
cjshannon 已提交
24
		</div>
M
Mr.doob 已提交
25 26


27
		<h2>Properties</h2>
28
		<div>See the base [page:Material] class for common parameters.</div>
M
Mr.doob 已提交
29

30
		<h3>[property:Color color]</h3>
E
Eric Haines 已提交
31 32 33
		<div>
		Diffuse color of the material. Default is white.<br />
		</div>
M
Mr.doob 已提交
34

35
		<h3>[property:Color ambient]</h3>
E
Eric Haines 已提交
36 37 38
		<div>
		Ambient color of the material, multiplied by the color of the [page:AmbientLight]. Default is white.<br />
		</div>
M
Mr.doob 已提交
39

40
		<h3>[property:Color emissive]</h3>
41
		<div>
E
Eric Haines 已提交
42
		Emissive (light) color of the material, essentially a solid color unaffected by other lighting. Default is black.<br />
43
		</div>
M
Mr.doob 已提交
44

45
		<h3>[property:Integer shading]</h3>
E
Eric Haines 已提交
46 47
		<div>How the triangles of a curved surface are rendered: as a smooth surface, as flat separate facets, or no shading at all.</div>

48
		<div>Options are [page:Materials THREE.SmoothShading] (default), [page:Materials THREE.FlatShading], [page:Materials THREE.NoShading].</div>
E
Eric Haines 已提交
49
		
50
		<h3>[property:Boolean wireframe]</h3>
E
Eric Haines 已提交
51 52
		<div>Whether the triangles' edges are displayed instead of surfaces. Default is *false*.</div>
		
53
		<h3>[property:Float wireframeLinewidth]</h3>
E
Eric Haines 已提交
54
		<div>Line thickness for wireframe mode. Default is *1.0*.</div>
55
		<div>Due to limitations in the <a href="https://code.google.com/p/angleproject/" target="_blank">ANGLE layer</a>, on Windows platforms linewidth will always be 1 regardless of the set value.</div>
E
Eric Haines 已提交
56

57
		<h3>[property:String wireframeLinecap]</h3>
E
Eric Haines 已提交
58 59 60
		<div>Define appearance of line ends. Possible values are "butt", "round" and "square". Default is 'round'.</div>
		<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:WebGLRenderer WebGL] renderer, but does work with the [page:CanvasRenderer Canvas] renderer.</div>

61
		<h3>[property:String wireframeLinejoin]</h3>
E
Eric Haines 已提交
62 63 64
		<div>Define appearance of line joints. Possible values are "round", "bevel" and "miter". Default is 'round'.</div>
		<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:WebGLRenderer WebGL] renderer, but does work with the [page:CanvasRenderer Canvas] renderer.</div>

65
		<h3>[property:Integer vertexColors]</h3>
66
		<div>Define how the vertices gets colored. Possible values are THREE.NoColors, THREE.FaceColors and THREE.VertexColors. Default is THREE.NoColors.</div>
E
Eric Haines 已提交
67 68
		<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:CanvasRenderer Canvas] renderer, but does work with the [page:WebGLRenderer WebGL] renderer.</div>

69
		<h3>[property:Boolean fog]</h3>
E
Eric Haines 已提交
70 71 72
		<div>Define whether the material color is affected by global fog settings. Default is *true*.</div>
		<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:CanvasRenderer Canvas] renderer, but does work with the [page:WebGLRenderer WebGL] renderer.</div>

73
		<h3>[property:Texture map]</h3>
E
Eric Haines 已提交
74 75
		<div>Set color texture map. Default is null.</div>

76
		<h3>[property:Texture lightMap]</h3>
E
Eric Haines 已提交
77 78
		<div>Set light map. Default is null.</div>

79
		<h3>[property:Texture specularMap]</h3>
E
Eric Haines 已提交
80 81
		<div>Since this material does not have a specular component, the specular value affects only how much of the environment map affects the surface. Default is null.</div>

82
		<h3>[property:Texture alphaMap]</h3>
83 84 85
		<div>The alpha map is a grayscale texture that controls the opacity across the surface (black: fully transparent; white: fully opaque). Default is null.</div>
		<div>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>

86
		<h3>[property:TextureCube envMap]</h3>
E
Eric Haines 已提交
87 88
		<div>Set env map. Default is null.</div>

89
		<h3>[property:Float reflectivity]</h3>
E
Eric Haines 已提交
90 91
		<div>How much the environment map affects the surface; also see "combine".</div> 

92
		<h3>[property:Float refractionRatio]</h3>
93
		<div>The index of refraction for an environment map using [page:Textures THREE.CubeRefractionMapping]. Default is *0.98*.</div>
E
Eric Haines 已提交
94

95
		<h3>[property:Integer combine]</h3>
E
Eric Haines 已提交
96 97
		<div>How to combine the result of the surface's color with the environment map, if any.</div> 
		 
98
		<div>Options are [page:Textures THREE.Multiply] (default), [page:Textures THREE.MixOperation], [page:Textures THREE.AddOperation]. If mix is chosen, the reflectivity is used to blend between the two colors.</div>
E
Eric Haines 已提交
99
		 
100
		<h3>[property:Boolean skinning]</h3>
E
Eric Haines 已提交
101 102
		<div>Define whether the material uses skinning. Default is *false*.</div>
	
103
		<h3>[property:Boolean morphTargets]</h3>
E
Eric Haines 已提交
104 105
		<div>Define whether the material uses morphTargets. Default is *false*.</div>	

G
Greg Tatum 已提交
106 107 108 109 110
		<h3>[property:boolean wrapAround]</h3>
		<div>
			Define whether the diffuse lighting wraps around the model or not. This option adds a little more (tintable) light
			onto the side of the object in relation to a light.
		</div>
E
Eric Haines 已提交
111

112
		<h3>[property:Vector3 wrapRGB]</h3>
C
cjshannon 已提交
113
		<div>
G
Greg Tatum 已提交
114 115 116 117
			Decide how much of the wrap around values get used if the wrapAround option is set. The x, y, z values correspond
			to the r, g, b values respectively. The typical range is of each is from 0 to 1. For example setting all of the
			vector values to 0.5 will add a moderate amount of light to the side of the model. Changing *b* to 1 will
			tint the light on the side to be more blue. Defaults to *(1,1,1)*.
C
cjshannon 已提交
118 119
		</div> 

120
		<h3>[property:boolean morphNormals]</h3>
C
cjshannon 已提交
121
		<div>
G
Greg Tatum 已提交
122 123 124
			Defines whether the material uses morphNormals. Set as true to pass morphNormal attributes from the [page:Geometry]
			to the shader. Default is *false*.
		</div>
C
cjshannon 已提交
125 126


E
Eric Haines 已提交
127
		<h2>Methods</h2>
M
Mr.doob 已提交
128

129
		<h2>Source</h2>
M
Mr.doob 已提交
130

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