bevy_sparse_tilemap 0.4.0

A Tilemap crate for the Bevy game engine with a focus on large map sizes and ECS sparse maps
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

use std::f32::consts::FRAC_PI_6;

use lettuces::{HexOrientation, OffsetHexMode, Quat};
use map_chunk_layer::HexChunkLayer;
use map_data::HexMapData;

use crate::{map::chunk::Chunk, tilemap_builder::TilemapBuilder, tilemap_manager::TilemapManager};

/// Implements [`ChunkLayer`](crate::map::chunk::ChunkLayer) for a hexagonal map
pub mod map_chunk_layer;
/// Implements [`MapData`](crate::map::MapData) for a hexagonal map
pub mod map_data;

/// Type alias for [`TilemapManager`] for the built in hexagon map types.
pub type HexTilemapManager<'w, 's, TileData, MapLayers> =
    TilemapManager<'w, 's, TileData, MapLayers, HexChunkLayer<TileData>, HexMapData>;

/// Type alias for [`Chunk`] using the built in [`HexChunkLayer`]
pub type HexChunk<TileData> = Chunk<HexChunkLayer<TileData>, TileData>;

/// Type alias for [`TilemapBuilder`] for the built in hexagon map types
pub type HexTilemapBuilder<TileData, MapLayers> =
    TilemapBuilder<TileData, MapLayers, HexChunkLayer<TileData>, HexMapData>;

/// Converts a [`HexOrientation`] into a [`OffsetHexMode`]. This sets it to Odd Rows and Odd Columns respectively which are the only two that this crate supports
pub fn hex_offset_from_orientation(orientation: HexOrientation) -> OffsetHexMode {
    match orientation {
        HexOrientation::Pointy => OffsetHexMode::OddRows,
        HexOrientation::Flat => OffsetHexMode::OddColumns,
    }
}

/// Returns the correct hexagon rotation for the given orientation
pub fn hex_rotation(orientation: HexOrientation) -> Quat {
    Quat::from_rotation_z(match orientation {
        HexOrientation::Pointy => 0.0,
        HexOrientation::Flat => FRAC_PI_6,
    })
}