/* * RmgObject.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 "RmgObject.h" #include "RmgMap.h" #include "../mapping/CMapEditManager.h" #include "../mapping/CMap.h" #include "../VCMI_Lib.h" #include "../mapObjectConstructors/AObjectTypeHandler.h" #include "../mapObjectConstructors/CObjectClassesHandler.h" #include "../mapObjects/ObjectTemplate.h" #include "../mapObjects/CGObjectInstance.h" #include "Functions.h" #include "../TerrainHandler.h" VCMI_LIB_NAMESPACE_BEGIN using namespace rmg; Object::Instance::Instance(const Object& parent, CGObjectInstance & object): dParent(parent), dObject(object) { setPosition(dPosition); } Object::Instance::Instance(const Object& parent, CGObjectInstance & object, const int3 & position): Instance(parent, object) { setPosition(position); } const Area & Object::Instance::getBlockedArea() const { if(dBlockedAreaCache.empty()) { std::set blockedArea = dObject.getBlockedPos(); dBlockedAreaCache.assign(rmg::Tileset(blockedArea.begin(), blockedArea.end())); if(dObject.isVisitable() || dBlockedAreaCache.empty()) dBlockedAreaCache.add(dObject.visitablePos()); } return dBlockedAreaCache; } int3 Object::Instance::getTopTile() const { return object().getTopVisiblePos(); } int3 Object::Instance::getPosition(bool isAbsolute) const { if(isAbsolute) return dPosition + dParent.getPosition(); else return dPosition; } int3 Object::Instance::getVisitablePosition() const { return dObject.visitablePos(); } const rmg::Area & Object::Instance::getAccessibleArea() const { if(dAccessibleAreaCache.empty()) { auto neighbours = rmg::Area({getVisitablePosition()}).getBorderOutside(); // FIXME: Blocked area of removable object is also accessible area for neighbors rmg::Area visitable = rmg::Area(neighbours) - getBlockedArea(); // TODO: Add in one operation to avoid multiple invalidation for(const auto & from : visitable.getTilesVector()) { if(isVisitableFrom(from)) dAccessibleAreaCache.add(from); } } return dAccessibleAreaCache; } void Object::Instance::setPosition(const int3 & position) { dPosition = position; dObject.pos = dPosition + dParent.getPosition(); dBlockedAreaCache.clear(); dAccessibleAreaCache.clear(); dParent.clearCachedArea(); } void Object::Instance::setPositionRaw(const int3 & position) { if(!dObject.pos.valid()) { dObject.pos = dPosition + dParent.getPosition(); dBlockedAreaCache.clear(); dAccessibleAreaCache.clear(); dParent.clearCachedArea(); } auto shift = position + dParent.getPosition() - dObject.pos; dAccessibleAreaCache.translate(shift); dBlockedAreaCache.translate(shift); dPosition = position; dObject.pos = dPosition + dParent.getPosition(); } void Object::Instance::setAnyTemplate(CRandomGenerator & rng) { auto templates = dObject.getObjectHandler()->getTemplates(); if(templates.empty()) throw rmgException(boost::str(boost::format("Did not find any graphics for object (%d,%d)") % dObject.ID % dObject.getObjTypeIndex())); dObject.appearance = *RandomGeneratorUtil::nextItem(templates, rng); dAccessibleAreaCache.clear(); setPosition(getPosition(false)); } void Object::Instance::setTemplate(TerrainId terrain, CRandomGenerator & rng) { auto templates = dObject.getObjectHandler()->getMostSpecificTemplates(terrain); if (templates.empty()) { auto terrainName = VLC->terrainTypeHandler->getById(terrain)->getNameTranslated(); throw rmgException(boost::str(boost::format("Did not find graphics for object (%d,%d) at %s") % dObject.ID % dObject.getObjTypeIndex() % terrainName)); } dObject.appearance = *RandomGeneratorUtil::nextItem(templates, rng); dAccessibleAreaCache.clear(); setPosition(getPosition(false)); } void Object::Instance::clear() { if (onCleared) onCleared(&dObject); delete &dObject; dBlockedAreaCache.clear(); dAccessibleAreaCache.clear(); dParent.clearCachedArea(); } bool Object::Instance::isVisitableFrom(const int3 & position) const { auto relPosition = position - getPosition(true); return dObject.appearance->isVisitableFrom(relPosition.x, relPosition.y); } bool Object::Instance::isBlockedVisitable() const { return dObject.isBlockedVisitable(); } bool Object::Instance::isRemovable() const { return dObject.isRemovable(); } CGObjectInstance & Object::Instance::object() { return dObject; } const CGObjectInstance & Object::Instance::object() const { return dObject; } Object::Object(CGObjectInstance & object, const int3 & position): guarded(false) { addInstance(object, position); } Object::Object(CGObjectInstance & object): guarded(false) { addInstance(object); } Object::Object(const Object & object): guarded(false) { for(const auto & i : object.dInstances) addInstance(const_cast(i.object()), i.getPosition()); setPosition(object.getPosition()); } std::list & Object::instances() { if (cachedInstanceList.empty()) { for(auto & i : dInstances) cachedInstanceList.push_back(&i); } return cachedInstanceList; } std::list & Object::instances() const { if (cachedInstanceConstList.empty()) { for(const auto & i : dInstances) cachedInstanceConstList.push_back(&i); } return cachedInstanceConstList; } void Object::addInstance(Instance & object) { //assert(object.dParent == *this); setGuardedIfMonster(object); dInstances.push_back(object); cachedInstanceList.push_back(&object); cachedInstanceConstList.push_back(&object); clearCachedArea(); visibleTopOffset.reset(); } Object::Instance & Object::addInstance(CGObjectInstance & object) { dInstances.emplace_back(*this, object); setGuardedIfMonster(dInstances.back()); cachedInstanceList.push_back(&dInstances.back()); cachedInstanceConstList.push_back(&dInstances.back()); clearCachedArea(); visibleTopOffset.reset(); return dInstances.back(); } Object::Instance & Object::addInstance(CGObjectInstance & object, const int3 & position) { dInstances.emplace_back(*this, object, position); setGuardedIfMonster(dInstances.back()); cachedInstanceList.push_back(&dInstances.back()); cachedInstanceConstList.push_back(&dInstances.back()); clearCachedArea(); visibleTopOffset.reset(); return dInstances.back(); } const int3 & Object::getPosition() const { return dPosition; } int3 Object::getVisitablePosition() const { assert(!dInstances.empty()); for(const auto & instance : dInstances) if(!getArea().contains(instance.getVisitablePosition())) return instance.getVisitablePosition(); return dInstances.back().getVisitablePosition(); //fallback - return position of last object } const rmg::Area & Object::getAccessibleArea(bool exceptLast) const { if(dInstances.empty()) return dAccessibleAreaFullCache; if(exceptLast && !dAccessibleAreaCache.empty()) return dAccessibleAreaCache; if(!exceptLast && !dAccessibleAreaFullCache.empty()) return dAccessibleAreaFullCache; // FIXME: This clears tiles for every consecutive object for(auto i = dInstances.begin(); i != std::prev(dInstances.end()); ++i) dAccessibleAreaCache.unite(i->getAccessibleArea()); dAccessibleAreaFullCache = dAccessibleAreaCache; dAccessibleAreaFullCache.unite(dInstances.back().getAccessibleArea()); dAccessibleAreaCache.subtract(getArea()); dAccessibleAreaFullCache.subtract(getArea()); if(exceptLast) return dAccessibleAreaCache; else return dAccessibleAreaFullCache; } const rmg::Area & Object::getBlockVisitableArea() const { if(dBlockVisitableCache.empty()) { for(const auto & i : dInstances) { // FIXME: Account for blockvis objects with multiple visitable tiles if (i.isBlockedVisitable()) dBlockVisitableCache.add(i.getVisitablePosition()); } } return dBlockVisitableCache; } const rmg::Area & Object::getRemovableArea() const { if(dRemovableAreaCache.empty()) { for(const auto & i : dInstances) { if (i.isRemovable()) dRemovableAreaCache.unite(i.getBlockedArea()); } } return dRemovableAreaCache; } const rmg::Area & Object::getVisitableArea() const { if(dVisitableCache.empty()) { for(const auto & i : dInstances) { // FIXME: Account for bjects with multiple visitable tiles dVisitableCache.add(i.getVisitablePosition()); } } return dVisitableCache; } const rmg::Area Object::getEntrableArea() const { // Calculate Area that hero can freely pass // Do not use blockVisitTiles, unless they belong to removable objects (resources etc.) // area = accessibleArea - (blockVisitableArea - removableArea) // FIXME: What does it do? AccessibleArea means area AROUND the object rmg::Area entrableArea = getVisitableArea(); rmg::Area blockVisitableArea = getBlockVisitableArea(); blockVisitableArea.subtract(getRemovableArea()); entrableArea.subtract(blockVisitableArea); return entrableArea; } void Object::setPosition(const int3 & position) { auto shift = position - dPosition; dAccessibleAreaCache.translate(shift); dAccessibleAreaFullCache.translate(shift); dBlockVisitableCache.translate(shift); dVisitableCache.translate(shift); dRemovableAreaCache.translate(shift); dFullAreaCache.translate(shift); dPosition = position; for(auto& i : dInstances) i.setPositionRaw(i.getPosition()); } void Object::setTemplate(const TerrainId & terrain, CRandomGenerator & rng) { for(auto& i : dInstances) i.setTemplate(terrain, rng); visibleTopOffset.reset(); } const Area & Object::getArea() const { if(!dFullAreaCache.empty() || dInstances.empty()) return dFullAreaCache; for(const auto & instance : dInstances) { dFullAreaCache.unite(instance.getBlockedArea()); } return dFullAreaCache; } const int3 Object::getVisibleTop() const { if (visibleTopOffset) { return dPosition + visibleTopOffset.value(); } else { int3 topTile(-1, 10000, -1); //Start at the bottom for (const auto& i : dInstances) { if (i.getTopTile().y < topTile.y) { topTile = i.getTopTile(); } } visibleTopOffset = topTile - dPosition; return topTile; } } bool rmg::Object::isGuarded() const { return guarded; } void rmg::Object::setGuardedIfMonster(const Instance& object) { if (object.object().ID == Obj::MONSTER) { guarded = true; } } void Object::Instance::finalize(RmgMap & map, CRandomGenerator & rng) { if(!map.isOnMap(getPosition(true))) throw rmgException(boost::str(boost::format("Position of object %d at %s is outside the map") % dObject.id % getPosition(true).toString())); //If no specific template was defined for this object, select any matching if (!dObject.appearance) { const auto * terrainType = map.getTile(getPosition(true)).terType; auto templates = dObject.getObjectHandler()->getTemplates(terrainType->getId()); if (templates.empty()) { throw rmgException(boost::str(boost::format("Did not find graphics for object (%d,%d) at %s (terrain %d)") % dObject.ID % dObject.getObjTypeIndex() % getPosition(true).toString() % terrainType)); } else { setTemplate(terrainType->getId(), rng); } } if (dObject.isVisitable() && !map.isOnMap(dObject.visitablePos())) throw rmgException(boost::str(boost::format("Visitable tile %s of object %d at %s is outside the map") % dObject.visitablePos().toString() % dObject.id % dObject.pos.toString())); for(const auto & tile : dObject.getBlockedPos()) { if(!map.isOnMap(tile)) throw rmgException(boost::str(boost::format("Tile %s of object %d at %s is outside the map") % tile.toString() % dObject.id % dObject.pos.toString())); } for(const auto & tile : getBlockedArea().getTilesVector()) { map.setOccupied(tile, ETileType::USED); } map.getMapProxy()->insertObject(&dObject); } void Object::finalize(RmgMap & map, CRandomGenerator & rng) { if(dInstances.empty()) throw rmgException("Cannot finalize object without instances"); for(auto & dInstance : dInstances) { dInstance.finalize(map, rng); } } void Object::clearCachedArea() const { dFullAreaCache.clear(); dAccessibleAreaCache.clear(); dAccessibleAreaFullCache.clear(); dBlockVisitableCache.clear(); dVisitableCache.clear(); dRemovableAreaCache.clear(); } void Object::clear() { for(auto & instance : dInstances) instance.clear(); dInstances.clear(); cachedInstanceList.clear(); cachedInstanceConstList.clear(); visibleTopOffset.reset(); clearCachedArea(); } VCMI_LIB_NAMESPACE_END