File: Cylindrical.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 (75 lines) | stat: -rw-r--r-- 2,199 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
<!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>

		<p class="desc">
			A point's [link:https://en.wikipedia.org/wiki/Cylindrical_coordinate_system cylindrical coordinates].
		</p>


		<h2>Constructor</h2>

		<h3>[name]( [param:Float radius], [param:Float theta], [param:Float y] )</h3>
		<p>
		[page:Float radius] - distance from the origin to a point in the x-z plane.
		Default is *1.0*.<br />
		[page:Float theta] - counterclockwise angle in the x-z plane measured in radians
		from the positive z-axis. Default is *0*.<br />
		[page:Float y] - height above the x-z plane. Default is *0*.
		</p>


		<h2>Properties</h2>

		<h3>[property:Float radius]</h3>

		<h3>[property:Float theta]</h3>

		<h3>[property:Float y]</h3>


		<h2>Methods</h2>

		<h3>[method:Cylindrical clone]()</h3>
		<p>
		Returns a new cylindrical with the same [page:.radius radius], [page:.theta theta]
		and [page:.y y] properties as this one.
		</p>

		<h3>[method:Cylindrical copy]( [param:Cylindrical other] )</h3>
		<p>
			Copies the values of the passed Cylindrical's [page:.radius radius], [page:.theta theta]
			and [page:.y y] properties to this cylindrical.
		</p>

		<h3>[method:Cylindrical set]( [param:Float radius], [param:Float theta], [param:Float y] )</h3>
		<p>Sets values of this cylindrical's [page:.radius radius], [page:.theta theta]
		and [page:.y y] properties.</p>

		<h3>[method:Cylindrical setFromVector3]( [param:Vector3 vec3] )</h3>
		<p>
			Sets values of this cylindrical's [page:.radius radius], [page:.theta theta]
			and [page:.y y] properties from the [page:Vector3 Vector3].
		</p>

		<h3>[method:Cylindrical setFromCartesianCoords]( [param:Float x], [param:Float y], [param:Float z] )</h3>
		<p>
			Sets values of this cylindrical's [page:.radius radius], [page:.theta theta]
			and [page:.y y] properties from Cartesian coordinates.
		</p>

		<h2>Source</h2>

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