snapr 0.7.1

Library enabling a flexible and frictionless way to render snapshots of maps with overlayed geometries.
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

//! Contains utilities to make rendering SVGs breezy-er.

use resvg::{
    render,
    usvg::{Options, Tree},
};
use tiny_skia::{Pixmap, Transform};

use super::{style::ColorOptions, Context, Drawable};

/// Configuration structure used to generate a [`Drawable`] SVG.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct Svg {
    pub offset: (i32, i32),
    pub svg: String,
}

impl Svg {
    /// Attempts to convert the [`SvgOptions`] into a valid [`Svg`].
    pub(crate) fn try_as_svg(&self, pixel: (i32, i32)) -> Result<SpatialSvg, crate::Error> {
        let mut options = Options::default();
        options.fontdb_mut().load_system_fonts();

        let svg = SpatialSvg {
            pixel: (pixel.0 - self.offset.0, pixel.1 - self.offset.1),
            tree: Tree::from_str(&self.svg, &options)?,
        };

        Ok(svg)
    }
}

/// Configuration structure used to generate a [`Drawable`] label.
#[derive(Clone, Debug, PartialEq)]
pub struct Label {
    pub color_options: ColorOptions,
    pub font_family: String,
    pub font_size: f32,
    pub offset: (i32, i32),
    pub text: String,
}

impl Default for Label {
    fn default() -> Self {
        Self {
            color_options: ColorOptions::default(),
            font_family: "Arial".to_string(),
            font_size: 16.0,
            offset: (0, 12),
            text: String::default(),
        }
    }
}

impl Label {
    /// Attempts to convert the [`LabelStyle`] into a valid [`Svg`].
    pub(crate) fn try_as_svg(&self, pixel: (i32, i32)) -> Result<SpatialSvg, crate::Error> {
        let raw_svg = format!(
            r##"
            <svg xmlns="http://www.w3.org/2000/svg">
                <text style="fill: {foreground}; font-family: '{font_family}'; font-size: {font_size}px; paint-order: stroke; stroke: {background}; stroke-width: {border}px;">{text}</text>
            </svg>
            "##,
            foreground = self.color_options.foreground_as_hex_code(),
            font_family = self.font_family,
            font_size = self.font_size,
            background = self.color_options.background_as_hex_code(),
            border = self.color_options.border.unwrap_or(0.0),
            text = self.text,
        );

        let mut options = Options::default();
        options.fontdb_mut().load_system_fonts();

        let svg = SpatialSvg {
            pixel: (pixel.0 - self.offset.0, pixel.1 - self.offset.1),
            tree: Tree::from_str(&raw_svg, &options)?,
        };

        Ok(svg)
    }
}

/// Represents an SVG that's drawn centered on a certain [`pixel`](Self::pixel).
#[derive(Clone, Debug)]
pub(crate) struct SpatialSvg {
    pub(crate) pixel: (i32, i32),
    pub(crate) tree: Tree,
}

impl Drawable for SpatialSvg {
    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(level = "TRACE", skip(self, pixmap), err)
    )]
    fn draw(&self, pixmap: &mut Pixmap, _: &Context) -> Result<(), crate::Error> {
        let SpatialSvg { pixel, tree } = self;

        let svg_size = tree.size();
        let (x, y) = *pixel;

        #[cfg(feature = "tracing")]
        {
            tracing::trace!("rendering `SpatialSvg` to `pixmap`");
        }

        render(
            tree,
            Transform::from_translate(
                x as f32 - (svg_size.width() / 2.0),
                y as f32 - (svg_size.height() / 2.0),
            ),
            &mut pixmap.as_mut(),
        );

        Ok(())
    }
}