Browse Source

Added MultiMaterial doc

looeee 8 years ago
parent
commit
8fae0d8cf2
1 changed files with 24 additions and 7 deletions
  1. 24 7
      docs/api/materials/MultiMaterial.html

+ 24 - 7
docs/api/materials/MultiMaterial.html

@@ -13,7 +13,7 @@
 		<div class="desc">
 		A Material to define multiple materials for the same geometry.
 		The geometry decides which material is used for which faces by the [page:Face3 faces materialindex].
-		The materialindex corresponds with the index of the material in the materials array.
+		The material index corresponds with the index of the material in the [page:.materials] array.
 		</div>
 
 
@@ -22,26 +22,43 @@
 
 		<h3>[name]( [page:Array materials] )</h3>
 		<div>
-		materials -- The materials for the geometry.
-		</div>
-		<div>
-		Creates a MultiMaterial with the correct materials.
+		[page:Array materials] -- an array of [page:Material Materials] to be used in the MultiMaterial.<br /><br />
+
+		Creates a new [name].
 		</div>
 
 
 		<h2>Properties</h2>
 
+		<h3>[property:Boolean isMultiMaterial]</h3>
+		<div>
+			Used to check whether this or derived classes are multi materials. Default is *true*.<br /><br />
 
+			You should not change this, as it used internally for optimisation.
+		</div>
 
 		<h3>[property:Array materials]</h3>
+		<div>An array containing the materials being used by the MultiMaterial.</div>
+
+		<h3>[property:String uuid]</h3>
 		<div>
-		Get or set the materials for the geometry.
+		[link:http://en.wikipedia.org/wiki/Universally_unique_identifier UUID] of this material instance.
+		This gets automatically assigned, so this shouldn't be edited.
 		</div>
 
-		<h2>Methods</h2>
+		<h3>[property:Array visible]</h3>
+		<div>Whether or not [page:Mesh meshes] using this material should be rendered.</div>
 
+		<h2>Methods</h2>
 
+		<h3>[method:MultiMaterial clone]()</h3>
+		<div>Return a clone of this MultiMaterial.</div>
 
+		<h3>[method:null toJSON]( [page:object meta] )</h3>
+		<div>
+		meta -- object containing metadata such as textures or images for the material.<br />
+		Convert the material to Three JSON format.
+		</div>
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]