qd_condition.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_CONDITION_H
#define QDENGINE_QDCORE_QD_CONDITION_H

#include "qdengine/parser/xml_fwd.h"
#include "qdengine/qdcore/qd_named_object.h"
#include "qdengine/qdcore/qd_condition_data.h"
#include "qdengine/qdcore/qd_condition_object_reference.h"

namespace Common {
class WriteStream;
}

namespace QDEngine {



class qdCondition {
public:
    enum ConditionType {
        CONDITION_TRUE,
        CONDITION_FALSE,

        CONDITION_MOUSE_CLICK,
        CONDITION_MOUSE_OBJECT_CLICK,
        CONDITION_OBJECT_IN_ZONE,
        CONDITION_PERSONAGE_WALK_DIRECTION,                                 // 5
        CONDITION_PERSONAGE_STATIC_DIRECTION,
        CONDITION_TIMER,
        CONDITION_MOUSE_DIALOG_CLICK,
        CONDITION_MINIGAME_STATE,
        CONDITION_OBJECT_STATE,                                             // 10
        CONDITION_MOUSE_ZONE_CLICK,
        CONDITION_MOUSE_OBJECT_ZONE_CLICK,
        CONDITION_OBJECT_STATE_WAS_ACTIVATED,
        CONDITION_OBJECT_STATE_WAS_NOT_ACTIVATED,
        CONDITION_OBJECT_NOT_IN_STATE,                                      // 15
        CONDITION_OBJECTS_DISTANCE,
        CONDITION_PERSONAGE_ACTIVE,
        CONDITION_OBJECT_STATE_WAITING,
        CONDITION_OBJECT_STATE_ANIMATION_PHASE,
        CONDITION_OBJECT_PREV_STATE,                                        // 20
        CONDITION_STATE_TIME_GREATER_THAN_VALUE,
        CONDITION_STATE_TIME_GREATER_THAN_STATE_TIME,
        CONDITION_STATE_TIME_IN_INTERVAL,
        CONDITION_COUNTER_GREATER_THAN_VALUE,
        CONDITION_COUNTER_LESS_THAN_VALUE,                                  // 25
        CONDITION_COUNTER_GREATER_THAN_COUNTER,
        CONDITION_COUNTER_IN_INTERVAL,
        CONDITION_OBJECT_ON_PERSONAGE_WAY,
        CONDITION_KEYPRESS,
        CONDITION_ANY_PERSONAGE_IN_ZONE,                                    // 30
        CONDITION_MOUSE_RIGHT_CLICK,
        CONDITION_MOUSE_RIGHT_OBJECT_CLICK,
        CONDITION_MOUSE_RIGHT_ZONE_CLICK,
        CONDITION_MOUSE_RIGHT_OBJECT_ZONE_CLICK,
        CONDITION_OBJECT_HIDDEN,                                            // 35
        CONDITION_MOUSE_HOVER,
        CONDITION_MOUSE_OBJECT_HOVER,
        CONDITION_MOUSE_HOVER_ZONE,
        CONDITION_MOUSE_OBJECT_HOVER_ZONE,
        CONDITION_MOUSE_CLICK_FAILED,                                       // 40
        CONDITION_MOUSE_OBJECT_CLICK_FAILED,
        CONDITION_MOUSE_CLICK_EVENT,
        CONDITION_MOUSE_OBJECT_CLICK_EVENT,
        CONDITION_MOUSE_RIGHT_CLICK_EVENT,
        CONDITION_MOUSE_RIGHT_OBJECT_CLICK_EVENT,                           // 45
        CONDITION_MOUSE_STATE_PHRASE_CLICK,
        CONDITION_OBJECT_IS_CLOSER,
        CONDITION_ANIMATED_OBJECT_IDLE_GREATER_THAN_VALUE,
        CONDITION_ANIMATED_OBJECTS_INTERSECTIONAL_BOUNDS,
    };

    enum ConditionDataIndex {
        OBJECT_NAME = 0,
        MOUSE_OBJECT_NAME = 1,
        ZONE_NAME = 1,
        DIRECTION_ANGLE = 1,
        PERSONAGE_NAME = 0,
        TIMER_PERIOD = 0,
        TIMER_RND = 1,
        MINIGAME_NAME = 0,
        MINIGAME_STATE_NAME = 1,
        OBJECT_STATE_NAME = 1,
        CLICK_ZONE_NAME = 0,
        OBJECT2_NAME = 1,
        OBJECTS_DISTANCE = 2,
        ANIMATION_PHASE = 2,
        STATE_TIME = 2
    };

    qdCondition();
    qdCondition(ConditionType tp);
    qdCondition(const qdCondition &cnd);
    ~qdCondition();

    qdCondition &operator = (const qdCondition &cnd);

    ConditionType type() const {
        return _type;
    }
    void set_type(ConditionType tp);

    static const char *type2str(uint type);

    bool put_value(int idx, const char *str);

    bool is_click_condition() const {
        return (_type == CONDITION_MOUSE_CLICK || _type == CONDITION_MOUSE_DIALOG_CLICK || _type == CONDITION_MOUSE_ZONE_CLICK);
    }
    bool is_object_click_condition() const {
        return (_type == CONDITION_MOUSE_OBJECT_CLICK || _type == CONDITION_MOUSE_OBJECT_ZONE_CLICK);
    }

    // val_index - индекс, по которому пропишется значение
    // в qdConditionDataInt::_data или qdConditionDataFloat::_data
    bool put_value(int idx, int val, int val_index = 0);
    bool put_value(int idx, float val, int val_index = 0);

    bool get_value(int idx, const char *&str) const;
    bool get_value(int idx, int &val, int val_index = 0) const;
    bool get_value(int idx, float &val, int val_index = 0) const;

    bool put_object(int idx, qdNamedObject *obj);
    const qdNamedObject *get_object(int idx) ;

    const qdNamedObject *owner() const {
        return _owner;
    }
    void set_owner(const qdNamedObject *p) {
        _owner = p;
    }

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

    void quant(float dt);

    bool load_data(Common::SeekableReadStream &fh, int save_version);
    bool save_data(Common::WriteStream &fh) const;

    bool init();

    bool is_inversed() const {
        return _is_inversed;
    }
    void inverse(bool inverse_mode = true) {
        _is_inversed = inverse_mode;
    }

    bool check();

    bool is_in_group() const {
        return _is_in_group;
    }
    void add_group_reference() {
        _is_in_group = true;
    }
    void remove_group_reference() {
        _is_in_group = false;
    }

    static bool successful_click() {
        return _successful_click;
    }
    static bool successful_object_click() {
        return _successful_object_click;
    }
    static void clear_successful_clicks() {
        _successful_click = _successful_object_click = false;
    }

private:

    ConditionType _type;
    const qdNamedObject *_owner = nullptr;

    typedef Std::vector<qdConditionData> data_container_t;
    data_container_t _data;

    typedef Std::vector<qdConditionObjectReference> objects_container_t;
    objects_container_t _objects;

    bool _is_inversed;

    bool _is_in_group;

    static bool _successful_click;
    static bool _successful_object_click;

    bool init_data(int data_index, qdConditionData::data_t data_type, int data_size = 0) {
        assert(data_index >= 0 && data_index < (int)_data.size());

        _data[data_index].set_type(data_type);
        if (data_size)
            _data[data_index].alloc_data(data_size);

        return true;
    }
};

} // namespace QDEngine

#endif // QDENGINE_QDCORE_QD_CONDITION_H