Przeglądaj źródła

Completed curve docs

Greg Tatum 10 lat temu
rodzic
commit
a7639c71f5

+ 34 - 15
docs/api/extras/curves/CubicBezierCurve.html

@@ -11,35 +11,54 @@
 		
 		
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
+		<div class="desc">
+			Create a smooth 2d <a href="http://en.wikipedia.org/wiki/B%C3%A9zier_curve#mediaviewer/File:Bezier_curve.svg" target="_blank">cubic bezier curve</a>.
+		</div>
 
 
 		<h2>Example</h2>
 		<h2>Example</h2>
 
 
-		<code>todo</code>
+<code>
+var curve = new THREE.CubicBezierCurve(
+	new THREE.Vector3(-10, 0, 0),
+	new THREE.Vector3(-5,  15, 0),
+	new THREE.Vector3( 20, 15, 0),
+	new THREE.Vector3( 10, 0, 0)
+);
 
 
-		<h2>Constructor</h2>
+var path = new THREE.Path( curve.getPoints(50) );
 
 
+var geometry = path.createPointsGeometry( 50 );
+var material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
 
 
-		<h3>todo</h3>
-		<div></div>
+//Create the final Object3d to add to the scene
+var curveObject = new THREE.Line( geometry, material );
+</code>
 
 
+		<h2>Constructor</h2>
 
 
-		<h2>Properties</h2>
 
 
-		<h3>todo</h3>
+		<h3>[name]([page:Vector2 v0], [page:Vector2 v1], [page:Vector2 v2], [page:Vector2 v3])</h3>
 		<div>
 		<div>
-		todo
-		</div> 
+			[page:Vector2 v0] – The starting point<br/>
+			[page:Vector2 v1] – The first control point<br/>
+			[page:Vector2 v2] – The second control point<br/>
+			[page:Vector2 v3] – The ending point<br/>
+		</div>
+
+		<h2>Properties</h2>
+		
+		<h3>.[page:Vector2 v0]</h3>
+		
+		<h3>.[page:Vector2 v1]</h3>
+		
+		<h3>.[page:Vector2 v2]</h3>
+		
+		<h3>.[page:Vector2 v3]</h3>
 
 
 
 
 		<h2>Methods</h2>
 		<h2>Methods</h2>
 		
 		
-
-		<h3>todo</h3>
-		<div>todo</div>
-		<div>
-		todo
-		</div>
+		<h3>See [page:Curve] for inherited methods</h3>
 		
 		
 		<h2>Source</h2>
 		<h2>Source</h2>
 
 

+ 35 - 16
docs/api/extras/curves/CubicBezierCurve3.html

@@ -11,36 +11,55 @@
 		
 		
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
+		<div class="desc">
+			Create a smooth 3d <a href="http://en.wikipedia.org/wiki/B%C3%A9zier_curve#mediaviewer/File:Bezier_curve.svg" target="_blank">cubic bezier curve</a>.
+		</div>
 
 
 		<h2>Example</h2>
 		<h2>Example</h2>
 
 
-		<code>todo</code>
+<code>
+var curve = new THREE.CubicBezierCurve3(
+	new THREE.Vector3(-10, 0, 0),
+	new THREE.Vector3(-5,  15, 0),
+	new THREE.Vector3( 20, 15, 0),
+	new THREE.Vector3( 10, 0, 0)
+);
 
 
-		<h2>Constructor</h2>
+var geometry = new THREE.Geometry();
+geometry.vertices = curve.getPoints(50);
 
 
+var material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
 
 
-		<h3>todo</h3>
-		<div></div>
+//Create the final Object3d to add to the scene
+var curveObject = new THREE.Line( geometry, material );
 
 
+</code>
 
 
-		<h2>Properties</h2>
+		<h2>Constructor</h2>
 
 
-		<h3>todo</h3>
-		<div>
-		todo
-		</div> 
 
 
+		<h3>[name]([page:Vector3 v0], [page:Vector3 v1], [page:Vector3 v2], [page:Vector3 v3])</h3>
+		<div>
+			[page:Vector3 v0] – The starting point<br/>
+			[page:Vector3 v1] – The first control point<br/>
+			[page:Vector3 v2] – The second control point<br/>
+			[page:Vector3 v3] – The ending point<br/>
+		</div>
 
 
-		<h2>Methods</h2>
+		<h2>Properties</h2>
+		
+		<h3>.[page:Vector3 v0]</h3>
+		
+		<h3>.[page:Vector3 v1]</h3>
+		
+		<h3>.[page:Vector3 v2]</h3>
+		
+		<h3>.[page:Vector3 v3]</h3>
 		
 		
 
 
-		<h3>todo</h3>
-		<div>todo</div>
-		<div>
-		todo
-		</div>
+		<h2>Methods</h2>
 		
 		
+		<h3>See [page:Curve] for inherited methods</h3>		
 		<h2>Source</h2>
 		<h2>Source</h2>
 
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

+ 32 - 14
docs/api/extras/curves/QuadraticBezierCurve.html

@@ -11,36 +11,54 @@
 		
 		
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
+		<div class="desc">
+			Create a smooth 2d <a href="http://en.wikipedia.org/wiki/B%C3%A9zier_curve#mediaviewer/File:B%C3%A9zier_2_big.gif" target="_blank">quadratic bezier curve</a>.
+		</div>
 
 
 		<h2>Example</h2>
 		<h2>Example</h2>
 
 
-		<code>todo</code>
+<code>
+var curve = new THREE.QuadraticBezierCurve(
+	new THREE.Vector3(-10, 0, 0),
+	new THREE.Vector3( 20, 15, 0),
+	new THREE.Vector3( 10, 0, 0)
+);
+
+var path = new THREE.Path( curve.getPoints(50) );
+
+var geometry = path.createPointsGeometry( 50 );
+var material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
+
+//Create the final Object3d to add to the scene
+var curveObject = new THREE.Line( geometry, material );
+</code>
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
 
 
-		<h3>todo</h3>
-		<div></div>
+		<h3>[name]([page:Vector2 v0], [page:Vector2 v1], [page:Vector2 v2])</h3>
+		<div>
+			[page:Vector2 v0] – The starting point<br/>
+			[page:Vector2 v1] – The middle control point<br/>
+			[page:Vector2 v2] – The ending point<br/>
+		</div>
 
 
 
 
 		<h2>Properties</h2>
 		<h2>Properties</h2>
 
 
-		<h3>todo</h3>
-		<div>
-		todo
-		</div> 
+		
+		<h3>.[page:Vector2 v0]</h3>
+		
+		<h3>.[page:Vector2 v1]</h3>
+		
+		<h3>.[page:Vector2 v2]</h3>
 
 
 
 
 		<h2>Methods</h2>
 		<h2>Methods</h2>
 		
 		
 
 
-		<h3>todo</h3>
-		<div>todo</div>
-		<div>
-		todo
-		</div>
-		
+		<h3>See [page:Curve] for inherited methods</h3>		
+
 		<h2>Source</h2>
 		<h2>Source</h2>
 
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

+ 32 - 14
docs/api/extras/curves/QuadraticBezierCurve3.html

@@ -11,35 +11,53 @@
 		
 		
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
+		<div class="desc">
+			Create a smooth 3d <a href="http://en.wikipedia.org/wiki/B%C3%A9zier_curve#mediaviewer/File:B%C3%A9zier_2_big.gif" target="_blank">quadratic bezier curve</a>.
+		</div>
 
 
 		<h2>Example</h2>
 		<h2>Example</h2>
 
 
-		<code>todo</code>
+<code>
+var curve = new THREE.QuadraticBezierCurve3(
+	new THREE.Vector3(-10, 0, 0),
+	new THREE.Vector3( 20, 15, 0),
+	new THREE.Vector3( 10, 0, 0)
+);
 
 
-		<h2>Constructor</h2>
+var geometry = new THREE.Geometry();
+geometry.vertices = curve.getPoints(50);
 
 
+var material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
 
 
-		<h3>todo</h3>
-		<div></div>
+//Create the final Object3d to add to the scene
+var curveObject = new THREE.Line( geometry, material );
+</code>
 
 
+		<h2>Constructor</h2>
 
 
-		<h2>Properties</h2>
 
 
-		<h3>todo</h3>
+		<h3>[name]([page:Vector3 v0], [page:Vector3 v1], [page:Vector3 v2])</h3>
 		<div>
 		<div>
-		todo
-		</div> 
+			[page:Vector3 v0] – The starting point<br/>
+			[page:Vector3 v1] – The middle control point<br/>
+			[page:Vector3 v2] – The ending point<br/>
+		</div>
+
+
+
+		<h2>Properties</h2>
+		
+		<h3>.[page:Vector3 v0]</h3>
+		
+		<h3>.[page:Vector3 v1]</h3>
+		
+		<h3>.[page:Vector3 v2]</h3>
 
 
 
 
 		<h2>Methods</h2>
 		<h2>Methods</h2>
 		
 		
 
 
-		<h3>todo</h3>
-		<div>todo</div>
-		<div>
-		todo
-		</div>
+		<h3>See [page:Curve] for inherited methods</h3>		
 		
 		
 		<h2>Source</h2>
 		<h2>Source</h2>
 
 

+ 2 - 1
docs/api/extras/curves/SplineCurve.html

@@ -30,7 +30,8 @@ var path = new THREE.Path( curve.getPoints(50) );
 var geometry = path.createPointsGeometry( 50 );
 var geometry = path.createPointsGeometry( 50 );
 var material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
 var material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
 
 
-var object3d = new THREE.Line( geometry, material );
+//Create the final Object3d to add to the scene
+var splineObject = new THREE.Line( geometry, material );
 </code>
 </code>
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>

+ 4 - 1
docs/api/extras/curves/SplineCurve3.html

@@ -29,6 +29,9 @@ var geometry = new THREE.Geometry();
 geometry.vertices = curve.getPoints(50);
 geometry.vertices = curve.getPoints(50);
 
 
 var material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
 var material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
+
+//Create the final Object3d to add to the scene
+var splineObject = new THREE.Line( geometry, material );
 </code>
 </code>
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
@@ -40,7 +43,7 @@ var material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
 
 
 		<h2>Properties</h2>
 		<h2>Properties</h2>
 
 
-		<h3>[property:Array points]</h3>
+		<h3>.[property:Array points]</h3>
 
 
 		<h2>Methods</h2>
 		<h2>Methods</h2>