scena 1.0.0

A Rust-native scene-graph renderer with typed scene state, glTF assets, and explicit prepare/render lifecycles.
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
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

use crate::Assets;
use crate::diagnostics::LookupError;
use crate::picking::{CursorPosition, Hit, HitTarget, InteractionContext, Viewport};

use super::{CameraKey, NodeKey, NodeKind, RenderableNode, Scene, Transform};

impl Scene {
    pub fn pick(
        &self,
        camera: CameraKey,
        cursor: CursorPosition,
        viewport: Viewport,
    ) -> Result<Option<Hit>, LookupError> {
        crate::picking::pick_scene(self, camera, cursor, viewport)
    }

    pub fn pick_with_assets<F>(
        &self,
        camera: CameraKey,
        cursor: CursorPosition,
        viewport: Viewport,
        assets: &Assets<F>,
    ) -> Result<Option<Hit>, LookupError> {
        crate::picking::pick_scene_with_assets(self, assets, camera, cursor, viewport)
    }

    pub fn pick_pointer(
        &self,
        camera: CameraKey,
        physical_x: f32,
        physical_y: f32,
        physical_width: u32,
        physical_height: u32,
        device_pixel_ratio: f32,
    ) -> Result<Option<Hit>, LookupError> {
        let viewport = Viewport::new(physical_width, physical_height, device_pixel_ratio).ok_or(
            LookupError::InvalidViewport {
                width: physical_width,
                height: physical_height,
            },
        )?;
        self.pick(
            camera,
            CursorPosition::physical(physical_x, physical_y),
            viewport,
        )
    }

    pub fn pick_and_select(
        &mut self,
        camera: CameraKey,
        physical_x: f32,
        physical_y: f32,
        physical_width: u32,
        physical_height: u32,
        device_pixel_ratio: f32,
    ) -> Result<Option<Hit>, LookupError> {
        let hit = self.pick_pointer(
            camera,
            physical_x,
            physical_y,
            physical_width,
            physical_height,
            device_pixel_ratio,
        )?;
        let target = hit.map(|hit| hit.target());
        self.interaction.set_hover(target);
        self.interaction.set_primary_selection(target);
        Ok(hit)
    }

    pub fn pick_and_select_with_assets<F>(
        &mut self,
        camera: CameraKey,
        cursor: CursorPosition,
        viewport: Viewport,
        assets: &Assets<F>,
    ) -> Result<Option<Hit>, LookupError> {
        let hit = self.pick_with_assets(camera, cursor, viewport, assets)?;
        let target = hit.map(|hit| hit.target());
        self.interaction.set_hover(target);
        self.interaction.set_primary_selection(target);
        Ok(hit)
    }

    pub fn pick_and_hover(
        &mut self,
        camera: CameraKey,
        physical_x: f32,
        physical_y: f32,
        physical_width: u32,
        physical_height: u32,
        device_pixel_ratio: f32,
    ) -> Result<Option<Hit>, LookupError> {
        let hit = self.pick_pointer(
            camera,
            physical_x,
            physical_y,
            physical_width,
            physical_height,
            device_pixel_ratio,
        )?;
        self.set_hover_target(hit.map(|hit| hit.target()));
        Ok(hit)
    }

    pub fn pick_and_hover_with_assets<F>(
        &mut self,
        camera: CameraKey,
        cursor: CursorPosition,
        viewport: Viewport,
        assets: &Assets<F>,
    ) -> Result<Option<Hit>, LookupError> {
        let hit = self.pick_with_assets(camera, cursor, viewport, assets)?;
        self.set_hover_target(hit.map(|hit| hit.target()));
        Ok(hit)
    }

    pub fn set_hover_target(&mut self, target: Option<HitTarget>) {
        self.interaction.set_hover(target);
    }

    pub fn set_primary_selection_target(&mut self, target: Option<HitTarget>) {
        self.interaction.set_primary_selection(target);
    }

    pub(crate) fn pickable_renderables(
        &self,
    ) -> impl Iterator<Item = (NodeKey, &RenderableNode, Transform)> {
        self.nodes
            .iter()
            .filter_map(|(key, node)| match &node.kind {
                NodeKind::Renderable(renderable) if self.visible_for_active_camera(key) => self
                    .world_transform(key)
                    .map(|transform| (key, renderable, transform)),
                NodeKind::Empty
                | NodeKind::Renderable(_)
                | NodeKind::Mesh(_)
                | NodeKind::Model(_)
                | NodeKind::InstanceSet(_)
                | NodeKind::Label(_)
                | NodeKind::Camera(_)
                | NodeKind::Light(_) => None,
            })
    }

    pub fn interaction(&self) -> &InteractionContext {
        &self.interaction
    }

    pub fn interaction_mut(&mut self) -> &mut InteractionContext {
        &mut self.interaction
    }
}