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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
//! Port of `three.js/src/cameras/PerspectiveCamera.js` + `Camera.js`
//! (rung 1 subset).
use crate::core::{Node, Object3D};
use crate::math::math_utils::{js_max, js_min};
use crate::math::{CoordinateSystem, Matrix4, Vector2, Vector3, Vector4, DEG2RAD, RAD2DEG};
/// `Camera.view` — the frustum window specification set by
/// [`PerspectiveCamera::set_view_offset`] and
/// [`OrthographicCamera::set_view_offset`](super::OrthographicCamera::set_view_offset).
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct CameraView {
/// Whether the offset is applied; [`clear_view_offset`](super::PerspectiveCamera::clear_view_offset) clears this and leaves the rest.
pub enabled: bool,
/// The full width of the multiview setup.
pub full_width: f64,
/// The full height of the multiview setup.
pub full_height: f64,
/// The horizontal offset of this sub-camera within the full frame.
pub offset_x: f64,
/// The vertical offset of this sub-camera within the full frame.
pub offset_y: f64,
/// The width of this sub-camera's window.
pub width: f64,
/// The height of this sub-camera's window.
pub height: f64,
}
/// three.js' `PerspectiveCamera`: a camera whose projection matches how the
/// human eye and most cameras see, with distant objects appearing smaller.
#[derive(Clone)]
pub struct PerspectiveCamera {
/// The camera's own scene-graph node. `Camera` is an `Object3D` in three.js
/// and examples nest it (`scene.add( camera )`, `camera.add( light )`), so it
/// owns a [`Node`] rather than a bare `Object3D`.
pub node: Node,
/// The vertical field of view, from bottom to top of view, in degrees.
pub fov: f64,
/// The aspect ratio, usually the canvas width divided by its height.
pub aspect: f64,
/// The camera's near plane. Unlike [`OrthographicCamera`](super::OrthographicCamera)'s, `0.0` is not valid here.
pub near: f64,
/// The camera's far plane, greater than [`near`](Self::near).
pub far: f64,
/// The zoom factor of the camera.
pub zoom: f64,
/// Object distance used for stereoscopy and depth-of-field effects. Does not
/// influence the projection matrix.
pub focus: f64,
/// `Camera.view`, set by [`set_view_offset`](Self::set_view_offset).
pub view: Option<CameraView>,
/// Film size used for the larger axis, in millimetres. Only matters when
/// [`film_offset`](Self::film_offset) is nonzero.
pub film_gauge: f64,
/// Horizontal off-centre offset, in the same unit as [`film_gauge`](Self::film_gauge).
pub film_offset: f64,
/// The coordinate system [`update_projection_matrix`](Self::update_projection_matrix)
/// builds the projection for.
pub coordinate_system: CoordinateSystem,
/// `Camera.projectionMatrix`.
pub projection_matrix: Matrix4,
/// `Camera.projectionMatrixInverse`.
pub projection_matrix_inverse: Matrix4,
/// `Camera.matrixWorldInverse`.
pub matrix_world_inverse: Matrix4,
/// `camera.viewport` — not a `Camera` field in three.js until an
/// application sets one: an [`ArrayCamera`](super::ArrayCamera)'s
/// sub-camera's rectangle in CSS pixels, top-left origin, which the
/// backend turns into the draw's `setViewport()`.
pub viewport: Option<Vector4>,
}
impl PerspectiveCamera {
/// `new PerspectiveCamera( fov, aspect, near, far )`.
pub fn new(fov: f64, aspect: f64, near: f64, far: f64) -> Self {
// `Camera.isCamera` — `Object3D.lookAt()` branches on it.
let object = Object3D {
object_type: "PerspectiveCamera",
is_camera: true,
..Default::default()
};
let mut camera = Self {
node: object.into_node(),
fov,
aspect,
near,
far,
zoom: 1.0,
focus: 10.0,
view: None,
film_gauge: 35.0,
film_offset: 0.0,
// `WebGPURenderer` sets `camera.coordinateSystem` to `WebGPUCoordinateSystem`.
coordinate_system: CoordinateSystem::WebGpu,
projection_matrix: Matrix4::identity(),
projection_matrix_inverse: Matrix4::identity(),
matrix_world_inverse: Matrix4::identity(),
viewport: None,
};
camera.update_projection_matrix();
camera
}
/// `PerspectiveCamera.setFocalLength()`.
pub fn set_focal_length(&mut self, focal_length: f64) {
// see http://www.bobatkins.com/photography/technical/field_of_view.html
let v_extent_slope = 0.5 * self.get_film_height() / focal_length;
self.fov = RAD2DEG * 2.0 * v_extent_slope.atan();
self.update_projection_matrix();
}
/// `PerspectiveCamera.getFocalLength()`.
pub fn get_focal_length(&self) -> f64 {
let v_extent_slope = (DEG2RAD * 0.5 * self.fov).tan();
0.5 * self.get_film_height() / v_extent_slope
}
/// `PerspectiveCamera.getEffectiveFOV()`.
pub fn get_effective_fov(&self) -> f64 {
RAD2DEG * 2.0 * ((DEG2RAD * 0.5 * self.fov).tan() / self.zoom).atan()
}
/// `PerspectiveCamera.getFilmWidth()`.
pub fn get_film_width(&self) -> f64 {
// film not completely covered in portrait format (aspect < 1)
self.film_gauge * js_min(self.aspect, 1.0)
}
/// `PerspectiveCamera.getFilmHeight()`.
pub fn get_film_height(&self) -> f64 {
// film not completely covered in landscape format (aspect > 1)
self.film_gauge / js_max(self.aspect, 1.0)
}
/// `PerspectiveCamera.getViewBounds()`.
pub fn get_view_bounds(
&self,
distance: f64,
min_target: &mut Vector2,
max_target: &mut Vector2,
) {
let mut v3 = Vector3::new(-1.0, -1.0, 0.5);
v3.apply_matrix4(&self.projection_matrix_inverse);
min_target.set(v3.x, v3.y).multiply_scalar(-distance / v3.z);
let mut v3 = Vector3::new(1.0, 1.0, 0.5);
v3.apply_matrix4(&self.projection_matrix_inverse);
max_target.set(v3.x, v3.y).multiply_scalar(-distance / v3.z);
}
/// `PerspectiveCamera.getViewSize()`.
pub fn get_view_size(&self, distance: f64) -> Vector2 {
let mut min_target = Vector2::default();
let mut max_target = Vector2::default();
self.get_view_bounds(distance, &mut min_target, &mut max_target);
let mut target = Vector2::default();
target.sub_vectors(&max_target, &min_target);
target
}
/// `PerspectiveCamera.setViewOffset()`.
pub fn set_view_offset(
&mut self,
full_width: f64,
full_height: f64,
x: f64,
y: f64,
width: f64,
height: f64,
) {
self.aspect = full_width / full_height;
self.view = Some(CameraView {
enabled: true,
full_width,
full_height,
offset_x: x,
offset_y: y,
width,
height,
});
self.update_projection_matrix();
}
/// `PerspectiveCamera.clearViewOffset()`.
pub fn clear_view_offset(&mut self) {
if let Some(view) = self.view.as_mut() {
view.enabled = false;
}
self.update_projection_matrix();
}
/// `PerspectiveCamera.updateProjectionMatrix()`.
pub fn update_projection_matrix(&mut self) {
let near = self.near;
let mut top = near * (DEG2RAD * 0.5 * self.fov).tan() / self.zoom;
let mut height = 2.0 * top;
let mut width = self.aspect * height;
let mut left = -0.5 * width;
if let Some(view) = self.view {
if view.enabled {
let full_width = view.full_width;
let full_height = view.full_height;
left += view.offset_x * width / full_width;
top -= view.offset_y * height / full_height;
width *= view.width / full_width;
height *= view.height / full_height;
}
}
let skew = self.film_offset;
if skew != 0.0 {
left += near * skew / self.get_film_width();
}
self.projection_matrix.make_perspective(
left,
left + width,
top,
top - height,
near,
self.far,
self.coordinate_system,
);
self.projection_matrix_inverse = self.projection_matrix;
self.projection_matrix_inverse.invert();
}
/// Move the camera along the direction it already looks in, until `box_`
/// fills the frame with `margin` of it left as slack (`0.0` is tight, `0.1`
/// leaves 10 % of the half-frame free on the tightest side). Not a three.js
/// method — see issue #51.
///
/// The view *direction* is the camera's own, taken from `matrix_world`; only
/// the position moves, along that direction, and `near`/`far` are set to the
/// box's extent along it. `fov`, `aspect` and `zoom` are read, not written,
/// so the caller's framing choices survive the fit.
///
/// The distance is the one that actually frames the box: a bounding sphere
/// wastes the corners, and so does taking the eight corners' *lateral*
/// extent, because a corner nearer the camera needs more distance than a far
/// one at the same offset. For each corner this asks what distance `d` puts
/// it exactly on a frustum plane — `|x| / tan_h - depth` horizontally,
/// `|y| / tan_v - depth` vertically, with `depth` the corner's offset along
/// the view direction from the box centre — and takes the largest of the
/// sixteen answers.
///
/// A view offset ([`set_view_offset`](Self::set_view_offset)) is ignored;
/// the fit is to the full frustum.
pub fn fit(&mut self, box_: &crate::math::Box3, margin: f64) {
if box_.is_empty() {
return;
}
self.update_matrix_world();
let matrix_world = self.node.borrow().matrix_world;
let (right, up, forward) = super::view_basis(&matrix_world);
let offsets = super::corner_offsets(box_, &right, &up, &forward);
// The margin shrinks the half-angles, so the tightest corner lands at
// `1 - margin` in normalised device coordinates instead of at 1.
let slack = (1.0 - margin).clamp(f64::EPSILON, 1.0);
let tan_v = (DEG2RAD * 0.5 * self.fov).tan() / self.zoom * slack;
let tan_h = tan_v * self.aspect;
let mut distance = 0.0_f64;
let mut near_depth = f64::INFINITY;
let mut far_depth = f64::NEG_INFINITY;
for offset in &offsets {
distance = js_max(distance, offset.x.abs() / tan_h - offset.z);
distance = js_max(distance, offset.y.abs() / tan_v - offset.z);
near_depth = js_min(near_depth, offset.z);
far_depth = js_max(far_depth, offset.z);
}
// A box much deeper than it is wide can be framed from inside itself;
// hold it at the camera's current near plane instead.
let near_floor = js_max(self.near, f64::EPSILON);
distance = js_max(distance, near_floor - near_depth);
self.near = distance + near_depth;
self.far = distance + far_depth;
if self.far <= self.near {
// A box with no depth along the view direction.
self.far = self.near * 2.0;
}
self.update_projection_matrix();
// `position` is local; the direction and the centre are in world space.
let center = box_.get_center();
let mut position = Vector3::ZERO;
position
.copy(&forward)
.multiply_scalar(-distance)
.add(¢er);
if let Some(parent) = self.node.parent() {
parent.update_world_matrix(true, false);
let mut inverse = parent.borrow().matrix_world;
inverse.invert();
position.apply_matrix4(&inverse);
}
self.node.borrow_mut().position = position;
self.update_matrix_world();
}
/// `Object3D.lookAt()` for a camera: the matrix looks *from* the camera
/// position *at* the target.
pub fn look_at(&mut self, target: &Vector3) {
let mut object = self.node.borrow_mut();
let mut m = Matrix4::identity();
m.look_at(&object.position, target, &object.up);
object.quaternion.set_from_rotation_matrix(&m);
}
/// `Camera.updateMatrixWorld()`.
pub fn update_matrix_world(&mut self) {
self.node.update_matrix_world(false);
self.matrix_world_inverse = self.node.borrow().matrix_world;
self.matrix_world_inverse.invert();
}
}