awsm-renderer 0.4.0

awsm-renderer
Documentation 
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

//! Query filters and the engine-bridge `SpatialQuery` trait.

use glam::Vec3;

use crate::{bounds::Aabb, frustum::Frustum, meshes::MeshKey};

use super::node::SceneNode;

/// Predicate filter applied to leaves during a frustum query. Each call
/// site fills this in once and the iterator handles the per-leaf check.
#[derive(Debug, Clone, Copy, Default)]
pub struct NodeFilter {
    pub exclude_hidden: bool,
    pub exclude_hud: bool,
    pub require_cast_shadows: bool,
    pub require_receive_shadows: bool,
}

impl NodeFilter {
    /// Default for the camera (geometry) pass: skip hidden, keep HUD.
    pub fn camera_default() -> Self {
        Self {
            exclude_hidden: true,
            exclude_hud: false,
            require_cast_shadows: false,
            require_receive_shadows: false,
        }
    }

    /// Filter for the shadow-caster pass: cast_shadows && !hidden && !hud.
    pub fn shadow_caster() -> Self {
        Self {
            exclude_hidden: true,
            exclude_hud: true,
            require_cast_shadows: true,
            require_receive_shadows: false,
        }
    }

    /// All-active filter: !hidden.
    pub fn visible() -> Self {
        Self {
            exclude_hidden: true,
            exclude_hud: false,
            require_cast_shadows: false,
            require_receive_shadows: false,
        }
    }

    /// Returns true if the node passes the filter.
    pub fn matches(&self, node: &SceneNode) -> bool {
        if self.exclude_hidden && node.flags.hidden {
            return false;
        }
        if self.exclude_hud && node.flags.hud {
            return false;
        }
        if self.require_cast_shadows && !node.flags.cast_shadows {
            return false;
        }
        if self.require_receive_shadows && !node.flags.receive_shadows {
            return false;
        }
        true
    }
}

/// Read-only spatial query surface exposed to external crates. The
/// renderer is the sole writer of the underlying structure.
pub trait SpatialQuery {
    /// Returns the mesh keys whose world AABBs intersect the frustum,
    /// filtered by `filter`.
    fn query_frustum(&self, frustum: &Frustum, filter: NodeFilter) -> Vec<MeshKey>;

    /// Returns the mesh keys whose world AABBs intersect `aabb`.
    fn query_envelope(&self, aabb: &Aabb) -> Vec<MeshKey>;

    /// Returns the mesh key whose AABB-center is closest to `point`.
    fn nearest(&self, point: Vec3) -> Option<MeshKey>;
}