molgfx-core 0.3.5

The semantic scene graph: columnar tables, GPU record layouts, the borrowed coordinate seam.
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

//! Scene lifecycle for caller-owned categorical label volumes.

use super::{Scene, StoredSegmentation};
use crate::SegmentedVolume;
use crate::handle::SegmentationHandle;

#[cfg(test)]
#[path = "segmentation_tests.rs"]
mod tests;

impl Scene {
    /// Stores an immutable shared categorical label grid.
    pub fn add_segmented_volume(&mut self, volume: SegmentedVolume) -> SegmentationHandle {
        self.segmentation_revision = self.segmentation_revision.wrapping_add(1);
        SegmentationHandle(self.segmentations.insert(StoredSegmentation {
            value: volume,
            revision: 0,
        }))
    }

    /// Resolves a categorical label-grid handle.
    #[must_use]
    pub fn segmented_volume(&self, handle: SegmentationHandle) -> Option<&SegmentedVolume> {
        self.segmentations.get(handle.0).map(|stored| &stored.value)
    }

    /// Replaces a categorical grid while preserving its stable handle.
    ///
    /// # Errors
    ///
    /// Returns [`crate::CoreError::StaleHandle`] when the grid was removed.
    pub fn replace_segmented_volume(
        &mut self,
        handle: SegmentationHandle,
        volume: SegmentedVolume,
    ) -> Result<(), crate::CoreError> {
        let stored = self
            .segmentations
            .get_mut(handle.0)
            .ok_or(crate::CoreError::StaleHandle)?;
        stored.value = volume;
        stored.revision = stored.revision.wrapping_add(1);
        self.segmentation_revision = self.segmentation_revision.wrapping_add(1);
        Ok(())
    }

    /// Removes a categorical grid and invalidates its handle.
    pub fn remove_segmented_volume(
        &mut self,
        handle: SegmentationHandle,
    ) -> Option<SegmentedVolume> {
        let removed = self
            .segmentations
            .remove(handle.0)
            .map(|stored| stored.value);
        if removed.is_some() {
            self.segmentation_revision = self.segmentation_revision.wrapping_add(1);
        }
        removed
    }

    /// Counter keying categorical-grid texture reconciliation.
    #[must_use]
    pub const fn segmentation_revision(&self) -> u64 {
        self.segmentation_revision
    }

    /// Revision of one categorical grid's contents.
    #[must_use]
    pub fn segmentation_content_revision(&self, handle: SegmentationHandle) -> Option<u64> {
        self.segmentations
            .get(handle.0)
            .map(|stored| stored.revision)
    }
}