Make tilemap respond to Anchor component.

Cargo.toml

@@ -52,7 +52,7 @@ features = [
     "multi_threaded",
     "default_font",
     "webgl2",
-    "default_font",
+    "bevy_gizmos",
 ]
 
 [target.'cfg(unix)'.dev-dependencies.bevy]
@@ -74,7 +74,7 @@ features = [
     "multi_threaded",
     "default_font",
     "webgl2",
-    "default_font",
+    "bevy_gizmos",
 ]
 
 
@@ -198,3 +198,7 @@ required-features = ["render"]
 name = "visibility"
 path = "examples/visibility.rs"
 required-features = ["render"]
+[[example]]
+name = "anchor"
+path = "examples/anchor.rs"
+required-features = ["render"]

README.md

@@ -15,6 +15,7 @@ A tilemap rendering plugin for [`bevy`](https://bevyengine.org/). It is more ECS
 - GPU powered animations.
 - Isometric and Hexagonal tile maps.
 - Examples for integration with [Tiled](https://www.mapeditor.org/) and [LDTK](https://ldtk.io/) editors.
+- Can `Anchor` tilemap like a sprite.
 
 ## Screenshots
 

examples/accessing_tiles.rs

@@ -90,7 +90,7 @@ fn startup(mut commands: Commands, asset_server: Res<AssetServer>) {
             map_type,
             texture: TilemapTexture::Single(texture_handle),
             tile_size,
-            transform: get_tilemap_center_transform(&map_size, &grid_size, &map_type, 0.0),
+            anchor: TilemapAnchor::Center,
             ..Default::default()
         },
         LastUpdate(0.0),

examples/anchor.rs

@@ -0,0 +1,159 @@
+//! Demonstrate tilemap with an [Anchor] component.
+use bevy::prelude::*;
+use bevy_ecs_tilemap::prelude::*;
+use rand::seq::SliceRandom;
+use rand::thread_rng;
+
+mod helpers;
+use helpers::anchor::rotate_right;
+
+fn color(s: &str) -> Color {
+    Srgba::hex(s).expect("hex color").into()
+}
+
+fn startup(
+    mut commands: Commands,
+    asset_server: Res<AssetServer>,
+    #[cfg(all(not(feature = "atlas"), feature = "render"))] array_texture_loader: Res<
+        ArrayTextureLoader,
+    >,
+) {
+    commands.spawn(Camera2d);
+
+    let texture_handle: Handle<Image> = asset_server.load("tiles.png");
+
+    let map_size = TilemapSize { x: 12, y: 12 };
+
+    // Create a tilemap entity a little early.
+    // We want this entity early because we need to tell each tile which tilemap entity
+    // it is associated with. This is done with the TilemapId component on each tile.
+    // Eventually, we will insert the `TilemapBundle` bundle on the entity, which
+    // will contain various necessary components, such as `TileStorage`.
+    let tilemap_entity = commands.spawn_empty().id();
+
+    // To begin creating the map we will need a `TileStorage` component.
+    // This component is a grid of tile entities and is used to help keep track of individual
+    // tiles in the world. If you have multiple layers of tiles you would have a tilemap entity
+    // per layer, each with their own `TileStorage` component.
+    let mut tile_storage = TileStorage::empty(map_size);
+
+    let mut rng = thread_rng();
+    let colors: Vec<Color> = vec![
+        color("FFBE0B"),
+        color("FB5607"),
+        color("FF006E"),
+        color("8338EC"),
+        color("3A86FF"),
+    ];
+
+    // Spawn the elements of the tilemap.
+    // Alternatively, you can use helpers::filling::fill_tilemap.
+    for x in 0..map_size.x {
+        for y in 0..map_size.y {
+            let tile_pos = TilePos { x, y };
+            let tile_entity = commands
+                .spawn(TileBundle {
+                    position: tile_pos,
+                    tilemap_id: TilemapId(tilemap_entity),
+                    color: TileColor(*colors.choose(&mut rng).unwrap()),
+                    ..Default::default()
+                })
+                .id();
+            tile_storage.set(&tile_pos, tile_entity);
+        }
+    }
+
+    let tile_size = TilemapTileSize { x: 16.0, y: 16.0 };
+    let grid_size = tile_size.into();
+    let map_type = TilemapType::default();
+
+    // The tilemap is placed at the origin, but its anchor can change.
+    commands.entity(tilemap_entity).insert(TilemapBundle {
+        grid_size,
+        map_type,
+        size: map_size,
+        storage: tile_storage,
+        texture: TilemapTexture::Single(texture_handle),
+        tile_size,
+        transform: Transform::IDENTITY,
+        anchor: TilemapAnchor::TopLeft,
+        ..Default::default()
+    });
+
+    // Add atlas to array texture loader so it's preprocessed before we need to use it.
+    // Only used when the atlas feature is off and we are using array textures.
+    #[cfg(all(not(feature = "atlas"), feature = "render"))]
+    {
+        array_texture_loader.add(TilemapArrayTexture {
+            texture: TilemapTexture::Single(asset_server.load("tiles.png")),
+            tile_size,
+            ..Default::default()
+        });
+    }
+}
+
+fn mark_origin(mut gizmos: Gizmos) {
+    gizmos.axes_2d(Transform::IDENTITY, 1000.0);
+}
+
+fn change_anchor(
+    keyboard_input: Res<ButtonInput<KeyCode>>,
+    mut query: Query<&mut TilemapAnchor, With<TilemapTexture>>,
+    text: Single<Entity, With<Text>>,
+    mut writer: TextUiWriter,
+) {
+    if keyboard_input.just_pressed(KeyCode::Space) {
+        for mut anchor in &mut query {
+            *anchor = rotate_right(&anchor);
+            *writer.text(*text, 1) = format!("{:?}", *anchor);
+        }
+    }
+}
+
+fn main() {
+    App::new()
+        .add_plugins(
+            DefaultPlugins
+                .set(WindowPlugin {
+                    primary_window: Some(Window {
+                        title: String::from("Anchor Example - Press Space to change anchor."),
+                        resolution: Vec2::splat(450.0).into(),
+                        ..Default::default()
+                    }),
+                    ..default()
+                })
+                .set(ImagePlugin::default_nearest()),
+        )
+        .add_plugins(TilemapPlugin)
+        .add_systems(Startup, startup)
+        .add_systems(Startup, setup_header)
+        .add_systems(Update, helpers::camera::movement)
+        .add_systems(Update, change_anchor)
+        .add_systems(Update, mark_origin)
+        .run();
+}
+
+fn setup_header(mut commands: Commands) {
+    let font_size = 15.0;
+    commands
+        .spawn((
+            Text::new("Anchor: "),
+            TextLayout::new_with_justify(JustifyText::Center),
+            TextFont {
+                font_size,
+                ..default()
+            },
+            Node {
+                top: Val::Px(10.0),
+                left: Val::Px(10.0),
+                ..default()
+            },
+        ))
+        .with_child((
+            TextSpan::new("TopLeft"),
+            TextFont {
+                font_size,
+                ..default()
+            },
+        ));
+}

examples/animation.rs

@@ -60,7 +60,7 @@ fn create_background(mut commands: Commands, asset_server: Res<AssetServer>) {
         tile_size,
         storage: tile_storage,
         texture: TilemapTexture::Single(texture_handle),
-        transform: get_tilemap_center_transform(&size, &grid_size, &map_type, 0.0),
+        anchor: TilemapAnchor::Center,
         ..Default::default()
     });
 }
@@ -117,7 +117,8 @@ fn create_animated_flowers(mut commands: Commands, asset_server: Res<AssetServer
         tile_size,
         storage: tile_storage,
         texture: TilemapTexture::Single(texture_handle),
-        transform: get_tilemap_center_transform(&map_size, &grid_size, &map_type, 1.0),
+        anchor: TilemapAnchor::Center,
+        transform: Transform::from_xyz(0.0, 0.0, 1.0),
         ..Default::default()
     });
 }

examples/basic.rs

@@ -56,7 +56,7 @@ fn startup(
         storage: tile_storage,
         texture: TilemapTexture::Single(texture_handle),
         tile_size,
-        transform: get_tilemap_center_transform(&map_size, &grid_size, &map_type, 0.0),
+        anchor: TilemapAnchor::Center,
         ..Default::default()
     });
 

examples/bench.rs

@@ -35,7 +35,7 @@ fn startup(mut commands: Commands, asset_server: Res<AssetServer>) {
         storage: tile_storage,
         texture: TilemapTexture::Single(texture_handle),
         tile_size,
-        transform: get_tilemap_center_transform(&map_size, &grid_size, &map_type, 0.0),
+        anchor: TilemapAnchor::Center,
         render_settings: TilemapRenderSettings {
             render_chunk_size: UVec2::new(256, 256),
             ..Default::default()

examples/colors.rs

@@ -76,7 +76,6 @@ fn startup(mut commands: Commands, asset_server: Res<AssetServer>) {
 
     let tile_size = TilemapTileSize { x: 16.0, y: 16.0 };
     let grid_size = tile_size.into();
-    let map_type = TilemapType::default();
 
     commands.entity(tilemap_entity).insert(TilemapBundle {
         grid_size,
@@ -85,7 +84,7 @@ fn startup(mut commands: Commands, asset_server: Res<AssetServer>) {
         texture: TilemapTexture::Single(texture_handle),
         tile_size,
         map_type: TilemapType::Square,
-        transform: get_tilemap_center_transform(&map_size, &grid_size, &map_type, 0.0),
+        anchor: TilemapAnchor::Center,
         ..Default::default()
     });
 }

examples/custom_shader.rs

@@ -58,7 +58,7 @@ fn startup(
             storage: tile_storage,
             texture: TilemapTexture::Single(texture_handle.clone()),
             tile_size,
-            transform: get_tilemap_center_transform(&map_size, &grid_size, &map_type, 0.0),
+            anchor: TilemapAnchor::Center,
             material: my_material_handle.clone(),
             ..Default::default()
         });
@@ -84,8 +84,8 @@ fn startup(
             storage: tile_storage,
             texture: TilemapTexture::Single(texture_handle),
             tile_size: TilemapTileSize { x: 16.0, y: 16.0 },
-            transform: get_tilemap_center_transform(&map_size, &grid_size, &map_type, 1.0)
-                * Transform::from_xyz(32.0, 32.0, 0.0),
+            anchor: TilemapAnchor::Center,
+            transform: Transform::from_xyz(32.0, 32.0, 1.0),
             material: my_material_handle,
             ..Default::default()
         });

examples/game_of_life.rs

@@ -42,7 +42,7 @@ fn startup(mut commands: Commands, asset_server: Res<AssetServer>) {
             storage: tile_storage,
             texture: TilemapTexture::Single(texture_handle),
             tile_size,
-            transform: get_tilemap_center_transform(&map_size, &grid_size, &map_type, 0.0),
+            anchor: TilemapAnchor::Center,
             ..Default::default()
         },
         LastUpdate(0.0),

examples/helpers/anchor.rs

@@ -0,0 +1,20 @@
+use bevy::prelude::Vec2;
+use bevy_ecs_tilemap::anchor::TilemapAnchor;
+
+#[allow(dead_code)]
+pub fn rotate_right(anchor: &TilemapAnchor) -> TilemapAnchor {
+    use TilemapAnchor::*;
+    match anchor {
+        TopLeft => TopCenter,
+        TopCenter => TopRight,
+        TopRight => CenterRight,
+        CenterRight => BottomRight,
+        BottomRight => BottomCenter,
+        BottomCenter => BottomLeft,
+        BottomLeft => CenterLeft,
+        CenterLeft => Center,
+        Center => Custom(Vec2::splat(0.25)),
+        Custom(_) => None,
+        None => TopLeft,
+    }
+}

examples/helpers/ldtk.rs

@@ -1,5 +1,5 @@
 use bevy_ecs_tilemap::{
-    helpers::geometry::get_tilemap_center_transform,
+    anchor::TilemapAnchor,
     map::{TilemapId, TilemapSize, TilemapTexture, TilemapTileSize},
     tiles::{TileBundle, TilePos, TileStorage, TileTextureIndex},
     TilemapBundle,
@@ -227,12 +227,8 @@ pub fn process_loaded_tile_maps(
                             storage,
                             texture: TilemapTexture::Single(texture),
                             tile_size,
-                            transform: get_tilemap_center_transform(
-                                &size,
-                                &grid_size,
-                                &map_type,
-                                layer_id as f32,
-                            ),
+                            anchor: TilemapAnchor::Center,
+                            transform: Transform::from_xyz(0.0, 0.0, layer_id as f32),
                             ..default()
                         });
                     }

examples/helpers/mod.rs

@@ -1,3 +1,4 @@
+pub mod anchor;
 pub mod camera;
 pub mod ldtk;
 pub mod tiled;

examples/helpers/tiled.rs

@@ -380,12 +380,8 @@ pub fn process_loaded_maps(
                             texture: tilemap_texture.clone(),
                             tile_size,
                             spacing: tile_spacing,
-                            transform: get_tilemap_center_transform(
-                                &map_size,
-                                &grid_size,
-                                &map_type,
-                                layer_index as f32,
-                            ) * Transform::from_xyz(offset_x, -offset_y, 0.0),
+                            anchor: TilemapAnchor::Center,
+                            transform: Transform::from_xyz(offset_x, -offset_y, layer_index as f32),
                             map_type,
                             render_settings: *render_settings,
                             ..Default::default()