bevy_deepzoom 0.0.5

Deep Zoom Image (DZI) tile streaming Bevy
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
use super::*;
use crate::ortho_ext::OrthoExt as _;
use bevy::{
    asset::{LoadState, RenderAssetUsages},
    color::palettes::basic::{GREEN, YELLOW},
    image::ImageLoaderSettings,
    math::ops::log2,
    prelude::*,
    sprite::Anchor,
};
use std::cmp::max;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
struct LevelGeometry {
    width: u32,
    height: u32,
    scale: u64,
}

#[derive(Clone, Copy, Debug, PartialEq)]
struct TileGeometry {
    top_left: Vec2,
    size: Vec2,
    rect: Rect,
}

pub(crate) fn load_dzi_asset(
    asset_server: Res<AssetServer>,
    mut viewers: Query<&mut DeepZoom, (Added<DeepZoom>, With<Camera2d>)>,
) {
    for mut deep_zoom in viewers.iter_mut() {
        deep_zoom.state = DeepZoomState {
            dzi: Some(asset_server.load(deep_zoom.config.dzi_path.clone())),
            ..Default::default()
        };
    }
}

pub(crate) fn finish_loading_dzi(
    mut commands: Commands,
    asset_server: Res<AssetServer>,
    dzi_assets: Res<Assets<DziContents>>,
    mut viewers: Query<(Entity, &mut Projection, &mut DeepZoom), With<Camera2d>>,
) {
    for (entity, mut projection, mut deep_zoom) in viewers.iter_mut() {
        if deep_zoom.state.load_state != DeepZoomLoadState::Loading {
            continue;
        }

        let dzi_handle = deep_zoom
            .state
            .dzi
            .as_ref()
            .expect("DeepZoom viewer must have a DZI handle while loading");

        if dzi_assets.get(dzi_handle).is_some() {
            if deep_zoom.config.initial_view == DeepZoomInitialView::FitWidth {
                let dzi = crate::loaded_dzi(&deep_zoom, &dzi_assets)
                    .expect("loaded DeepZoom viewer must have a loaded DZI asset");
                let projection = projection.ortho_mut().expect("2d cam is ortho");
                projection.scale = crate::fit_width_scale(dzi, projection);
            }

            deep_zoom.state.load_state = DeepZoomLoadState::Loaded;
            commands.trigger(DeepZoomLoaded(entity));
            continue;
        }

        if let Some(LoadState::Failed(error)) = asset_server.get_load_state(dzi_handle.id()) {
            deep_zoom.state.load_state = DeepZoomLoadState::Failed;
            commands.trigger(DeepZoomLoadFailed(entity, error));
        }
    }
}

pub(crate) fn update_zoom_level(
    dzi_assets: Res<Assets<DziContents>>,
    mut viewers: Query<(&mut Projection, &mut DeepZoom), With<Camera2d>>,
) {
    for (mut proj, mut deep_zoom) in viewers.iter_mut() {
        if deep_zoom.state.load_state != DeepZoomLoadState::Loaded {
            continue;
        }

        let dzi = crate::loaded_dzi(&deep_zoom, &dzi_assets)
            .expect("loaded DeepZoom viewer must have a loaded DZI asset");

        let proj = proj.ortho_mut().expect("2d cam is ortho");
        let full_resolution_level = get_zoom_levels(dzi, deep_zoom.config.pyramid_depth);
        let required_zoom_level = get_required_zoom_level(
            full_resolution_level,
            proj.scale,
            deep_zoom.config.zoom_level_bias,
        )
        .min(full_resolution_level);
        if deep_zoom.state.zoom_level == required_zoom_level {
            continue;
        }

        deep_zoom.state.zoom_level = required_zoom_level;
        match deep_zoom.state.lowest_zoom_level {
            Some(lowest) if deep_zoom.state.zoom_level < lowest => {
                deep_zoom.state.lowest_zoom_level = Some(deep_zoom.state.zoom_level)
            }
            None => deep_zoom.state.lowest_zoom_level = Some(deep_zoom.state.zoom_level),
            _ => {}
        }
    }
}

pub(crate) fn render_debug_ui(
    viewers: Query<&DeepZoom, With<Camera2d>>,
    tiles: Query<&DziTile>,
    mut gizmos: Gizmos,
) {
    for tile in tiles.iter() {
        let Ok(deep_zoom) = viewers.get(tile.owner_entity) else {
            continue;
        };
        if !deep_zoom.config.draw_debug_ui {
            continue;
        }

        let color = if deep_zoom.state.tiles_loading.contains(&tile.id) {
            YELLOW
        } else {
            GREEN
        };
        let size = tile.rect.size();
        let center = tile.rect.center();
        let iso = Isometry2d::new(center, 0.0.into());
        gizmos.rect_2d(iso, size, Color::Srgba(color));
    }
}

pub(crate) fn cleanup_orphaned_tiles(
    mut commands: Commands,
    tiles: Query<(Entity, &DziTile)>,
    viewers: Query<(), (With<Camera2d>, With<DeepZoom>)>,
) {
    for (entity, tile) in tiles.iter() {
        if viewers.get(tile.owner_entity).is_err() {
            commands.entity(entity).despawn();
        }
    }
}

pub(crate) fn despawn_out_of_view_tiles(
    mut commands: Commands,
    tiles: Query<(Entity, &DziTile)>,
    mut viewers: Query<(Entity, &Projection, &Transform, &mut DeepZoom), With<Camera2d>>,
) {
    for (viewer_entity, proj, transform, mut deep_zoom) in viewers.iter_mut() {
        if deep_zoom.state.load_state != DeepZoomLoadState::Loaded {
            continue;
        }

        let proj = proj.ortho().expect("we have 2d cam");
        let viewport_rect = get_rect_in_view(proj, transform);
        let zoom_level = deep_zoom.state.zoom_level;
        let lowest_zoom_level = deep_zoom.state.lowest_zoom_level;

        for (entity, tile) in tiles.iter() {
            if tile.owner_entity != viewer_entity {
                continue;
            }

            // Keep around the lowest zoom level so there's always something to see on the screen
            if matches!(lowest_zoom_level, Some(lowest) if tile.zoom_level == lowest) {
                continue;
            }

            if viewport_rect.intersect(tile.rect).is_empty() || tile.zoom_level > zoom_level {
                commands.entity(entity).despawn();
                deep_zoom.state.tiles_loading.remove(&tile.id);
                deep_zoom.state.tiles_loaded.remove(&tile.id);
            }
        }
    }
}

fn show_all_tiles_for(tiles: &mut Query<(&DziTile, &mut Visibility)>, viewer: Entity) {
    for (tile, mut visibility) in tiles.iter_mut() {
        if tile.owner_entity == viewer && *visibility != Visibility::Inherited {
            *visibility = Visibility::Inherited;
        }
    }
}

/// Hide coarse LOD tiles fully occluded by loaded finer tiles, to cut basemap
/// overdraw. Every level `0..=zoom_level` stays spawned (each covers the whole
/// view), so without this they all rasterize every frame even though only the
/// finest loaded level is ever seen. A tile at level `L` is hidden when level
/// `L+1` is loaded across the whole view (its pixels are then all covered by a
/// finer, higher-z tile); coarser fallbacks stay visible wherever the finer
/// level still has gaps, so there is never a blank/visible difference.
///
/// Hiding is only attempted once the view is fully streamed
/// (`DeepZoomState::view_fully_streamed`). Tiles spawn incrementally — one per
/// frame, and cached/already-loaded tiles bypass `tiles_loading` entirely — so
/// a finer level can be only partially spawned while every tile it *has* spawned
/// is loaded. Without the coverage gate, the per-level "all spawned loaded"
/// check would read as complete and hide the coarse fallback over the regions
/// the finer level has not spawned yet, flashing black tile-by-tile as the
/// finer level fills in. `view_fully_streamed` guarantees the finer level is
/// fully spawned across the view, so per-level completeness reflects true
/// coverage.
pub(crate) fn cull_occluded_tiles(
    mut tiles: Query<(&DziTile, &mut Visibility)>,
    viewers: Query<(Entity, &DeepZoom)>,
) {
    for (viewer_entity, deep_zoom) in viewers.iter() {
        if deep_zoom.state.load_state != DeepZoomLoadState::Loaded {
            continue;
        }

        if !deep_zoom.state.view_fully_streamed {
            // Still streaming in tiles for the current view: a finer level may not
            // cover the whole view yet, so keep every coarse fallback visible
            // (this also instantly undoes any prior cull when motion resumes).
            show_all_tiles_for(&mut tiles, viewer_entity);
            continue;
        }

        // Fully streamed: every in-view tile is spawned, so per-level
        // completeness reflects true coverage — hiding occluded levels is safe.
        let levels = deep_zoom.state.zoom_level as usize + 2;
        // `complete[L]` = there is ≥1 spawned level-`L` tile for this viewer and
        // every spawned level-`L` tile is loaded.
        let mut any = vec![false; levels];
        let mut all_loaded = vec![true; levels];
        for (tile, _) in tiles.iter() {
            if tile.owner_entity != viewer_entity {
                continue;
            }
            let level = tile.zoom_level as usize;
            if level >= levels {
                continue;
            }
            any[level] = true;
            if !deep_zoom.state.tiles_loaded.contains(&tile.id) {
                all_loaded[level] = false;
            }
        }
        let complete = |level: usize| level < levels && any[level] && all_loaded[level];

        for (tile, mut visibility) in tiles.iter_mut() {
            if tile.owner_entity != viewer_entity {
                continue;
            }
            let target = if complete(tile.zoom_level as usize + 1) {
                Visibility::Hidden
            } else {
                Visibility::Inherited
            };
            if *visibility != target {
                *visibility = target;
            }
        }
    }
}

pub(crate) fn check_tile_loading_status(
    mut messages: MessageReader<AssetEvent<Image>>,
    tiles: Query<(&DziTile, &Sprite)>,
    mut viewers: Query<&mut DeepZoom, With<Camera2d>>,
) {
    for message in messages.read() {
        if let AssetEvent::LoadedWithDependencies { id } = message {
            for (tile, sprite) in tiles.iter() {
                if sprite.image.id() == *id {
                    let Ok(mut deep_zoom) = viewers.get_mut(tile.owner_entity) else {
                        continue;
                    };
                    deep_zoom.state.tiles_loading.remove(&tile.id);
                    deep_zoom.state.tiles_loaded.insert(tile.id);
                }
            }
        }
    }
}

pub(crate) fn spawn_in_view_tiles(
    mut commands: Commands,
    dzi_assets: Res<Assets<DziContents>>,
    asset_server: Res<AssetServer>,
    mut viewers: Query<(Entity, &Projection, &Transform, &mut DeepZoom), With<Camera2d>>,
) {
    'viewers: for (viewer_entity, proj, transform, mut deep_zoom) in viewers.iter_mut() {
        // Assume not fully streamed; only completing the spawn walk below without
        // spawning anything or hitting the load throttle proves the view is fully
        // covered. `cull_occluded_tiles` reads this to know hiding is safe.
        deep_zoom.state.view_fully_streamed = false;

        if deep_zoom.state.load_state != DeepZoomLoadState::Loaded {
            continue;
        }
        if deep_zoom.state.tiles_loading.len() >= deep_zoom.config.max_concurrent_tile_loads {
            continue;
        }

        let dzi = crate::loaded_dzi(&deep_zoom, &dzi_assets)
            .expect("loaded DeepZoom viewer must have a loaded DZI asset");

        let proj = proj.ortho().expect("we have 2d cam");
        let viewport_rect = get_rect_in_view(proj, transform);
        let max_tile_size = dzi.tile_size;

        for level in 0..=deep_zoom.state.zoom_level {
            let geometry = level_geometry(dzi, deep_zoom.config.pyramid_depth, level);
            let tiles_across = geometry.width.div_ceil(max_tile_size);
            let tiles_down = geometry.height.div_ceil(max_tile_size);

            for i in 0..tiles_across {
                for j in 0..tiles_down {
                    if deep_zoom.state.tiles_loading.len()
                        >= deep_zoom.config.max_concurrent_tile_loads
                    {
                        continue 'viewers;
                    }

                    let id = (level as u16, i as u16, j as u16);
                    if deep_zoom.state.tiles_loading.contains(&id)
                        || deep_zoom.state.tiles_loaded.contains(&id)
                    {
                        continue;
                    }

                    let tile = tile_geometry(dzi, geometry.scale, i, j, tiles_across, tiles_down);

                    if viewport_rect.intersect(tile.rect).is_empty() {
                        continue;
                    }

                    let path = format!(
                        "{}/{level}/{i}_{j}.{}",
                        deep_zoom.config.tiles_base_path, dzi.format
                    );
                    let handle = asset_server
                        .load_builder()
                        .with_settings(|settings: &mut ImageLoaderSettings| {
                            settings.asset_usage = RenderAssetUsages::RENDER_WORLD;
                        })
                        .load(path);
                    deep_zoom.state.tiles_loading.insert(id);
                    commands.spawn((
                        Name::from(format!("DZI Tile {level}/{i}_{j}")),
                        DziTile {
                            owner_entity: viewer_entity,
                            id,
                            zoom_level: level,
                            rect: tile.rect,
                        },
                        Sprite {
                            image: handle,
                            custom_size: Some(tile.size),
                            color: Color::WHITE,
                            ..Default::default()
                        },
                        Anchor::TOP_LEFT,
                        Transform::from_translation(Vec3::new(
                            tile.top_left.x,
                            tile.top_left.y,
                            level as f32 * 0.001 + deep_zoom.config.tile_layer,
                        )),
                    ));

                    continue 'viewers;
                }
            }
        }

        // Reached the end of the spawn walk without spawning or being throttled:
        // every in-view tile at every level is already spawned, so the view is
        // fully covered and the cull may safely hide occluded coarse levels.
        deep_zoom.state.view_fully_streamed = true;
    }
}

fn get_required_zoom_level(full_resolution_level: u32, scale: f32, zoom_level_bias: u32) -> u32 {
    full_resolution_level - (log2(scale).ceil() as u32).min(full_resolution_level) + zoom_level_bias
}

fn get_zoom_levels(dzi: &DziContents, pyramid_depth: DeepZoomPyramidDepth) -> u32 {
    let largest_side = max(dzi.size.width, dzi.size.height);
    match pyramid_depth {
        DeepZoomPyramidDepth::OnePixel => log2(largest_side.max(1) as f32).ceil() as u32,
        DeepZoomPyramidDepth::OneTile => {
            log2((largest_side as f32 / dzi.tile_size as f32).max(1.0)).ceil() as u32
        }
    }
}

fn level_geometry(
    dzi: &DziContents,
    pyramid_depth: DeepZoomPyramidDepth,
    level: u32,
) -> LevelGeometry {
    let full_resolution_level = get_zoom_levels(dzi, pyramid_depth);
    let level_offset = full_resolution_level.saturating_sub(level);
    let scale = 2u64.pow(level_offset);

    LevelGeometry {
        width: (dzi.size.width as u64).div_ceil(scale) as u32,
        height: (dzi.size.height as u64).div_ceil(scale) as u32,
        scale,
    }
}

fn tile_geometry(
    dzi: &DziContents,
    scale: u64,
    x_index: u32,
    y_index: u32,
    tiles_across: u32,
    tiles_down: u32,
) -> TileGeometry {
    let (left, right) = tile_axis_bounds(
        dzi.size.width,
        dzi.tile_size,
        dzi.overlap,
        scale,
        x_index,
        tiles_across,
    );
    let (top, bottom) = tile_axis_bounds(
        dzi.size.height,
        dzi.tile_size,
        dzi.overlap,
        scale,
        y_index,
        tiles_down,
    );

    let half_width = dzi.size.width as f32 * 0.5;
    let half_height = dzi.size.height as f32 * 0.5;
    let top_left = Vec2::new(left as f32 - half_width, half_height - top as f32);
    let bottom_right = Vec2::new(right as f32 - half_width, half_height - bottom as f32);

    TileGeometry {
        top_left,
        size: Vec2::new(bottom_right.x - top_left.x, top_left.y - bottom_right.y),
        rect: Rect::from_corners(top_left, bottom_right),
    }
}

fn tile_axis_bounds(
    full_size: u32,
    tile_size: u32,
    overlap: u32,
    scale: u64,
    index: u32,
    tile_count: u32,
) -> (u64, u64) {
    let full_size = full_size as u64;
    let tile_size = tile_size as u64;
    let overlap = overlap as u64 * scale;

    let unique_start = (index as u64 * tile_size * scale).min(full_size);
    let unique_end = ((index as u64 + 1) * tile_size * scale).min(full_size);
    let start = if index == 0 {
        unique_start
    } else {
        unique_start.saturating_sub(overlap)
    };
    let end = if index + 1 == tile_count {
        unique_end
    } else {
        (unique_end + overlap).min(full_size)
    };

    (start, end)
}

fn get_rect_in_view(proj: &OrthographicProjection, transform: &Transform) -> Rect {
    let position = transform.translation.truncate();
    Rect::from_corners(proj.area.min + position, proj.area.max + position)
}