concinnity-cook 0.18.65

Asset cook pipeline that bakes an authored Concinnity world into a blob
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229

// src/world/camera_shot.rs
// Build-time expansion: CameraShot → Camera3D.

use std::path::Path;

use super::expand::{asset_name, type_norm};
use super::preset::load_preset_obj;

pub(crate) fn expand_camera_shots(
    asset_values: &mut Vec<serde_json::Value>,
    assets_dir: Option<&Path>,
) {
    let mut result: Vec<serde_json::Value> = Vec::new();
    for value in asset_values.drain(..) {
        if type_norm(&value) != "camerashot" {
            result.push(value);
            continue;
        }
        let shot_name = asset_name(&value);
        let args = value.get("args").cloned().unwrap_or(serde_json::json!({}));

        let preset_str = args.get("preset").and_then(|v| v.as_str()).unwrap_or("");
        let preset_args: serde_json::Value = if !preset_str.is_empty() {
            let hardcoded = camera_shot_preset(preset_str);
            if hardcoded.is_null() {
                load_preset_obj(preset_str, "shots", assets_dir)
                    .get("args")
                    .cloned()
                    .unwrap_or(serde_json::json!({}))
            } else {
                hardcoded
            }
        } else {
            serde_json::json!({})
        };

        let fov = args
            .get("fov_y_degrees")
            .or_else(|| preset_args.get("fov_y_degrees"))
            .and_then(|v| v.as_f64())
            .unwrap_or(75.0);
        let near = args
            .get("near")
            .or_else(|| preset_args.get("near"))
            .and_then(|v| v.as_f64())
            .unwrap_or(0.05);
        let far = args
            .get("far")
            .or_else(|| preset_args.get("far"))
            .and_then(|v| v.as_f64())
            .unwrap_or(200.0);
        let pos_v = args.get("position").or_else(|| preset_args.get("position"));
        let position = pos_v
            .and_then(|a| a.as_array())
            .map(|a| {
                serde_json::json!([
                    a.first().and_then(|v| v.as_f64()).unwrap_or(0.0),
                    a.get(1).and_then(|v| v.as_f64()).unwrap_or(0.0),
                    a.get(2).and_then(|v| v.as_f64()).unwrap_or(0.0)
                ])
            })
            .unwrap_or(serde_json::json!([0.0, 0.0, 0.0]));
        let yaw = args
            .get("yaw")
            .or_else(|| preset_args.get("yaw"))
            .and_then(|v| v.as_f64())
            .unwrap_or(0.0);
        let pitch = args
            .get("pitch")
            .or_else(|| preset_args.get("pitch"))
            .and_then(|v| v.as_f64())
            .unwrap_or(0.0);

        result.push(serde_json::json!({
            "name": shot_name,
            "type": "Camera3D",
            "args": {
                "fov_y_degrees": fov,
                "near": near,
                "far": far,
                "position": position,
                "yaw": yaw,
                "pitch": pitch
            }
        }));
    }
    *asset_values = result;
}

fn camera_shot_preset(preset: &str) -> serde_json::Value {
    match preset {
        "shot_eye_level" => {
            serde_json::json!({"fov_y_degrees":75.0,"position":[0.0,1.75,0.0],"yaw":std::f64::consts::PI,"near":0.05,"far":200.0})
        }
        "shot_overhead" => {
            serde_json::json!({"fov_y_degrees":60.0,"position":[0.0,8.0,0.0],"pitch":-1.3963,"near":0.05,"far":200.0})
        }
        "shot_dramatic_low" => {
            serde_json::json!({"fov_y_degrees":85.0,"position":[0.0,0.4,0.0],"pitch":0.2618,"near":0.05,"far":200.0})
        }
        "shot_outdoor_wide" => {
            serde_json::json!({"fov_y_degrees":80.0,"position":[0.0,1.75,0.0],"near":0.05,"far":500.0})
        }
        _ => serde_json::Value::Null,
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn expands_to_camera3d() {
        let mut assets = vec![serde_json::json!({
            "name": "wide",
            "type": "CameraShot",
            "args": {"fov_y_degrees": 80.0, "position": [0.0, 1.75, 8.0], "yaw": std::f64::consts::PI}
        })];
        expand_camera_shots(&mut assets, None);
        assert_eq!(assets.len(), 1);
        assert_eq!(assets[0]["name"], "wide");
        assert_eq!(assets[0]["type"], "Camera3D");
        assert_eq!(assets[0]["args"]["fov_y_degrees"], 80.0);
    }

    #[test]
    fn preset_eye_level_expands() {
        let mut assets = vec![serde_json::json!({
            "name": "cam",
            "type": "CameraShot",
            "args": {"preset": "shot_eye_level"}
        })];
        expand_camera_shots(&mut assets, None);
        assert_eq!(assets[0]["type"], "Camera3D");
        let fov = assets[0]["args"]["fov_y_degrees"].as_f64().unwrap();
        assert!((fov - 75.0).abs() < 0.01);
    }

    #[test]
    fn inline_args_override_preset() {
        let mut assets = vec![serde_json::json!({
            "name": "cam",
            "type": "CameraShot",
            "args": {"preset": "shot_eye_level", "fov_y_degrees": 90.0}
        })];
        expand_camera_shots(&mut assets, None);
        let fov = assets[0]["args"]["fov_y_degrees"].as_f64().unwrap();
        assert!((fov - 90.0).abs() < 0.01);
    }

    #[test]
    fn non_camera_shot_assets_pass_through() {
        let mut assets = vec![serde_json::json!({"name":"x","type":"Logger","args":{}})];
        expand_camera_shots(&mut assets, None);
        assert_eq!(assets[0]["type"], "Logger");
    }

    // Expand a single CameraShot built from `args` and return the Camera3D args.
    fn expand_args(args: serde_json::Value) -> serde_json::Value {
        let mut assets = vec![serde_json::json!({
            "name": "cam",
            "type": "CameraShot",
            "args": args
        })];
        expand_camera_shots(&mut assets, None);
        assert_eq!(assets.len(), 1);
        assert_eq!(assets[0]["type"], "Camera3D");
        assets[0]["args"].clone()
    }

    #[test]
    fn preset_overhead_looks_down_from_above() {
        let args = expand_args(serde_json::json!({"preset": "shot_overhead"}));
        assert_eq!(args["fov_y_degrees"], 60.0);
        assert_eq!(args["position"], serde_json::json!([0.0, 8.0, 0.0]));
        assert_eq!(args["pitch"], -1.3963);
        // The preset sets no yaw, so the type default applies.
        assert_eq!(args["yaw"], 0.0);
    }

    #[test]
    fn preset_dramatic_low_tilts_up_from_near_the_floor() {
        let args = expand_args(serde_json::json!({"preset": "shot_dramatic_low"}));
        assert_eq!(args["fov_y_degrees"], 85.0);
        assert_eq!(args["position"], serde_json::json!([0.0, 0.4, 0.0]));
        assert_eq!(args["pitch"], 0.2618);
    }

    #[test]
    fn preset_outdoor_wide_pushes_the_far_plane_out() {
        let args = expand_args(serde_json::json!({"preset": "shot_outdoor_wide"}));
        assert_eq!(args["fov_y_degrees"], 80.0);
        assert_eq!(args["far"], 500.0);
        assert_eq!(args["near"], 0.05);
    }

    // An unknown preset name is not a build error: it falls through to the
    // on-disk preset lookup, which misses, leaving the type defaults.
    #[test]
    fn unknown_preset_falls_back_to_defaults() {
        let args = expand_args(serde_json::json!({"preset": "cn_test_no_such_shot"}));
        assert_eq!(args["fov_y_degrees"], 75.0);
        assert_eq!(args["near"], 0.05);
        assert_eq!(args["far"], 200.0);
        assert_eq!(args["position"], serde_json::json!([0.0, 0.0, 0.0]));
    }

    // A short position array keeps the components it has; the rest read zero.
    #[test]
    fn short_position_array_pads_missing_components_with_zero() {
        let args = expand_args(serde_json::json!({"position": [1.0, 2.0]}));
        assert_eq!(args["position"], serde_json::json!([1.0, 2.0, 0.0]));
    }

    #[test]
    fn defaults_applied_when_no_args() {
        let mut assets = vec![serde_json::json!({
            "name": "cam",
            "type": "CameraShot",
            "args": {}
        })];
        expand_camera_shots(&mut assets, None);
        assert_eq!(assets[0]["type"], "Camera3D");
        let fov = assets[0]["args"]["fov_y_degrees"].as_f64().unwrap();
        assert!((fov - 75.0).abs() < 0.01);
        let near = assets[0]["args"]["near"].as_f64().unwrap();
        assert!((near - 0.05).abs() < 0.001);
    }
}