SPAR/AIModule/SparAIModule/PerceptualState/Unit/UnitLocationData.h

Go to the documentation of this file.

#pragma once
#include <BWAPI.h>
#include <iostream>

class PrimitiveLocation;
class CompositeLocation;

class UnitLocationData : public Component
{
public:
  UnitLocationData(BWAPI::Unit* unit, PrimitiveLocation* location)
    : m_unit(unit)
    , m_type(unit->getType())
    , m_player(unit->getPlayer())
    , m_location(location)
    , m_primitiveLocationData(NULL)
    , m_regionData(NULL)
    , m_mapData(NULL)
  {
  }
  virtual ~UnitLocationData() {}
  const BWAPI::Player* getPlayer() const { return m_player; }
  BWAPI::UnitType getType() const { return m_type; }
  PrimitiveLocation* getLocation() const { return m_location; }
  void updateLocation(PrimitiveLocation* newLocation) { m_location = newLocation; }
protected:
  // ADD AN EVENT MECHANISM IF EVER THERE MAY BE MORE THAN THESE THREE SUBSCRIBERS!
  friend class PrimitiveLocation;
  friend class CompositeLocation;
  void* m_primitiveLocationData;
  void* m_regionData;
  void* m_mapData;

  BWAPI::Unit* const m_unit;
  const BWAPI::Player* const m_player;
  BWAPI::UnitType m_type;
  PrimitiveLocation* m_location;
};

class ForeignUnit : public UnitLocationData
{
public:
  class SavedState
  {
  public:
    SavedState(BWAPI::Unit* unit)
      : m_unitType(unit->getType())
      , m_position(unit->getPosition())
      , m_hitPoints(unit->getHitPoints())
      , m_tilePosition(unit->getTilePosition())
      , m_isLifted(unit->isLifted())
    {}

    BWAPI::UnitType getType() const { return m_unitType; }
    BWAPI::Position getPosition() const { return m_position; }
    BWAPI::TilePosition getTilePosition() const { return m_tilePosition; }
    int getHitPoints() const { return m_hitPoints; }
    bool isLifted() const { return m_isLifted; }

  private:
    // Add stuff here as necessary
    BWAPI::UnitType m_unitType;
    BWAPI::Position m_position;
    BWAPI::TilePosition m_tilePosition;
    int m_hitPoints;
    bool m_isLifted;
  };

  ForeignUnit(BWAPI::Unit* unitPtr, PrimitiveLocation* location)
    : UnitLocationData(unitPtr, location)
    , m_lastKnownState(unitPtr)
    , m_lastUnitEvadedFrame(-1)
  {}

  bool isAccessible() const
  {
    // Not yet evaded
    return m_lastUnitEvadedFrame == -1;
  }

  int getLastEvadedFrame() const
  {
    return m_lastUnitEvadedFrame;
  }

  BWAPI::UnitType getType() const { return isAccessible() ? m_unit->getType() : m_lastKnownState.getType(); }
  BWAPI::UnitType getLastType() const { return m_lastKnownState.getType(); }
  BWAPI::TilePosition getTilePosition() const { return isAccessible() ? m_unit->getTilePosition() : m_lastKnownState.getTilePosition(); }
  BWAPI::Position getPosition() const { return isAccessible() ? m_unit->getPosition() : m_lastKnownState.getPosition(); }

  BWAPI::Unit* getUnit() const
  {
    // WARNING: IF THE UNIT IS NOT ACCESSIBLE (IN FOG OF WAR) THE UNIT POINTER MAY NOT BE VALID ANY MORE

    // If unit is not accessible, use saved state instead.
    // However this can be tolerated for minerals since they always have the same pointer.
    assert(isAccessible() || m_lastKnownState.getType().isMineralField());

    return m_unit;
  }

  const SavedState& getLastKnownState() const
  {
    // If unit is accessible, use unit pointer directly
    assert(!isAccessible());

    return m_lastKnownState;
  }

  void markAsAccessible()
  {
    m_lastUnitEvadedFrame = -1;
  }

  void markAsInaccessible()
  {
    m_lastKnownState = SavedState(m_unit);

    m_lastUnitEvadedFrame = BWAPI::Broodwar->getFrameCount();
  }

protected:
  friend class PrimitiveLocation;

  int m_lastUnitEvadedFrame;
  SavedState m_lastKnownState;
};