qd_conditional_object.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_CONDITIONAL_OBJECT_H
#define QDENGINE_QDCORE_CONDITIONAL_OBJECT_H

#include "qdengine/parser/xml_fwd.h"
#include "qdengine/qdcore/qd_condition.h"
#include "qdengine/qdcore/qd_condition_group.h"
#include "qdengine/qdcore/qd_named_object.h"

namespace Common {
class WriteStream;
}

namespace QDEngine {

class qdConditionalObject : public qdNamedObject {
public:
    qdConditionalObject();
    qdConditionalObject(const qdConditionalObject &obj);
    ~qdConditionalObject();

    qdConditionalObject &operator = (const qdConditionalObject &obj);

    enum ConditionsMode {
        CONDITIONS_AND,
        CONDITIONS_OR
    };

    typedef Std::vector<qdCondition> conditions_container_t;
    typedef Std::vector<qdConditionGroup> condition_groups_container_t;

    virtual bool check_conditions();
    int add_condition(const qdCondition *p);
    bool update_condition(int num, const qdCondition &p);

    bool remove_conditon(int idx);

    const qdCondition *get_condition(int idx = 0) const {
        return &*(_conditions.begin() + idx);
    }

    int conditions_count() const {
        return _conditions.size();
    }

    int add_condition_group(const qdConditionGroup *p);
    bool update_condition_group(int num, const qdConditionGroup &p);

    bool remove_conditon_group(int idx);

    const qdConditionGroup *get_condition_group(int idx = 0) const {
        return &*(_condition_groups.begin() + idx);
    }

    int condition_groups_count() const {
        return _condition_groups.size();
    }

    ConditionsMode conditions_mode() const {
        return _conditions_mode;
    }
    void set_conditions_mode(ConditionsMode m) {
        _conditions_mode = m;
    }

    bool has_conditions() const {
        return !_conditions.empty();
    }

    void conditions_quant(float dt);

    virtual bool init();

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

    bool is_condition_in_group(int condition_idx) const;

    enum trigger_start_mode {
        TRIGGER_START_FAILED,
        TRIGGER_START_ACTIVATE,
        TRIGGER_START_WAIT
    };
    virtual trigger_start_mode trigger_start() = 0;


    virtual bool trigger_can_start() const;

protected:

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

private:

    ConditionsMode _conditions_mode;

    conditions_container_t _conditions;

    condition_groups_container_t _condition_groups;

    bool check_group_conditions(const qdConditionGroup &gr);
};

} // namespace QDEngine

#endif // QDENGINE_QDCORE_CONDITIONAL_OBJECT_H