feat: add building_well class definition

what:
 + add implementation for updating well image based on average desirability
 +add window info background for well building

Author: s.kushnirenko

src/building/building.cpp

@@ -16,6 +16,7 @@
 #include "building/building_booth.h"
 #include "building/building_health.h"
 #include "building/building_pottery.h"
+#include "building/building_well.h"
 #include "city/buildings.h"
 #include "city/population.h"
 #include "city/warning.h"
@@ -330,6 +331,7 @@ building_impl *building::dcast() {
     case BUILDING_BOOTH: _ptr = new building_booth(*this); break;
     case BUILDING_APOTHECARY: _ptr = new building_apothecary(*this); break;
     case BUILDING_POTTERY_WORKSHOP: _ptr = new building_pottery(*this); break;
+    case BUILDING_WELL: _ptr = new building_well(*this); break;
 
     case BUILDING_SMALL_MASTABA:
     case BUILDING_SMALL_MASTABA_SIDE:
@@ -497,14 +499,11 @@ e_overlay building::get_overlay() const {
         case BUILDING_JUGGLER_SCHOOL:
             return OVERLAY_BOOTH;
 
-        case BUILDING_WELL:
-            return OVERLAY_WATER;
-
         case BUILDING_PHYSICIAN:
             return OVERLAY_PHYSICIAN;
     }
 
-    return OVERLAY_NONE;
+    return const_cast<building*>(this)->dcast()->get_overlay();
 }
 
 void building_clear_all() {

src/building/building.h

@@ -383,10 +383,13 @@ class building_impl {
     virtual void on_create() {}
     virtual void spawn_figure() {}
     virtual void update_graphic() {}
+    virtual void update_month() {}
     virtual void update_day() {}
     virtual void window_info_background(object_info &ctx) {}
     virtual void window_info_foreground(object_info &ctx) {}
     virtual bool draw_ornaments_and_animations_height(vec2i point, tile2i tile, painter &ctx);
+    virtual e_overlay get_overlay() const { return OVERLAY_NONE; }
+    virtual bool need_road_access() const { return true; }
 
     inline bool is_main() { return base.is_main(); }
     inline figure *create_roaming_figure(e_figure_type _type, e_figure_action created_action, e_building_slot slot) { return base.create_roaming_figure(_type, created_action, slot); }
@@ -395,6 +398,7 @@ class building_impl {
     inline tile2i tile() const { return base.tile; }
     inline e_building_type type() const { return base.type; }
 
+
     building &base;
     building::impl_data_t &data;
 };

src/building/building_well.cpp

@@ -0,0 +1,33 @@
+#include "building_well.h"
+
+#include "grid/desirability.h"
+#include "grid/image.h"
+#include "grid/water_supply.h"
+#include "window/building/common.h"
+#include "graphics/elements/panel.h"
+#include "graphics/elements/lang_text.h"
+
+void building_well::update_month() {
+    int avg_desirability = map_desirabilty_avg(tile(), 4);
+    map_image_set(tile(), avg_desirability > 30 ? IMG_WELL_FANCY : IMG_WELL);
+}
+
+void building_well::window_info_background(object_info &c) {
+    c.help_id = 62;
+    window_building_play_sound(&c, "wavs/well.wav");
+    outer_panel_draw(c.offset, c.width_blocks, c.height_blocks);
+    lang_text_draw_centered(109, 0, c.offset.x, c.offset.y + 10, 16 * c.width_blocks, FONT_LARGE_BLACK_ON_LIGHT);
+    int well_necessity = map_water_supply_is_well_unnecessary(c.building_id, 2);
+    int text_id = 0;
+    if (well_necessity == WELL_NECESSARY) { // well is OK
+        text_id = 1;
+    } else if (well_necessity == WELL_UNNECESSARY_FOUNTAIN) { // all houses have fountain
+        text_id = 2;
+    } else if (well_necessity == WELL_UNNECESSARY_NO_HOUSES) { // no houses around
+        text_id = 3;
+    }
+
+    if (text_id) {
+        window_building_draw_description_at(c, 16 * c.height_blocks - 160, 109, text_id);
+    }
+}

src/building/building_well.h

@@ -0,0 +1,12 @@
+#pragma once
+
+#include "building/building.h"
+
+class building_well : public building_impl {
+public:
+    building_well(building &b) : building_impl(b) {}
+    //virtual void on_create() override;
+    virtual void update_month() override;
+    virtual bool need_road_access() const { return false; }
+    virtual void window_info_background(object_info &ctx) override;
+};

src/building/figure.cpp

@@ -1136,10 +1136,8 @@ void building::update_month() {
         }
         break;
 
-    case BUILDING_WELL: {
-            int avg_desirability = map_desirabilty_avg(tile, 4);
-            map_image_set(tile, avg_desirability > 30 ? IMG_WELL_FANCY : IMG_WELL);
-        }
+    default:
+        dcast()->update_month();
         break;
     }
 }

src/city/warnings.h

@@ -1,7 +1,6 @@
 #pragma once
 
-#include "building/building_type.h"
-#include "grid/point.h"
+#include "building/building.h"
 
 void building_construction_warning_reset(void);
 void building_construction_warning_check_food_stocks(int type);

src/grid/terrain.cpp

@@ -45,11 +45,11 @@ void map_terrain_add_in_area(int x_min, int y_min, int x_max, int y_max, int ter
         }
     }
 }
-void map_terrain_add_with_radius(int x, int y, int size, int radius, int terrain) {
-    grid_area area = map_grid_get_area(tile2i(x, y), size, radius);
+void map_terrain_add_with_radius(tile2i tile, int size, int radius, int terrain) {
+    grid_area area = map_grid_get_area(tile, size, radius);
 
-    map_grid_area_foreach(area.tmin, area.tmax, [&] (tile2i tile) {
-        map_terrain_add(tile.grid_offset(), terrain);
+    map_grid_area_foreach(area.tmin, area.tmax, [&] (tile2i t) {
+        map_terrain_add(t.grid_offset(), terrain);
     });
 }
 void map_terrain_remove_with_radius(int x, int y, int size, int radius, int terrain) {

src/grid/terrain.h

@@ -91,7 +91,7 @@ void map_terrain_remove(int grid_offset, int terrain);
 
 void map_terrain_add_in_area(int x_min, int y_min, int x_max, int y_max, int terrain);
 
-void map_terrain_add_with_radius(int x, int y, int size, int radius, int terrain);
+void map_terrain_add_with_radius(tile2i tile, int size, int radius, int terrain);
 
 void map_terrain_remove_with_radius(int x, int y, int size, int radius, int terrain);
 

src/grid/water_supply.cpp

@@ -63,8 +63,7 @@ void map_water_supply_update_houses() {
         } else if (b.house_size) {
             b.has_water_access = false;
             b.has_well_access = 0;
-            if (b.data.house.water_supply
-                || map_terrain_exists_tile_in_area_with_type(b.tile.x(), b.tile.y(), b.size, TERRAIN_FOUNTAIN_RANGE)) {
+            if (b.data.house.water_supply|| map_terrain_exists_tile_in_area_with_type(b.tile.x(), b.tile.y(), b.size, TERRAIN_FOUNTAIN_RANGE)) {
                 b.has_water_access = true;
             }
         }
@@ -120,7 +119,7 @@ static void fill_canals_from_offset(int grid_offset) {
         if (image_id >= image_without_water) {
             map_image_set(grid_offset, image_id - IMAGE_CANAL_FULL_OFFSET);
         }
-        map_terrain_add_with_radius(MAP_X(grid_offset), MAP_Y(grid_offset), 1, 2, TERRAIN_IRRIGATION_RANGE);
+        map_terrain_add_with_radius(tile2i(grid_offset), 1, 2, TERRAIN_IRRIGATION_RANGE);
 
         next_offset = -1;
         for (int i = 0; i < 4; i++) {
@@ -201,7 +200,7 @@ static void update_canals_from_water_lifts() {
             if (b->has_water_access) {
                 fill_canals_from_offset(b->tile.grid_offset() + OUTPUT_OFFSETS[b->data.industry.orientation][0]);
                 fill_canals_from_offset(b->tile.grid_offset() + OUTPUT_OFFSETS[b->data.industry.orientation][1]);
-                map_terrain_add_with_radius(b->tile.x(), b->tile.y(), 2, 2, TERRAIN_IRRIGATION_RANGE);
+                map_terrain_add_with_radius(b->tile, 2, 2, TERRAIN_IRRIGATION_RANGE);
             }
         }
     }
@@ -219,14 +218,12 @@ void map_update_canals(void) {
     update_canals_from_water_lifts();
 }
 
-void map_update_wells_range(void) {
+void map_update_wells_range() {
     OZZY_PROFILER_SECTION("Game/Run/Tick/Wells Range Update");
     map_terrain_remove_all(TERRAIN_FOUNTAIN_RANGE);
-    buildings_valid_do([&](building& b) {
-        if (b.type == BUILDING_WELL) {
-            map_terrain_add_with_radius(b.tile.x(), b.tile.y(), 1, 3, TERRAIN_FOUNTAIN_RANGE);
-        }
-    });
+    buildings_valid_do([](building& b) {
+        map_terrain_add_with_radius(b.tile, 1, 3, TERRAIN_FOUNTAIN_RANGE);
+    }, BUILDING_WELL);
 }
 
 e_well_status map_water_supply_is_well_unnecessary(int well_id, int radius) {

src/window/building/utility.cpp

@@ -220,22 +220,6 @@ void window_building_draw_water_supply(object_info* c) {
     inner_panel_draw(c->offset.x + 16, c->offset.y + 144, c->width_blocks - 2, 4);
     window_building_draw_employment(c, 150);
 }
-void window_building_draw_well(object_info* c) {
-    c->help_id = 62;
-    window_building_play_sound(c, "wavs/well.wav");
-    outer_panel_draw(c->offset, c->width_blocks, c->height_blocks);
-    lang_text_draw_centered(109, 0, c->offset.x, c->offset.y + 10, 16 * c->width_blocks, FONT_LARGE_BLACK_ON_LIGHT);
-    int well_necessity = map_water_supply_is_well_unnecessary(c->building_id, 2);
-    int text_id = 0;
-    if (well_necessity == WELL_NECESSARY) // well is OK
-        text_id = 1;
-    else if (well_necessity == WELL_UNNECESSARY_FOUNTAIN) // all houses have fountain
-        text_id = 2;
-    else if (well_necessity == WELL_UNNECESSARY_NO_HOUSES) // no houses around
-        text_id = 3;
-    if (text_id)
-        window_building_draw_description_at(c, 16 * c->height_blocks - 160, 109, text_id);
-}
 
 void window_building_draw_mission_post(object_info* c) {
     c->help_id = 8;

src/window/building/utility.h

@@ -19,7 +19,6 @@ void window_building_draw_water_lift(object_info* c);
 void window_building_draw_aqueduct(object_info* c);
 void window_building_draw_fountain(object_info* c);
 void window_building_draw_water_supply(object_info* c);
-void window_building_draw_well(object_info* c);
 
 void window_building_draw_mission_post(object_info* c);
 void window_building_draw_native_hut(object_info* c);

src/window/window_building_info.cpp

@@ -727,7 +727,6 @@ static void draw_refresh_background() {
             case BUILDING_WATER_LIFT: window_building_draw_water_lift(&context); break;
             case BUILDING_MENU_BEAUTIFICATION: window_building_draw_fountain(&context); break;
             case BUILDING_WATER_SUPPLY: window_building_draw_water_supply(&context); break;
-            case BUILDING_WELL: window_building_draw_well(&context); break;
 
             case BUILDING_SMALL_STATUE:
             case BUILDING_MEDIUM_STATUE: