gitadmin
/
three.js
mirror of https://github.com/mrdoob/three.js.git


			
				
					
						
						
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
							<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<base href="../../../../" />
		<script src="page.js"></script>
		<link type="text/css" rel="stylesheet" href="page.css" />
	</head>
	<body>
		[page:Curve] &rarr;

		<h1>[name]</h1>

		<p class="desc">
			An abstract base class extending [page:Curve]. A CurvePath is simply an
			array of connected curves, but retains the api of a curve.
		</p>

		<h2>Constructor</h2>

		<h3>[name]()</h3>
		<p>The constructor take no parameters.</p>

		<h2>Properties</h2>
		<p>See the base [page:Curve] class for common properties.</p>

		<h3>[property:Array curves]</h3>
		<p>The array of [page:Curve Curves].</p>

		<h3>[property:Boolean autoClose]</h3>
		<p>Whether or not to automatically close the path.</p>

		<h2>Methods</h2>
		<p>See the base [page:Curve] class for common methods.</p>

		<h3>[method:undefined add]( [param:Curve curve] )</h3>
		<p>Add a curve to the [page:.curves] array.</p>

		<h3>[method:this closePath]()</h3>
		<p>Adds a [page:LineCurve lineCurve] to close the path.</p>

		<h3>[method:Array getCurveLengths]()</h3>
		<p>
			Get list of cumulative curve lengths of the curves in the [page:.curves]
			array.
		</p>

		<h3>[method:Array getPoints]( [param:Integer divisions] )</h3>
		<p>
			divisions -- number of pieces to divide the curve into. Default is
			`12`.<br /><br />

			Returns an array of points representing a sequence of curves. The
			`division` parameter defines the number of pieces each curve is divided
			into. However, for optimization and quality purposes, the actual sampling
			resolution for each curve depends on its type. For example, for a
			[page:LineCurve], the returned number of points is always just 2.
		</p>

		<h3>[method:Array getSpacedPoints]( [param:Integer divisions] )</h3>
		<p>
			divisions -- number of pieces to divide the curve into. Default is
			`40`.<br /><br />

			Returns a set of divisions + 1 equi-spaced points using getPointAt( u ).
		</p>

		<h2>Source</h2>

		<p>
			[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
		</p>
	</body>
</html>