Map.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2021 Julien Bernard
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
#ifndef GF_MAP_H
#define GF_MAP_H

#include "Array2D.h"
#include "CoreApi.h"
#include "Flags.h"
#include "Vector.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  enum class CellProperty : uint8_t {
    Transparent = 0x01, 
    Walkable    = 0x02, 
    Visible     = 0x10, 
    Explored    = 0x20, 
  };

  constexpr Flags<CellProperty> EmptyCell = combineFlags(CellProperty::Transparent, CellProperty::Walkable);

  enum class FieldOfVision {
    Basic,  
  };

  enum class FieldOfVisionLimit {
    Included, 
    Excluded, 
  };

  enum class Route {
    AStar,    
    Dijkstra, 
  };

  class GF_CORE_API SquareMap {
  public:


    SquareMap(Vector2i size);

    Vector2i getSize() const;

    PositionRange<int> getRange() const;

    void setCell(Vector2i pos, Flags<CellProperty> flags);

    void reset(Flags<CellProperty> flags);

    void setTransparent(Vector2i pos, bool transparent = true);

    bool isTransparent(Vector2i pos) const;

    void setWalkable(Vector2i pos, bool walkable = true);

    bool isWalkable(Vector2i pos) const;

    void setEmpty(Vector2i pos);

    void clearFieldOfVision();

    void clearExplored();

    void computeFieldOfVision(Vector2i pos, int maxRadius = 0, FieldOfVisionLimit limit = FieldOfVisionLimit::Included, FieldOfVision algorithm = FieldOfVision::Basic);

    void computeLocalFieldOfVision(Vector2i pos, int maxRadius = 0, FieldOfVisionLimit limit = FieldOfVisionLimit::Included, FieldOfVision algorithm = FieldOfVision::Basic);

    bool isInFieldOfVision(Vector2i pos) const;

    bool isExplored(Vector2i pos) const;

    std::vector<Vector2i> computeRoute(Vector2i origin, Vector2i target, float diagonalCost = Sqrt2, Route algorithm = Route::AStar);

  private:
    Array2D<Flags<CellProperty>, int> m_cells;
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}

template<>
struct EnableBitmaskOperators<CellProperty> {
  static constexpr bool value = true;
};
#endif
}



#endif // GF_MAP_H