vcmi/client/battle/CBattleFieldController.h

/*
 * CBattleFieldController.h, part of VCMI engine
 *
 * Authors: listed in file AUTHORS in main folder
 *
 * License: GNU General Public License v2.0 or later
 * Full text of license available in license.txt file, in main folder
 *
 */
#pragma once

#include "../../lib/battle/BattleHex.h"
#include "../gui/CIntObject.h"

VCMI_LIB_NAMESPACE_BEGIN

class CStack;

VCMI_LIB_NAMESPACE_END

struct SDL_Surface;
struct Rect;
struct Point;

class CClickableHex;
class CCanvas;
class IImage;
class CBattleInterface;

enum class EBattleFieldLayer {
					   // confirmed ordering requirements:
	OBSTACLES     = 0,
	CORPSES       = 0,
	WALLS         = 1,
	HEROES        = 1,
	STACKS        = 1, // after corpses, obstacles
	BATTLEMENTS   = 2, // after stacks
	STACK_AMOUNTS = 2, // after stacks, obstacles, corpses
	EFFECTS       = 3, // after obstacles, battlements
};

class CBattleFieldRenderer
{
public:
	using RendererPtr = std::shared_ptr<CCanvas>;
	using RenderFunctor = std::function<void(RendererPtr)>;

private:
	CBattleInterface * owner;

	struct RenderableInstance
	{
		RenderFunctor functor;
		EBattleFieldLayer layer;
		BattleHex tile;
	};
	std::vector<RenderableInstance> objects;

	void collectObjects();
	void sortObjects();
	void renderObjects(RendererPtr targetCanvas);
public:
	CBattleFieldRenderer(CBattleInterface * owner);

	void insert(EBattleFieldLayer layer, BattleHex tile, RenderFunctor functor);
	void execute(RendererPtr targetCanvas);
};

class CBattleFieldController : public CIntObject
{
	CBattleInterface * owner;

	std::shared_ptr<IImage> background;
	std::shared_ptr<IImage> cellBorder;
	std::shared_ptr<IImage> cellShade;

	std::shared_ptr<CCanvas> cellBorders;

	/// Canvas that contains background, hex grid (if enabled), absolute obstacles and movement range of active stack
	std::shared_ptr<CCanvas> backgroundWithHexes;

	//BattleHex previouslyHoveredHex; //number of hex that was hovered by the cursor a while ago
	//BattleHex currentlyHoveredHex; //number of hex that is supposed to be hovered (for a while it may be inappropriately set, but will be renewed soon)
	BattleHex attackingHex; //hex from which the stack would perform attack with current cursor

	std::vector<BattleHex> occupyableHexes; //hexes available for active stack
	std::array<bool, GameConstants::BFIELD_SIZE> stackCountOutsideHexes; // hexes that when in front of a unit cause it's amount box to move back

	std::vector<std::shared_ptr<CClickableHex>> bfield; //11 lines, 17 hexes on each

	void showHighlightedHex(std::shared_ptr<CCanvas> to, BattleHex hex, bool darkBorder);

	std::set<BattleHex> getHighlightedHexesStackRange();
	std::set<BattleHex> getHighlightedHexesSpellRange();

	void showBackground(std::shared_ptr<CCanvas> canvas);
	void showBackgroundImage(std::shared_ptr<CCanvas> canvas);
	void showBackgroundImageWithHexes(std::shared_ptr<CCanvas> canvas);
	void showHighlightedHexes(std::shared_ptr<CCanvas> canvas);

public:
	CBattleFieldController(CBattleInterface * owner);

	void redrawBackgroundWithHexes();
	void renderBattlefield(std::shared_ptr<CCanvas> canvas);

	Rect hexPositionLocal(BattleHex hex) const;
	Rect hexPosition(BattleHex hex) const;
	bool isPixelInHex(Point const & position);

	BattleHex getHoveredHex();

	void setBattleCursor(BattleHex myNumber);
	BattleHex fromWhichHexAttack(BattleHex myNumber);
	bool isTileAttackable(const BattleHex & number) const;
	bool stackCountOutsideHex(const BattleHex & number) const;
};