Bevy Slippy Tiles

A helper bevy plugin to handle downloading OpenStreetMap-compliant slippy tiles.

[DownloadSlippyTilesEvent] can be fired to request one or more slippy tile downloads.

[SlippyTileDownloadedEvent] is fired when a requested slippy tile has been retrieved successfully. The file path is stored in the event and can be used with the asset loader.

Example

Here's a snippet of the example in this crate. This app will load a slippy tile and it's surrounding 8 tiles at the latitude and longitude specified.

Run with: cargo run --example simple

https://user-images.githubusercontent.com/14075649/214139995-c69fc4c7-634e-487a-af0d-a8ac42b6851f.mp4

```rust,ignore use bevy::{ecs::schedule::ShouldRun, prelude::*}; use bevyslippytiles::{ Coordinates, DownloadSlippyTilesEvent, Radius, SlippyTileCoordinates, SlippyTileDownloadedEvent, SlippyTilesPlugin, SlippyTilesSettings, TileSize, ZoomLevel, };

const LATITUDE: f64 = 45.4111; const LONGITUDE: f64 = -75.6980;

fn main() { App::new() // Our slippy tiles settings and plugin .insertresource(SlippyTilesSettings::new( "https://tile.openstreetmap.org", // Tile server endpoint. "tiles/", // assets/ folder storing the slippy tile downloads. )) .addplugins(DefaultPlugins) .add_plugin(SlippyTilesPlugin);

    // ...

}

// ...

fn requestslippytiles(mut downloadslippytile_events: EventWriter) {

// ...

let slippy_tile_event = DownloadSlippyTilesEvent {
    tile_size: TileSize::Normal, // Size of tiles - Normal = 256px, Large = 512px (not all tile servers).
    zoom_level: ZoomLevel::L18, // Map zoom level (L0 = entire world, L19 = closest zoom level).
    coordinates: Coordinates::from_latitude_longitude(LATITUDE, LONGITUDE),
    radius: Radius(1), // Request one layer of surrounding tiles (2 = two layers of surrounding tiles - 25 total, 3 = three layers of surrounding tiles - 49 total, etc).
    use_cache: true, // Don't make request if already requested previously, or if file already exists in tiles directory.
};
download_slippy_tile_events.send(slippy_tile_event);

}

fn displayslippytiles( mut commands: Commands, assetserver: Res, mut slippytiledownloadedevents: EventReader, ) { for slippytiledownloadedevent in slippytiledownloadedevents.iter() { let zoomlevel = slippytiledownloadedevent.zoomlevel; // Convert our slippy tile position to pixels on the screen relative to the center tile. let SlippyTileCoordinates { x: centerx, y: centery, } = Coordinates::fromlatitudelongitude(LATITUDE, LONGITUDE) // Our origin center. .getslippytilecoordinates(zoomlevel); let SlippyTileCoordinates { x: currentx, y: currenty, } = slippytiledownloadedevent .coordinates .getslippytilecoordinates(zoomlevel);

    let tile_pixels = slippy_tile_downloaded_event.tile_size.to_pixels() as f32;
    let transform_x = (current_x as f32 - center_x as f32) * tile_pixels;
    let transform_y = (center_y as f32 - current_y as f32) * tile_pixels;

    // Add our slippy tile to the screen.
    commands.spawn(SpriteBundle {
        texture: asset_server.load(slippy_tile_downloaded_event.path.clone()),
        transform: Transform::from_xyz(transform_x, transform_y, 0.0),
        ..Default::default()
    });
}

} ```

Bevy Compatibility

|bevy|bevy_renet| |---|---| |0.10|TBD| |0.9|0.1.3|