map_widget.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 ULTIMA_SHARED_MAPS_MAP_WIDGET_H
#define ULTIMA_SHARED_MAPS_MAP_WIDGET_H

#include "common/events.h"
#include "common/ptr.h"
#include "common/serializer.h"
#include "common/str.h"
#include "ultima/shared/core/message_target.h"
#include "ultima/shared/core/rect.h"

namespace Ultima {
namespace Shared {

class Game;

namespace Maps {

enum Direction {
    DIR_NONE = 0,
    DIR_LEFT = 1, DIR_RIGHT = 2, DIR_UP = 3, DIR_DOWN = 4,
    DIR_WEST = 1, DIR_EAST = 2, DIR_NORTH = 3, DIR_SOUTH = 4
};

class MapBase;

class MapWidget : public MessageTarget {
    DECLARE_MESSAGE_MAP;
protected:
    Game *_game;                        // Game reference
    MapBase *_map;                      // Map reference
public:
    Point _position;                    // Position within the map
    Direction _direction;               // Direction
    Common::String _name;               // Name of widget
public:
    static Direction directionFromKey(Common::KeyCode keycode);
public:
    CLASSDEF;

    MapWidget(Game *game, MapBase *map) : _game(game), _map(map), _direction(DIR_NONE) {}
    MapWidget(Game *game, MapBase *map, const Point &pt, Direction dir = DIR_NONE) : _game(game), _map(map), _position(pt), _direction(dir) {}
    MapWidget(Game *game, MapBase *map, const Common::String &name, const Point &pt, Direction dir = DIR_NONE) :
        _game(game), _map(map), _name(name), _position(pt), _direction(dir) {}

    ~MapWidget() override {}

    virtual const char *getClassName() const { return nullptr; }

    virtual void synchronize(Common::Serializer &s);

    void addInfoMsg(const Common::String &text, bool newLine = true, bool replaceLine = false);

    virtual uint getTileNum() const { return 0; }

    virtual bool isBlocking() const { return true; }

    virtual void update(bool isPreUpdate) {}

    enum CanMove { UNSET = 0, YES = 1, NO = 2 };

    virtual CanMove canMoveTo(const Point &destPos);

    virtual void moveTo(const Point &destPos, Direction dir = DIR_NONE);
};

typedef Common::SharedPtr<MapWidget> MapWidgetPtr;

} // End of namespace Maps
} // End of namespace Shared
} // End of namespace Ultima

#endif