qd_interface_element_state.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 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; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef QDENGINE_QDCORE_QD_INTERFACE_ELEMENT_STATE_H
#define QDENGINE_QDCORE_QD_INTERFACE_ELEMENT_STATE_H

#include "qdengine/parser/xml_fwd.h"
#include "qdengine/qdcore/qd_animation_info.h"
#include "qdengine/qdcore/qd_interface_object_base.h"
#include "qdengine/qdcore/qd_interface_element_state_mode.h"


namespace QDEngine {


class qdInterfaceEvent {
public:
    enum event_t {
        EVENT_NONE = 0,
        EVENT_EXIT,             // 1
        EVENT_LOAD_SCENE,           // 2
        EVENT_SAVE_GAME,            // 3
        EVENT_NEW_GAME,             // 4
        EVENT_CHANGE_INTERFACE_SCREEN,      // 5
        EVENT_CHANGE_PERSONAGE,         // 6
        // (парметер имя элемента)
        EVENT_TMP_HIDE_ELEMENT,         // 7
        // (парметер имя элемента)
        EVENT_HIDE_ELEMENT,         // 8
        // (парметер имя элемента)
        EVENT_SHOW_ELEMENT,         // 9
        EVENT_RESUME_GAME,          // 10

        EVENT_SET_SAVE_MODE,            // 11

        EVENT_SET_LOAD_MODE,            // 12
        EVENT_ACTIVATE_PERSONAGE,       // 13
        EVENT_PREV_ELEMENT_STATE,       // 14
        EVENT_NEXT_ELEMENT_STATE,       // 15
        EVENT_MAIN_MENU,            // 16
        EVENT_PLAY_VIDEO,           // 17
        EVENT_BUTTON_STATE,         // 18
        EVENT_CLEAR_MOUSE,          // 19
        EVENT_SCROLL_LEFT,          // 20
        EVENT_SCROLL_RIGHT,         // 21
        EVENT_SCROLL_UP,            // 22
        EVENT_SCROLL_DOWN,          // 23
        EVENT_SHOW_INTERFACE_SCREEN_AS_MODAL,   // 24
        EVENT_MODAL_OK,             // 25
        EVENT_MODAL_CANCEL,         // 26
        EVENT_HALL_OF_FAME_PLAYER,  // 27
        EVENT_HALL_OF_FAME_SCORE,   // 28
        EVENT_HALL_OF_FAME_CUR_SCORE    // 29
    };

    enum activation_t {
        EVENT_ACTIVATION_CLICK = 0,
        EVENT_ACTIVATION_HOVER
    };

    qdInterfaceEvent(event_t id, const char *data, bool anm_flag, activation_t activation = EVENT_ACTIVATION_CLICK) : _event(id), _event_data(data), _is_before_animation(anm_flag), _activation(activation) { }
    ~qdInterfaceEvent() {}

    bool operator == (event_t id) const {
        return (_event == id);
    }

    event_t event() const {
        return _event;
    }
    bool has_data() const {
        return !_event_data.empty();
    }
    const char *event_data() const {
        return _event_data.c_str();
    }
    bool is_before_animation() const {
        return _is_before_animation;
    }
    activation_t activation() const {
        return _activation;
    }

private:

    event_t _event;
    Common::String _event_data;
    bool _is_before_animation;
    activation_t _activation;
};

class qdInterfaceElementState : public qdInterfaceObjectBase {
public:
    enum state_mode_t {
        DEFAULT_MODE = 0,
        MOUSE_HOVER_MODE,
        EVENT_MODE
    };

    enum {
        NUM_MODES = 3
    };

    qdInterfaceElementState();
    qdInterfaceElementState(const qdInterfaceElementState &st);
    ~qdInterfaceElementState();

    qdInterfaceElementState &operator = (const qdInterfaceElementState &st);


    void set_sound_file(const Common::Path str, state_mode_t snd_id = DEFAULT_MODE);
    const Common::Path sound_file(state_mode_t snd_id = DEFAULT_MODE) const {
        return _modes[snd_id].sound_file();
    }
    const qdSound *sound(state_mode_t snd_id = DEFAULT_MODE) const {
        return _modes[snd_id].sound();
    }
    bool has_sound(state_mode_t snd_id = DEFAULT_MODE) const {
        return _modes[snd_id].has_sound();
    }


    void set_animation_file(const Common::Path name, state_mode_t anm_id = DEFAULT_MODE);
    const Common::Path animation_file(state_mode_t anm_id = DEFAULT_MODE) const {
        return _modes[anm_id].animation_file();
    }
    int animation_flags(state_mode_t anm_id = DEFAULT_MODE) const {
        return _modes[anm_id].animation_flags();
    }

    void set_animation_flag(int fl, state_mode_t anm_id = DEFAULT_MODE) {
        _modes[anm_id].set_animation_flag(fl);
    }
    void drop_animation_flag(int fl, state_mode_t anm_id = DEFAULT_MODE) {
        _modes[anm_id].drop_animation_flag(fl);
    }
    bool check_animation_flag(int fl, state_mode_t anm_id = DEFAULT_MODE) const {
        return _modes[anm_id].check_animation_flag(fl);
    }

    const qdAnimation *animation(state_mode_t anm_id = DEFAULT_MODE) const {
        return _modes[anm_id].animation();
    }
    bool has_animation(state_mode_t anm_id = DEFAULT_MODE) const {
        return _modes[anm_id].has_animation();
    }

    bool register_resources();
    bool unregister_resources();

    bool save_script(Common::WriteStream &fh, int indent = 0) const;
    bool load_script(const xml::tag *p);


    bool quant(float dt);

    void set_state_mode(state_mode_t mode) {
        _state_mode = mode;
    }
    state_mode_t state_mode() const {
        return _state_mode;
    }
    bool has_state_mode(state_mode_t mode) const;

    bool has_contour(state_mode_t mode) const {
        return _modes[mode].has_contour();
    }
    bool get_contour(state_mode_t mode, qdContour &cnt) const;
    bool set_contour(state_mode_t mode, const qdContour &cnt);

    bool hit_test(int x, int y, state_mode_t mode) const {
        return _modes[mode].hit_test(x, y);
    }

    bool mouse_handler(int x, int y, mouseDispatcher::mouseEvent ev);
    bool keyboard_handler(Common::KeyCode vkey);

    typedef Std::vector<qdInterfaceEvent> events_container_t;
    const events_container_t &events() const {
        return _events;
    }
    void add_event(const qdInterfaceEvent &ev) {
        _events.push_back(ev);
    }
    void erase_event(int iNum) {
        _events.erase(_events.begin() + iNum);
    }
    void erase_all_events() {
        _events.clear();
    }

    bool need_active_game() const;

    const qdInterfaceEvent *find_event(qdInterfaceEvent::event_t type) const;
    bool has_event(qdInterfaceEvent::event_t type, const char *ev_data = NULL) const;

private:

    events_container_t _events;

    qdInterfaceElementStateMode _modes[NUM_MODES];

    state_mode_t _state_mode;
    state_mode_t _prev_state_mode;


    bool handle_events(qdInterfaceEvent::activation_t activation_type, bool before_animation);
};

} // namespace QDEngine

#endif // QDENGINE_QDCORE_QD_INTERFACE_ELEMENT_STATE_H