MeshPhongMaterial.html 9.0 KB
Newer Older
1 2 3
<!DOCTYPE html>
<html lang="en">
	<head>
M
Mr.doob 已提交
4 5 6 7 8
		<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" />
9 10
	</head>
	<body>
C
cjshannon 已提交
11
		[page:Material] &rarr;
M
Mr.doob 已提交
12

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

E
Eric Haines 已提交
15
		<div class="desc">A material for shiny surfaces, evaluated per pixel.</div>
M
Mr.doob 已提交
16

M
Mr.doob 已提交
17
		<iframe src='scenes/material-browser.html#MeshPhongMaterial'></iframe>
M
Mr.doob 已提交
18

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

C
cjshannon 已提交
21

G
Greg Tatum 已提交
22
		<h3>[name]([page:Object parameters])</h3>
C
cjshannon 已提交
23
		<div>
G
Greg Tatum 已提交
24
		parameters -- an object with one or more of the material's properties defining the its appearance.
C
cjshannon 已提交
25 26
		</div>
		<div>
27
		color — geometry color in hexadecimal. Default is 0xffffff.<br />
28
		map — Set texture map. Default is null <br />
29
		lightMap — Set light map. Default is null.<br />
30
		aoMap — Set ao map. Default is null.<br />
31
		emissiveMap — Set emissive map. Default is null.<br />
32 33 34 35 36 37 38 39 40 41 42 43 44 45
		specularMap — Set specular map. Default is null.<br />
		alphaMap — Set alpha map. Default is null.<br />
		envMap — Set env map. Default is null.<br />
		fog — Define whether the material color is affected by global fog settings. Default is true.<br />
		shading — Define shading type. Default is THREE.SmoothShading.<br />
		wireframe — render geometry as wireframe. Default is false.<br />
		wireframeLinewidth — Line thickness. Default is 1.<br />
		wireframeLinecap — Define appearance of line ends. Default is 'round'.<br />
		wireframeLinejoin — Define appearance of line joints. Default is 'round'.<br />
		vertexColors — Define how the vertices gets colored. Default is THREE.NoColors.<br />
		skinning — Define whether the material uses skinning. Default is false.<br />
		morphTargets — Define whether the material uses morphTargets. Default is false.
		</div>
		<div>
P
PaulJacobs 已提交
46
		Example:<br>
G
Greg Tatum 已提交
47
		materials.push( new THREE.MeshPhongMaterial( { color: 0xdddddd, specular: 0x009900, shininess: 30, shading: THREE.FlatShading } ) );
P
PaulJacobs 已提交
48
	
C
cjshannon 已提交
49
		</div>
M
Mr.doob 已提交
50 51


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

55
		<h3>[property:Color color]</h3>
E
Eric Haines 已提交
56 57 58 59
		<div>
		Diffuse color of the material. Default is white.<br />
		</div>

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

65
		<h3>[property:Color specular]</h3>
E
Eric Haines 已提交
66 67 68
		<div>
		Specular color of the material, i.e., how shiny the material is and the color of its shine. Setting this the same color as the diffuse value (times some intensity) makes the material more metallic-looking; setting this to some gray makes the material look more plastic. Default is dark gray.<br />
		</div>
M
Mr.doob 已提交
69

70
		<h3>[property:Float shininess]</h3>
G
Greg Tatum 已提交
71
		<div>How shiny the specular highlight is; a higher value gives a sharper highlight. Default is *30*. It should not be set to 0.</div>
E
Eric Haines 已提交
72

73 74 75 76 77 78
		<h3>[property:boolean metal]</h3>
		<div>
			If set to true the shader multiplies the specular highlight by the underlying color of the object, making
			it appear to be more metal-like and darker. If set to false the specular highlight is added ontop of the
			underlying colors.
		</div> 
E
Eric Haines 已提交
79

80
		<h3>[property:Texture map]</h3>
81
		<div>Set color texture map. Default is null. The texture map color is modulated by the diffuse color.</div>
E
Eric Haines 已提交
82

83
		<h3>[property:Texture lightMap]</h3>
84
		<div>Set light map. Default is null. The lightMap requires a second set of UVs.</div>
E
Eric Haines 已提交
85

86
		<h3>[property:Texture aoMap]</h3>
87 88 89 90
		<div>Set ambient occlusion map. Default is null. The aoMap requires a second set of UVs.</div>

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

92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
		<h3>[property:Texture bumpMap]</h3>
		<div>
			The texture to create a bump map. The black and white values map to the perceived depth in relation to the lights.
			Bump doesn't actually affect the geometry of the object, only the lighting. If a normal map is defined this will
			be ignored.
		</div>
		
		<h3>[property:Float bumpScale]</h3>
		<div>
			How much the bump map affects the material. Typical ranges are 0-1. Default is 1.
		</div>

		<h3>[property:Texture normalMap]</h3>
		<div>
			The texture to create a normal map. The RGB values affect the surface normal for each pixel fragment and change
			the way the color is lit. Normal maps do not change the actual shape of the surface, only the lighting.
		</div>
		
		<h3>[property:Vector2 normalScale]</h3>
		<div>
			How much the normal map affects the material. Typical ranges are 0-1. Default is (1,1).
		</div> 

115
		<h3>[property:Texture specularMap]</h3>
E
Eric Haines 已提交
116 117
		<div>The specular map value affects both how much the specular surface highlight contributes and how much of the environment map affects the surface. Default is null.</div>

118
		<h3>[property:Texture alphaMap]</h3>
119 120 121
		<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>

122
		<h3>[property:TextureCube envMap]</h3>
E
Eric Haines 已提交
123
		<div>Set env map. Default is null.</div>
124 125 126 127 128 129
		
		<h3>[property:Integer combine]</h3>
		<div>How to combine the result of the surface's color with the environment map, if any.</div> 
		 
		<div>Options are [page:Textures THREE.MultiplyOperation] (default), [page:Textures THREE.MixOperation], [page:Textures THREE.AddOperation]. If mix is chosen, the reflectivity is used to blend between the two colors.</div>
		 
130
		<h3>[property:Float reflectivity]</h3>
E
Eric Haines 已提交
131 132
		<div>How much the environment map affects the surface; also see "combine".</div> 

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

136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
		<h3>[property:Boolean fog]</h3>
		<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>

		<h3>[property:Integer shading]</h3>
		<div>How the triangles of a curved surface are rendered: as a smooth surface, as flat separate facets, or no shading at all.</div>

		<div>Options are [page:Materials THREE.SmoothShading] (default), [page:Materials THREE.FlatShading], [page:Materials THREE.NoShading].</div>
		
		<h3>[property:Boolean wireframe]</h3>
		<div>Whether the triangles' edges are displayed instead of surfaces. Default is *false*.</div>
		
		<h3>[property:Float wireframeLinewidth]</h3>
		<div>Line thickness for wireframe mode. Default is *1.0*.</div>
		<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>

		<h3>[property:String wireframeLinecap]</h3>
		<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>

		<h3>[property:String wireframeLinejoin]</h3>
		<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>

		<h3>[property:Integer vertexColors]</h3>
		<div>Define how the vertices gets colored. Possible values are THREE.NoColors, THREE.FaceColors and THREE.VertexColors. Default is THREE.NoColors.</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>

164
		<h3>[property:Boolean skinning]</h3>
E
Eric Haines 已提交
165 166
		<div>Define whether the material uses skinning. Default is *false*.</div>
	
167
		<h3>[property:Boolean morphTargets]</h3>
E
Eric Haines 已提交
168 169
		<div>Define whether the material uses morphTargets. Default is *false*.</div>	

G
Greg Tatum 已提交
170
		<h3>[property:boolean morphNormals]</h3>
C
cjshannon 已提交
171
		<div>
G
Greg Tatum 已提交
172 173 174
			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 已提交
175

E
Eric Haines 已提交
176
		<h2>Methods</h2>
M
Mr.doob 已提交
177

178
		<h2>Source</h2>
M
Mr.doob 已提交
179

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