egui_hooks 0.11.0

React Hooks like API for egui
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

use std::{collections::HashMap, sync::Arc};

use egui::util::id_type_map::SerializableAny;
use parking_lot::{RawRwLock, RwLock, lock_api::ArcRwLockWriteGuard};

use crate::dispatcher::Dispatcher;

use super::Hook;

#[derive(Default)]
pub struct KvHook<K, V> {
    _marker: std::marker::PhantomData<(K, V)>,
}

impl<K, V> KvHook<K, V> {
    #[inline]
    pub fn new() -> Self {
        Self {
            _marker: std::marker::PhantomData,
        }
    }
}

impl<K: Send + Sync + 'static, V: Send + Sync + 'static, D> Hook<D> for KvHook<K, V> {
    type Backend = Arc<RwLock<HashMap<K, V>>>;
    type Output = Kv<K, V>;

    fn init(
        &mut self,
        _index: usize,
        _deps: &D,
        backend: Option<Self::Backend>,
        ui: &mut egui::Ui,
    ) -> Self::Backend {
        backend.unwrap_or_else(|| Dispatcher::from_ctx(ui.ctx()).get_kv_or_default())
    }

    fn hook(self, backend: &mut Self::Backend, _ui: &mut egui::Ui) -> Self::Output {
        Kv(backend.write_arc())
    }
}

#[derive(Default)]
pub struct PersistedKvHook<K, V> {
    _marker: std::marker::PhantomData<(K, V)>,
}

impl<K, V> PersistedKvHook<K, V> {
    #[inline]
    pub fn new() -> Self {
        Self {
            _marker: std::marker::PhantomData,
        }
    }
}

impl<K: SerializableAny + Eq + std::hash::Hash, V: SerializableAny, D> Hook<D>
    for PersistedKvHook<K, V>
{
    type Backend = Arc<RwLock<HashMap<K, V>>>;
    type Output = Kv<K, V>;

    fn init(
        &mut self,
        _index: usize,
        _deps: &D,
        backend: Option<Self::Backend>,
        ui: &mut egui::Ui,
    ) -> Self::Backend {
        backend
            .unwrap_or_else(|| Dispatcher::from_ctx(ui.ctx()).get_persisted_kv_or_default(ui.ctx()))
    }

    fn hook(self, backend: &mut Self::Backend, _ui: &mut egui::Ui) -> Self::Output {
        Kv(backend.write_arc())
    }
}

pub struct Kv<K, V>(ArcRwLockWriteGuard<RawRwLock, HashMap<K, V>>);

impl<K, V> std::ops::Deref for Kv<K, V> {
    type Target = HashMap<K, V>;

    #[inline]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<K, V> std::ops::DerefMut for Kv<K, V> {
    #[inline]
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}