qd_game_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_QD_GAME_OBJECT_H
#define QDENGINE_QDCORE_QD_GAME_OBJECT_H

#include "qdengine/parser/xml_fwd.h"
#include "qdengine/system/input/mouse_input.h"
#include "qdengine/system/graphics/gr_screen_region.h"
#include "qdengine/qdcore/qd_named_object.h"

namespace Common {
class WriteStream;
}

namespace QDEngine {

const int QD_OBJ_MOVING_FLAG            = 0x01;
const int QD_OBJ_HIDDEN_FLAG            = 0x02;
const int QD_OBJ_INVERSE_PERSPECTIVE_FLAG   = 0x04;
const int QD_OBJ_SHOW_NAME_FLAG         = 0x08;
const int QD_OBJ_NO_SCALE_FLAG          = 0x10;
const int QD_OBJ_SCREEN_COORDS_FLAG     = 0x20;
const int QD_OBJ_NON_PLAYER_PERSONAGE_FLAG  = 0x40;
const int QD_OBJ_HAS_BOUND_FLAG         = 0x80;
const int QD_OBJ_DISABLE_MOVEMENT_FLAG      = 0x100;
const int QD_OBJ_DISABLE_MOUSE_FLAG     = 0x200;
const int QD_OBJ_IS_IN_TRIGGER_FLAG     = 0x400;
const int QD_OBJ_STATE_CHANGE_FLAG      = 0x800;
const int QD_OBJ_IS_IN_INVENTORY_FLAG       = 0x1000;
const int QD_OBJ_KEYBOARD_CONTROL_FLAG      = 0x2000;
const int QD_OBJ_FIXED_SCREEN_COORDS_FLAG   = 0x4000;

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

    qdGameObject &operator = (const qdGameObject &obj);

    void set_parallax_offset(int offs_x, int offs_y) {
        _parallax_offset.x = offs_x;
        _parallax_offset.y = offs_y;
    }
    const Vect2i &get_parallax_offset() const {
        return _parallax_offset;
    }

    virtual void redraw(int offs_x = 0, int offs_y = 0) const = 0;
    virtual void debug_redraw() const = 0;
    virtual void draw_contour(uint32 color) const = 0;
    virtual void draw_shadow(int offs_x, int offs_y, uint32 color, int alpha) const = 0;

    virtual bool need_redraw() const {
        return false;
    }
    virtual void post_redraw() { }

    virtual const grScreenRegion last_screen_region() const {
        return grScreenRegion_EMPTY;
    }
    virtual grScreenRegion screen_region() const {
        return grScreenRegion(grScreenRegion_EMPTY);
    }

    virtual bool mouse_handler(int x, int y, mouseDispatcher::mouseEvent ev) = 0;
    virtual bool hit(int x, int y) const = 0;

    const Vect2i &screen_pos() const {
        return _screen_r;
    }
    virtual bool update_screen_pos();
    virtual Vect2s screen_size() const = 0;

    float screen_depth() const {
        return _screen_depth;
    }

    virtual bool is_visible() const {
        return !check_flag(QD_OBJ_HIDDEN_FLAG);
    }

    const Vect3f &R() const {
        return _r;
    }
    void set_pos(const Vect3f &rr) {
        _r = rr;
    }

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

    virtual bool load_resources() {
        return true;
    };
    virtual void free_resources() { };

    virtual bool init();

    virtual void quant(float dt);

    virtual bool init_grid_zone() {
        return false;
    }
    virtual bool toggle_grid_zone(bool make_walkable = false) {
        return false;
    }
    virtual bool save_grid_zone() {
        return false;
    }
    virtual bool restore_grid_zone() {
        return false;
    }
    virtual bool set_grid_zone_attributes(int attr) const {
        return false;
    }
    virtual bool drop_grid_zone_attributes(int attr) const {
        return false;
    }

    virtual bool get_debug_info(Common::String &buf) const {
        return true;
    }

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

    const Vect2i &get_screen_R() const {
        return _screen_r;
    }

    void setTempPosInList(uint pos) { _tempPosInList = pos; }
    uint tempPosInList() const { return _tempPosInList; }

    Common::String flag2str(int flags) const;

protected:

    virtual bool load_script_body(const xml::tag *p);
    virtual bool save_script_body(Common::WriteStream &fh, int indent = 0) const;

    void set_screen_R(const Vect2i &v) {
        _screen_r = v;
    }

private:

    Vect3f _r;
    Vect2i _parallax_offset;

    Vect2i _screen_r;
    float _screen_depth;
    uint _tempPosInList;
};

#ifdef __QD_DEBUG_ENABLE__
inline bool qdbg_is_object(const qdNamedObject *obj, const char *scene_name, const char *object_name) {
    if (dynamic_cast<const qdGameObject * >(obj)) {
        if (obj->name() && !strcmp(object_name, obj->name())) {
            if (!scene_name || (obj->owner() && obj->owner()->name() && !strcmp(obj->owner()->name(), scene_name)))
                return true;
        }
    }

    return false;
}
#else
inline bool qdbg_is_object(const qdNamedObject *, const char *, const char *) {
    return false;
}
#endif

} // namespace QDEngine

#endif // QDENGINE_QDCORE_QD_GAME_OBJECT_H