Browse Source

Merge remote-tracking branch 'remotes/mrdoob/dev' into unflip

alteredq 13 years ago
parent
commit
af44943ecc

+ 3 - 2
docs/api/core/Object3D.html

@@ -64,12 +64,12 @@
 		Up direction.
 		</div>
 
-		<h3>.[page:Vector3 matrix]</h3>
+		<h3>.[page:Matrix4 matrix]</h3>
 		<div>
 		Local transform.
 		</div>
 
-		<h3>.[page:Vector3 matrixRotationWorld]</h3>
+		<h3>.[page:Matrix4 matrixRotationWorld]</h3>
 		<div>
 		Global rotation.
 		</div>
@@ -85,6 +85,7 @@
 		</div>
 
 		<h3>.[page:Float boundRadius]</h3>
+		<div>Default is 0.0.</div>
 
 		<h3>.[page:Float boundRadiusScale]</h3>
 		<div>

+ 15 - 11
docs/api/extras/geometries/SphereGeometry.html

@@ -7,26 +7,30 @@
 		<link type="text/css" rel="stylesheet" href="../../../page.css" />
 	</head>
 	<body>
+		[page:Geometry] &rarr;
+		
 		<h1>[name]</h1>
 
-		<div class="desc">todo</div>
+		<div class="desc">A class for generating sphere geometries</div>
 
 
 		<h2>Constructor</h2>
 
-		<h3>[name]()</h3>
+		<h3>[name]( [page:Number radius], [page:Number segmentsWidth], [page:Number segmentsHeight], [page:Number phiStart], [page:Number phiLength], [page:Number thetaStart], [page:Number thetaLength] )</h3>
 
 
-		<h2>Properties</h2>
-
-		<h3>.[page:Vector3 todo]</h3>
-
-
-		<h2>Methods</h2>
-
-		<h3>.todo( [page:Vector3 todo] )</h3>
 		<div>
-		todo — todo<br />
+		radius — sphere radius. Default is 50.<br />
+		segmentsWidth — number of horizontal segments. Minimum value is 3, and the default is 8.<br />
+		segmentsHeight — number of vertical segments. Minimum value is 2, and the default is 6.<br />
+		phiStart — specify horizontal starting angle. Default is 0.<br />
+		phiLength — specify horizontal sweep angle size. Default is Math.PI * 2.<br />
+		thetaStart — specify vertical starting angle. Default is 0.<br />
+		thetaLength — specify vertical sweep angle size. Default is Math.PI.<br />
+		</div>
+		
+		<div>
+		The geometry is created by sweeping and calculating vertexes around the Y axis (horizontal sweep) and the Z axis (vertical sweep). Thus, incomplete spheres (akin to <em>'sphere slices'</em>) can be created through the use of different values of phiStart, phiLength, thetaStart and thetaLength, in order to define the points in which we start (or end) calculating those vertices.
 		</div>
 
 

+ 35 - 11
docs/api/materials/ParticleBasicMaterial.html

@@ -11,25 +11,49 @@
 
 		<h1>[name]</h1>
 
-		<div class="desc">todo</div>
+		<div class="desc">The default material used by [page:ParticleSystem particle] systems.</div>
 
 
 		<h2>Constructor</h2>
 
-		<h3>[name]()</h3>
+		<h3>[name]( [page:Object parameters] )</h3>
 
+		<div>parameters is an object with one or more properties defining the material's appearance.</div>
+		
+		<div>
+		color — Particle color in hexadecimal. Default is 0xffffff.<br />
+		map — a [page:Texture texture]. Default is null. // TODO: specify what is its purpose<br />
+		size — Define size of particles. Default is 1.0.<br />
+		sizeAttenuation — Enable/disable size attenuation with distance.<br />
+		vertexColors — Define whether the material uses vertex colors, or not. Default is false.<br />
+		fog — Define whether the material color is affected by global fog settings. Default is true.
+		</div>
 
 		<h2>Properties</h2>
 
-		<h3>.[page:Vector3 todo]</h3>
-
-
-		<h2>Methods</h2>
-
-		<h3>.todo( [page:Vector3 todo] )</h3>
-		<div>
-		todo — todo<br />
-		</div>
+		<h3>.[page:Number color]</h3>
+		
+		<div>Sets the color of the particles. Default is 0xffffff.</div>
+		
+		<h3>.[page:Texture map]</h3>
+		
+		<div>Sets the color of the particles using data from a texture (?).</div>
+		
+		<h3>.[page:Number size]</h3>
+		
+		<div>Sets the size of the particles. Default is 1.0.</div>
+
+		<h3>.[page:Boolean sizeAttenuation]</h3>
+		
+		<div>Specify whether particles' size will get smaller with the distance. Default is true.</div>
+
+		<h3>.[page:Boolean vertexColors]</h3>
+		<div>Define whether the material uses vertex colors, or not. Default is false.</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>.[page:Boolean fog]</h3>
+		<div>Define whether the material color is affected by global fog settings.</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>
 
 
 		<h2>Source</h2>

+ 13 - 8
docs/api/objects/ParticleSystem.html

@@ -11,26 +11,31 @@
 
 		<h1>[name]</h1>
 
-		<div class="desc">todo</div>
+		<div class="desc">A class for displaying particles in the form of variable size points. For example, if using the [page:WebGLRenderer], the particles are displayed using GL_POINTS.</div>
 
 
 		<h2>Constructor</h2>
 
-		<h3>[name]()</h3>
+		<h3>[name]( [page:Geometry geometry], [page:Material material] )</h3>
 
+		<div>
+		geometry — An instance of [page:Geometry].<br />
+		material — An instance of [page:Material] (optional).
+		</div>
 
 		<h2>Properties</h2>
 
-		<h3>.[page:Vector3 todo]</h3>
+		<h3>.[page:Geometry geometry]</h3>
 
+		<div>An instance of [page:Geometry], where each vertex designates the position of a particle in the system.</div>
 
-		<h2>Methods</h2>
+		<h3>.[page:Material material]</h3>
 
-		<h3>.todo( [page:Vector3 todo] )</h3>
-		<div>
-		todo — todo<br />
-		</div>
+		<div>An instance of [page:Material], defining the object's appearance. Default is a [page:ParticleBasicMaterial] with randomised colour.</div>
 
+		<h3>.[page:Boolean frustrumCulled]</h3>
+		
+		<div>Specifies whether the particle system will be culled if it's outside the camera's frustum. By default this is set to false.</div>
 
 		<h2>Source</h2>