editor/action/mouse/mouse_action.cpp

Go to the documentation of this file.

/* $Id: mouse_action.cpp 53695 2012-03-30 15:42:21Z fendrin $ */
/*
   Copyright (C) 2008 - 2012 by Tomasz Sniatowski <kailoran@gmail.com>
   Part of the Battle for Wesnoth Project http://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.
*/
#define GETTEXT_DOMAIN "wesnoth-editor"

#include "editor/action/action.hpp"
#include "editor/toolkit/brush.hpp"
#include "../../editor_display.hpp"
#include "mouse_action.hpp"

#include "construct_dialog.hpp"
#include "gettext.hpp"
#include "gui/dialogs/editor_set_starting_position.hpp"
#include "editor/palette/terrain_palettes.hpp"

namespace editor {

bool mouse_action::has_context_menu() const
{
    return false;
}

void mouse_action::move(editor_display& disp, const map_location& hex)
{
    if (hex != previous_move_hex_) {
        update_brush_highlights(disp, hex);
        previous_move_hex_ = hex;
    }
}

void mouse_action::update_brush_highlights(editor_display& disp, const map_location& hex)
{
    disp.set_brush_locs(affected_hexes(disp, hex));
}

std::set<map_location> mouse_action::affected_hexes(
        editor_display& /*disp*/, const map_location& hex)
{
    std::set<map_location> res;
    res.insert(hex);
    return res;
}

editor_action* mouse_action::drag_left(editor_display& /*disp*/,
        int /*x*/, int /*y*/, bool& /*partial*/, editor_action* /*last_undo*/)
{
    return NULL;
}

editor_action* mouse_action::drag_right(editor_display& /*disp*/,
        int /*x*/, int /*y*/, bool& /*partial*/, editor_action* /*last_undo*/)
{
    return NULL;
}

editor_action* mouse_action::drag_end(
        editor_display& /*disp*/, int /*x*/, int /*y*/)
{
    return NULL;
}

editor_action* mouse_action::up_right(
        editor_display& /*disp*/, int /*x*/, int /*y*/)
{
    return NULL;
}

editor_action* mouse_action::up_left(
        editor_display& /*disp*/, int /*x*/, int /*y*/)
{
    return NULL;
}

editor_action* mouse_action::key_event(
    editor_display& disp, const SDL_Event& event)
{
    if (!has_alt_modifier() && (event.key.keysym.sym >= '1' && event.key.keysym.sym <= '9')) {
        int side = event.key.keysym.sym - '0';
        if (side >= 1 && side <= gamemap::MAX_PLAYERS) {
            map_location pos = disp.get_map().starting_position(side);
            if (pos.valid()) {
                disp.scroll_to_tile(pos, display::WARP);
            }
        }
        return NULL;
    }
    if (!disp.map().on_board(previous_move_hex_) || event.type != SDL_KEYUP) {
        return NULL;
    }
    editor_action* a = NULL;
    if ((has_alt_modifier() && (event.key.keysym.sym >= '1' && event.key.keysym.sym <= '9'))
    || event.key.keysym.sym == SDLK_DELETE) {
        int res = event.key.keysym.sym - '0';
        if (res > gamemap::MAX_PLAYERS || event.key.keysym.sym == SDLK_DELETE) res = 0;
        int player_starting_at_hex = disp.map().is_starting_position(previous_move_hex_) + 1;
        if (res == 0 && player_starting_at_hex != -1) {
            a = new editor_action_starting_position(map_location(), player_starting_at_hex);
        } else if (res > 0 && res != player_starting_at_hex) {
            a = new editor_action_starting_position(previous_move_hex_, res);
        }
    }
    return a;
}

void mouse_action::set_mouse_overlay(editor_display& disp)
{
    disp.set_mouseover_hex_overlay(NULL);
}

bool mouse_action::has_alt_modifier() const
{
    return key_[SDLK_RALT] || key_[SDLK_LALT];
}

bool mouse_action::has_shift_modifier() const
{
    return key_[SDLK_RSHIFT] || key_[SDLK_LSHIFT];
}

bool mouse_action::has_ctrl_modifier() const
{
#ifdef __APPLE__
    return key_[SDLK_RMETA] || key_[SDLK_LMETA];
#else
    return key_[SDLK_RCTRL] || key_[SDLK_LCTRL];
#endif
}

void mouse_action::set_terrain_mouse_overlay(editor_display& disp, t_translation::t_terrain fg,
        t_translation::t_terrain bg)
{
    surface image_fg(image::get_image("terrain/"
        + disp.get_map().get_terrain_info(fg).editor_image() + ".png"));
    surface image_bg(image::get_image("terrain/"
        + disp.get_map().get_terrain_info(bg).editor_image() + ".png"));

    if (image_fg == NULL || image_bg == NULL) {
        ERR_ED << "Missing terrain icon\n";
        disp.set_mouseover_hex_overlay(NULL);
        return;
    }

    // Create a transparent surface of the right size.
    surface image = create_compatible_surface(image_fg, image_fg->w, image_fg->h);
    sdl_fill_rect(image,NULL,SDL_MapRGBA(image->format,0,0,0, 0));

    // For efficiency the size of the tile is cached.
    // We assume all tiles are of the same size.
    // The zoom factor can change, so it's not cached.
    // NOTE: when zooming and not moving the mouse, there are glitches.
    // Since the optimal alpha factor is unknown, it has to be calculated
    // on the fly, and caching the surfaces makes no sense yet.
    static const Uint8 alpha = 196;
    static const int size = image_fg->w;
    static const int half_size = size / 2;
    static const int quarter_size = size / 4;
    static const int offset = 2;
    static const int new_size = half_size - 2;
    const int zoom = static_cast<int>(size * disp.get_zoom_factor());

    // Blit left side
    image_fg = scale_surface(image_fg, new_size, new_size);
    SDL_Rect rcDestLeft = create_rect(offset, quarter_size, 0, 0);
    sdl_blit ( image_fg, NULL, image, &rcDestLeft );

    // Blit left side
    image_bg = scale_surface(image_bg, new_size, new_size);
    SDL_Rect rcDestRight = create_rect(half_size, quarter_size, 0, 0);
    sdl_blit ( image_bg, NULL, image, &rcDestRight );

    //apply mask so the overlay is contained within the mouseover hex
    image = mask_surface(image, image::get_hexmask());

    // Add the alpha factor and scale the image
    image = scale_surface(adjust_surface_alpha(image, alpha), zoom, zoom);

    // Set as mouseover
    disp.set_mouseover_hex_overlay(image);
}

std::set<map_location> brush_drag_mouse_action::affected_hexes(
    editor_display& /*disp*/, const map_location& hex)
{
    return get_brush().project(hex);
}

editor_action* brush_drag_mouse_action::click_left(editor_display& disp, int x, int y)
{
    map_location hex = disp.hex_clicked_on(x, y);
    previous_drag_hex_ = hex;
    return click_perform_left(disp, affected_hexes(disp, hex));
}

editor_action* brush_drag_mouse_action::click_right(editor_display& disp, int x, int y)
{
    map_location hex = disp.hex_clicked_on(x, y);
    previous_drag_hex_ = hex;
    return click_perform_right(disp, affected_hexes(disp, hex));
}

editor_action* brush_drag_mouse_action::drag_left(editor_display& disp,
        int x, int y, bool& partial, editor_action* last_undo)
{
    return drag_generic<&brush_drag_mouse_action::click_perform_left>(disp, x, y, partial, last_undo);
}

editor_action* brush_drag_mouse_action::drag_right(editor_display& disp,
        int x, int y, bool& partial, editor_action* last_undo)
{
    return drag_generic<&brush_drag_mouse_action::click_perform_right>(disp, x, y, partial, last_undo);
}

editor_action* brush_drag_mouse_action::drag_end(
        editor_display& /*disp*/, int /*x*/, int /*y*/)
{
    return NULL;
}

template <editor_action* (brush_drag_mouse_action::*perform_func)(editor_display&, const std::set<map_location>&)>
editor_action* brush_drag_mouse_action::drag_generic(editor_display& disp, int x, int y, bool& partial, editor_action* last_undo)
{
    map_location hex = disp.hex_clicked_on(x, y);
    move(disp, hex);
    if (hex != previous_drag_hex_) {
        std::set<map_location> current_step_locs = affected_hexes(disp, hex);
        editor_action_extendable* last_undo_x = dynamic_cast<editor_action_extendable*>(last_undo);
        LOG_ED << "Last undo is " << last_undo << " and as x " << last_undo_x << "\n";
        partial = true;
        editor_action* a = (this->*perform_func)(disp, affected_hexes(disp, hex));
        previous_drag_hex_ = hex;
        return a;
    } else {
        return NULL;
    }
}

const brush& brush_drag_mouse_action::get_brush()
{
    assert(brush_);
    assert(*brush_);
    return **brush_;
}


editor_action* mouse_action_paint::click_left(editor_display& disp, int x, int y)
{
    if (has_ctrl_modifier()) {
        map_location hex = disp.hex_clicked_on(x, y);
        set_selected_fg_terrain(disp.map().get_terrain(hex));
        return NULL;
    } else {
        return brush_drag_mouse_action::click_left(disp, x, y);
    }
}

editor_action* mouse_action_paint::click_right(editor_display& disp, int x, int y)
{
    if (has_ctrl_modifier()) {
        map_location hex = disp.hex_clicked_on(x, y);
        set_selected_bg_terrain(disp.map().get_terrain(hex));
        return NULL;
    } else {
        return brush_drag_mouse_action::click_right(disp, x, y);
    }
}

editor_action* mouse_action_paint::click_perform_left(
        editor_display& /*disp*/, const std::set<map_location>& hexes)
{
    if (has_ctrl_modifier()) return NULL;
    return new editor_action_chain(new editor_action_paint_area(
            hexes, terrain_palette_.selected_fg_item(), has_shift_modifier()));
}

editor_action* mouse_action_paint::click_perform_right(
        editor_display& /*disp*/, const std::set<map_location>& hexes)
{
    if (has_ctrl_modifier()) return NULL;
    return new editor_action_chain(new editor_action_paint_area(
            hexes, terrain_palette_.selected_bg_item(), has_shift_modifier()));
}

void mouse_action_paint::set_mouse_overlay(editor_display& disp)
{
    set_terrain_mouse_overlay(disp, terrain_palette_.selected_fg_item(),
            terrain_palette_.selected_bg_item());
}


std::set<map_location> mouse_action_select::affected_hexes(
    editor_display& disp, const map_location& hex)
{
    if (has_shift_modifier()) {
        return disp.map().get_contiguous_terrain_tiles(hex);
    } else {
        return brush_drag_mouse_action::affected_hexes(disp, hex);
    }
}

editor_action* mouse_action_select::key_event(
        editor_display& disp, const SDL_Event& event)
{
    editor_action* ret = mouse_action::key_event(disp, event);
    update_brush_highlights(disp, previous_move_hex_);
    return ret;
}

editor_action* mouse_action_select::click_perform_left(
        editor_display& /*disp*/, const std::set<map_location>& hexes)
{
    return new editor_action_chain(new editor_action_select(hexes));
}

editor_action* mouse_action_select::click_perform_right(
        editor_display& /*disp*/, const std::set<map_location>& hexes)
{
    return new editor_action_chain(new editor_action_deselect(hexes));
}

void mouse_action_select::set_mouse_overlay(editor_display& disp)
{
    surface image;
    if (has_shift_modifier()) {
        image = image::get_image("editor/tool-overlay-select-wand.png");
    } else {
        image = image::get_image("editor/tool-overlay-select-brush.png");
    }
    Uint8 alpha = 196;
    int size = image->w;
    int zoom = static_cast<int>(size * disp.get_zoom_factor());

    // Add the alpha factor and scale the image
    image = scale_surface(adjust_surface_alpha(image, alpha), zoom, zoom);
    disp.set_mouseover_hex_overlay(image);
}


bool mouse_action_paste::has_context_menu() const
{
    return true;
}

std::set<map_location> mouse_action_paste::affected_hexes(
    editor_display& /*disp*/, const map_location& hex)
{
    return paste_.get_offset_area(hex);
}

editor_action* mouse_action_paste::click_left(editor_display& disp, int x, int y)
{
    map_location hex = disp.hex_clicked_on(x, y);
    editor_action_paste* a = new editor_action_paste(paste_, hex);
    return a;
}

editor_action* mouse_action_paste::click_right(editor_display& /*disp*/, int /*x*/, int /*y*/)
{
    return NULL;
}

void mouse_action_paste::set_mouse_overlay(editor_display& disp)
{
    disp.set_mouseover_hex_overlay(NULL); //TODO
}

std::set<map_location> mouse_action_fill::affected_hexes(
    editor_display& disp, const map_location& hex)
{
    return disp.map().get_contiguous_terrain_tiles(hex);
}

editor_action* mouse_action_fill::click_left(editor_display& disp, int x, int y)
{
    map_location hex = disp.hex_clicked_on(x, y);
    if (has_ctrl_modifier()) {
        set_selected_fg_terrain(disp.map().get_terrain(hex));
        return NULL;
    } else {
        //TODO only take the base terrain into account when searching for contiguous terrain when painting base only
        //or use a different key modifier for that
        editor_action_fill* a = new editor_action_fill(hex, terrain_palette_.selected_fg_item(),
                has_shift_modifier());
        return a;
    }
}

editor_action* mouse_action_fill::click_right(editor_display& disp, int x, int y)
{
    map_location hex = disp.hex_clicked_on(x, y);
    if (has_ctrl_modifier()) {
        set_selected_bg_terrain(disp.map().get_terrain(hex));
        return NULL;
    } else {
        //TODO only take the base terrain into account when searching for contiguous terrain when painting base only
        //or use a different key modifier for that
        editor_action_fill* a = new editor_action_fill(hex, terrain_palette_.selected_bg_item(),
                has_shift_modifier());
        return a;
    }
}

void mouse_action_fill::set_mouse_overlay(editor_display& disp)
{
    set_terrain_mouse_overlay(disp, terrain_palette_.selected_fg_item(),
            terrain_palette_.selected_bg_item());
}

editor_action* mouse_action_starting_position::up_left(editor_display& disp, int x, int y)
{
    if (!click_) return NULL;
    click_ = false;
    map_location hex = disp.hex_clicked_on(x, y);
    if (!disp.map().on_board(hex)) {
        return NULL;
    }

    const unsigned player_starting_at_hex =
        static_cast<unsigned>(disp.map().is_starting_position(hex) + 1); // 1st player = 1

    std::vector<map_location> starting_positions;

    for(int i = 1; i <= gamemap::MAX_PLAYERS; ++i) {
        starting_positions.push_back(disp.map().starting_position(i));
    }

    gui2::teditor_set_starting_position dlg(
        player_starting_at_hex, gamemap::MAX_PLAYERS, starting_positions);
    dlg.show(disp.video());

    unsigned new_player_at_hex = dlg.result(); // 1st player = 1
    editor_action* a = NULL;

    if(new_player_at_hex != player_starting_at_hex) {
        if(!new_player_at_hex) {
            // Erase current starting position
            a = new editor_action_starting_position(map_location(), player_starting_at_hex);
        } else {
            // Set a starting position
            a = new editor_action_starting_position(hex, new_player_at_hex);
        }
    }

    update_brush_highlights(disp, hex);

    return a;
}

editor_action* mouse_action_starting_position::click_left(editor_display& /*disp*/, int /*x*/, int /*y*/)
{
    click_ = true;
    return NULL;
}

editor_action* mouse_action_starting_position::up_right(editor_display& disp, int x, int y)
{
    map_location hex = disp.hex_clicked_on(x, y);
    int player_starting_at_hex = disp.map().is_starting_position(hex) + 1;
    if (player_starting_at_hex != -1) {
        return new editor_action_starting_position(map_location(), player_starting_at_hex);
    } else {
        return NULL;
    }
}

editor_action* mouse_action_starting_position::click_right(editor_display& /*disp*/, int /*x*/, int /*y*/)
{
    return NULL;
}

void mouse_action_starting_position::set_mouse_overlay(editor_display& disp)
{
    surface image = image::get_image("editor/tool-overlay-starting-position.png");
    Uint8 alpha = 196;
    int size = image->w;
    int zoom = static_cast<int>(size * disp.get_zoom_factor());

    // Add the alpha factor and scale the image
    image = scale_surface(adjust_surface_alpha(image, alpha), zoom, zoom);
    disp.set_mouseover_hex_overlay(image);
}


} //end namespace editor