lib-curveball 1.0.0

Curve generating utility for Neverball
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
134
135
136
137
138
139
140
141

// Copyright 2025 Jordan Johnson
// SPDX-License-Identifier: Apache-2.0 OR MIT

//! Structs for Quake3 maps.

use crate::map::geometry::Brush;
use core::fmt;
use std::fmt::{Display, Formatter};

use std::collections::HashMap;

/// A Quake3 map entity.
#[derive(Debug, Clone)]
pub struct QEntity {
    pub parameters: HashMap<String, String>,
    pub brushes: Vec<Brush>,
}

impl QEntity {
    pub(crate) fn bake(&self) -> impl Display + use<'_> {
        struct QEntityDisp<'a>(&'a QEntity);
        impl Display for QEntityDisp<'_> {
            fn fmt(&self, f: &mut Formatter) -> fmt::Result {
                writeln!(f, "{{",)?;
                for (key, value) in self.0.parameters.iter() {
                    writeln!(f, "\"{key}\" \"{value}\"")?;
                }
                for (i, brush) in self.0.brushes.iter().enumerate() {
                    writeln!(f, "// brush {i}")?;
                    write!(f, "{}", brush.bake())?;
                }
                writeln!(f, "}}")?;
                Ok(())
            }
        }
        QEntityDisp(self)
    }
}

/// A Quake3 map.
///
/// Importantly, this struct implements `Display`, so one can convert this struct into text to be
/// written to a `.map` file.
#[derive(Debug, Clone)]
pub struct QMap {
    pub entities: Vec<QEntity>,
    pub metadata: Vec<String>,
}

impl QMap {
    pub fn new(entities: Vec<QEntity>) -> Self {
        Self {
            entities,
            metadata: Vec::new(),
        }
    }

    pub fn with_metadata(mut self, metadata: String) -> Self {
        self.metadata.push(metadata);
        self
    }

    pub fn with_tb_neverball_metadata(self) -> Self {
        self.with_metadata("Game: Neverball".to_string())
            .with_metadata("Format: Quake3".to_string())
    }

    pub fn bake(&self) -> impl Display + use<'_> {
        struct QMapDisp<'a>(&'a QMap);
        impl Display for QMapDisp<'_> {
            fn fmt(&self, f: &mut Formatter) -> fmt::Result {
                for metadata_line in self.0.metadata.iter().flat_map(|meta| meta.lines()) {
                    writeln!(f, "// {}", metadata_line)?;
                }
                for (i, entity) in self.0.entities.iter().enumerate() {
                    writeln!(f, "// entity {i}")?;
                    write!(f, "{}", entity.bake())?;
                }
                Ok(())
            }
        }
        QMapDisp(self)
    }
}

impl Display for QMap {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.bake())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::map::entity::SimpleWorldspawn;
    use glam::DVec3;

    #[test]
    fn compile_map() {
        let vertices = vec![
            DVec3::from([0.0, 0.0, 0.0]),
            DVec3::from([0.0, 0.0, 1.0]),
            DVec3::from([0.0, 1.0, 0.0]),
            DVec3::from([1.0, 0.0, 0.0]),
            DVec3::from([0.3, 0.3, 0.3]),
        ];

        let brush1 = Brush::try_from_vertices(&vertices, Some(1000)).unwrap();
        let brush2 = Brush::try_from_vertices(&vertices, Some(1000)).unwrap();

        let worldspawn = SimpleWorldspawn::new(vec![brush1, brush2]);
        let entity: QEntity = worldspawn.into();
        let map: QMap = QMap::new(vec![entity]).with_tb_neverball_metadata();

        println!("{}", map.to_string());

        let should_eq_str = r#"// Game: Neverball
// Format: Quake3
// entity 0
{
"classname" "worldspawn"
// brush 0
{
( 0.000000 0.000000 0.000000 ) ( 0.000000 1.000000 0.000000 ) ( 0.000000 0.000000 1.000000 ) mtrl/invisible 0 0 0 0.5 0.5 0 0 0
( 0.000000 1.000000 0.000000 ) ( 1.000000 0.000000 0.000000 ) ( 0.000000 0.000000 1.000000 ) mtrl/invisible 0 0 0 0.5 0.5 0 0 0
( 1.000000 0.000000 0.000000 ) ( 0.000000 0.000000 0.000000 ) ( 0.000000 0.000000 1.000000 ) mtrl/invisible 0 0 0 0.5 0.5 0 0 0
( 0.000000 0.000000 0.000000 ) ( 1.000000 0.000000 0.000000 ) ( 0.000000 1.000000 0.000000 ) mtrl/invisible 0 0 0 0.5 0.5 0 0 0
}
// brush 1
{
( 0.000000 0.000000 0.000000 ) ( 0.000000 1.000000 0.000000 ) ( 0.000000 0.000000 1.000000 ) mtrl/invisible 0 0 0 0.5 0.5 0 0 0
( 0.000000 1.000000 0.000000 ) ( 1.000000 0.000000 0.000000 ) ( 0.000000 0.000000 1.000000 ) mtrl/invisible 0 0 0 0.5 0.5 0 0 0
( 1.000000 0.000000 0.000000 ) ( 0.000000 0.000000 0.000000 ) ( 0.000000 0.000000 1.000000 ) mtrl/invisible 0 0 0 0.5 0.5 0 0 0
( 0.000000 0.000000 0.000000 ) ( 1.000000 0.000000 0.000000 ) ( 0.000000 1.000000 0.000000 ) mtrl/invisible 0 0 0 0.5 0.5 0 0 0
}
}
"#;
        println!("{}", should_eq_str);
        assert_eq!(format!("{}", map.to_string()), should_eq_str);
    }
}