krabmaga 0.6.1

A modern developing art for reliable and efficient Agent-based Model (ABM) simulation with the Rust language.
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

use std::marker::PhantomData;
use std::path::Path;

use bevy::ecs::system::SystemParam;

use bevy::prelude::{AssetServer, Assets, Handle, Image, Res, ResMut, Resource, Sprite};
use hashbrown::HashMap;

// A simple lazy loader of sprites, mainly for use with the Emoji sprite feature offered by the framework.
// This allows loading sprites only once, storing a handle pointing to the sprite resource itself and returning clones
// of the handle, for optimization purposes.
#[derive(Resource)]
pub struct AssetHandleFactory {
    emoji_loaders: HashMap<String, Handle<Image>>,
}

impl AssetHandleFactory {
    pub fn new() -> AssetHandleFactory {
        AssetHandleFactory {
            emoji_loaders: HashMap::new(),
        }
    }

    // Get the sprite_render associated to the emoji code lazily.
    pub fn get_emoji_loader(
        &mut self,
        emoji_code: String,
        asset_server: &Res<AssetServer>,
    ) -> Sprite {
        Sprite::from_image(self.get_material_handle(emoji_code, asset_server))
    }

    // Actually fetch the sprite resource from the filesystem, from the framework asset folder.
    fn load_emoji_sprite(
        &mut self,
        asset_server: &Res<AssetServer>,
        emoji_filename: String,
    ) -> Handle<Image> {
        asset_server.load(Path::new("emojis").join(emoji_filename))
    }

    // The core of this factory, stores a reference of the materials handle so that it doesn't get
    // garbage collected and returns its clone.
    pub fn get_material_handle(
        &mut self,
        emoji_code: String,
        asset_server: &Res<AssetServer>,
    ) -> Handle<Image> {
        let emoji_filename = format!("{}.png", emoji_code);
        let texture = match self.emoji_loaders.get(&emoji_code) {
            Some(handle) => (*handle).clone(),
            None => {
                let handle = self.load_emoji_sprite(asset_server, emoji_filename);
                self.emoji_loaders.insert(emoji_code, handle.clone());
                handle
            }
        };
        texture
    }
}

// A bundle of resources related to sprite assets, commonly used to edit the graphical representation of an agent.
#[derive(SystemParam)]
pub struct AssetHandleFactoryResource<'w, 's> {
    pub sprite_factory: ResMut<'w, AssetHandleFactory>,
    pub asset_server: Res<'w, AssetServer>,
    pub assets: ResMut<'w, Assets<Image>>,
    marker: PhantomData<&'s ()>,
}

impl<'w, 's> AssetHandleFactoryResource<'w, 's> {
    // A proxy method that exposes [AssetHandleFactory get_emoji_loader](AssetHandleFactory#get_emoji_loader)
    pub fn get_emoji_loader(&mut self, emoji_code: String) -> Sprite {
        self.sprite_factory
            .get_emoji_loader(emoji_code, &self.asset_server)
    }

    // A proxy method that exposes [AssetHandleFactory get_material_handle](AssetHandleFactory#get_material_handle)
    pub fn get_material_handle(&mut self, emoji_code: String) -> Handle<Image> {
        self.sprite_factory
            .get_material_handle(emoji_code, &self.asset_server)
    }
}