File: CatmullRomCurve3.html

package info (click to toggle)
three.js 111%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 15,184 kB
  • sloc: javascript: 133,174; makefile: 24; sh: 1
file content (83 lines) | stat: -rw-r--r-- 2,481 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<!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>

		<p class="desc">Create a smooth 3d spline curve from a series of points using the
			[link:https://en.wikipedia.org/wiki/Centripetal_Catmull-Rom_spline Catmull-Rom] algorithm.</p>

		<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 points = curve.getPoints( 50 );
var geometry = new THREE.BufferGeometry().setFromPoints( points );

var material = new THREE.LineBasicMaterial( { color : 0xff0000 } );

// Create the final object to add to the scene
var curveObject = new THREE.Line( geometry, material );
</code>

		<h3>[example:webgl_geometry_extrude_splines geometry / extrude / splines]</h3>


		<h2>Constructor</h2>

		<h3>[name]( [param:Array points], [param:Boolean closed], [param:String curveType], [param:Float tension] )</h3>
		<p>
			points – An array of [page:Vector3] points<br/>
			closed – Whether the curve is closed. Default is *false*.<br/>
			curveType – Type of the curve. Default is *centripetal*.<br/>
			tension – Tension of the curve. Default is *0.5*.
		</p>


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

		<h3>[property:Boolean isCatmullRomCurve3]</h3>
		<p>
			Used to check whether this or derived classes are CatmullRomCurve3s. Default is *true*.<br /><br />

			You should not change this, as it used internally for optimisation.
		</p>

		<h3>[property:Array points]</h3>
		<p>The array of [page:Vector3] points that define the curve. It needs at least two entries.</p>

		<h3>[property:Boolean closed]</h3>
		<p>The curve will loop back onto itself when this is true.</p>

		<h3>[property:String curveType]</h3>
		<p>Possible values are *centripetal*, *chordal* and *catmullrom*.</p>

		<h3>[property:float tension]</h3>
		<p>When [page:.type] is *catmullrom*, defines catmullrom's tension.</p>


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

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