gardens: moved gardens logic to own files, add terrain flag that mark planer future tiles

Author: dalerank

src/building/building_entertainment.cpp

@@ -4,6 +4,7 @@
 #include "grid/terrain.h"
 #include "grid/tiles.h"
 #include "grid/image.h"
+#include "grid/gardens.h"
 #include "grid/building_tiles.h"
 #include "graphics/view/view.h"
 
@@ -82,7 +83,7 @@ void building_entertainment::place_latch_on_venue(e_building_type type, int dx,
     switch (type) {
     case BUILDING_GARDENS:
         map_terrain_add(point, TERRAIN_GARDEN);
-        map_tiles_update_all_gardens();
+        map_tiles_gardens_update_all();
         break;
 
     case BUILDING_BOOTH:

src/building/building_garden.cpp

@@ -16,6 +16,7 @@
 #include "grid/terrain.h"
 #include "grid/property.h"
 #include "grid/image.h"
+#include "grid/gardens.h"
 #include "grid/random.h"
 #include "grid/building_tiles.h"
 #include "figure/formation_herd.h"
@@ -26,42 +27,43 @@
 
 building_garden::static_params garden_m;
 
-int building_garden::static_params::place_impl(tile2i start, tile2i end) const {
+int building_garden::static_params::place_impl(tile2i start, tile2i end, bool place) const {
     game_undo_restore_map(1);
 
     grid_area area = map_grid_get_area(start, end);
 
     int items_placed = 0;
-    map_grid_area_foreach(area.tmin, area.tmax, [&] (tile2i tile) {
-        int grid_offset = tile.grid_offset();
-        if (map_terrain_is(grid_offset, TERRAIN_NOT_CLEAR)) {
+    map_grid_area_foreach(area.tmin, area.tmax, [&] (tile2i rtile) {
+        if (map_terrain_is(rtile, TERRAIN_NOT_CLEAR)) {
             return;
         }
 
-        if (map_terrain_exists_tile_in_radius_with_type(tile, 1, 1, TERRAIN_FLOODPLAIN)) {
+        if (map_terrain_exists_tile_in_radius_with_type(rtile, 1, 1, TERRAIN_FLOODPLAIN)) {
             return;
         }
 
-        if (formation_herd_breeding_ground_at(tile, 1)) {
+        if (formation_herd_breeding_ground_at(rtile, 1)) {
             map_property_clear_constructing_and_deleted();
             city_warning_show(WARNING_HERD_BREEDING_GROUNDS);
-        } else {
-            items_placed++;
-            map_terrain_add(grid_offset, TERRAIN_GARDEN);
-        }
+            return;
+        } 
+
+        items_placed++;
+        int addition_flag = place ? 0 : TERRAIN_PLANER_FUTURE;
+        map_terrain_add(rtile, TERRAIN_GARDEN| addition_flag);
     });
-    map_tiles_update_all_gardens();
+    map_tiles_gardens_update_all();
 
     return items_placed;
 }
 
 int building_garden::static_params::planer_construction_update(build_planner &planer, tile2i start, tile2i end) const {
-    return place_impl(start, end);
+    return place_impl(start, end, false);
 }
 
 int building_garden::static_params::planer_construction_place(build_planner &planer, tile2i start, tile2i end, int orientation, int variant) const {
     planer.should_update_land_routing = true;
-    return place_impl(start, end);
+    return place_impl(start, end, true);
 }
 
 void building_garden::on_place_checks() {  /*nothing*/ }

src/building/building_garden.h

@@ -10,7 +10,7 @@ class building_garden : public building_impl {
     virtual building_garden *dcast_garden() override { return this; }
 
     struct static_params : public buildings::model_t<building_garden> {
-        int place_impl(tile2i start, tile2i end) const;
+        int place_impl(tile2i start, tile2i end, bool place) const;
         virtual int planer_construction_update(build_planner &planer, tile2i start, tile2i end) const override;
         virtual int planer_construction_place(build_planner &planer, tile2i start, tile2i end, int orientation, int variant) const override;
     };

src/building/building_house.cpp

@@ -18,6 +18,7 @@
 #include "grid/grid.h"
 #include "grid/tiles.h"
 #include "grid/image.h"
+#include "grid/gardens.h"
 #include "grid/random.h"
 #include "grid/terrain.h"
 #include "config/config.h"
@@ -1020,7 +1021,7 @@ bool building_house_spacious_apartment::evolve(house_demands* demands) {
             if (can_expand(4)) {
                 base.house_is_merged = 0;
                 expand_to_common_residence();
-                map_tiles_update_all_gardens();
+                map_tiles_gardens_update_all();
                 return true;
             }
         } else if (status == e_house_decay) {
@@ -1091,7 +1092,7 @@ bool building_house_fancy_residence::evolve(house_demands* demands) {
         if (status == e_house_evolve) {
             if (can_expand(9)) {
                 expand_to_common_manor();
-                map_tiles_update_all_gardens();
+                map_tiles_gardens_update_all();
                 return true;
             }
         } else if (status == e_house_decay) {
@@ -1159,7 +1160,7 @@ bool building_house_stately_manor::evolve(house_demands* demands) {
         if (status == e_house_evolve) {
             if (can_expand(16)) {
                 expand_to_modest_estate();
-                map_tiles_update_all_gardens();
+                map_tiles_gardens_update_all();
                 return true;
             }
         } else if (status == e_house_decay) {

src/building/construction/clear.cpp

@@ -10,6 +10,7 @@
 #include "graphics/window.h"
 #include "grid/canals.h"
 #include "grid/bridge.h"
+#include "grid/gardens.h"
 #include "grid/building.h"
 #include "grid/building_tiles.h"
 #include "grid/grid.h"
@@ -166,7 +167,7 @@ static int clear_land_confirmed(bool measure_only, clear_confirm_t confirm) {
         map_tiles_update_region_empty_land(true, area.tmin, area.tmax);
         map_tiles_update_region_meadow(x_min, y_min, x_max, y_max);
         map_tiles_update_region_rubble(x_min, y_min, x_max, y_max);
-        map_tiles_update_all_gardens();
+        map_tiles_gardens_update_all();
         map_tiles_update_area_roads(x_min, y_min, radius);
         map_tiles_update_all_plazas();
         map_tiles_update_area_walls(area.tmin, radius);

src/grid/gardens.cpp

@@ -0,0 +1,26 @@
+#include "grid/gardens.h"
+
+#include "grid/tiles.h"
+#include "grid/terrain.h"
+#include "grid/image.h"
+#include "grid/property.h"
+#include "building/building_garden.h"
+
+void map_tiles_gardens_clear_garden_image(int grid_offset) {
+    const bool is_garden = map_terrain_is(grid_offset, TERRAIN_GARDEN);
+    const bool is_elevation = map_terrain_is(grid_offset, TERRAIN_ELEVATION | TERRAIN_ACCESS_RAMP);
+    if (is_garden && !is_elevation) {
+        map_image_set(grid_offset, 0);
+        map_property_set_multi_tile_size(grid_offset, 1);
+        map_property_mark_draw_tile(grid_offset);
+    }
+}
+
+void map_tiles_gardens_update_all() {
+    map_tiles_foreach_map_tile(map_tiles_gardens_clear_garden_image);
+    map_tiles_foreach_map_tile(building_garden::set_image);
+}
+
+void map_tiles_gardens_determine() {
+    map_tiles_foreach_map_tile(building_garden::determine_tile);
+}

src/grid/gardens.h

@@ -0,0 +1,4 @@
+#pragma once
+
+void map_tiles_gardens_update_all();
+void map_tiles_gardens_determine();

src/grid/orientation.cpp

@@ -19,6 +19,7 @@
 #include "grid/grid.h"
 #include "grid/trees.h"
 #include "grid/property.h"
+#include "grid/gardens.h"
 #include "grid/routing/routing_terrain.h"
 #include "grid/terrain.h"
 #include "grid/tiles.h"
@@ -54,7 +55,7 @@ void map_orientation_change(int counter_clockwise) {
     map_tiles_river_refresh_entire();
     map_tiles_update_all_earthquake();
     map_tiles_update_all_rocks();
-    map_tiles_update_all_gardens();
+    map_tiles_gardens_update_all();
 
     map_tiles_add_entry_exit_flags();
 

src/grid/terrain.h

@@ -38,7 +38,7 @@ enum e_terrain : uint32_t {
     TERRAIN_DUNE = 0x2000000,
     TERRAIN_DEEPWATER = 0x4000000,
     TERRAIN_SUBMERGED_ROAD = 0x8000000,
-    TERRAIN_UNK_07 = 0x10000000,
+    TERRAIN_PLANER_FUTURE = 0x10000000,
     TERRAIN_UNK_08 = 0x20000000,
     TERRAIN_UNK_09 = 0x40000000,
     TERRAIN_SHORE = 0x80000000,

src/grid/tiles.cpp

@@ -230,24 +230,6 @@ void map_tiles_update_region_shrub(int x_min, int y_min, int x_max, int y_max) {
     map_tiles_foreach_region_tile(tile2i(x_min, y_min), tile2i(x_max, y_max), set_shrub_image);
 }
 
-static void clear_garden_image(int grid_offset) {
-    if (map_terrain_is(grid_offset, TERRAIN_GARDEN)
-        && !map_terrain_is(grid_offset, TERRAIN_ELEVATION | TERRAIN_ACCESS_RAMP)) {
-        map_image_set(grid_offset, 0);
-        map_property_set_multi_tile_size(grid_offset, 1);
-        map_property_mark_draw_tile(grid_offset);
-    }
-}
-
-void map_tiles_update_all_gardens(void) {
-    map_tiles_foreach_map_tile(clear_garden_image);
-    map_tiles_foreach_map_tile(building_garden::set_image);
-}
-
-void map_tiles_determine_gardens(void) {
-    map_tiles_foreach_map_tile(building_garden::determine_tile);
-}
-
 static void remove_plaza_below_building(int grid_offset) {
     if (map_terrain_is(grid_offset, TERRAIN_ROAD) && map_property_is_plaza_or_earthquake(grid_offset)) {
         if (map_terrain_is(grid_offset, TERRAIN_BUILDING))