javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git


			
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
							<!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>
		<h1>[name]</h1>

		<div class="desc">
		An abstract base class for creating a [name] object that contains methods for interpolation.
		For an array of [name]s see [page:CurvePath].
		</div>

		<h2>Constructor</h2>


		<h3>[name]()</h3>
		<div>
		This constructor creates a new [name].
		</div>

		<h2>Properties</h2>

		<h3>[property:Integer arcLengthDivisions]</h3>
		<div>This value determines the amount of divisions when calculating the cumulative segment lengths of a curve via [page:.getLengths].
			To ensure precision when using methods like [page:.getSpacedPoints], it is recommended to increase [page:.arcLengthDivisions] if the curve is very large. Default is 200.</div>

		<h2>Methods</h2>

		<h3>[method:Vector getPoint]( [page:Float t] )</h3>
		<div>Returns a vector for point t of the curve where t is between 0 and 1. Must be implemented in the extending curve.</div>

		<h3>[method:Vector getPointAt]( [page:Float u] )</h3>
		<div>
			Returns a vector for point at a relative position in curve according to arc length.
			u is in the range [0, 1].
		</div>

		<h3>[method:Array getPoints]( [page:Integer divisions] )</h3>
		<div>
			divisions -- number of pieces to divide the curve into. Default is *5*.<br /><br />

			Returns a set of divisions + 1 points using getPoint( t ).
		</div>

		<h3>[method:Array getSpacedPoints]( [page:Integer divisions] )</h3>
		<div>
			divisions -- number of pieces to divide the curve into. Default is *5*.<br /><br />

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

		<h3>[method:Float getLength]()</h3>
		<div>Get total curve arc length.</div>

		<h3>[method:Array getLengths]( [page:Integer divisions] )</h3>
		<div>Get list of cumulative segment lengths.</div>

		<h3>[method:null updateArcLengths]()</h3>
		<div>Update the cumlative segment distance cache.</div>

		<h3>[method:Float getUtoTmapping]( [page:Float u], [page:Float distance] )</h3>
		<div>
			Given u in the range ( 0 .. 1 ), returns [page:Float t] also in the range ( 0 .. 1 ).
			u and t can then be used to give you points which are equidistant from the ends of the curve,
			using [page:.getPoint].
		 </div>

		<h3>[method:Vector getTangent]( [page:Float t] )</h3>
		<div>
			Returns a unit vector tangent at t. If the derived curve does not implement its
			tangent derivation, two points a small delta apart will be used to find its gradient
			which seems to give a reasonable approximation.
		</div>

		<h3>[method:Vector getTangentAt]( [page:Float u] )</h3>
		<div>
			Returns tangent at a point which is equidistant to the ends of the curve from the
			point given in [page:.getTangent].
		</div>

		<h3>[method:Object computeFrenetFrames]( [page:Integer segments], [page:Boolean closed] )</h3>
		<div>
		Generates the Frenet Frames. Used in geometries like [page:TubeGeometry] or [page:ExtrudeGeometry].
		</div>

		<h2>Source</h2>

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