File: Triangle.html

package info (click to toggle)
three.js 111%2Bdfsg1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 15,212 kB
  • sloc: javascript: 133,174; makefile: 24; sh: 1
file content (146 lines) | stat: -rw-r--r-- 4,691 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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<!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 geometric triangle as defined by three [page:Vector3 Vector3s] representing its
			three corners.
		</p>


		<h2>Constructor</h2>


		<h3>[name]( [param:Vector3 a], [param:Vector3 b], [param:Vector3 c] )</h3>
		<p>
		[page:Vector3 a] - the first corner of the triangle. Default is a [page:Vector3] at (0, 0, 0).<br />
		[page:Vector3 b] - the second corner of the triangle. Default is a [page:Vector3] at (0, 0, 0).<br />
		[page:Vector3 c] - the final corner of the triangle. Default is a [page:Vector3] at (0, 0, 0).<br /><br />

		Creates a new [name].
		</p>


		<h2>Properties</h2>

		<h3>[property:Vector3 a]</h3>
		<p>
			The first corner of the triangle. Default is a [page:Vector3] at (0, 0, 0).
		</p>

		<h3>[property:Vector3 b]</h3>
		<p>
			The second corner of the triangle. Default is a [page:Vector3] at (0, 0, 0).
		</p>

		<h3>[property:Vector3 c]</h3>
		<p>
		the final corner of the triangle. Default is a [page:Vector3] at (0, 0, 0)
		</p>

		<h2>Methods</h2>

		<h3>[method:Triangle clone]()</h3>
		<p>
			Returns a new triangle with the same [page:.a a], [page:.b b] and  [page:.c c] properties as this one.
		</p>

		<h3>[method:Vector3 closestPointToPoint]( [param:Vector3 point], [param:Vector3 target] )</h3>
		<p>
		[page:Vector3 point] - [page:Vector3] <br />
		[page:Vector3 target] — the result will be copied into this Vector3.<br /><br />

		Returns the closest point on the triangle to [page:Vector3 point].
		</p>

		<h3>[method:Boolean containsPoint]( [param:Vector3 point] )</h3>
		<p>
		[page:Vector3 point] - [page:Vector3] to check.<br /><br />

		Returns true if the passed point, when projected onto the plane of the triangle, lies within the triangle.
		</p>

		<h3>[method:Triangle copy]( [param:Triangle triangle] )</h3>
		<p>
			Copies the values of the passed triangles's [page:.a a], [page:.b b] and [page:.c c]
			properties to this triangle.
		</p>

		<h3>[method:Boolean equals]( [param:Triangle triangle] )</h3>
		<p>
		Returns true if the two triangles have identical [page:.a a], [page:.b b] and [page:.c c] properties.
		</p>

		<h3>[method:Float getArea]()</h3>
		<p>Return the area of the triangle.</p>

		<h3>[method:Vector3 getBarycoord]( [param:Vector3 point], [param:Vector3 target] )</h3>
		<p>
		[page:Vector3 point] - [page:Vector3] <br />
		[page:Vector3 target] — the result will be copied into this Vector3.<br /><br />

		Return a [link:https://en.wikipedia.org/wiki/Barycentric_coordinate_system barycentric coordinate]
		 from the given vector. <br/><br/>

		[link:http://commons.wikimedia.org/wiki/File:Barycentric_coordinates_1.png Picture of barycentric coordinates]
		</p>

		<h3>[method:Vector3 getMidpoint]( [param:Vector3 target] )</h3>
		<p>
		[page:Vector3 target] — the result will be copied into this Vector3.<br /><br />

		Calculate the midpoint of the triangle.
		</p>

		<h3>[method:Vector3 getNormal]( [param:Vector3 target] )</h3>
		<p>
		[page:Vector3 target] — the result will be copied into this Vector3.<br /><br />

		Calculate the [link:https://en.wikipedia.org/wiki/Normal_(geometry) normal vector] of the triangle.
		</p>

		<h3>[method:Plane getPlane]( [param:Plane target] )</h3>
		<p>
		[page:Plane target] — the result will be copied into this Plane.<br /><br />

		Calculate a [page:Plane plane] based on the triangle. .
		</p>

		<h3>[method:Boolean intersectsBox]( [param:Box3 box] )</h3>
		<p>
		[page:Box3 box] - Box to check for intersection against.<br /><br />

		Determines whether or not this triangle intersects [page:Box3 box].
		</p>

		<h3>[method:Triangle set]( [param:Vector3 a], [param:Vector3 b], [param:Vector3 c] ) [param:Triangle this]</h3>
		<p>
		Sets the triangle's [page:.a a], [page:.b b] and [page:.c c] properties to the passed [page:vector3 vector3s].<br>
		Please note that this method only copies the values from the given objects.
		</p>

		<h3>[method:Triangle setFromPointsAndIndices]( [param:Array points], [param:Integer i0], [param:Integer i1], [param:Integer i2] ) [param:Triangle this]</h3>
		<p>
		points - [page:Array] of [page:Vector3]s <br />
		i0 - [page:Integer] index <br />
		i1 - [page:Integer] index <br />
		i2 - [page:Integer] index<br /><br />

		Sets the triangle's vectors to the vectors in the array.
		</p>

		<h2>Source</h2>

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