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

//! Liquid definitions.

use getset::{CopyGetters, Getters};
use serde::{Deserialize, Serialize};
use traffloat_types::units;

use crate::atlas::IconRef;
use crate::{lang, IdString};

/// Identifies a liquid type.
pub type Id = crate::Id<Def>;

impl_identifiable!(Def);

/// A type of liquid.
#[derive(Debug, Clone, Getters, CopyGetters, Serialize, Deserialize)]
#[cfg_attr(feature = "xy", derive(xylem::Xylem))]
#[cfg_attr(feature = "xy", xylem(derive(Deserialize)))]
pub struct Def {
    /// ID of the liquid type.
    #[getset(get_copy = "pub")]
    #[cfg_attr(feature = "xy", xylem(args(new = true)))]
    id:          Id,
    /// String ID of the liquid type.
    #[getset(get = "pub")]
    #[cfg_attr(feature = "xy", xylem(serde(default)))]
    id_str:      IdString<Def>,
    /// Name of the liquid type.
    #[getset(get = "pub")]
    name:        lang::Item,
    /// Short summary of the liquid type.
    #[getset(get = "pub")]
    summary:     lang::Item,
    /// Long description of the liquid type.
    #[getset(get = "pub")]
    description: lang::Item,
    /// Viscosity of a liquid.
    #[getset(get_copy = "pub")]
    viscosity:   units::LiquidViscosity,
    /// The texture of the liquid.
    #[getset(get = "pub")]
    texture:     IconRef,
}

/// A formula for mixing liquids.
///
/// Formulas are always commutative, i.e. `a + b = b + a`;
/// the commutation is automatically filled.
///
/// To ensure reproducibility, formulas should be associative,
/// i.e. `a + (b + c) = (a + b) + c`.
#[derive(Debug, Clone, CopyGetters, Serialize, Deserialize)]
#[cfg_attr(feature = "xy", derive(xylem::Xylem))]
#[cfg_attr(feature = "xy", xylem(derive(Deserialize)))]
pub struct Formula {
    /// One of the ingredients for mixing.
    #[getset(get_copy = "pub")]
    augend: Id,
    /// One of the ingredients for mixing.
    #[getset(get_copy = "pub")]
    addend: Id,
    /// The output after mixing.
    #[getset(get_copy = "pub")]
    sum:    Id,
}

/// The default output if no corresponding formula is defined.
#[derive(Debug, Clone, CopyGetters, Serialize, Deserialize)]
#[cfg_attr(feature = "xy", derive(xylem::Xylem))]
#[cfg_attr(feature = "xy", xylem(derive(Deserialize)))]
pub struct DefaultFormula {
    /// The output after mixing.
    #[getset(get_copy = "pub")]
    sum: Id,
}