latkit 0.2.0

Columnar data drawn as vertices, edges, lines, and areas on the GPU.
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

use schemars::JsonSchema;
use serde::{Deserialize, Deserializer};

use super::Shape;
use super::form::{Presets, preset_or, presets};
use crate::gpu::shaders as wgsl;

/// A vertex's port: where a net its reference field names meets it, on one side of its marker: a
/// side, or options. An output drives its net: layouts rank a net from its outputs, and its arrows
/// point away from them.
///
/// ```
/// # use latkit::{Port, Side, Vertices};
/// let pumps = Vertices::of("plant", "Pump").port("in", Side::Left).port("out", Port::output(Side::Right));
/// ```
#[derive(Clone, PartialEq, Debug, Deserialize, JsonSchema)]
#[serde(remote = "Self", rename_all = "camelCase", deny_unknown_fields)]
#[schemars(transform = presets::<Port>)]
pub struct Port {
    /// The side it sits on.
    pub side: Side,
    /// Its place among the ports on that side, from the top or the left; in declaration order unless set.
    #[serde(default)]
    pub order: Option<u32>,
    /// Its name, drawn beside it inside the marker.
    #[serde(default)]
    pub label: Option<String>,
    /// Its marker.
    #[serde(default)]
    pub shape: Shape,
    /// Whether it drives the net its reference field names; an input unless set.
    #[serde(default)]
    pub output: bool,
}

impl Presets for Port {
    const NAMES: &'static [&'static str] = &["left", "right", "top", "bottom"];

    fn preset(name: &str) -> Option<Port> {
        let side = [Side::Left, Side::Right, Side::Top, Side::Bottom];
        Port::NAMES.iter().position(|n| *n == name).map(|i| Port::new(side[i]))
    }

    fn options<'de, D: serde::Deserializer<'de>>(deserializer: D) -> Result<Port, D::Error> {
        Port::deserialize(deserializer)
    }
}

impl<'de> Deserialize<'de> for Port {
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Port, D::Error> {
        preset_or(deserializer)
    }
}

/// A side of a marker.
#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub enum Side {
    /// The left side.
    Left,
    /// The right side.
    Right,
    /// The top.
    Top,
    /// The bottom.
    Bottom,
}

impl Port {
    /// A round input on `side`.
    pub fn new(side: Side) -> Port {
        Port { side, order: None, label: None, shape: Shape::Ellipse, output: false }
    }

    /// A round output on `side`.
    pub fn output(side: Side) -> Port {
        Port { output: true, ..Port::new(side) }
    }

    /// This port, labeled `label`.
    #[must_use]
    pub fn label(mut self, label: impl Into<String>) -> Port {
        self.label = Some(label.into());
        self
    }

    /// Each of `ports`' codes: its side in two bits, its place among the ports on its side (by their
    /// order, then as declared) and how many share the side in eight bits each, and whether it is an
    /// output.
    pub(crate) fn codes(ports: &[&Port]) -> Vec<u32> {
        (0..ports.len())
            .map(|i| {
                let port = ports[i];
                let mut same: Vec<usize> = (0..ports.len()).filter(|&j| ports[j].side == port.side).collect();
                same.sort_by_key(|&j| (ports[j].order.unwrap_or(u32::MAX), j));
                let place = same.iter().position(|&j| j == i).unwrap_or(0) as u32;
                let output = if port.output { wgsl::PORT_OUTPUT } else { 0 };
                port.side.code() | (place.min(255) << 2) | ((same.len() as u32).min(255) << 10) | output
            })
            .collect()
    }
}

impl From<Side> for Port {
    fn from(side: Side) -> Port {
        Port::new(side)
    }
}

impl Side {
    pub(crate) fn code(self) -> u32 {
        match self {
            Side::Left => 0,
            Side::Right => 1,
            Side::Top => 2,
            Side::Bottom => 3,
        }
    }

    /// The side of `code`, or `None` for any other number.
    pub(crate) fn from_code(code: u32) -> Option<Side> {
        [Side::Left, Side::Right, Side::Top, Side::Bottom].get(code as usize).copied()
    }
}