#include <ZoneArea.hxx>

Inheritance diagram for ZoneArea:

Collaboration diagram for ZoneArea:

Public Member Functions
	ZoneArea (ZoneNode zoneNode)

void	addNode (ZoneNode zoneNode) override
	Add a zoneNode to this zoneArea. More...

void	removeZoneNode (Point coordinate)
	Remove a zoneNode on a given coordinate from this zoneArea. More...

void	setPowerSupply (bool hasPower)
	Set the power supply for this Area. More...

bool	hasPowerSupply ()
	Get the Power supply for this Area. More...

void	setWaterSupply (bool hasWater)
	Set the water supply for this Area. More...

bool	hasWaterSupply ()
	Get the water supply for this Area. More...

ZoneType	getZone () const
	Get the zone for this Area. More...

ZoneDensity	getZoneDensity ()
	Get the zone density for this Area. More...

bool	isVacant () const
	If this area has unoccupied nodes left. More...

void	spawnBuildings ()
	Spawn buildings on nodes in this area if all demands are fulfilled. More...

bool	isWithinBoundaries (Point coordinate) const
	Check if a given point is within the boundaries of this zone area. More...

void	setVacancy (Point coordinate, bool vacancy)
	Set vacancy for this tile. More...

Public Member Functions inherited from MapGrid< ZoneNode >
	MapGrid (ZoneNode node)

virtual	~MapGrid ()=0

size_t	size ()

virtual void	removeNode (Point coordinate)
	Remove a node on a given coordinate from this gridnode. More...

bool	isNeighbor (Point coordinate) const
	If this coordinate is a neighbor of one of the node in the grid. More...

bool	isMemberOf (Point coordinate) const
	If this coordinate is part of the grid. More...

auto	begin ()

auto	end ()

Private Member Functions
bool	checkVacancy () const
	internal function to check for vacancy More...

TileSize	getMaximumTileSize (Point originPoint)
	Returns the possible size of buildings that can be placed on this coordinate in a zone. More...

Private Attributes
ZoneType	m_zoneType

ZoneDensity	m_zoneDensity

bool	m_hasPower = false

bool	m_hasWater = false

bool	m_isVacant = false

int	xmin

int	xmax

int	ymin

int	ymax

Friends
void	mergeZoneAreas (ZoneArea &mainZone, ZoneArea &toBeMerged)

Additional Inherited Members
Protected Attributes inherited from MapGrid< ZoneNode >
std::vector< ZoneNode >	m_gridNodes

Detailed Description

Definition at line 19 of file ZoneArea.hxx.

Constructor & Destructor Documentation

◆ ZoneArea()

ZoneArea::ZoneArea ( ZoneNode zoneNode )

Definition at line 18 of file ZoneArea.cxx.

     : MapGrid{zoneNode}, m_zoneType(zoneNode.zoneType), m_zoneDensity(zoneNode.zoneDensity),
       xmin(std::max(0, zoneNode.coordinate.x - 1)), xmax(std::min(Settings::instance().mapSize, zoneNode.coordinate.x + 1)),
       ymin(std::max(0, zoneNode.coordinate.y - 1)), ymax(std::min(Settings::instance().mapSize, zoneNode.coordinate.y + 1))
 {
   //update vacancy in case constructor is called with a zonenode
   m_isVacant = checkVacancy();
 }

Member Function Documentation

◆ addNode()

void ZoneArea::addNode ( ZoneNode zoneNode )

overridevirtual

Add a zoneNode to this zoneArea.

Parameters

zoneNode ZoneNode to add

Reimplemented from MapGrid< ZoneNode >.

Definition at line 106 of file ZoneArea.cxx.

 {
   m_gridNodes.push_back(zoneNode);
  
   //update vacancy
   m_isVacant = checkVacancy();
  
   if (zoneNode.coordinate.x == xmin)
   {
     xmin = std::max(0, xmin - 1);
   }
   else if (zoneNode.coordinate.x == xmax)
   {
     xmax = std::min(Settings::instance().mapSize, xmax + 1);
   }
   else if (zoneNode.coordinate.y == ymin)
   {
     ymin = std::max(0, ymin - 1);
   }
   else if (zoneNode.coordinate.y == ymax)
   {
     ymax = std::min(Settings::instance().mapSize, ymax + 1);
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkVacancy()

bool ZoneArea::checkVacancy ( ) const

private

internal function to check for vacancy

Definition at line 59 of file ZoneArea.cxx.

 {
   return m_gridNodes.end() !=
          std::find_if(m_gridNodes.begin(), m_gridNodes.end(), [](const ZoneNode &node) { return node.occupied == false; });
 }

Here is the caller graph for this function:

◆ getMaximumTileSize()

TileSize ZoneArea::getMaximumTileSize ( Point originPoint )

private

Returns the possible size of buildings that can be placed on this coordinate in a zone.

Parameters

originPoint coordinate where we want to know how many free zone tiles there are next to it

Returns: struct with height and with for the possible tilesize that can be placed on this coordinate

Definition at line 65 of file ZoneArea.cxx.

 {
   TileSize possibleSize = {1, 1};
  
   for (int distance = 1; distance <= possibleSize.width || distance <= possibleSize.height; distance++)
   {
     std::vector<Point> xDirection = PointFunctions::getArea({originPoint.x - distance, originPoint.y}, originPoint);
     std::vector<Point> yDirection = PointFunctions::getArea(originPoint, {originPoint.x, originPoint.y + distance});
     // check if there's a tile in x direction (top of the origin point)
     bool increaseX = true;
     bool increaseY = true;
  
     for (auto coord : xDirection)
     {
       if (!isMemberOf(coord))
       {
         increaseX = false;
         break;
       }
     }
     for (auto coord : yDirection)
     {
       if (!isMemberOf(coord))
       {
         increaseY = false;
         break;
       }
     }
  
     if (increaseX)
     {
       possibleSize.width++;
     }
     if (increaseY)
     {
       possibleSize.height++;
     }
   }
   return possibleSize;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getZone()

ZoneType ZoneArea::getZone ( ) const

inline

Get the zone for this Area.

Returns: zone for this area

Definition at line 71 of file ZoneArea.hxx.

71 { return m_zoneType; };

◆ getZoneDensity()

ZoneDensity ZoneArea::getZoneDensity ( )

inline

Get the zone density for this Area.

Returns: zone density for this area

Definition at line 78 of file ZoneArea.hxx.

78 { return m_zoneDensity; };

◆ hasPowerSupply()

bool ZoneArea::hasPowerSupply ( )

inline

Get the Power supply for this Area.

Returns: if the area has power supply

Definition at line 50 of file ZoneArea.hxx.

50 { return m_hasPower; };

◆ hasWaterSupply()

bool ZoneArea::hasWaterSupply ( )

inline

Get the water supply for this Area.

Returns: if the area has water supply

Definition at line 64 of file ZoneArea.hxx.

64 { return m_hasWater; };

◆ isVacant()

bool ZoneArea::isVacant ( ) const

inline

If this area has unoccupied nodes left.

Returns: if this zoneArea is vacant or not

Definition at line 85 of file ZoneArea.hxx.

85 { return m_isVacant; };

◆ isWithinBoundaries()

bool ZoneArea::isWithinBoundaries ( Point coordinate ) const

inline

Check if a given point is within the boundaries of this zone area.

Parameters

coordinate point to check

Returns: if a given point is with the boundaries of this zone area

Definition at line 98 of file ZoneArea.hxx.

   {
     return (xmin <= coordinate.x) && (xmax >= coordinate.x) && (ymin <= coordinate.y) && (ymax >= coordinate.y);
   }

◆ removeZoneNode()

void ZoneArea::removeZoneNode ( Point coordinate )

Remove a zoneNode on a given coordinate from this zoneArea.

Parameters

coordinate Coordinates of the mapNode with a zone tile

Definition at line 131 of file ZoneArea.cxx.

 {
   m_gridNodes.erase(std::remove_if(begin(), end(), [coordinate](const ZoneNode &node) { return node.coordinate == coordinate; }),
                     end());
   //update vacancy
   m_isVacant = checkVacancy();
 }

Here is the call graph for this function:

◆ setPowerSupply()

void ZoneArea::setPowerSupply ( bool hasPower )

inline

Set the power supply for this Area.

Parameters

hasPower whether the area has power supply or not

Definition at line 43 of file ZoneArea.hxx.

43 { m_hasPower = hasPower; };

◆ setVacancy()

void ZoneArea::setVacancy	(	Point	coordinate,
		bool	vacancy
	)

Set vacancy for this tile.

Parameters

coordinate	What tile to vacate / occupy
vacancy	true if vacant, false if occupied

Definition at line 139 of file ZoneArea.cxx.

 {
   auto node = std::find_if(begin(), end(), [coordinate](const ZoneNode &zNode) { return zNode.coordinate == coordinate; });
   if (node != end())
   {
     if (vacancy)
     {
       node->occupied = false;
     }
     else
     {
       node->occupied = true;
     }
     m_isVacant = checkVacancy();
   }
 }

Here is the call graph for this function:

◆ setWaterSupply()

void ZoneArea::setWaterSupply ( bool hasWater )

inline

Set the water supply for this Area.

Parameters

hasWater whether the area has water supply or not

Definition at line 57 of file ZoneArea.hxx.

57 { m_hasWater = hasWater; };

◆ spawnBuildings()

void ZoneArea::spawnBuildings ( )

Spawn buildings on nodes in this area if all demands are fulfilled.

Definition at line 27 of file ZoneArea.cxx.

 {
   constexpr int amountOfBuildingsToSpawn = 5;
   auto &randomizer = Randomizer::instance();
   // shuffle mapNodes so placement of building looks random
   randomizer.shuffle(begin(), end());
  
   int buildingsSpawned = 0;
  
   // pick every single zone node we have
   for (auto &node : m_gridNodes)
   {
     if (buildingsSpawned >= amountOfBuildingsToSpawn)
     {
       break;
     }
     if (node.occupied)
     {
       continue;
     }
  
     // get the maximum size we can spawn at this node
     TileSize maxTileSize = getMaximumTileSize(node.coordinate);
     std::string buildingTileID =
         TileManager::instance().getRandomTileIDForZoneWithRandomSize(m_zoneType, m_zoneDensity, maxTileSize).value_or("");
  
     // place the building
     MapFunctions::instance().setTileID(buildingTileID, node.coordinate);
     buildingsSpawned++;
   }
 }

Here is the call graph for this function:

Friends And Related Function Documentation

◆ mergeZoneAreas

void mergeZoneAreas	(	ZoneArea &	mainZone,
		ZoneArea &	toBeMerged
	)

friend

Definition at line 7 of file ZoneArea.cxx.

 {
   mainZone.m_gridNodes.insert(mainZone.end(), toBeMerged.begin(), toBeMerged.end());
   mainZone.m_hasPower |= toBeMerged.m_hasPower;
   mainZone.m_hasWater |= toBeMerged.m_hasWater;
   mainZone.xmin = std::min(mainZone.xmin, toBeMerged.xmin);
   mainZone.xmax = std::max(mainZone.xmax, toBeMerged.xmax);
   mainZone.ymin = std::min(mainZone.ymin, toBeMerged.ymin);
   mainZone.ymax = std::max(mainZone.ymax, toBeMerged.ymax);
 };

Member Data Documentation

◆ m_hasPower

bool ZoneArea::m_hasPower = false

private

Definition at line 115 of file ZoneArea.hxx.

◆ m_hasWater

bool ZoneArea::m_hasWater = false

private

Definition at line 116 of file ZoneArea.hxx.

◆ m_isVacant

bool ZoneArea::m_isVacant = false

private

Definition at line 117 of file ZoneArea.hxx.

◆ m_zoneDensity

ZoneDensity ZoneArea::m_zoneDensity

private

Definition at line 113 of file ZoneArea.hxx.

◆ m_zoneType

ZoneType ZoneArea::m_zoneType

private

Definition at line 112 of file ZoneArea.hxx.

◆ xmax

int ZoneArea::xmax

private

Definition at line 118 of file ZoneArea.hxx.

◆ xmin

int ZoneArea::xmin

private

Definition at line 118 of file ZoneArea.hxx.

◆ ymax

int ZoneArea::ymax

private

Definition at line 118 of file ZoneArea.hxx.

◆ ymin

int ZoneArea::ymin

private

Definition at line 118 of file ZoneArea.hxx.

The documentation for this class was generated from the following files:

src/game/ZoneArea.hxx
src/game/ZoneArea.cxx

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ZoneArea()

Member Function Documentation

◆ addNode()

◆ checkVacancy()

◆ getMaximumTileSize()

◆ getZone()

◆ getZoneDensity()

◆ hasPowerSupply()

◆ hasWaterSupply()

◆ isVacant()

◆ isWithinBoundaries()

◆ removeZoneNode()

◆ setPowerSupply()

◆ setVacancy()

◆ setWaterSupply()

◆ spawnBuildings()

Friends And Related Function Documentation

◆ mergeZoneAreas

Member Data Documentation

◆ m_hasPower

◆ m_hasWater

◆ m_isVacant

◆ m_zoneDensity

◆ m_zoneType

◆ xmax

◆ xmin

◆ ymax

◆ ymin