map.h

Go to the documentation of this file.

/*
 *  The Mana Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2012  The Mana Developers
 *
 *  This file is part of The Mana Client.
 *
 *  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 2 of the License, or
 *  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/>.
 */
 
#pragma once
 
#include "actor.h"
#include "position.h"
#include "properties.h"
#include "simpleanimation.h"
 
#include <list>
#include <vector>
 
class AmbientLayer;
class Graphics;
class MapLayer;
class Particle;
class Tileset;
 
const int DEFAULT_TILE_LENGTH = 32;
 
struct MetaTile
{
    // Pathfinding members
    int Fcost;               
    int Gcost;               
    int Hcost;               
    unsigned whichList = 0;  
    int parentX;             
    int parentY;             
    unsigned char blockmask = 0; 
};
 
class TileAnimation
{
    public:
        TileAnimation(Animation animation);
 
        void update(int dt);
 
        void addAffectedTile(MapLayer *layer, int index)
        { mAffected.emplace_back(layer, index); }
 
    private:
        std::vector<std::pair<MapLayer*, int> > mAffected;
        SimpleAnimation mAnimation;
        Image *mLastImage = nullptr;
};
 
class MapLayer
{
    public:
        MapLayer(int x, int y, int width, int height, bool isFringeLayer,
                 Map *map);
 
        ~MapLayer();
 
        int getWidth() const { return mWidth; }
 
        void setTile(int x, int y, Image *img);
 
        void setTile(int index, Image *img) { mTiles[index] = img; }
 
        Image *getTile(int x, int y) const
        { return mTiles[x + y * mWidth]; }
 
        void draw(Graphics *graphics,
                  int startX, int startY,
                  int endX, int endY,
                  int scrollX, int scrollY,
                  const Actors &actors,
                  int debugFlags) const;
 
        bool isFringeLayer() const
        { return mIsFringeLayer; }
 
        int getTileDrawWidth(int x1, int y1, int endX, int &width) const;
 
        void setMask(int mask) { mMask = mask; }
        int getMask() const { return mMask; }
 
    private:
        int mX, mY;
        int mWidth, mHeight;
        int mMask = 1;
        bool mIsFringeLayer;    
        Image **mTiles;
        Map *mMap;              
};
 
class Map : public Properties
{
    public:
        enum BlockType
        {
            BLOCKTYPE_NONE = -1,
            BLOCKTYPE_WALL,
            BLOCKTYPE_CHARACTER,
            BLOCKTYPE_MONSTER,
            NB_BLOCKTYPES
        };
 
        enum BlockMask
        {
            BLOCKMASK_WALL      = 0x80, // = bin 1000 0000
            BLOCKMASK_CHARACTER = 0x01, // = bin 0000 0001
            BLOCKMASK_MONSTER   = 0x02, // = bin 0000 0010
            BLOCKMASK_ALL       = 0xFF  // = bin 1111 1111
        };
 
        enum DebugFlags
        {
            DEBUG_NONE = 0x0,
            DEBUG_GRID = 0x1,
            DEBUG_COLLISION_TILES = 0x2,
            DEBUG_BEING_COLLISION_RADIUS = 0x4,
            DEBUG_BEING_POSITION = 0x8,
            DEBUG_BEING_PATH = 0x10,
            DEBUG_MOUSE_PATH = 0x20,
            DEBUG_BEING_IDS = 0x40,
            DEBUG_SPECIAL1 = 0x80,
            DEBUG_SPECIAL2 = 0x100,
            DEBUG_SPECIAL3 = 0x200
        };
 
        Map(int width, int height, int tileWidth, int tileHeight);
 
        ~Map() override;
 
        void initializeAmbientLayers();
 
        void update(int dt);
 
        void draw(Graphics *graphics, int scrollX, int scrollY);
 
        void drawCollision(Graphics *graphics, int scrollX, int scrollY,
                           int debugFlags) const;
 
        void addLayer(MapLayer *layer);
 
        void addTileset(Tileset *tileset);
 
        Tileset *getTilesetWithGid(unsigned gid) const;
 
        MetaTile *getMetaTile(int x, int y) const;
 
        void blockTile(int x, int y, BlockType type);
 
        bool getWalk(int x, int y,
                     unsigned char walkmask = BLOCKMASK_WALL) const;
 
        bool occupied(int x, int y) const;
 
        int getWidth() const { return mWidth; }
 
        int getHeight() const { return mHeight; }
 
        int getTileWidth() const
        { return mTileWidth; }
 
        int getTileHeight() const
        { return mTileHeight; }
 
        Vector getTileCenter(int x, int y) const;
 
        std::string getMusicFile() const;
        std::string getName() const;
 
        std::string getFilename() const;
 
        Position checkNodeOffsets(int radius, unsigned char walkMask,
                                  const Position &position) const;
        Position checkNodeOffsets(int radius, unsigned char walkMask,
                                  int x, int y) const
        { return checkNodeOffsets(radius, walkMask, Position(x, y)); }
 
        Path findTilePath(int startPixelX, int startPixelY, int endPixelX,
                          int endPixelY, unsigned char walkMask,
                          int maxCost = 20);
 
        Path findPixelPath(int startPixelX, int startPixelY,
                          int destPixelX, int destPixelY,
                          int radius, unsigned char walkmask, int maxCost = 20);
 
        void addParticleEffect(const std::string &effectFile, int x, int y, int w = 0, int h = 0);
 
        void initializeParticleEffects(Particle* particleEngine);
 
        void addAnimation(int gid, TileAnimation animation);
 
        void setDebugFlags(int flags) { mDebugFlags = flags; }
 
        int getDebugFlags() const { return mDebugFlags; }
 
        TileAnimation *getAnimationForGid(int gid);
 
        void setMask(int mask);
 
    protected:
        friend class Actor;
 
        Actors::iterator addActor(Actor *actor);
 
        void removeActor(Actors::iterator iterator);
 
    private:
        Path findPath(int startX, int startY, int destX, int destY,
                      unsigned char walkmask, int maxCost = 20);
 
        enum LayerType
        {
            FOREGROUND_LAYERS,
            BACKGROUND_LAYERS
        };
 
        void updateAmbientLayers(float scrollX, float scrollY);
 
        void drawAmbientLayers(Graphics *graphics, LayerType type, float scrollX, float scrollY,
                         int detail);
 
        bool contains(int x, int y) const;
 
        unsigned *mOccupation[NB_BLOCKTYPES];
 
        int mWidth, mHeight;
        int mTileWidth, mTileHeight;
        int mMaxTileHeight, mMaxTileWidth;
        MetaTile *mMetaTiles;
        std::vector<MapLayer *> mLayers;
        std::vector<Tileset *> mTilesets;
        Actors mActors;
 
        // debug flags
        int mDebugFlags;
 
        // Pathfinding members
        unsigned mOnClosedList, mOnOpenList;
 
        // Overlay data
        std::vector<AmbientLayer> mBackgrounds;
        std::vector<AmbientLayer> mForegrounds;
        float mLastScrollX;
        float mLastScrollY;
 
        // Particle effect data
        struct ParticleEffectData
        {
            std::string file;
            int x;
            int y;
            int w;
            int h;
        };
        std::list<ParticleEffectData> particleEffects;
 
        std::map<int, TileAnimation> mTileAnimations;
 
        int mMask = 1;
};