Home Explore Help
Sign In
javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git
2
0
Fork 0
Files Issues 0 Wiki
Browse Source

Documentation: add CatmullRomCurve3 page

Joshua Koo 9 years ago
parent
9eaf8ff368
commit
bb4c213d83
2 changed files with 61 additions and 0 deletions
Unified View Show Diff Stats
  1. 60 0
      docs/api/extras/curves/CatmullRomCurve3.html
  2. 1 0
      docs/list.js

+ 60 - 0
docs/api/extras/curves/CatmullRomCurve3.html
View File 

@@ -0,0 +1,60 @@
 
+<!DOCTYPE html>
 
+<html lang="en">
 
+	<head>
 
+		<meta charset="utf-8" />
 
+		<base href="../../../" />
 
+		<script src="list.js"></script>
 
+		<script src="page.js"></script>
 
+		<link type="text/css" rel="stylesheet" href="page.css" />
 
+	</head>
 
+	<body>
 
+		[page:Curve] &rarr;
 
+
 
+		<h1>[name]</h1>
 
+
 
+		<div class="desc">Create a smooth 3d spline curve from a series of points using the Catmull-Rom algorithm</div>
 
+
 
+		<h2>Example</h2>
 
+
 
+<code>
 
+//Create a closed wavey loop
 
+var curve = new THREE.CatmullRomCurve3( [
 
+	new THREE.Vector3( -10, 0, 10 ),
 
+	new THREE.Vector3( -5, 5, 5 ),
 
+	new THREE.Vector3( 0, 0, 0 ),
 
+	new THREE.Vector3( 5, -5, 5 ),
 
+	new THREE.Vector3( 10, 0, 10 )
 
+] );
 
+
 
+var geometry = new THREE.Geometry();
 
+geometry.vertices = curve.getPoints( 50 );
 
+
 
+var material = new THREE.LineBasicMaterial( { color : 0xff0000 } );
 
+</code>
 
+
 
+		<h3>[example:webgl_geometry_extrude_splines geometry / extrude / splines]</h3>
 
+
 
+
 
+		<h2>Constructor</h2>
 
+
 
+
 
+		<h3>[name]( [page:Array points] )</h3>
 
+		<div>points – An array of [page:Vector3] points</div>
 
+
 
+		<h2>Properties</h2>
 
+
 
+		<h3>[property:Array points]</h3>
 
+		
+		<h3>[property:Boolean closed] – curve loops back onto itself when true. False by default.</h3>
 
+		
+		<h3>[property:String type] - possible values are `centripetal` (default), `chordal` and `catmullrom`
 
+			
+		<h3>[property:float tension] - when type is `catmullrom`, defines catmullrom's tension. Defaults to 0.5
 
+
 
+		<h2>Methods</h2>
 
+
 
+		<h3>See [page:Curve] for inherited methods</h3>
 
+
 
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 
+	</body>
 
+</html>

+ 1 - 0
docs/list.js
View File 

@@ -178,6 +178,7 @@ var list = {
 
 
 
 		"Extras / Curves": [
 
 		"Extras / Curves": [
 
 			[ "ArcCurve", "api/extras/curves/ArcCurve" ],
 
 			[ "ArcCurve", "api/extras/curves/ArcCurve" ],
 
+			[ "CatmullRomCurve3", "api/extras/curves/CatmullRomCurve3" ],
 
 			[ "ClosedSplineCurve3", "api/extras/curves/ClosedSplineCurve3" ],
 
 			[ "ClosedSplineCurve3", "api/extras/curves/ClosedSplineCurve3" ],
 
 			[ "CubicBezierCurve", "api/extras/curves/CubicBezierCurve" ],
 
 			[ "CubicBezierCurve", "api/extras/curves/CubicBezierCurve" ],
 
 			[ "CubicBezierCurve3", "api/extras/curves/CubicBezierCurve3" ],
 
 			[ "CubicBezierCurve3", "api/extras/curves/CubicBezierCurve3" ],