vcmi/client/widgets/CArtifactsOfHeroBase.cpp

/*
 * CArtifactsOfHeroBase.cpp, 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
 *
 */
#include "StdInc.h"
#include "CArtifactsOfHeroBase.h"

#include "../gui/CGuiHandler.h"
#include "../gui/CursorHandler.h"
#include "../gui/Shortcut.h"

#include "Buttons.h"

#include "../CPlayerInterface.h"
#include "../CGameInfo.h"

#include "../../CCallback.h"

#include "../../lib/ArtifactUtils.h"
#include "../../lib/mapObjects/CGHeroInstance.h"

CArtifactsOfHeroBase::CArtifactsOfHeroBase()
	: backpackPos(0),
	curHero(nullptr)
{
}

CArtifactsOfHeroBase::~CArtifactsOfHeroBase()
{
	// TODO: cursor handling is CWindowWithArtifacts level. Should be moved when trading, kingdom and hero window are reworked
	// This will interfere with the implementation of a separate backpack window
	CCS->curh->dragAndDropCursor(nullptr);

	// Artifact located in artifactsTransitionPos should be returned
	if(getPickedArtifact())
	{
		auto slot = ArtifactUtils::getArtAnyPosition(curHero, curHero->artifactsTransitionPos.begin()->artifact->getTypeId());
		if(slot == ArtifactPosition::PRE_FIRST)
		{
			LOCPLINT->cb->eraseArtifactByClient(ArtifactLocation(curHero, ArtifactPosition::TRANSITION_POS));
		}
		else
		{
			LOCPLINT->cb->swapArtifacts(ArtifactLocation(curHero, ArtifactPosition::TRANSITION_POS), ArtifactLocation(curHero, slot));
		}
	}
}

void CArtifactsOfHeroBase::init(
	CHeroArtPlace::ClickHandler lClickCallback,
	CHeroArtPlace::ClickHandler rClickCallback,
	const Point & position,
	BpackScrollHandler scrollHandler)
{
	// CArtifactsOfHeroBase::init may be transform to CArtifactsOfHeroBase::CArtifactsOfHeroBase if OBJECT_CONSTRUCTION_CAPTURING is removed
	OBJECT_CONSTRUCTION_CAPTURING(255 - DISPOSE);
	pos += position;
	for(int g = 0; g < GameConstants::BACKPACK_START; g++)
	{
		artWorn[ArtifactPosition(g)] = std::make_shared<CHeroArtPlace>(slotPos[g]);
	}
	backpack.clear();
	for(int s = 0; s < 5; s++)
	{
		auto artPlace = std::make_shared<CHeroArtPlace>(Point(403 + 46 * s, 365));
		backpack.push_back(artPlace);
	}
	for(auto artPlace : artWorn)
	{
		artPlace.second->slot = artPlace.first;
		artPlace.second->setArtifact(nullptr);
		artPlace.second->leftClickCallback = lClickCallback;
		artPlace.second->rightClickCallback = rClickCallback;
	}
	for(auto artPlace : backpack)
	{
		artPlace->setArtifact(nullptr);
		artPlace->leftClickCallback = lClickCallback;
		artPlace->rightClickCallback = rClickCallback;
	}
	leftBackpackRoll = std::make_shared<CButton>(Point(379, 364), "hsbtns3.def", CButton::tooltip(), [scrollHandler]() { scrollHandler(-1); }, EShortcut::MOVE_LEFT);
	rightBackpackRoll = std::make_shared<CButton>(Point(632, 364), "hsbtns5.def", CButton::tooltip(), [scrollHandler]() { scrollHandler(+1); }, EShortcut::MOVE_RIGHT);
	leftBackpackRoll->block(true);
	rightBackpackRoll->block(true);
}

void CArtifactsOfHeroBase::leftClickArtPlace(CHeroArtPlace & artPlace)
{
	if(leftClickCallback)
		leftClickCallback(*this, artPlace);
}

void CArtifactsOfHeroBase::rightClickArtPlace(CHeroArtPlace & artPlace)
{
	if(rightClickCallback)
		rightClickCallback(*this, artPlace);
}

void CArtifactsOfHeroBase::setHero(const CGHeroInstance * hero)
{
	curHero = hero;
	if(curHero->artifactsInBackpack.size() > 0)
		backpackPos %= curHero->artifactsInBackpack.size();
	else
		backpackPos = 0;

	for(auto slot : artWorn)
	{
		setSlotData(slot.second, slot.first, *curHero);
	}
	scrollBackpackForArtSet(0, *curHero);
}

const CGHeroInstance * CArtifactsOfHeroBase::getHero() const
{
	return curHero;
}

void CArtifactsOfHeroBase::scrollBackpack(int offset)
{
	scrollBackpackForArtSet(offset, *curHero);
	safeRedraw();
}

void CArtifactsOfHeroBase::scrollBackpackForArtSet(int offset, const CArtifactSet & artSet)
{
	// offset==-1 => to left; offset==1 => to right
	using slotInc = std::function<ArtifactPosition(ArtifactPosition&)>;
	auto artsInBackpack = static_cast<int>(artSet.artifactsInBackpack.size());
	auto scrollingPossible = artsInBackpack > backpack.size();

	slotInc inc_straight = [](ArtifactPosition & slot) -> ArtifactPosition
	{
		return slot + 1;
	};
	slotInc inc_ring = [artsInBackpack](ArtifactPosition & slot) -> ArtifactPosition
	{
		return ArtifactPosition(GameConstants::BACKPACK_START + (slot - GameConstants::BACKPACK_START + 1) % artsInBackpack);
	};
	slotInc inc;
	if(scrollingPossible)
		inc = inc_ring;
	else
		inc = inc_straight;

	backpackPos += offset;
	if(backpackPos < 0)
		backpackPos += artsInBackpack;

	if(artsInBackpack)
		backpackPos %= artsInBackpack;

	auto slot = ArtifactPosition(GameConstants::BACKPACK_START + backpackPos);
	for(auto artPlace : backpack)
	{
		setSlotData(artPlace, slot, artSet);
		slot = inc(slot);
	}

	// Blocking scrolling if there is not enough artifacts to scroll
	leftBackpackRoll->block(!scrollingPossible);
	rightBackpackRoll->block(!scrollingPossible);
}

void CArtifactsOfHeroBase::safeRedraw()
{
	if(isActive())
	{
		if(parent)
			parent->redraw();
		else
			redraw();
	}
}

void CArtifactsOfHeroBase::markPossibleSlots(const CArtifactInstance * art, bool assumeDestRemoved)
{
	for(auto artPlace : artWorn)
		artPlace.second->selectSlot(art->artType->canBePutAt(curHero, artPlace.second->slot, assumeDestRemoved));
}

void CArtifactsOfHeroBase::unmarkSlots()
{
	for(auto & artPlace : artWorn)
		artPlace.second->selectSlot(false);

	for(auto & artPlace : backpack)
		artPlace->selectSlot(false);
}

CArtifactsOfHeroBase::ArtPlacePtr CArtifactsOfHeroBase::getArtPlace(const ArtifactPosition & slot)
{
	if(ArtifactUtils::isSlotEquipment(slot))
	{
		if(artWorn.find(slot) == artWorn.end())
		{
			logGlobal->error("CArtifactsOfHero::getArtPlace: invalid slot %d", slot);
			return nullptr;
		}
		return artWorn[slot];
	}
	if(ArtifactUtils::isSlotBackpack(slot))
	{
		for(ArtPlacePtr artPlace : backpack)
			if(artPlace->slot == slot)
				return artPlace;
		return nullptr;
	}
	else
	{
		return nullptr;
	}
}

void CArtifactsOfHeroBase::updateWornSlots()
{
	for(auto place : artWorn)
		updateSlot(place.first);
}

void CArtifactsOfHeroBase::updateBackpackSlots()
{
	if(curHero->artifactsInBackpack.size() <= backpack.size() && backpackPos != 0)
		backpackPos = 0;
	scrollBackpackForArtSet(0, *curHero);
}

void CArtifactsOfHeroBase::updateSlot(const ArtifactPosition & slot)
{
	setSlotData(getArtPlace(slot), slot, *curHero);
}

const CArtifactInstance * CArtifactsOfHeroBase::getPickedArtifact()
{
	// Returns only the picked up artifact. Not just highlighted like in the trading window.
	if(!curHero || curHero->artifactsTransitionPos.empty())
		return nullptr;
	else
		return curHero->getArt(ArtifactPosition::TRANSITION_POS);
}

void CArtifactsOfHeroBase::setSlotData(ArtPlacePtr artPlace, const ArtifactPosition & slot, const CArtifactSet & artSet)
{
	// Spurious call from artifactMoved in attempt to update hidden backpack slot
	if(!artPlace && ArtifactUtils::isSlotBackpack(slot))
	{
		return;
	}

	artPlace->slot = slot;
	if(auto slotInfo = artSet.getSlot(slot))
	{
		artPlace->lockSlot(slotInfo->locked);
		artPlace->setArtifact(slotInfo->artifact);
		if(!slotInfo->artifact->isCombined())
		{
			// If the artifact is part of at least one combined artifact, add additional information
			std::map<const CArtifact*, int> arts;
			for(const auto combinedArt : slotInfo->artifact->artType->getPartOf())
			{
				arts.insert(std::pair(combinedArt, 0));
				for(const auto part : combinedArt->getConstituents())
					if(artSet.hasArt(part->getId(), true))
						arts.at(combinedArt)++;
			}
			artPlace->addCombinedArtInfo(arts);
		}
	}
	else
	{
		artPlace->setArtifact(nullptr);
	}
}