avian3d 0.6.1

An ECS-driven physics engine for the Bevy game engine
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

//! An [`IdPool`] for managing and reusing identifiers.

use alloc::collections::BinaryHeap;
use core::cmp::Reverse;

/// A pool for efficient allocation and reuse of `u32` identifiers.
///
/// Freed IDs are stored in a min-heap, and reused such that the lowest available IDs are allocated first.
#[derive(Clone, Debug, Default)]
#[cfg_attr(feature = "serialize", derive(serde::Serialize, serde::Deserialize))]
pub struct IdPool {
    /// A min-heap of free IDs. The lowest free IDs are allocated first.
    free_ids: BinaryHeap<Reverse<u32>>,
    /// The next ID to be allocated. Only incremented when no free IDs are available.
    next_index: u32,
}

impl IdPool {
    /// Creates a new empty [`IdPool`].
    #[inline(always)]
    pub const fn new() -> Self {
        Self {
            free_ids: BinaryHeap::new(),
            next_index: 0,
        }
    }

    /// Creates a new [`IdPool`] with the given initial capacity.
    ///
    /// This is useful for preallocating space for IDs to avoid reallocations.
    #[inline(always)]
    pub fn with_capacity(capacity: usize) -> Self {
        Self {
            free_ids: BinaryHeap::with_capacity(capacity),
            next_index: 0,
        }
    }

    /// Allocates a new ID.
    ///
    /// If there are free IDs available, the lowest free ID is reused.
    #[inline(always)]
    pub fn alloc(&mut self) -> u32 {
        if let Some(id) = self.free_ids.pop() {
            id.0
        } else {
            let id = self.next_index;
            self.next_index += 1;
            id
        }
    }

    /// Frees an ID, making it available for reuse.
    ///
    /// The ID is assumed to not already be freed.
    #[inline(always)]
    pub fn free(&mut self, id: u32) {
        debug_assert!(id < self.next_index);
        self.free_ids.push(Reverse(id));
    }

    /// Clears the pool, removing all free IDs and resetting the next index.
    #[inline(always)]
    pub fn clear(&mut self) {
        self.free_ids.clear();
        self.next_index = 0;
    }

    /// Returns the next ID that will be allocated.
    #[inline(always)]
    pub fn next_id(&self) -> u32 {
        if let Some(id) = self.free_ids.peek() {
            id.0
        } else {
            self.next_index
        }
    }

    /// Returns the number of allocated IDs.
    #[inline(always)]
    pub fn len(&self) -> usize {
        self.next_index as usize - self.free_ids.len()
    }

    /// Returns the number of free IDs.
    #[inline(always)]
    pub fn free_len(&self) -> usize {
        self.free_ids.len()
    }

    /// Returns the total number of IDs (allocated + free).
    #[inline(always)]
    pub fn total_len(&self) -> usize {
        self.next_index as usize
    }

    /// Returns `true` if the pool is empty (no allocated IDs).
    #[inline(always)]
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }
}