cornerstone-math
Version:
Math and computation geometry functionality for cornerstone
762 lines (761 loc) • 25 kB
HTML
<html lang="en">
<head>
<title>Code coverage report for src\plane.js</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../prettify.css" />
<link rel="stylesheet" href="../base.css" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1>
<a href="../index.html">all files</a> / <a href="index.html">src/</a> plane.js
</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">10% </span>
<span class="quiet">Statements</span>
<span class='fraction'>7/70</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">0% </span>
<span class="quiet">Branches</span>
<span class='fraction'>0/26</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">9.52% </span>
<span class="quiet">Functions</span>
<span class='fraction'>2/21</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">10% </span>
<span class="quiet">Lines</span>
<span class='fraction'>7/70</span>
</div>
</div>
</div>
<div class='status-line low'></div>
<pre><table class="coverage">
<tr><td class="line-count quiet">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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233</td><td class="line-coverage quiet"><span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1×</span>
<span class="cline-any cline-yes">1×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span></td><td class="text"><pre class="prettyprint lang-js">import Vector3 from './vector3.js';
// Copied from Three.JS
/**
* @author bhouston / http://exocortex.com
*/
class Plane {
constructor (normal, constant) <span class="fstat-no" title="function not covered" >{</span>
<span class="cstat-no" title="statement not covered" > this.normal = (normal !== undefined) ? normal : new Vector3(1, 0, 0);</span>
<span class="cstat-no" title="statement not covered" > this.constant = (constant !== undefined) ? constant : 0;</span>
}
set (normal, constant) <span class="fstat-no" title="function not covered" >{</span>
<span class="cstat-no" title="statement not covered" > this.normal.copy(normal);</span>
<span class="cstat-no" title="statement not covered" > this.constant = constant;</span>
<span class="cstat-no" title="statement not covered" > return this;</span>
}
setComponents (x, y, z, w) <span class="fstat-no" title="function not covered" >{</span>
<span class="cstat-no" title="statement not covered" > this.normal.set(x, y, z);</span>
<span class="cstat-no" title="statement not covered" > this.constant = w;</span>
<span class="cstat-no" title="statement not covered" > return this;</span>
}
setFromNormalAndCoplanarPoint (normal, point) <span class="fstat-no" title="function not covered" >{</span>
<span class="cstat-no" title="statement not covered" > this.normal.copy(normal);</span>
// Must be this.normal, not normal, as this.normal is normalized
<span class="cstat-no" title="statement not covered" > this.constant = -point.dot(this.normal);</span>
<span class="cstat-no" title="statement not covered" > return this;</span>
}
copy (plane) <span class="fstat-no" title="function not covered" >{</span>
<span class="cstat-no" title="statement not covered" > this.normal.copy(plane.normal);</span>
<span class="cstat-no" title="statement not covered" > this.constant = plane.constant;</span>
<span class="cstat-no" title="statement not covered" > return this;</span>
}
normalize () <span class="fstat-no" title="function not covered" >{</span>
// Note: will lead to a divide by zero if the plane is invalid.
const inverseNormalLength = <span class="cstat-no" title="statement not covered" >1.0 / this.normal.length();</span>
<span class="cstat-no" title="statement not covered" > this.normal.multiplyScalar(inverseNormalLength);</span>
<span class="cstat-no" title="statement not covered" > this.constant *= inverseNormalLength;</span>
<span class="cstat-no" title="statement not covered" > return this;</span>
}
negate () <span class="fstat-no" title="function not covered" >{</span>
<span class="cstat-no" title="statement not covered" > this.constant *= -1;</span>
<span class="cstat-no" title="statement not covered" > this.normal.negate();</span>
<span class="cstat-no" title="statement not covered" > return this;</span>
}
distanceToPoint (point) <span class="fstat-no" title="function not covered" >{</span>
<span class="cstat-no" title="statement not covered" > return this.normal.dot(point) + this.constant;</span>
}
distanceToSphere (sphere) <span class="fstat-no" title="function not covered" >{</span>
<span class="cstat-no" title="statement not covered" > return this.distanceToPoint(sphere.center) - sphere.radius;</span>
}
projectPoint (point, optionalTarget) <span class="fstat-no" title="function not covered" >{</span>
<span class="cstat-no" title="statement not covered" > return this.orthoPoint(point, optionalTarget).sub(point).negate();</span>
}
orthoPoint (point, optionalTarget) <span class="fstat-no" title="function not covered" >{</span>
const perpendicularMagnitude = <span class="cstat-no" title="statement not covered" >this.distanceToPoint(point);</span>
const result = <span class="cstat-no" title="statement not covered" >optionalTarget || new Vector3();</span>
<span class="cstat-no" title="statement not covered" > return result.copy(this.normal).multiplyScalar(perpendicularMagnitude);</span>
}
isIntersectionLine (line) <span class="fstat-no" title="function not covered" >{</span>
// Note: this tests if a line intersects the plane, not whether it (or its end-points) are coplanar with it.
const startSign = <span class="cstat-no" title="statement not covered" >this.distanceToPoint(line.start);</span>
const endSign = <span class="cstat-no" title="statement not covered" >this.distanceToPoint(line.end);</span>
<span class="cstat-no" title="statement not covered" > return (startSign < 0 && endSign > 0) || (endSign < 0 && startSign > 0);</span>
}
intersectPlane (targetPlane) <span class="fstat-no" title="function not covered" >{</span>
// Returns the intersection line between two planes
const direction = <span class="cstat-no" title="statement not covered" >this.normal.clone().cross(targetPlane.normal);</span>
const origin = <span class="cstat-no" title="statement not covered" >new Vector3();</span>
const intersectionData = <span class="cstat-no" title="statement not covered" >{</span>
origin,
direction
};
// If the planes are parallel, return an empty vector for the intersection line
<span class="cstat-no" title="statement not covered" > if (this.normal.clone().cross(targetPlane.normal).length < 1e-10) {</span>
<span class="cstat-no" title="statement not covered" > intersectionData.direction = new Vector3();</span>
<span class="cstat-no" title="statement not covered" > return intersectionData;</span>
}
const h1 = <span class="cstat-no" title="statement not covered" >this.constant;</span>
const h2 = <span class="cstat-no" title="statement not covered" >targetPlane.constant;</span>
const n1dotn2 = <span class="cstat-no" title="statement not covered" >this.normal.clone().dot(targetPlane.normal);</span>
const c1 = <span class="cstat-no" title="statement not covered" >-(h1 - h2 * n1dotn2) / (1 - n1dotn2 * n1dotn2);</span>
const c2 = <span class="cstat-no" title="statement not covered" >-(h2 - h1 * n1dotn2) / (1 - n1dotn2 * n1dotn2);</span>
<span class="cstat-no" title="statement not covered" > intersectionData.origin = this.normal.clone().multiplyScalar(c1).add(targetPlane.normal.clone().multiplyScalar(c2));</span>
<span class="cstat-no" title="statement not covered" > return intersectionData;</span>
}
coplanarPoint (optionalTarget) <span class="fstat-no" title="function not covered" >{</span>
const result = <span class="cstat-no" title="statement not covered" >optionalTarget || new Vector3();</span>
<span class="cstat-no" title="statement not covered" > return result.copy(this.normal).multiplyScalar(-this.constant);</span>
}
translate (offset) <span class="fstat-no" title="function not covered" >{</span>
<span class="cstat-no" title="statement not covered" > this.constant = this.constant - offset.dot(this.normal);</span>
<span class="cstat-no" title="statement not covered" > return this;</span>
}
equals (plane) <span class="fstat-no" title="function not covered" >{</span>
<span class="cstat-no" title="statement not covered" > return plane.normal.equals(this.normal) && (plane.constant === this.constant);</span>
}
clone () <span class="fstat-no" title="function not covered" >{</span>
<span class="cstat-no" title="statement not covered" > return new Plane().copy(this);</span>
}
}
Plane.prototype.setFromCoplanarPoints = (function () {
const v1 = new Vector3();
const v2 = new Vector3();
return function (a, b, c) <span class="fstat-no" title="function not covered" >{</span>
const normal = <span class="cstat-no" title="statement not covered" >v1.subVectors(c, b).cross(v2.subVectors(a, b)).normalize();</span>
// Q: should an error be thrown if normal is zero (e.g. degenerate plane)?
<span class="cstat-no" title="statement not covered" > this.setFromNormalAndCoplanarPoint(normal, a);</span>
<span class="cstat-no" title="statement not covered" > return this;</span>
};
})();
Plane.prototype.intersectLine = (function () {
const v1 = new Vector3();
return function (line, optionalTarget) <span class="fstat-no" title="function not covered" >{</span>
const result = <span class="cstat-no" title="statement not covered" >optionalTarget || new Vector3();</span>
const direction = <span class="cstat-no" title="statement not covered" >line.delta(v1);</span>
const denominator = <span class="cstat-no" title="statement not covered" >this.normal.dot(direction);</span>
<span class="cstat-no" title="statement not covered" > if (denominator === 0) {</span>
// Line is coplanar, return origin
<span class="cstat-no" title="statement not covered" > if (this.distanceToPoint(line.start) === 0) {</span>
<span class="cstat-no" title="statement not covered" > return result.copy(line.start);</span>
}
// Unsure if this is the correct method to handle this case.
<span class="cstat-no" title="statement not covered" > return undefined;</span>
}
const t = <span class="cstat-no" title="statement not covered" >-(line.start.dot(this.normal) + this.constant) / denominator;</span>
<span class="cstat-no" title="statement not covered" > if (t < 0 || t > 1) {</span>
<span class="cstat-no" title="statement not covered" > return undefined;</span>
}
<span class="cstat-no" title="statement not covered" > return result.copy(direction).multiplyScalar(t).add(line.start);</span>
};
})();
export default Plane;
</pre></td></tr>
</table></pre>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage
generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Jun 09 2022 09:24:32 GMT+0200 (Central European Summer Time)
</div>
</div>
<script src="../prettify.js"></script>
<script>
window.onload = function () {
if (typeof prettyPrint === 'function') {
prettyPrint();
}
};
</script>
<script src="../sorter.js"></script>
</body>
</html>