frame.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2006 - 2024
    by Jeremy Rosen <jeremy.rosen@enst-bretagne.fr>
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.
 
    See the COPYING file for more details.
*/
 
#include "units/frame.hpp"
 
#include "color.hpp"
#include "draw.hpp"
#include "game_display.hpp"
#include "log.hpp"
#include "sound.hpp"
 
static lg::log_domain log_engine("engine");
#define ERR_NG LOG_STREAM(err, log_engine)
 
frame_parameters::frame_parameters()
    : duration(0)
    , halo_x(0)
    , halo_y(0)
    , blend_ratio(0.0)
    , highlight_ratio(1.0)
    , offset(0)
    , submerge(0.0)
    , x(0)
    , y(0)
    , directional_x(0)
    , directional_y(0)
    , auto_vflip(boost::logic::indeterminate)
    , auto_hflip(boost::logic::indeterminate)
    , primary_frame(boost::logic::indeterminate)
    , drawing_layer(display::LAYER_UNIT_DEFAULT - display::LAYER_UNIT_FIRST)
{}
 
frame_builder::frame_builder()
    : duration_(1)
    , auto_vflip_(boost::logic::indeterminate)
    , auto_hflip_(boost::logic::indeterminate)
    , primary_frame_(boost::logic::indeterminate)
    , drawing_layer_(std::to_string(display::LAYER_UNIT_DEFAULT - display::LAYER_UNIT_FIRST))
{}
 
frame_builder::frame_builder(const config& cfg,const std::string& frame_string)
    : duration_(1)
    , image_(cfg[frame_string + "image"])
    , image_diagonal_(cfg[frame_string + "image_diagonal"])
    , image_mod_(cfg[frame_string + "image_mod"])
    , halo_(cfg[frame_string + "halo"])
    , halo_x_(cfg[frame_string + "halo_x"])
    , halo_y_(cfg[frame_string + "halo_y"])
    , halo_mod_(cfg[frame_string + "halo_mod"])
    , sound_(cfg[frame_string + "sound"])
    , text_(cfg[frame_string + "text"])
    , blend_ratio_(cfg[frame_string + "blend_ratio"])
    , highlight_ratio_(cfg[frame_string + "alpha"])
    , offset_(cfg[frame_string + "offset"])
    , submerge_(cfg[frame_string + "submerge"])
    , x_(cfg[frame_string + "x"])
    , y_(cfg[frame_string + "y"])
    , directional_x_(cfg[frame_string + "directional_x"])
    , directional_y_(cfg[frame_string + "directional_y"])
    , auto_vflip_(boost::logic::indeterminate)
    , auto_hflip_(boost::logic::indeterminate)
    , primary_frame_(boost::logic::indeterminate)
    , drawing_layer_(cfg[frame_string + "layer"])
{
    if(cfg.has_attribute(frame_string + "auto_vflip")) {
        auto_vflip_ = cfg[frame_string + "auto_vflip"].to_bool();
    }
 
    if(cfg.has_attribute(frame_string + "auto_hflip")) {
        auto_hflip_ = cfg[frame_string + "auto_hflip"].to_bool();
    }
 
    if(cfg.has_attribute(frame_string + "primary")) {
        primary_frame_ = cfg[frame_string + "primary"].to_bool();
    }
 
    const auto& text_color_key = cfg[frame_string + "text_color"];
    if(!text_color_key.empty()) {
        try {
            text_color_ = color_t::from_rgb_string(text_color_key);
        } catch(const std::invalid_argument& e) {
            // Might be thrown either due to an incorrect number of elements or std::stoul failure.
            ERR_NG << "Invalid RBG text color in unit animation: " << text_color_key.str()
                << "\n" << e.what();
        }
    }
 
    if(const config::attribute_value* v = cfg.get(frame_string + "duration")) {
        duration(*v);
    } else if(!cfg.get(frame_string + "end")) {
        int halo_duration = (progressive_string(halo_, 1)).duration();
        int image_duration = (progressive_image(image_, 1)).duration();
        int image_diagonal_duration = (progressive_image(image_diagonal_, 1)).duration();
 
        duration(std::max(std::max(image_duration, image_diagonal_duration), halo_duration));
    } else {
        duration(cfg[frame_string + "end"].to_int() - cfg[frame_string + "begin"].to_int());
    }
 
    duration_ = std::max(duration_, 1);
 
    const auto& blend_color_key = cfg[frame_string + "blend_color"];
    if(!blend_color_key.empty()) {
        try {
            blend_with_ = color_t::from_rgb_string(blend_color_key);
        } catch(const std::invalid_argument& e) {
            // Might be thrown either due to an incorrect number of elements or std::stoul failure.
            ERR_NG << "Invalid RBG blend color in unit animation: " << blend_color_key.str()
                << "\n" << e.what();
        }
    }
}
 
frame_builder& frame_builder::image(const std::string& image ,const std::string&  image_mod)
{
    image_ = image;
    image_mod_ = image_mod;
    return *this;
}
 
frame_builder& frame_builder::image_diagonal(const std::string& image_diagonal,const std::string& image_mod)
{
    image_diagonal_ = image_diagonal;
    image_mod_ = image_mod;
    return *this;
}
 
frame_builder& frame_builder::sound(const std::string& sound)
{
    sound_ = sound;
    return *this;
}
 
frame_builder& frame_builder::text(const std::string& text,const color_t text_color)
{
    text_ = text;
    text_color_ = text_color;
    return *this;
}
 
frame_builder& frame_builder::halo(const std::string& halo, const std::string& halo_x, const std::string& halo_y,const std::string&  halo_mod)
{
    halo_ = halo;
    halo_x_ = halo_x;
    halo_y_ = halo_y;
    halo_mod_= halo_mod;
    return *this;
}
 
frame_builder& frame_builder::duration(const int duration)
{
    duration_ = duration;
    return *this;
}
 
frame_builder& frame_builder::blend(const std::string& blend_ratio,const color_t blend_color)
{
    blend_with_ = blend_color;
    blend_ratio_ = blend_ratio;
    return *this;
}
 
frame_builder& frame_builder::highlight(const std::string& highlight)
{
    highlight_ratio_ = highlight;
    return *this;
}
 
frame_builder& frame_builder::offset(const std::string& offset)
{
    offset_ = offset;
    return *this;
}
 
frame_builder& frame_builder::submerge(const std::string& submerge)
{
    submerge_ = submerge;
    return *this;
}
 
frame_builder& frame_builder::x(const std::string& x)
{
    x_ = x;
    return *this;
}
 
frame_builder& frame_builder::y(const std::string& y)
{
    y_ = y;
    return *this;
}
 
frame_builder& frame_builder::directional_x(const std::string& directional_x)
{
    directional_x_ = directional_x;
    return *this;
}
 
frame_builder& frame_builder::directional_y(const std::string& directional_y)
{
    directional_y_ = directional_y;
    return *this;
}
 
frame_builder& frame_builder::auto_vflip(const bool auto_vflip)
{
    auto_vflip_ = auto_vflip;
    return *this;
}
 
frame_builder& frame_builder::auto_hflip(const bool auto_hflip)
{
    auto_hflip_ = auto_hflip;
    return *this;
}
 
frame_builder& frame_builder::primary_frame(const bool primary_frame)
{
    primary_frame_ = primary_frame;
    return *this;
}
 
frame_builder& frame_builder::drawing_layer(const std::string& drawing_layer)
{
    drawing_layer_=drawing_layer;
    return *this;
}
 
frame_parsed_parameters::frame_parsed_parameters(const frame_builder& builder, int duration)
    : duration_(duration ? duration : builder.duration_)
    , image_(builder.image_,duration_)
    , image_diagonal_(builder.image_diagonal_,duration_)
    , image_mod_(builder.image_mod_)
    , halo_(builder.halo_,duration_)
    , halo_x_(builder.halo_x_,duration_)
    , halo_y_(builder.halo_y_,duration_)
    , halo_mod_(builder.halo_mod_)
    , sound_(builder.sound_)
    , text_(builder.text_)
    , text_color_(builder.text_color_)
    , blend_with_(builder.blend_with_)
    , blend_ratio_(builder.blend_ratio_,duration_)
    , highlight_ratio_(builder.highlight_ratio_,duration_)
    , offset_(builder.offset_,duration_)
    , submerge_(builder.submerge_,duration_)
    , x_(builder.x_,duration_)
    , y_(builder.y_,duration_)
    , directional_x_(builder.directional_x_,duration_)
    , directional_y_(builder.directional_y_,duration_)
    , auto_vflip_(builder.auto_vflip_)
    , auto_hflip_(builder.auto_hflip_)
    , primary_frame_(builder.primary_frame_)
    , drawing_layer_(builder.drawing_layer_,duration_)
{}
 
bool frame_parsed_parameters::does_not_change() const
{
    return
        image_.does_not_change() &&
        image_diagonal_.does_not_change() &&
        halo_.does_not_change() &&
        halo_x_.does_not_change() &&
        halo_y_.does_not_change() &&
        blend_ratio_.does_not_change() &&
        highlight_ratio_.does_not_change() &&
        offset_.does_not_change() &&
        submerge_.does_not_change() &&
        x_.does_not_change() &&
        y_.does_not_change() &&
        directional_x_.does_not_change() &&
        directional_y_.does_not_change() &&
        drawing_layer_.does_not_change();
}
 
bool frame_parsed_parameters::need_update() const
{
    return !this->does_not_change();
}
 
const frame_parameters frame_parsed_parameters::parameters(int current_time) const
{
    frame_parameters result;
    result.duration = duration_;
    result.image = image_.get_current_element(current_time);
    result.image_diagonal = image_diagonal_.get_current_element(current_time);
    result.image_mod = image_mod_;
    result.halo = halo_.get_current_element(current_time);
    result.halo_x = halo_x_.get_current_element(current_time);
    result.halo_y = halo_y_.get_current_element(current_time);
    result.halo_mod = halo_mod_;
    result.sound = sound_;
    result.text = text_;
    result.text_color = text_color_;
    result.blend_with = blend_with_;
    result.blend_ratio = blend_ratio_.get_current_element(current_time);
    result.highlight_ratio = highlight_ratio_.get_current_element(current_time,1.0);
    result.offset = offset_.get_current_element(current_time,-1000);
    result.submerge = submerge_.get_current_element(current_time);
    result.x = x_.get_current_element(current_time);
    result.y = y_.get_current_element(current_time);
    result.directional_x = directional_x_.get_current_element(current_time);
    result.directional_y = directional_y_.get_current_element(current_time);
    result.auto_vflip = auto_vflip_;
    result.auto_hflip = auto_hflip_;
    result.primary_frame = primary_frame_;
    result.drawing_layer = drawing_layer_.get_current_element(current_time,display::LAYER_UNIT_DEFAULT-display::LAYER_UNIT_FIRST);
    return result;
}
 
void frame_parsed_parameters::override(int duration,
        const std::string& highlight,
        const std::string& blend_ratio,
        color_t blend_color,
        const std::string& offset,
        const std::string& layer,
        const std::string& modifiers)
{
    if(!highlight.empty()) {
        highlight_ratio_ = progressive_double(highlight,duration);
    } else if(duration != duration_){
        highlight_ratio_ = progressive_double(highlight_ratio_.get_original(),duration);
    }
 
    if(!offset.empty()) {
        offset_ = progressive_double(offset,duration);
    } else if(duration != duration_){
        offset_ = progressive_double(offset_.get_original(),duration);
    }
 
    if(!blend_ratio.empty()) {
        blend_ratio_ = progressive_double(blend_ratio,duration);
        blend_with_  = blend_color;
    } else if(duration != duration_){
        blend_ratio_ = progressive_double(blend_ratio_.get_original(),duration);
    }
 
    if(!layer.empty()) {
        drawing_layer_ = progressive_int(layer,duration);
    } else if(duration != duration_){
        drawing_layer_ = progressive_int(drawing_layer_.get_original(),duration);
    }
 
    if(!modifiers.empty()) {
        image_mod_ += modifiers;
    }
 
    if(duration != duration_) {
        image_ = progressive_image(image_.get_original(), duration);
        image_diagonal_ = progressive_image(image_diagonal_.get_original(), duration);
        halo_ = progressive_string(halo_.get_original(), duration);
        halo_x_ = progressive_int(halo_x_.get_original(), duration);
        halo_y_ = progressive_int(halo_y_.get_original(), duration);
        submerge_ = progressive_double(submerge_.get_original(), duration);
        x_ = progressive_int(x_.get_original(), duration);
        y_ = progressive_int(y_.get_original(), duration);
        directional_x_ = progressive_int(directional_x_.get_original(), duration);
        directional_y_ = progressive_int(directional_y_.get_original(), duration);
        duration_ = duration;
    }
}
 
std::vector<std::string> frame_parsed_parameters::debug_strings() const
{
    std::vector<std::string> v;
 
    if(duration_ > 0) {
        v.emplace_back("duration=" + utils::half_signed_value(duration_));
    }
 
    if(!image_.get_original().empty()) {
        v.emplace_back("image=" + image_.get_original());
    }
 
    if(!image_diagonal_.get_original().empty()) {
        v.emplace_back("image_diagonal=" + image_diagonal_.get_original());
    }
 
    if(!image_mod_.empty()) {
        v.emplace_back("image_mod=" + image_mod_);
    }
 
    if(!halo_.get_original().empty()) {
        v.emplace_back("halo=" + halo_.get_original());
    }
 
    if(!halo_x_.get_original().empty()) {
        v.emplace_back("halo_x=" + halo_x_.get_original());
    }
 
    if(!halo_y_.get_original().empty()) {
        v.emplace_back("halo_y=" + halo_y_.get_original());
    }
 
    if(!halo_mod_.empty()) {
        v.emplace_back("halo_mod=" + halo_mod_);
    }
 
    if(!sound_.empty()) {
        v.emplace_back("sound=" + sound_);
    }
 
    if(!text_.empty()) {
        v.emplace_back("text=" + text_);
 
        if(text_color_) {
            v.emplace_back("text_color=" + text_color_->to_rgba_string());
        }
    }
 
    if(!blend_ratio_.get_original().empty()) {
        v.emplace_back("blend_ratio=" + blend_ratio_.get_original());
 
        if(blend_with_) {
            v.emplace_back("blend_with=" + blend_with_->to_rgba_string());
        }
    }
 
    if(!highlight_ratio_.get_original().empty()) {
        v.emplace_back("highlight_ratio=" + highlight_ratio_.get_original());
    }
 
    if(!offset_.get_original().empty()) {
        v.emplace_back("offset=" + offset_.get_original());
    }
 
    if(!submerge_.get_original().empty()) {
        v.emplace_back("submerge=" + submerge_.get_original());
    }
 
    if(!x_.get_original().empty()) {
        v.emplace_back("x=" + x_.get_original());
    }
 
    if(!y_.get_original().empty()) {
        v.emplace_back("y=" + y_.get_original());
    }
 
    if(!directional_x_.get_original().empty()) {
        v.emplace_back("directional_x=" + directional_x_.get_original());
    }
 
    if(!directional_y_.get_original().empty()) {
        v.emplace_back("directional_y=" + directional_y_.get_original());
    }
 
    if(!boost::indeterminate(auto_vflip_)) {
        v.emplace_back("auto_vflip=" + utils::bool_string(static_cast<bool>(auto_vflip_)));
    }
 
    if(!boost::indeterminate(auto_hflip_)) {
        v.emplace_back("auto_hflip=" + utils::bool_string(static_cast<bool>(auto_hflip_)));
    }
 
    if(!boost::indeterminate(primary_frame_)) {
        v.emplace_back("primary_frame=" + utils::bool_string(static_cast<bool>(primary_frame_)));
    }
 
    if(!drawing_layer_.get_original().empty()) {
        v.emplace_back("drawing_layer=" + drawing_layer_.get_original());
    }
 
    return v;
}
 
namespace
{
void render_unit_image(
    int x,
    int y,
    const display::drawing_layer drawing_layer,
    const map_location& loc,
    const image::locator& i_locator,
    bool hreverse,
    bool greyscale,
    uint8_t alpha,
    double highlight,
    color_t blendto,
    double blend_ratio,
    double submerge,
    bool vreverse)
{
    const point image_size = image::get_size(i_locator);
    if(!image_size.x || !image_size.y) {
        return;
    }
 
    display* disp = display::get_singleton();
 
    rect dest = disp->scaled_to_zoom({x, y, image_size.x, image_size.y});
    if(!dest.overlaps(disp->map_area())) {
        return;
    }
 
    // For now, we add to the existing IPF modifications for the image.
    std::string new_modifications;
 
    if(greyscale) {
        new_modifications += "~GS()";
    }
 
    texture tex;
    if(!new_modifications.empty()) {
        tex = image::get_texture({i_locator.get_filename(), i_locator.get_modifications() + new_modifications});
    } else {
        tex = image::get_texture(i_locator);
    }
 
    // Clamp blend ratio so nothing weird happens
    blend_ratio = std::clamp(blend_ratio, 0.0, 1.0);
 
    submerge_data data = display::get_submerge_data(dest, submerge, image_size, alpha, hreverse, vreverse);
 
    disp->drawing_buffer_add(drawing_layer, loc, [=](const rect&) mutable {
        tex.set_alpha_mod(alpha);
        if(submerge > 0.0) {
            // set clip for dry part
            // smooth_shaded doesn't use the clip information so it's fine to set it up front
            tex.set_src(data.unsub_src);
 
            // draw underwater part
            draw::smooth_shaded(tex, data.alpha_verts);
        }
        // draw dry part
        draw::flipped(tex, submerge > 0.0 ? data.unsub_dest : dest, hreverse, vreverse);
 
        if(uint8_t hl = float_to_color(highlight); hl > 0) {
            tex.set_blend_mode(SDL_BLENDMODE_ADD);
            tex.set_alpha_mod(hl);
            if(submerge > 0.0) {
                // draw underwater part
                draw::smooth_shaded(tex, data.alpha_verts);
            }
            // draw dry part
            draw::flipped(tex, submerge > 0.0 ? data.unsub_dest : dest, hreverse, vreverse);
        }
 
        tex.set_blend_mode(SDL_BLENDMODE_BLEND);
        tex.set_alpha_mod(SDL_ALPHA_OPAQUE);
    });
 
    // SDL hax to apply an active washout tint at the correct ratio
    if(blend_ratio > 0.0) {
        // Get a pure-white version of the texture
        const image::locator whiteout_locator(
            i_locator.get_filename(),
            i_locator.get_modifications()
                + new_modifications
                + "~CHAN(255, 255, 255, alpha)"
        );
 
        disp->drawing_buffer_add(drawing_layer, loc, [=, tex = image::get_texture(whiteout_locator)](const rect&) mutable {
            if (submerge > 0.0) {
                // also draw submerged portion
                // alpha_mod and color_mod are ignored,
                // so we have to put them in the smooth shaded vertex data.
                // This also has to incorporate the existing submerge alpha.
                blendto.a = uint8_t(data.alpha_verts[0].color.a * blend_ratio);
                data.alpha_verts[0].color = blendto;
                data.alpha_verts[1].color = blendto;
                blendto.a = uint8_t(data.alpha_verts[2].color.a * blend_ratio);
                data.alpha_verts[2].color = blendto;
                data.alpha_verts[3].color = blendto;
 
                // set clip for dry part
                // smooth_shaded doesn't use the clip information so it's fine to set it up front
                tex.set_src(data.unsub_src);
 
                // draw underwater part
                draw::smooth_shaded(tex, data.alpha_verts);
            }
 
            tex.set_alpha_mod(alpha * blend_ratio);
            tex.set_color_mod(blendto);
 
            // draw dry part
            draw::flipped(tex, submerge > 0.0 ? data.unsub_dest : dest, hreverse, vreverse);
 
            if(uint8_t hl = float_to_color(highlight); hl > 0) {
                tex.set_blend_mode(SDL_BLENDMODE_ADD);
                tex.set_alpha_mod(hl);
                if (submerge > 0.0) {
                    // draw underwater part
                    draw::smooth_shaded(tex, data.alpha_verts);
                }
                // draw dry part
                draw::flipped(tex, submerge > 0.0 ? data.unsub_dest : dest, hreverse, vreverse);
            }
 
            tex.set_color_mod(255, 255, 255);
            tex.set_blend_mode(SDL_BLENDMODE_BLEND);
            tex.set_alpha_mod(SDL_ALPHA_OPAQUE);
        });
    }
}
} // namespace
 
void unit_frame::redraw(const int frame_time, bool on_start_time, bool in_scope_of_frame,
        const map_location& src, const map_location& dst,
        halo::handle& halo_id, halo::manager& halo_man,
        const frame_parameters& animation_val, const frame_parameters& engine_val) const
{
    game_display* game_disp = game_display::get_singleton();
 
    const int xsrc = game_disp->get_location_x(src);
    const int ysrc = game_disp->get_location_y(src);
    const int xdst = game_disp->get_location_x(dst);
    const int ydst = game_disp->get_location_y(dst);
    const map_location::DIRECTION direction = src.get_relative_dir(dst);
 
    const frame_parameters current_data = merge_parameters(frame_time,animation_val,engine_val);
    double tmp_offset = current_data.offset;
 
    // Debug code to see the number of frames and their position
    //if(tmp_offset) {
    //  std::cout << static_cast<int>(tmp_offset * 100) << "," << "\n";
    //}
 
    if(on_start_time) {
        // Stuff that should be done only once per frame
        if(!current_data.sound.empty()  ) {
            sound::play_sound(current_data.sound);
        }
 
        if(!current_data.text.empty() && current_data.text_color) {
            game_disp->float_label(src, current_data.text, *current_data.text_color);
        }
    }
 
    image::locator image_loc;
    if(direction != map_location::NORTH && direction != map_location::SOUTH) {
        image_loc = current_data.image_diagonal.clone(current_data.image_mod);
    }
 
    if(image_loc.is_void() || image_loc.get_filename().empty()) { // invalid diag image, or not diagonal
        image_loc = current_data.image.clone(current_data.image_mod);
    }
 
    point image_size {0, 0};
    if(!image_loc.is_void() && !image_loc.get_filename().empty()) { // invalid diag image, or not diagonal
        image_size = image::get_size(image_loc);
    }
 
    const int d2 = display::get_singleton()->hex_size() / 2;
 
    const int x = static_cast<int>(tmp_offset * xdst + (1.0 - tmp_offset) * xsrc) + d2;
    const int y = static_cast<int>(tmp_offset * ydst + (1.0 - tmp_offset) * ysrc) + d2;
    const double disp_zoom = display::get_singleton()->get_zoom_factor();
 
    if(image_size.x && image_size.y) {
        bool facing_west = (
            direction == map_location::NORTH_WEST ||
            direction == map_location::SOUTH_WEST);
 
        bool facing_north = (
            direction == map_location::NORTH_WEST ||
            direction == map_location::NORTH ||
            direction == map_location::NORTH_EAST);
 
        if(!current_data.auto_hflip) { facing_west = false; }
        if(!current_data.auto_vflip) { facing_north = true; }
 
        int my_x = x + disp_zoom * (current_data.x - image_size.x / 2);
        int my_y = y + disp_zoom * (current_data.y - image_size.y / 2);
 
        if(facing_west) {
            my_x -= current_data.directional_x * disp_zoom;
        } else {
            my_x += current_data.directional_x * disp_zoom;
        }
 
        if(facing_north) {
            my_y += current_data.directional_y * disp_zoom;
        } else {
            my_y -= current_data.directional_y * disp_zoom;
        }
 
        // TODO: don't conflate highlights and alpha
        double brighten;
        uint8_t alpha;
        if(current_data.highlight_ratio >= 1.0) {
            brighten = current_data.highlight_ratio - 1.0;
            alpha = 255;
        } else {
            brighten = 0.0;
            alpha = float_to_color(current_data.highlight_ratio);
        }
 
        if(alpha != 0) {
            render_unit_image(my_x, my_y,
                static_cast<display::drawing_layer>(display::LAYER_UNIT_FIRST + current_data.drawing_layer),
                src,
                image_loc,
                facing_west,
                false,
                alpha,
                brighten,
                current_data.blend_with ? *current_data.blend_with : color_t(),
                current_data.blend_ratio,
                current_data.submerge,
                !facing_north
            );
        }
    }
 
    halo_id.reset();
 
    if(!in_scope_of_frame) { //check after frame as first/last frame image used in defense/attack anims
        return;
    }
 
    // No halos, exit
    if(current_data.halo.empty()) {
        return;
    }
 
    halo::ORIENTATION orientation;
    switch(direction)
    {
        case map_location::NORTH:
        case map_location::NORTH_EAST:
            orientation = halo::NORMAL;
            break;
        case map_location::SOUTH_EAST:
        case map_location::SOUTH:
            if(!current_data.auto_vflip) {
                orientation = halo::NORMAL;
            } else {
                orientation = halo::VREVERSE;
            }
            break;
        case map_location::SOUTH_WEST:
            if(!current_data.auto_vflip) {
                orientation = halo::HREVERSE;
            } else {
                orientation = halo::HVREVERSE;
            }
            break;
        case map_location::NORTH_WEST:
            orientation = halo::HREVERSE;
            break;
        case map_location::NDIRECTIONS:
        default:
            orientation = halo::NORMAL;
            break;
    }
 
    if(direction != map_location::SOUTH_WEST && direction != map_location::NORTH_WEST) {
        halo_id = halo_man.add(
            static_cast<int>(x + current_data.halo_x * disp_zoom),
            static_cast<int>(y + current_data.halo_y * disp_zoom),
            current_data.halo  + current_data.halo_mod,
            map_location(-1, -1),
            orientation
        );
    } else {
        halo_id = halo_man.add(
            static_cast<int>(x - current_data.halo_x * disp_zoom),
            static_cast<int>(y + current_data.halo_y * disp_zoom),
            current_data.halo  + current_data.halo_mod,
            map_location(-1, -1),
            orientation
        );
    }
}
 
std::set<map_location> unit_frame::get_overlaped_hex(const int frame_time, const map_location& src, const map_location& dst,
        const frame_parameters& animation_val, const frame_parameters& engine_val) const
{
    display* disp = display::get_singleton();
 
    const int xsrc = disp->get_location_x(src);
    const int ysrc = disp->get_location_y(src);
    const int xdst = disp->get_location_x(dst);
    const int ydst = disp->get_location_y(dst);
    const map_location::DIRECTION direction = src.get_relative_dir(dst);
 
    const frame_parameters current_data = merge_parameters(frame_time, animation_val, engine_val);
 
    double tmp_offset = current_data.offset;
    const int d2 = display::get_singleton()->hex_size() / 2;
 
    image::locator image_loc;
    if(direction != map_location::NORTH && direction != map_location::SOUTH) {
        image_loc = current_data.image_diagonal.clone(current_data.image_mod);
    }
 
    if(image_loc.is_void() || image_loc.get_filename().empty()) { // invalid diag image, or not diagonal
        image_loc = current_data.image.clone(current_data.image_mod);
    }
 
    // We always invalidate our own hex because we need to be called at redraw time even
    // if we don't draw anything in the hex itself
    std::set<map_location> result;
    if(tmp_offset == 0 && current_data.x == 0 && current_data.directional_x == 0 && image::is_in_hex(image_loc)) {
        result.insert(src);
 
        bool facing_north = (
            direction == map_location::NORTH_WEST ||
            direction == map_location::NORTH ||
            direction == map_location::NORTH_EAST);
 
        if(!current_data.auto_vflip) { facing_north = true; }
 
        int my_y = current_data.y;
        if(facing_north) {
            my_y += current_data.directional_y;
        } else {
            my_y -= current_data.directional_y;
        }
 
        if(my_y < 0) {
            result.insert(src.get_direction(map_location::NORTH));
            result.insert(src.get_direction(map_location::NORTH_EAST));
            result.insert(src.get_direction(map_location::NORTH_WEST));
        } else if(my_y > 0) {
            result.insert(src.get_direction(map_location::SOUTH));
            result.insert(src.get_direction(map_location::SOUTH_EAST));
            result.insert(src.get_direction(map_location::SOUTH_WEST));
        }
    } else {
        int w = 0, h = 0;
 
        if(!image_loc.is_void() && !image_loc.get_filename().empty()) {
            const point s = image::get_size(image_loc);
            w = s.x;
            h = s.y;
        }
 
        if(w != 0 || h != 0) {
            // TODO: unduplicate this code
            const int x = static_cast<int>(tmp_offset * xdst + (1.0 - tmp_offset) * xsrc) + d2;
            const int y = static_cast<int>(tmp_offset * ydst + (1.0 - tmp_offset) * ysrc) + d2;
            const double disp_zoom = display::get_singleton()->get_zoom_factor();
 
            bool facing_west = (
                direction == map_location::NORTH_WEST ||
                direction == map_location::SOUTH_WEST);
 
            bool facing_north = (
                direction == map_location::NORTH_WEST ||
                direction == map_location::NORTH ||
                direction == map_location::NORTH_EAST);
 
            if(!current_data.auto_hflip) { facing_west = false; }
            if(!current_data.auto_vflip) { facing_north = true; }
 
            int my_x = x + disp_zoom * (current_data.x - w / 2);
            int my_y = y + disp_zoom * (current_data.y - h / 2);
 
            if(facing_west) {
                my_x -= current_data.directional_x * disp_zoom;
            } else {
                my_x += current_data.directional_x * disp_zoom;
            }
 
            if(facing_north) {
                my_y += current_data.directional_y * disp_zoom;
            } else {
                my_y -= current_data.directional_y * disp_zoom;
            }
 
            // Check if our underlying hexes are invalidated. If we need to update ourselves because we changed,
            // invalidate our hexes and return whether or not was successful.
            const SDL_Rect r {my_x, my_y, int(w * disp_zoom), int(h * disp_zoom)};
            display::rect_of_hexes underlying_hex = disp->hexes_under_rect(r);
 
            result.insert(src);
            result.insert(underlying_hex.begin(), underlying_hex.end());
        } else {
            // We have no "redraw surface" but we still need to invalidate our own hex in case we have a halo
            // and/or sound that needs a redraw.
            result.insert(src);
            result.insert(dst);
        }
    }
 
    return result;
}
 
/**
 * This function merges the value provided by:
 *  - the frame
 *  - the engine (poison, flying unit...)
 *  - the animation as a whole
 *
 * There is no absolute rule for merging, so creativity is the rule. If a value is never provided by the engine, assert.
 * This way if it becomes used, people will easily find the right place to look.
 */
frame_parameters unit_frame::merge_parameters(int current_time, const frame_parameters& animation_val,
        const frame_parameters& engine_val) const
{
    frame_parameters result;
    const frame_parameters& current_val = builder_.parameters(current_time);
 
    result.primary_frame = engine_val.primary_frame;
    if(!boost::logic::indeterminate(animation_val.primary_frame)) {
        result.primary_frame = animation_val.primary_frame;
    }
 
    if(!boost::logic::indeterminate(current_val.primary_frame)) {
        result.primary_frame = current_val.primary_frame;
    }
 
    // Convert the tribool to bool
    const bool primary = static_cast<bool>(result.primary_frame) || boost::logic::indeterminate(result.primary_frame);
 
    /** The engine provides a default image to use for the unit when none is available */
    result.image = current_val.image.is_void() || current_val.image.get_filename().empty()
        ? animation_val.image
        : current_val.image;
 
    if(primary && (result.image.is_void() || result.image.get_filename().empty())) {
        result.image = engine_val.image;
    }
 
    /** The engine provides a default image to use for the unit when none is available */
    result.image_diagonal = current_val.image_diagonal.is_void() || current_val.image_diagonal.get_filename().empty()
        ? animation_val.image_diagonal
        : current_val.image_diagonal;
 
    if(primary && (result.image_diagonal.is_void() || result.image_diagonal.get_filename().empty())) {
        result.image_diagonal = engine_val.image_diagonal;
    }
 
    /**
     * The engine provides a string for "petrified" and "team color" modifications.
     * Note that image_mod is the complete modification and halo_mod is only the TC part.
     */
    result.image_mod = current_val.image_mod + animation_val.image_mod;
    if(primary) {
        result.image_mod += engine_val.image_mod;
    } else {
        result.image_mod += engine_val.halo_mod;
    }
 
    assert(engine_val.halo.empty());
    result.halo = current_val.halo.empty() ? animation_val.halo : current_val.halo;
 
    assert(engine_val.halo_x == 0);
    result.halo_x = current_val.halo_x ? current_val.halo_x : animation_val.halo_x;
 
    /** The engine provides a y modification for terrain with height adjust and flying units */
    result.halo_y = current_val.halo_y ? current_val.halo_y : animation_val.halo_y;
    result.halo_y += engine_val.halo_y;
 
    result.halo_mod = current_val.halo_mod + animation_val.halo_mod;
    result.halo_mod += engine_val.halo_mod;
 
    assert(engine_val.duration == 0);
    result.duration = current_val.duration;
 
    assert(engine_val.sound.empty());
    result.sound = current_val.sound.empty() ? animation_val.sound : current_val.sound;
 
    assert(engine_val.text.empty());
    result.text = current_val.text.empty() ? animation_val.text : current_val.text;
 
    assert(!engine_val.text_color);
    result.text_color = current_val.text_color ? current_val.text_color : animation_val.text_color;
 
    /** The engine provides a blend color for poisoned units */
    result.blend_with = current_val.blend_with ? current_val.blend_with : animation_val.blend_with;
    if(primary && engine_val.blend_with) {
        result.blend_with = engine_val.blend_with->blend_lighten(result.blend_with ? *result.blend_with : color_t(0,0,0));
    }
 
    /** The engine provides a blend color for poisoned units */
    result.blend_ratio = current_val.blend_ratio != 0 ? current_val.blend_ratio:animation_val.blend_ratio;
    if(primary && engine_val.blend_ratio != 0) {
        result.blend_ratio = std::min(result.blend_ratio + engine_val.blend_ratio, 1.0);
    }
 
    /** The engine provides a highlight ratio for selected units and visible "invisible" units */
    result.highlight_ratio = (current_val.highlight_ratio < 0.999 || current_val.highlight_ratio > 1.001) ?
        current_val.highlight_ratio : animation_val.highlight_ratio;
    if(primary && (engine_val.highlight_ratio < 0.999 || engine_val.highlight_ratio > 1.001)) {
        result.highlight_ratio = result.highlight_ratio * engine_val.highlight_ratio; // selected unit
    }
 
    assert(engine_val.offset == 0);
    result.offset = (current_val.offset != -1000) ? current_val.offset : animation_val.offset;
    if(result.offset == -1000) {
        result.offset = 0.0;
    }
 
    /** The engine provides a submerge for units in water */
    result.submerge = current_val.submerge != 0 ? current_val.submerge : animation_val.submerge;
    if(primary && engine_val.submerge != 0 && result.submerge == 0) {
        result.submerge = engine_val.submerge;
    }
 
    assert(engine_val.x == 0);
    result.x = current_val.x ? current_val.x : animation_val.x;
 
    /** The engine provides a y modification for terrain with height adjust and flying units */
    result.y = current_val.y?current_val.y:animation_val.y;
    result.y += engine_val.y;
 
    assert(engine_val.directional_x == 0);
    result.directional_x = current_val.directional_x ? current_val.directional_x : animation_val.directional_x;
 
    assert(engine_val.directional_y == 0);
    result.directional_y = current_val.directional_y ? current_val.directional_y : animation_val.directional_y;
 
    assert(engine_val.drawing_layer == display::LAYER_UNIT_DEFAULT - display::LAYER_UNIT_FIRST);
    result.drawing_layer = current_val.drawing_layer != display::LAYER_UNIT_DEFAULT-display::LAYER_UNIT_FIRST
        ? current_val.drawing_layer
        : animation_val.drawing_layer;
 
    /** The engine provides us with a default value to compare to. Update if different */
    result.auto_hflip = engine_val.auto_hflip;
 
    if(!boost::logic::indeterminate(animation_val.auto_hflip)) {
        result.auto_hflip = animation_val.auto_hflip;
    }
 
    if(!boost::logic::indeterminate(current_val.auto_hflip)) {
        result.auto_hflip = current_val.auto_hflip;
    }
 
    if(boost::logic::indeterminate(result.auto_hflip)) {
        result.auto_hflip = true;
    }
 
    result.auto_vflip = engine_val.auto_vflip;
 
    if(!boost::logic::indeterminate(animation_val.auto_vflip)) {
        result.auto_vflip = animation_val.auto_vflip;
    }
 
    if(!boost::logic::indeterminate(current_val.auto_vflip)) {
        result.auto_vflip = current_val.auto_vflip;
    }
 
    if(boost::logic::indeterminate(result.auto_vflip)) {
        result.auto_vflip = !primary;
    }
 
    return result;
}