three_rs/core/layers.rs
1//! Port of `three.js/src/core/Layers.js`.
2//!
3//! A membership bit mask over 32 layers. `Object3D.layers` and `Camera.layers`
4//! both default to layer 0, and the renderer's `_projectObject` only pushes an
5//! object whose `layers.test( camera.layers )` passes.
6
7/// `class Layers`.
8///
9/// three.js' `mask` is a JS number used as an `int32`: `1 << layer | 0` and the
10/// `>>> 0` in `set()`. A `u32` is the same 32 bits with no sign games.
11#[derive(Clone, Copy, Debug, PartialEq, Eq)]
12pub struct Layers {
13 /// `Layers.mask`.
14 pub mask: u32,
15}
16
17impl Default for Layers {
18 /// `new Layers()` — membership of layer 0 only.
19 fn default() -> Self {
20 Self { mask: 1 }
21 }
22}
23
24impl Layers {
25 /// `new Layers()` — see the `Default` impl.
26 pub fn new() -> Self {
27 Self::default()
28 }
29
30 /// `Layers.set( layer )`.
31 pub fn set(&mut self, layer: u32) {
32 self.mask = 1u32 << layer;
33 }
34
35 /// `Layers.enable( layer )`.
36 pub fn enable(&mut self, layer: u32) {
37 self.mask |= 1u32 << layer;
38 }
39
40 /// `Layers.enableAll()`.
41 pub fn enable_all(&mut self) {
42 self.mask = 0xffffffff;
43 }
44
45 /// `Layers.toggle( layer )`.
46 pub fn toggle(&mut self, layer: u32) {
47 self.mask ^= 1u32 << layer;
48 }
49
50 /// `Layers.disable( layer )`.
51 pub fn disable(&mut self, layer: u32) {
52 self.mask &= !(1u32 << layer);
53 }
54
55 /// `Layers.disableAll()`.
56 pub fn disable_all(&mut self) {
57 self.mask = 0;
58 }
59
60 /// `Layers.test( layers )`.
61 pub fn test(&self, layers: &Layers) -> bool {
62 (self.mask & layers.mask) != 0
63 }
64
65 /// `Layers.isEnabled( layer )`.
66 pub fn is_enabled(&self, layer: u32) -> bool {
67 (self.mask & (1u32 << layer)) != 0
68 }
69}