File: Face.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 (91 lines) | stat: -rw-r--r-- 2,381 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
82
83
84
85
86
87
88
89
90
91
<!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">
			Represents a section bounded by a specific amount of half-edges. The current implmentation assumes that a face always consist of three edges.
		</p>


		<h2>Constructor</h2>


		<h3>[name]()</h3>
		<p>
		</p>

		<h2>Properties</h2>

		<h3>[property:Vector3 normal]</h3>
		<p>
			The normal vector of the face. Default is a [page:Vector3] at (0, 0, 0).
		</p>

		<h3>[property:Vector3 midpoint]</h3>
		<p>
			The midpoint or centroid of the face. Default is a [page:Vector3] at (0, 0, 0).
		</p>

		<h3>[property:Float area]</h3>
		<p>
			The area of the face. Default is 0.
		</p>

		<h3>[property:Float constant]</h3>
		<p>
			Signed distance from face to the origin. Default is 0.
		</p>

		<h3>[property:VertexNode outside]</h3>
		<p>
			Reference to a vertex in a vertex list this face can see. Default is null.
		</p>

		<h3>[property:Integer mark]</h3>
		<p>
			Marks if a face is visible or deleted. Default is 'Visible'.
		</p>

		<h3>[property:HalfEdge edge]</h3>
		<p>
			Reference to the base edge of a face. To retrieve all edges, you can use the 'next' reference of the current edge. Default is null.
		</p>

		<h2>Methods</h2>

		<h3>[method:Face create]( [param:VertexNode a], [param:VertexNode b], [param:VertexNode c] )</h3>
		[page:VertexNode a] - First vertex of the face.<br /><br />
		[page:VertexNode b] - Second vertex of the face.<br /><br />
		[page:VertexNode c] - Third vertex of the face.<br /><br />

		<p>Creates a face.</p>

		<h3>[method:HalfEdge getEdge]( [param:Integer i] )</h3>
		[page:Integer i] - The index of the edge.<br /><br />

		<p>Returns an edge by the given index.</p>

		<h3>[method:Face compute] ()</h3>

		<p>Computes all properties of the face.</p>

		<h3>[method:Float distanceToPoint]( [param:Vector3 point] )</h3>
		[page:Vector3 point] - Any point in 3D space.<br /><br />

		<p>Returns the signed distance from a given point to the plane representation of this face.</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>