euv-engine 0.9.1

A high-performance 2D game engine built on the euv framework, featuring ECS, fixed-timestep game loop, canvas rendering, physics, collision detection, sprite animation, and audio.
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

use crate::*;

/// Implements static scene creation for `SceneManager`.
impl SceneManager {
    /// Creates a new `SceneRc` wrapping the given scene in a reference-counted cell.
    ///
    /// # Arguments
    ///
    /// - `T` - The concrete scene type implementing `Scene`.
    ///
    /// # Returns
    ///
    /// - `SceneRc` - The wrapped scene.
    pub fn create_scene<T>(scene: T) -> SceneRc
    where
        T: Scene + 'static,
    {
        Rc::new(RefCell::new(scene))
    }
}

/// Implements scene registration and lifecycle management for `SceneManager`.
impl SceneManager {
    /// Registers a scene under the given name.
    ///
    /// # Arguments
    ///
    /// - `String` - The name to register the scene under.
    /// - `SceneRc` - The scene to register.
    pub fn register(&mut self, name: String, scene: SceneRc) {
        self.get_mut_scenes().insert(name, scene);
    }

    /// Unregisters and removes the scene with the given name.
    ///
    /// # Arguments
    ///
    /// - `&str` - The name of the scene to remove.
    pub fn unregister(&mut self, name: &str) {
        self.get_mut_scenes().remove(name);
    }

    /// Transitions to the scene with the given name.
    ///
    /// Calls `on_exit` on the current scene and `on_enter` on the new scene.
    /// Returns `false` if no scene with the given name is registered.
    ///
    /// # Arguments
    ///
    /// - `&str` - The name of the scene to switch to.
    ///
    /// # Returns
    ///
    /// - `bool` - True if the transition was successful.
    pub fn switch_to(&mut self, name: &str) -> bool {
        if !self.get_scenes().contains_key(name) {
            return false;
        }
        let current_name: Option<String> = self.get_mut_current_scene_name().clone();
        if let Some(name) = current_name.as_ref()
            && let Some(current_scene) = self.get_scenes().get(name)
        {
            current_scene.borrow_mut().on_exit();
        }
        self.set_current_scene_name(Some(name.to_string()));
        if let Some(new_scene) = self.get_scenes().get(name) {
            new_scene.borrow_mut().on_enter();
        }
        true
    }

    /// Requests a deferred scene transition to be applied on the next update.
    ///
    /// # Arguments
    ///
    /// - `String` - The name of the scene to switch to.
    pub fn request_transition(&mut self, name: String) {
        self.set_pending_scene_name(Some(name));
    }

    /// Processes a pending scene transition if one was requested.
    pub fn process_pending_transition(&mut self) {
        let Some(name) = self.get_mut_pending_scene_name().take() else {
            return;
        };
        self.switch_to(&name);
    }

    /// Calls `on_update` on the current scene.
    ///
    /// # Arguments
    ///
    /// - `f64` - The delta time in seconds.
    pub fn update(&mut self, delta_time: f64) {
        self.process_pending_transition();
        let current_name: Option<String> = self.get_mut_current_scene_name().clone();
        let Some(current_name) = current_name.as_ref() else {
            return;
        };
        let Some(scene) = self.get_scenes().get(current_name) else {
            return;
        };
        scene.borrow_mut().on_update(delta_time);
    }

    /// Calls `on_render` on the current scene.
    ///
    /// # Arguments
    ///
    /// - `&CanvasRenderingContext2d` - The canvas rendering context.
    pub fn render(&self, context: &CanvasRenderingContext2d) {
        let Some(current_name) = self.current_scene_name.as_ref() else {
            return;
        };
        let Some(scene) = self.get_scenes().get(current_name) else {
            return;
        };
        scene.borrow().on_render(context);
    }

    /// Returns whether a scene with the given name is registered.
    ///
    /// # Arguments
    ///
    /// - `&str` - The scene name to check.
    ///
    /// # Returns
    ///
    /// - `bool` - True if the scene is registered.
    pub fn has_scene(&self, name: &str) -> bool {
        self.get_scenes().contains_key(name)
    }

    /// Returns the name of the currently active scene.
    ///
    /// # Returns
    ///
    /// - `Option<&str>` - The current scene name, or `None`.
    pub fn current_name(&self) -> Option<&str> {
        self.current_scene_name.as_deref()
    }
}

/// Implements `Default` for `SceneManager` as a new empty manager.
impl Default for SceneManager {
    fn default() -> SceneManager {
        SceneManager::new()
    }
}