annotation.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 ULTIMA4_MAP_ANNOTATION_H
#define ULTIMA4_MAP_ANNOTATION_H

#include "ultima/ultima4/core/coords.h"
#include "ultima/ultima4/core/types.h"
#include "ultima/ultima4/map/map_tile.h"
#include "common/list.h"

namespace Ultima {
namespace Ultima4 {

class Annotation;

class Annotation {
public:
    typedef Common::List<Annotation> List;

    Annotation(const Coords &coords, MapTile tile, bool visual = false, bool coverUp = false);

    void debug_output() const;

    // Getters
    const Coords &getCoords() const {
        return _coords;
    }

    MapTile &getTile() {
        return _tile;
    }

    bool isVisualOnly() const {
        return _visual;
    }

    int getTTL() const {
        return _ttl;
    }

    bool isCoverUp() const {
        return _coverUp;
    }

    // Setters
    void setCoords(const Coords &c) {
        _coords = c;
    }

    void setTile(const MapTile &t) {
        _tile = t;
    }

    void setVisualOnly(bool v) {
        _visual = v;
    }

    void setTTL(int turns) {
        _ttl = turns;
    }

    void passTurn() {
        if (_ttl > 0) _ttl--;
    }

    bool operator==(const Annotation &) const;

    // Properties
private:
    Coords _coords;
    MapTile _tile;
    bool _visual;
    int _ttl;
    bool _coverUp;
};

class AnnotationMgr {
public:
    AnnotationMgr();

    Annotation *add(Coords coords, MapTile tile, bool visual = false, bool isCoverUp = false);

    Annotation::List allAt(Coords pos);

    Common::List<Annotation *> ptrsToAllAt(Coords pos);

    void clear();

    void passTurn();

    void remove(Coords pos, MapTile tile);
    void remove(Annotation &);

    void remove(Annotation::List);

    int size() const;

private:
    Annotation::List  _annotations;
    Annotation::List::iterator _it;
};

} // End of namespace Ultima4
} // End of namespace Ultima

#endif