qd_named_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_NAMED_OBJECT_H
#define QDENGINE_QDCORE_QD_NAMED_OBJECT_H

#include "common/stream.h"
#include "qdengine/qdcore/qd_named_object_base.h"

namespace QDEngine {

enum qdNamedObjectType {
    QD_NAMED_OBJECT_GENERIC,
    QD_NAMED_OBJECT_SCALE_INFO,
    QD_NAMED_OBJECT_TRIGGER_CHAIN,
    QD_NAMED_OBJECT_SOUND,
    QD_NAMED_OBJECT_ANIMATION,
    QD_NAMED_OBJECT_ANIMATION_INFO,
    QD_NAMED_OBJECT_COORDS_ANIMATION,
    QD_NAMED_OBJECT_OBJ_STATE,
    QD_NAMED_OBJECT_STATIC_OBJ,
    QD_NAMED_OBJECT_ANIMATED_OBJ,
    QD_NAMED_OBJECT_MOVING_OBJ,
    QD_NAMED_OBJECT_MOUSE_OBJ,
    QD_NAMED_OBJECT_SCENE,
    QD_NAMED_OBJECT_LOCATION,
    QD_NAMED_OBJECT_DISPATCHER,

    QD_NAMED_OBJECT_ANIMATION_SET,
    QD_NAMED_OBJECT_GRID_ZONE,
    QD_NAMED_OBJECT_VIDEO,
    QD_NAMED_OBJECT_INVENTORY,
    QD_NAMED_OBJECT_MINIGAME,
    QD_NAMED_OBJECT_MUSIC_TRACK,
    QD_NAMED_OBJECT_GRID_ZONE_STATE,

    QD_NAMED_OBJECT_SOUND_INFO,
    QD_NAMED_OBJECT_ANIMATION_SET_INFO,

    QD_NAMED_OBJECT_GAME_END,
    QD_NAMED_OBJECT_COUNTER,

    QD_NAMED_OBJECT_FONT_INFO,

    QD_NAMED_OBJECT_MAX_TYPE
};

const char *objectType2str(int id);

class qdNamedObject : public qdNamedObjectBase {
public:
    qdNamedObject();
    qdNamedObject(const qdNamedObject &p);
    ~qdNamedObject();

    qdNamedObject &operator = (const qdNamedObject &p);

    qdNamedObject *owner() const {
        return _owner;
    }
    qdNamedObject *owner(qdNamedObjectType tp) const;

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

    void set_flag(int fl) {
        _flags |= fl;
    }
    void drop_flag(int fl) {
        _flags &= ~fl;
    }
    bool check_flag(int fl) const {
        if (_flags & fl) return true;
        return false;
    }
    void clear_flags() {
        _flags = 0;
    }
    int flags() const {
        return _flags;
    }

    virtual int named_object_type() const = 0;

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


    void add_trigger_reference() {
        _trigger_reference_count++;
    }
    void remove_trigger_reference() {
        if (_trigger_reference_count) _trigger_reference_count--;
    }
    void clear_trigger_references() {
        _trigger_reference_count = 0;
    }
    bool is_in_triggers() const {
        return (_trigger_reference_count > 0);
    }

    Common::String toString() const;

private:

    int _flags;

    int _trigger_reference_count;

    mutable qdNamedObject *_owner;
};

} // namespace QDEngine

#endif // QDENGINE_QDCORE_QD_NAMED_OBJECT_H