Browse Source

Minor improvements to SplineCurve doc

looeee 8 years ago
parent
commit
332600e22b
1 changed files with 17 additions and 4 deletions
  1. 17 4
      docs/api/extras/curves/SplineCurve.html

+ 17 - 4
docs/api/extras/curves/SplineCurve.html

@@ -12,7 +12,8 @@
 
 
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
-		<div class="desc">Create a smooth 2d spline curve from a series of points</div>
+		<div class="desc">Create a smooth 2d spline curve from a series of points. Internally this uses
+		[page:CurveUtils.interpolate] to create the curve.</div>
 
 
 		<h2>Example</h2>
 		<h2>Example</h2>
 
 
@@ -31,7 +32,7 @@ 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 } );
 
 
-// Create the final Object3d to add to the scene
+// Create the final object to add to the scene
 var splineObject = new THREE.Line( geometry, material );
 var splineObject = new THREE.Line( geometry, material );
 </code>
 </code>
 
 
@@ -39,16 +40,28 @@ var splineObject = new THREE.Line( geometry, material );
 
 
 
 
 		<h3>[name]( [page:Array points] )</h3>
 		<h3>[name]( [page:Array points] )</h3>
-		<div>points – An array of [page:Vector2] points</div>
+		<div>points – An array of [page:Vector2] points that define the curve.</div>
 
 
 
 
 		<h2>Properties</h2>
 		<h2>Properties</h2>
+		<div>See the base [page:Curve] class for common properties.</div>
 
 
 		<h3>[property:Array points]</h3>
 		<h3>[property:Array points]</h3>
+		<div>The array of [page:Vector2] points that define the curve.</div>
+
+		<h3>[property:Boolean isSplineCurve]</h3>
+		<div>
+			Used to check whether this or derived classes are SplineCurves. Default is *true*.<br /><br />
+
+			You should not change this, as it used internally for optimisation.
+		</div>
+
+
 
 
 		<h2>Methods</h2>
 		<h2>Methods</h2>
+		<div>See the base [page:Curve] class for common methods.</div>
+
 
 
-		<h3>See [page:Curve] for inherited methods</h3>
 
 
 		<h2>Source</h2>
 		<h2>Source</h2>