Grid.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_GRID_H
#define GF_GRID_H

#include "GraphicsApi.h"
#include "Hexagon.h"
#include "Transformable.h"
#include "Vector.h"
#include "VertexArray.h"
#include "VertexBuffer.h"

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

  class GF_GRAPHICS_API SquareGrid : public gf::Transformable {
  public:
    SquareGrid(Vector2i gridSize, Vector2f cellSize, const Color4f& color, float lineWidth = 1.0f);

    void setGridSize(Vector2i gridSize);

    Vector2i getGridSize() const noexcept {
      return m_gridSize;
    }

    void setCellSize(Vector2f cellSize);

    Vector2f getCellSize() const noexcept {
      return m_cellSize;
    }

    void setColor(const Color4f& color);

    const Color4f& getColor() const noexcept {
      return m_color;
    }

    void setLineWidth(float lineWidth) noexcept {
      m_lineWidth = lineWidth;
    }

    float getLineWidth() const noexcept {
      return m_lineWidth;
    }

    RectF getLocalBounds() const;

    void setAnchor(Anchor anchor);

    VertexBuffer commitGeometry() const;

    virtual void draw(RenderTarget& target, const RenderStates& states) override;

  private:
    void updateGeometry();

  private:
    Vector2i m_gridSize;
    Vector2f m_cellSize;
    Color4f m_color;
    float m_lineWidth;
    VertexArray m_vertices;
  };

  class GF_GRAPHICS_API HexagonGrid : public gf::Transformable {
  public:
    HexagonGrid(MapCellAxis axis, MapCellIndex index, Vector2i gridSize, float radius, const Color4f& color, float lineWidth = 1.0f);

    void setGridSize(Vector2i gridSize);

    Vector2i getGridSize() const noexcept {
      return m_gridSize;
    }

    void setRadius(float radius);

    float getRadius() const noexcept {
      return m_radius;
    }

    Vector2f getHexagonSize() const noexcept {
      return m_helper.getHexagonSize(m_radius);
    }

    void setColor(const Color4f& color);

    const Color4f& getColor() const noexcept {
      return m_color;
    }

    void setLineWidth(float lineWidth) noexcept {
      m_lineWidth = lineWidth;
    }

    float getLineWidth() const noexcept {
      return m_lineWidth;
    }

    RectF getLocalBounds() const;

    void setAnchor(Anchor anchor);

    VertexBuffer commitGeometry() const;

    virtual void draw(RenderTarget& target, const RenderStates& states) override;

  private:
    void updateGeometry();

  private:
    Vector2i m_gridSize;
    float m_radius;
    HexagonHelper m_helper;
    Color4f m_color;
    float m_lineWidth;
    VertexArray m_vertices;
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_GRID_H