File: HalfEdge.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 (81 lines) | stat: -rw-r--r-- 2,368 bytes parent folder | download | duplicates (4)
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
<!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">
			The basis for a half-edge data structure, also known as doubly connected edge list (DCEL).<br />
		</p>


		<h2>Constructor</h2>


		<h3>[name]( [param:VertexNode vertex], [param:Face face] )</h3>
		<p>
		[page:VertexNode vertex] - [page:VertexNode] A reference to its destination vertex.<br /><br />
		[page:Face face] - [page:Face] A reference to its face.<br />
		</p>

		<h2>Properties</h2>

		<h3>[property:VertexNode vertex]</h3>
		<p>
			Reference to the destination vertex. The origin vertex can be obtained by querying the destination of its twin, or of the previous half-edge. Default is undefined.
		</p>

		<h3>[property:HalfEdge prev]</h3>
		<p>
			Reference to the previous half-edge of the same face. Default is null.
		</p>

		<h3>[property:HalfEdge next]</h3>
		<p>
			Reference to the next half-edge of the same face. Default is null.
		</p>

		<h3>[property:HalfEdge twin]</h3>
		<p>
			Reference to the twin half-edge to reach the opposite face. Default is null.
		</p>

		<h3>[property:Face face]</h3>
		<p>
			 Each half-edge bounds a single face and thus has a reference to that face. Default is undefined.
		</p>

		<h2>Methods</h2>

		<h3>[method:VertexNode head]()</h3>
		<p>Returns the destintation vertex.</p>

		<h3>[method:VertexNode tail]()</h3>
		<p>Returns the origin vertex.</p>

		<h3>[method:Float length]()</h3>
		<p>Returns the [link:https://en.wikipedia.org/wiki/Euclidean_distance Euclidean length]
		(straight-line length) of the edge.</p>

		<h3>[method:Float lengthSquared]()</h3>
		<p>Returns the square of the [link:https://en.wikipedia.org/wiki/Euclidean_distance Euclidean length]
		(straight-line length) of the edge.</p>

		<h3>[method:HalfEdge setTwin]( [param:HalfEdge edge] )</h3>
		[page:HalfEdge edge] - Any half-edge.<br /><br />

		<p>Sets the twin edge of this half-edge. It also ensures that the twin reference of the given half-edge is correctly set.</p>

		<h2>Source</h2>

		<p>
			[link:https://github.com/mrdoob/three.js/blob/master/examples/js/math/ConvexHull.js examples/js/math/ConvexHull.js]
		</p>
	</body>
</html>