Skip to content

Commit 974e384

Browse files
committed
sorted and added missing parameters for material docs
1 parent 48c2a37 commit 974e384

File tree

9 files changed

+237
-192
lines changed

9 files changed

+237
-192
lines changed

docs/api/materials/MeshBasicMaterial.html

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,18 @@ <h3>[name]( [page:Object parameters] )</h3>
2424
<div>parameters is an object with one or more properties defining the material's appearance.</div>
2525
<div>
2626
color — geometry color in hexadecimal. Default is 0xffffff.<br />
27+
map — Sets the texture map. Default is null <br />
28+
lightMap — Set light map. Default is null.<br />
29+
specularMap — Set specular map. Default is null.<br />
30+
alphaMap — Set alpha map. Default is null.<br />
31+
envMap — Set env map. Default is null.<br />
32+
fog — Define whether the material color is affected by global fog settings. Default is true.<br />
33+
shading — Define shading type. Default is THREE.SmoothShading.<br />
2734
wireframe — render geometry as wireframe. Default is false.<br />
2835
wireframeLinewidth — Line thickness. Default is 1.<br />
2936
wireframeLinecap — Define appearance of line ends. Default is 'round'.<br />
3037
wireframeLinejoin — Define appearance of line joints. Default is 'round'.<br />
31-
shading — Define shading type. Default is THREE.SmoothShading.<br />
3238
vertexColors — Define how the vertices gets colored. Default is THREE.NoColors.<br />
33-
fog — Define whether the material color is affected by global fog settings. Default is true.<br />
34-
lightMap — Set light map. Default is null.<br />
35-
specularMap — Set specular map. Default is null.<br />
36-
alphaMap — Set alpha map. Default is null.<br />
37-
envMap — Set env map. Default is null.<br />
3839
skinning — Define whether the material uses skinning. Default is false.<br />
3940
morphTargets — Define whether the material uses morphTargets. Default is false.
4041
</div>
@@ -44,6 +45,26 @@ <h2>Properties</h2>
4445
<h3>[property:Integer color]</h3>
4546
<div>Sets the color of the geometry. Default is 0xffffff.</div>
4647

48+
<h3>[property:Texture lightMap]</h3>
49+
<div>Set light map. Default is null.</div>
50+
51+
<h3>[property:Texture specularMap]</h3>
52+
<div>Set specular map. Default is null.</div>
53+
54+
<h3>[property:Texture alphaMap]</h3>
55+
<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>
56+
<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>
57+
58+
<h3>[property:TextureCube envMap]</h3>
59+
<div>Set env map. Default is null.</div>
60+
61+
<h3>[property:Boolean fog]</h3>
62+
<div>Define whether the material color is affected by global fog settings.</div>
63+
<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>
64+
65+
<h3>[property:String shading]</h3>
66+
<div>Define shading type. Default is THREE.SmoothShading.</div>
67+
4768
<h3>[property:Boolean wireframe]</h3>
4869
<div>Render geometry as wireframe. Default is false (i.e. render as flat polygons).</div>
4970

@@ -59,30 +80,10 @@ <h3>[property:String wireframeLinejoin]</h3>
5980
<div>Define appearance of line joints. Possible values are "round", "bevel" and "miter". Default is 'round'.</div>
6081
<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>
6182

62-
<h3>[property:String shading]</h3>
63-
<div>Define shading type. Default is THREE.SmoothShading.</div>
64-
6583
<h3>[property:Integer vertexColors]</h3>
6684
<div>Define how the vertices gets colored. Possible values are THREE.NoColors, THREE.FaceColors and THREE.VertexColors. Default is THREE.NoColors.</div>
6785
<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>
6886

69-
<h3>[property:Boolean fog]</h3>
70-
<div>Define whether the material color is affected by global fog settings.</div>
71-
<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>
72-
73-
<h3>[property:Texture lightMap]</h3>
74-
<div>Set light map. Default is null.</div>
75-
76-
<h3>[property:Texture specularMap]</h3>
77-
<div>Set specular map. Default is null.</div>
78-
79-
<h3>[property:Texture alphaMap]</h3>
80-
<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>
81-
<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>
82-
83-
<h3>[property:TextureCube envMap]</h3>
84-
<div>Set env map. Default is null.</div>
85-
8687
<h3>[property:Boolean skinning]</h3>
8788
<div>Define whether the material uses skinning. Default is false.</div>
8889

docs/api/materials/MeshDepthMaterial.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ <h3>[name]([page:Object parameters])</h3>
2323
parameters is an object with one or more properties defining the material's appearance.
2424
</div>
2525
<div>
26+
morphTargets -- Define whether the material uses morphTargets. Default is false.<br/>
2627
wireframe -- Render geometry as wireframe. Default is false (i.e. render as smooth shaded).<br/>
2728
wireframeLinewidth -- Controls wireframe thickness. Default is 1.<br/>
2829
</div>
@@ -31,6 +32,9 @@ <h3>[name]([page:Object parameters])</h3>
3132
<h2>Properties</h2>
3233

3334

35+
<h3>[property:boolean morphTargets]</h3>
36+
<div>Define whether the material uses morphTargets. Default is false.</div>
37+
3438
<h3>[property:boolean wireframe]</h3>
3539
<div>Render geometry as wireframe. Default is false (i.e. render as smooth shaded).</div>
3640

docs/api/materials/MeshLambertMaterial.html

Lines changed: 62 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,23 @@ <h3>[name]([page:Object parameters])</h3>
2222
<div>
2323
parameters -- parameters is an object with one or more properties defining the material's appearance.
2424
</div>
25+
<div>
26+
color — Line color in hexadecimal. Default is 0xffffff.<br />
27+
map — Sets the texture map. Default is null <br />
28+
lightMap — Set light map. Default is null.<br />
29+
specularMap — Set specular map. Default is null.<br />
30+
alphaMap — Set alpha map. Default is null.<br />
31+
envMap — Set env map. Default is null.<br />
32+
fog — Define whether the material color is affected by global fog settings. Default is false.
33+
shading — How the triangles of a curved surface are rendered. Default is [page:Materials THREE.SmoothShading].<br/>
34+
wireframe — Render geometry as wireframe. Default is false (i.e. render as smooth shaded).<br/>
35+
wireframeLinewidth — Controls wireframe thickness. Default is 1.<br/>
36+
wireframeLinecap — Define appearance of line ends. Default is 'round'.<br />
37+
wireframeLinejoin — Define appearance of line joints. Default is 'round'.<br />
38+
vertexColors — Define how the vertices gets colored. Default is THREE.NoColors.<br />
39+
skinning — Define whether the material uses skinning. Default is false.<br />
40+
morphTargets — Define whether the material uses morphTargets. Default is false.<br/>
41+
</div>
2542

2643

2744
<h2>Properties</h2>
@@ -41,34 +58,20 @@ <h3>[property:Color emissive]</h3>
4158
<div>
4259
Emissive (light) color of the material, essentially a solid color unaffected by other lighting. Default is black.<br />
4360
</div>
44-
45-
<h3>[property:Integer shading]</h3>
46-
<div>How the triangles of a curved surface are rendered: as a smooth surface, as flat separate facets, or no shading at all.</div>
47-
48-
<div>Options are [page:Materials THREE.SmoothShading] (default), [page:Materials THREE.FlatShading], [page:Materials THREE.NoShading].</div>
49-
50-
<h3>[property:Boolean wireframe]</h3>
51-
<div>Whether the triangles' edges are displayed instead of surfaces. Default is *false*.</div>
5261

53-
<h3>[property:Float wireframeLinewidth]</h3>
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>
56-
57-
<h3>[property:String wireframeLinecap]</h3>
58-
<div>Define appearance of line ends. Possible values are "butt", "round" and "square". Default is 'round'.</div>
59-
<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>
60-
61-
<h3>[property:String wireframeLinejoin]</h3>
62-
<div>Define appearance of line joints. Possible values are "round", "bevel" and "miter". Default is 'round'.</div>
63-
<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>
64-
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>
67-
<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>
62+
<h3>[property:boolean wrapAround]</h3>
63+
<div>
64+
Define whether the diffuse lighting wraps around the model or not. This option adds a little more (tintable) light
65+
onto the side of the object in relation to a light.
66+
</div>
6867

69-
<h3>[property:Boolean fog]</h3>
70-
<div>Define whether the material color is affected by global fog settings. Default is *true*.</div>
71-
<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>
68+
<h3>[property:Vector3 wrapRGB]</h3>
69+
<div>
70+
Decide how much of the wrap around values get used if the wrapAround option is set. The x, y, z values correspond
71+
to the r, g, b values respectively. The typical range is of each is from 0 to 1. For example setting all of the
72+
vector values to 0.5 will add a moderate amount of light to the side of the model. Changing *b* to 1 will
73+
tint the light on the side to be more blue. Defaults to *(1,1,1)*.
74+
</div>
7275

7376
<h3>[property:Texture map]</h3>
7477
<div>Set color texture map. Default is null.</div>
@@ -86,37 +89,51 @@ <h3>[property:Texture alphaMap]</h3>
8689
<h3>[property:TextureCube envMap]</h3>
8790
<div>Set env map. Default is null.</div>
8891

92+
<h3>[property:Integer combine]</h3>
93+
<div>How to combine the result of the surface's color with the environment map, if any.</div>
94+
95+
<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>
96+
8997
<h3>[property:Float reflectivity]</h3>
9098
<div>How much the environment map affects the surface; also see "combine".</div>
9199

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

95-
<h3>[property:Integer combine]</h3>
96-
<div>How to combine the result of the surface's color with the environment map, if any.</div>
97-
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>
99-
103+
<h3>[property:Boolean fog]</h3>
104+
<div>Define whether the material color is affected by global fog settings. Default is *true*.</div>
105+
<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>
106+
107+
<h3>[property:Integer shading]</h3>
108+
<div>How the triangles of a curved surface are rendered: as a smooth surface, as flat separate facets, or no shading at all.</div>
109+
110+
<div>Options are [page:Materials THREE.SmoothShading] (default), [page:Materials THREE.FlatShading], [page:Materials THREE.NoShading].</div>
111+
112+
<h3>[property:Boolean wireframe]</h3>
113+
<div>Whether the triangles' edges are displayed instead of surfaces. Default is *false*.</div>
114+
115+
<h3>[property:Float wireframeLinewidth]</h3>
116+
<div>Line thickness for wireframe mode. Default is *1.0*.</div>
117+
<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>
118+
119+
<h3>[property:String wireframeLinecap]</h3>
120+
<div>Define appearance of line ends. Possible values are "butt", "round" and "square". Default is 'round'.</div>
121+
<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>
122+
123+
<h3>[property:String wireframeLinejoin]</h3>
124+
<div>Define appearance of line joints. Possible values are "round", "bevel" and "miter". Default is 'round'.</div>
125+
<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>
126+
127+
<h3>[property:Integer vertexColors]</h3>
128+
<div>Define how the vertices gets colored. Possible values are THREE.NoColors, THREE.FaceColors and THREE.VertexColors. Default is THREE.NoColors.</div>
129+
<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>
130+
100131
<h3>[property:Boolean skinning]</h3>
101132
<div>Define whether the material uses skinning. Default is *false*.</div>
102133

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

106-
<h3>[property:boolean wrapAround]</h3>
107-
<div>
108-
Define whether the diffuse lighting wraps around the model or not. This option adds a little more (tintable) light
109-
onto the side of the object in relation to a light.
110-
</div>
111-
112-
<h3>[property:Vector3 wrapRGB]</h3>
113-
<div>
114-
Decide how much of the wrap around values get used if the wrapAround option is set. The x, y, z values correspond
115-
to the r, g, b values respectively. The typical range is of each is from 0 to 1. For example setting all of the
116-
vector values to 0.5 will add a moderate amount of light to the side of the model. Changing *b* to 1 will
117-
tint the light on the side to be more blue. Defaults to *(1,1,1)*.
118-
</div>
119-
120137
<h3>[property:boolean morphNormals]</h3>
121138
<div>
122139
Defines whether the material uses morphNormals. Set as true to pass morphNormal attributes from the [page:Geometry]

docs/api/materials/MeshNormalMaterial.html

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,21 @@ <h3>[name]([page:Object parameters])</h3>
2424
parameters is an object with one or more properties defining the material's appearance.
2525
</div>
2626
<div>
27-
morphTargets -- Define whether the material uses morphTargets. Default is false.<br/>
28-
shading -- How the triangles of a curved surface are rendered. Default is [page:Materials THREE.SmoothShading].<br/>
27+
shading -- How the triangles of a curved surface are rendered. Default is [page:Materials THREE.FlatShading].<br/>
2928
wireframe -- Render geometry as wireframe. Default is false (i.e. render as smooth shaded).<br/>
3029
wireframeLinewidth -- Controls wireframe thickness. Default is 1.<br/>
30+
morphTargets -- Define whether the material uses morphTargets. Default is false.<br/>
3131
</div>
3232

3333

3434
<h2>Properties</h2>
3535

3636

37-
38-
<h3>[property:boolean morphTargets]</h3>
39-
<div>Define whether the material uses morphTargets. Default is false.</div>
40-
4137
<h3>[property:number shading]</h3>
4238
<div>
4339
How the triangles of a curved surface are rendered: as a smooth surface, as flat separate facets, or no shading at all.<br/><br/>
44-
Options are [page:Materials THREE.SmoothShading] (default), [page:Materials THREE.FlatShading]
40+
Options are [page:Materials THREE.SmoothShading], [page:Materials THREE.FlatShading](default)
4541
</div>
46-
4742

4843
<h3>[property:boolean wireframe]</h3>
4944
<div>
@@ -56,6 +51,9 @@ <h3>[property:number wireframeLinewidth]</h3>
5651
Due to limitations in the ANGLE layer, on Windows platforms linewidth will always be 1 regardless of the set value.
5752
</div>
5853

54+
<h3>[property:boolean morphTargets]</h3>
55+
<div>Define whether the material uses morphTargets. Default is false.</div>
56+
5957
<h2>Methods</h2>
6058

6159

0 commit comments

Comments
 (0)