Document Material, and remove doubleSided and flipSided properties from...

Document Material, and remove doubleSided and flipSided properties from Object3D docs, to reflect changes in commit b838b38f

Document Material, and remove doubleSided and flipSided properties from...
Document Material, and remove doubleSided and flipSided properties from Object3D docs, to reflect changes in commit b838b38f
d1771bb2 · sole · 60eb97d1 · d1771bb2 · d1771bb2
隐藏空白更改
内联并排

Showing with 101 addition and 16 deletion

docs/api/core/Object3D.html docs/api/core/Object3D.html +0 -10

docs/api/materials/Material.html docs/api/materials/Material.html +101 -6

未找到文件。
--- a/docs/api/core/Object3D.html
+++ b/docs/api/core/Object3D.html
@@ -102,16 +102,6 @@
 		Object gets rendered if *true*.
 		</div>

-		<h3>.[page:Boolean doubleSided]</h3>
-		<div>
-		Both sides of faces visible if *true*.
-		</div>
-
-		<h3>.[page:Boolean flipSided]</h3>
-		<div>
-		Backside of face visible if *true*.
-		</div>
-
 		<h3>.[page:Boolean castShadow]</h3>
 		<div>
 		Gets rendered into shadow map.

--- a/docs/api/materials/Material.html
+++ b/docs/api/materials/Material.html
@@ -9,26 +9,121 @@
 	<body>
 		<h1>[name]</h1>

-		<div class="desc">todo</div>
+		<div class="desc">Materials describe the appearance of [page:Object objects]. They are defined in a (mostly) renderer-independent way, so you don't have to rewrite materials if you decide to use a different renderer.</div>


 		<h2>Constructor</h2>

-		<h3>[name]()</h3>
+		<h3>[name]( [page:Object parameters] )</h3>


 		<h2>Properties</h2>

-		<h3>.[page:Vector3 todo]</h3>
+		<h3>.[page:Integer id]</h3>
+		<div>
+		Unique number of this material instance.
+		</div>
+		
+		<h3>.[page:String name]</h3>
+		<div>
+		Material name. Default is an empty string.
+		</div>
+		
+		<h3>.[page:Number opacity]</h3>
+		<div>
+		Opacity. Default is *1*.
+		</div>
+
+		<h3>.[page:Boolean transparent]</h3>
+		<div>
+		Defines whether this material is transparent. This has an effect on rendering, as transparent objects need an special treatment, and are rendered after the opaque (i.e. non transparent) objects. For a working example of this behaviour, check the [page:WebGLRenderer WebGLRenderer] code.
+		</div>
+		<div>Default is *false*.</div>
+
+		<h3>.[page:Blending blending]</h3>
+		<div>
+		Which blending to use when displaying objects with this material. Default is [page:NormalBlending].
+		</div>
+
+		<h3>.[page:Integer blendSrc]</h3>
+		<div>
+		Blending source. It's one of the blending mode constants defined in [page:Three Three.js]. Default is *SrcAlphaFactor*.
+		</div>
+		
+		<h3>.[page:Integer blendDst]</h3>
+		<div>
+		Blending destination. It's one of the blending mode constants defined in [page:Three Three.js]. Default is *OneMinusSrcAlphaFactor*.
+		</div>
+		
+		<h3>.[page:Integer blendEquation]</h3>
+		<div>
+		Blending equation to use when applying blending. It's one of the constants defined in [page:Three Three.js]. Default is *AddEquation*.
+		</div>

+		<h3>.[page:Boolean depthTest]</h3>
+		<div>
+		Whether to have depth test enabled when rendering this material. Default is *true*.
+		</div>

-		<h2>Methods</h2>
+		<h3>.[page:Boolean depthWrite]</h3>
+		<div>
+		Whether rendering this material has any effect on the depth buffer. Default is *true*.
+		</div>
+		<div>
+		When drawing 2D overlays it can be useful to disable the depth writing in order to layer several things together without creating z-index artifacts.
+		</div>

-		<h3>.todo( [page:Vector3 todo] )</h3>
+		<h3>.[page:Boolean polygonOffset]</h3>
 		<div>
-		todo — todo<br />
+		Whether to use polygon offset. Default is *false*. This corresponds to the *POLYGON_OFFSET_FILL* WebGL feature.
 		</div>

+		<h3>.[page:Integer polygonOffsetFactor]</h3>
+		<div>
+		Sets the polygon offset factor. Default is *0*.
+		</div>
+		
+		<h3>.[page:Integer polygonOffsetUnits]</h3>
+		<div>
+		Sets the polygon offset units. Default is *0*.
+		</div>
+
+		<h3>.[page:Number alphaTest]</h3>
+		<div>
+		Sets the alpha value to be used when running an alpha test. Default is *0*.
+		</div>
+
+		<h3>.[page:Boolean overdraw]</h3>
+		<div>
+		Enables/disables overdraw. If enabled, polygons are drawn slightly bigger in order to fix antialiasing gaps when using the [page:CanvasRenderer]. Default is *false*.
+		</div>
+
+		<h3>.[page:Boolean visible]</h3>
+		<div>
+		Define whether this material is visible. Default is *true*.
+		</div>
+
+		<h3>.[page:Boolean doubleSided]</h3>
+		<div>
+		Defines whether this both sides of faces will be visible. Default is *false*.
+		</div>
+		
+		<div>
+		The normals in each face will be used in order to determine which side is visible; positive normals are the front face and thus visible, whereas negative normals correspond to the back faces and are normally not rendered, which can cause a 'disappearing' effect if an object is rotated and its backfaces are looking at the camera.
+		</div>
+
+		<h3>.[page:Boolean flipSided]</h3>
+		<div>
+		Defines if the object's faces are flipsided. If enabled, faces with negative normals will be visible (which is the opposite of the default behaviour). Default is *false*.
+		</div>
+
+		<h3>.[page:Boolean needsUpdate]</h3>
+		<div>
+		Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL.
+		</div>
+		<div>
+		This property is automatically set to *true* when instancing a new material.
+		</div>

 		<h2>Source</h2>