edges 0.8.1

a library for getting the edges of objects in images with transparency
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

#![doc = include_str!("../README.md")]

use binary_image::{BinaryImage, BinaryView, Bit};
use image::{DynamicImage, GenericImageView};

#[cfg(feature = "bevy")]
pub(crate) use bevy_math::prelude::{UVec2, Vec2};
#[cfg(all(not(feature = "bevy"), feature = "glam-latest"))]
pub(crate) use glam::{UVec2, Vec2};

pub extern crate binary_image;
pub use iter::Edges as EdgesIter;

pub mod anchor;
pub mod utils;

#[cfg(feature = "bevy")]
mod bevy;
mod iter;
#[cfg(all(feature = "bevy", test))]
mod tests;

/// A struct representing the edges of a image.
#[derive(Default, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Edges<I: GenericImageView<Pixel = Bit>>(pub I);

impl<I> Edges<I>
where
    I: GenericImageView<Pixel = Bit>,
{
    /// Translates the edges of a single image into a coordinate system centered at (0, 0).
    ///
    /// # Returns
    ///
    /// A vector of `Vec2` representing the translated edge points.
    #[inline]
    #[must_use]
    pub fn single_translated(&self) -> Option<Vec<Vec2>> {
        self.iter()
            .next()
            .map(|polygon| self.anchor().translate(polygon))
    }

    /// Retrieves the raw edge points of a single image.
    ///
    /// # Returns
    ///
    /// A vector of `UVec2` representing the raw edge points.
    #[inline]
    #[must_use]
    pub fn single_raw(&self) -> Option<Vec<UVec2>> {
        self.iter().next()
    }

    /// Translates the edges of multiple images into a coordinate system centered at (0, 0).
    ///
    /// # Returns
    ///
    /// A vector of vectors of `Vec2` representing the translated edge points of each image.
    #[inline]
    #[must_use]
    pub fn multi_translated(&self) -> Vec<Vec<Vec2>> {
        self.anchor().translate_polygons(self.iter())
    }

    /// Retrieves the raw edge points of multiple images.
    ///
    /// # Returns
    ///
    /// A vector of vectors of `UVec2` representing the raw edge points of each image.
    #[inline]
    #[must_use]
    pub fn multi_raw(&self) -> Vec<Vec<UVec2>> {
        self.iter().collect()
    }

    #[inline]
    #[must_use]
    pub fn iter(&self) -> iter::Edges<I> {
        self.into_iter()
    }

    #[inline]
    #[must_use]
    fn anchor(&self) -> anchor::Anchor {
        anchor::Anchor::Center(self.height(), self.width())
    }
}

impl From<DynamicImage> for Edges<BinaryImage> {
    fn from(image: DynamicImage) -> Edges<BinaryImage> {
        Self(BinaryImage::from(image))
    }
}

impl<'a> From<&'a DynamicImage> for Edges<BinaryView<'a, DynamicImage>> {
    fn from(image: &'a DynamicImage) -> Edges<BinaryView<'a, DynamicImage>> {
        Self(BinaryView::Ref(image))
    }
}

impl<I> std::fmt::Debug for Edges<I>
where
    I: GenericImageView<Pixel = Bit>,
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Edges")
            .field("raw", &self.multi_raw())
            .field("translated", &self.multi_translated())
            .finish()
    }
}

impl<I> std::ops::Deref for Edges<I>
where
    I: GenericImageView<Pixel = Bit>,
{
    type Target = I;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<'a, I> IntoIterator for &'a Edges<I>
where
    I: GenericImageView<Pixel = Bit>,
{
    type Item = Vec<UVec2>;
    type IntoIter = iter::Edges<'a, I>;
    fn into_iter(self) -> Self::IntoIter {
        Self::IntoIter::new(&self.0)
    }
}