Galaxy.h

Go to the documentation of this file.

// Copyright © 2008-2023 Pioneer Developers. See AUTHORS.txt for details
// Licensed under the terms of the GPL v3. See licenses/GPL-3.txt
 
#ifndef _GALAXY_H
#define _GALAXY_H
 
#include "CustomSystem.h"
#include "Factions.h"
#include "GalaxyCache.h"
#include "JsonFwd.h"
#include "PerfStats.h"
#include "RefCounted.h"
#include <cstdio>
 
struct SDL_Surface;
class GalaxyGenerator;
 
class Galaxy : public RefCounted {
protected:
    friend class GalaxyGenerator;
    Galaxy(RefCountedPtr<GalaxyGenerator> galaxyGenerator, float radius, float sol_offset_x, float sol_offset_y,
        const std::string &factionsDir, const std::string &customSysDir);
    void SetGalaxyGenerator(RefCountedPtr<GalaxyGenerator> galaxyGenerator);
    virtual void Init();
 
public:
    // lightyears
    const float GALAXY_RADIUS;
    const float SOL_OFFSET_X;
    const float SOL_OFFSET_Y;
 
    static RefCountedPtr<Galaxy> LoadFromJson(const Json &jsonObj);
    void ToJson(Json &jsonObj);
 
    ~Galaxy();
 
    bool IsInitialized() const { return m_initialized; }
    /* 0 - 255 */
    virtual Uint8 GetSectorDensity(const int sx, const int sy, const int sz) const = 0;
    FactionsDatabase *GetFactions() { return &m_factions; }                // XXX const correctness
    CustomSystemsDatabase *GetCustomSystems() { return &m_customSystems; } // XXX const correctness
 
    RefCountedPtr<const Sector> GetSector(const SystemPath &path) { return m_sectorCache.GetCached(path); }
    RefCountedPtr<Sector> GetMutableSector(const SystemPath &path) { return m_sectorCache.GetCached(path); }
    RefCountedPtr<SectorCache::Slave> NewSectorSlaveCache() { return m_sectorCache.NewSlaveCache(); }
 
    RefCountedPtr<StarSystem> GetStarSystem(const SystemPath &path) { return m_starSystemCache.GetCached(path); }
    RefCountedPtr<StarSystemCache::Slave> NewStarSystemSlaveCache() { return m_starSystemCache.NewSlaveCache(); }
 
    void FlushCaches();
    void Dump(FILE *file, Sint32 centerX, Sint32 centerY, Sint32 centerZ, Sint32 radius);
 
    RefCountedPtr<GalaxyGenerator> GetGenerator() const;
    const std::string &GetGeneratorName() const;
    int GetGeneratorVersion() const;
 
    Perf::Stats &GetStats() { return m_stats; }
    const Perf::Stats &GetStats() const { return m_stats; }
 
private:
    bool m_initialized;
    Perf::Stats m_stats;
    RefCountedPtr<GalaxyGenerator> m_galaxyGenerator;
    SectorCache m_sectorCache;
    StarSystemCache m_starSystemCache;
    FactionsDatabase m_factions;
    CustomSystemsDatabase m_customSystems;
};
 
class DensityMapGalaxy : public Galaxy {
private:
    friend class GalaxyGenerator;
    DensityMapGalaxy(RefCountedPtr<GalaxyGenerator> galaxyGenerator, const std::string &mapfile,
        float radius, float sol_offset_x, float sol_offset_y, const std::string &factionsDir, const std::string &customSysDir);
 
public:
    virtual Uint8 GetSectorDensity(const int sx, const int sy, const int sz) const;
 
private:
    std::unique_ptr<float[]> m_galaxyMap;
    Sint32 m_mapWidth, m_mapHeight;
};
 
#endif /* _GALAXY_H */