RectMap

[dizzyi]

Development Workflow

• cargo clippy
• cargo build
• cargo fmt
• cargo rustdoc
• cargo test

Added

examples/rect_map.rs

An example of using RectMap.

cargo run --example rect_map --features "bevy"

src/storage/rect.rs

• unit test

A hex storage map that internally use an 1D Vec, and index by converting to offset coordinate.

pub struct RectMap<T> {
    inner: Vec<T>,
    meta: RectMetadata,
}

The meta data for RectMap, but also act as the builder.

pub struct RectMetadata {
    hex_layout: HexLayout,
    offset_mode: OffsetHexMode,
    half_size: IVec2,
    wrap_strategies: [WrapStrategy; 2],
}

Wrapping Strategy when trying to wrap hex coordinate to ensure it contain inside the map.

pub enum WrapStrategy {
    Clamp,
    Cycle,
}

Example

let rect_hex_map = RectMetadata::default()
    .with_hex_layout(HexLayout::pointy().with_hex_size(1.0))
    .with_half_size(IVec2::new(8,12))
    .with_offset_mode(OffsetHexMode::Odd)
    .with_wrap_strategies([WrapStrategy::Cycle, WrapStrategy::Clamp])
    .build_default::<i32>();

feature bevy_ecs

Added feature to derive Resource and Component for hexx's types.

#[cfg_attr(
    feature = "bevy_ecs",
    derive(bevy_ecs::resource::Resource, bevy_ecs::component::Component)
)]
#[derive(Clone)]
pub struct RectMap<T> {
    /* ... */
}

[ManevilleF]

Thanks a lot for this PR, this is a useful feature and I appreciate the amount of tests and documentation, especially a fully fledged bevy example !

I did a first review, as I wish for some API changes, I did not test the code or the example yet

[ManevilleF]

Why is this Deref needed ?

[dizzyi]

this Deref expose function inside RectMetadata function that take reference &RectMetadata: len, is_empty, iter_hex, contains_hex, wrap_hex, while avoiding exposing builder pattern function that take ownership RectMetadata, making a getter ->RectMetadata will expose builder pattern function, and getter -> &RectMetadata is just a more verbose version of this Deref

[dizzyi]

Added more api to create size of map

pub fn from_half_size(half_size: UVec2) -> Self {}
pub fn from_start_end(start: IVec2, end IVec2) -> Self {}
pub const fn from_start_dim(start: IVec2, dim: UVec2) -> Self {}

[ManevilleF]

Thanks for all the improvements made,

I can see there is a bunch of tests, but they test the index logic without constructing a map
Could you add tests that check that:

• RectMap::iter().count() == RectMap::len()
• RectMap::new(.., |h| h) can be constructed and queried properly and the value is the correct one ?
• Test that querying out of bounds does return None if no wrapping is set

[ManevilleF]

Are those methods needed ? The only usage I can think of would be to overwrite a cloned metadata with a different size

[ManevilleF]

Suggested change

	/// builder patter, set half size
	/// builder pattern, set half size

[ManevilleF]

Suggested change

	/// builder patter, set start and end
	/// builder pattern, set start and end