소스 검색

Minor improvements and deprecation warning for SplineCurve3 doc

looeee 8 년 전
부모
커밋
499d8aadb4
2개의 변경된 파일16개의 추가작업 그리고 15개의 파일을 삭제
  1. 8 10
      docs/api/extras/curves/SplineCurve.html
  2. 8 5
      docs/api/extras/curves/SplineCurve3.html

+ 8 - 10
docs/api/extras/curves/SplineCurve.html

@@ -12,8 +12,13 @@
 
 		<h1>[name]</h1>
 
-		<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>
+		<div class="desc">
+		Create a smooth 2d spline curve from a series of points. Internally this uses
+		[page:CurveUtils.interpolate] to create the curve.
+
+		Note that this will be deprecated. Please use a [page:CatmullRomCurve3] instead.
+
+		</div>
 
 		<h2>Example</h2>
 
@@ -47,14 +52,7 @@ var splineObject = new THREE.Line( geometry, material );
 		<div>See the base [page:Curve] class for common properties.</div>
 
 		<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>
+		<div>The array of [page:Vector3] points that define the curve.</div>
 
 
 

+ 8 - 5
docs/api/extras/curves/SplineCurve3.html

@@ -12,11 +12,14 @@
 
 		<h1>[name]</h1>
 
-		<div class="desc">Create a smooth 3d spline curve from a series of points</div>
+		<div class="desc">Create a smooth 3d spline curve from a series of points.. Internally this uses
+		[page:CurveUtils.interpolate] to create the curve.</div>
 
 		<h2>Example</h2>
 
-<code>
+		<div>[example:webgl_geometry_extrude_splines geometry / extrude / splines ] (choose PipeSpline)</div>
+
+		<code>
 //Create a closed bent a sine-like wave
 var curve = new THREE.SplineCurve3( [
 	new THREE.Vector3( -10, 0, 10 ),
@@ -31,11 +34,11 @@ geometry.vertices = curve.getPoints( 50 );
 
 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 );
-</code>
+	</code>
+
 
-		<h3>[example:webgl_geometry_extrude_splines geometry / extrude / splines ] (choose PipeSpline)</h3>
 
 
 		<h2>Constructor</h2>