ZoneArray.hpp

/*
 * The big star catalogue extension to Stellarium:
 * Author and Copyright: Johannes Gajdosik, 2006, 2007
 * The implementation of SpecialZoneArray<Star>::draw is based on
 * Stellarium, Copyright (C) 2002 Fabien Chereau,
 * and therefore has shared copyright.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef _ZONEARRAY_HPP_
#define _ZONEARRAY_HPP_

#include "ZoneData.hpp"
#include "Star.hpp"

#include "StelCore.hpp"
#include "StelSkyDrawer.hpp"
#include "StarMgr.hpp"

#include <QString>
#include <QFile>
#include <QDebug>

#ifdef __OpenBSD__
#include <unistd.h>
#endif

class StelPainter;

// Patch by Rainer Canavan for compilation on irix with mipspro compiler part 1
#ifndef MAP_NORESERVE
#  ifdef MAP_AUTORESRV
#    if (defined(__sgi) && defined(_COMPILER_VERSION))
#      define MAP_NORESERVE MAP_AUTORESRV
#    endif
#  else
#    define MAP_NORESERVE 0
#  endif
#endif


#define NR_OF_HIP 120416
#define FILE_MAGIC 0x835f040a
#define FILE_MAGIC_OTHER_ENDIAN 0x0a045f83
#define FILE_MAGIC_NATIVE 0x835f040b
#define MAX_MAJOR_FILE_VERSION 0

struct HipIndexStruct
{
    const SpecialZoneArray<Star1> *a;
    const SpecialZoneData<Star1> *z;
    const Star1 *s;
};

class ZoneArray
{
public:
    static ZoneArray *create(const QString &extended_file_name, bool use_mmap);
    virtual ~ZoneArray()
    {
        nr_of_zones = 0;
    }

    unsigned int getNrOfStars() const { return nr_of_stars; }

    virtual void updateHipIndex(HipIndexStruct hipIndex[]) const {Q_UNUSED(hipIndex);}

    virtual void searchAround(const StelCore* core, int index,const Vec3d &v,double cosLimFov,
                              QList<StelObjectP > &result) = 0;

    virtual void draw(StelPainter* sPainter, int index,bool is_inside,
                      const RCMag* rcmag_table, int limitMagIndex, StelCore* core,
                      int maxMagStarName, float names_brightness,
                      const QVector<SphericalCap>& boundingCaps) const = 0;

    bool isInitialized(void) const { return (nr_of_zones>0); }

    void initTriangle(int index, const Vec3f &c0, const Vec3f &c1, const Vec3f &c2);
    
    virtual void scaleAxis() = 0;

    const QString fname;

    const int level;

    const int mag_min;

    const int mag_range;

    const int mag_steps;

    float star_position_scale;

protected:
    static bool readFile(QFile& file, void *data, qint64 size);

    ZoneArray(const QString& fname, QFile* file, int level, int mag_min, int mag_range, int mag_steps);
    unsigned int nr_of_zones;
    unsigned int nr_of_stars;
    ZoneData *zones;
    QFile* file;
};

template<class Star>
class SpecialZoneArray : public ZoneArray
{
public:
    SpecialZoneArray(QFile* file,bool byte_swap,bool use_mmap,int level,int mag_min,
             int mag_range,int mag_steps);
    ~SpecialZoneArray(void);
protected:
    SpecialZoneData<Star> *getZones(void) const
    {
        return static_cast<SpecialZoneData<Star>*>(zones);
    }

    virtual void draw(StelPainter* sPainter, int index, bool isInsideViewport,
              const RCMag *rcmag_table, int limitMagIndex, StelCore* core,
              int maxMagStarName, float names_brightness,
              const QVector<SphericalCap>& boundingCaps) const;

    virtual void scaleAxis();
    virtual void searchAround(const StelCore* core, int index,const Vec3d &v,double cosLimFov,
                      QList<StelObjectP > &result);

    Star *stars;
private:
    uchar *mmap_start;
};

class HipZoneArray : public SpecialZoneArray<Star1>
{
public:
    HipZoneArray(QFile* file,bool byte_swap,bool use_mmap,
           int level,int mag_min,int mag_range,int mag_steps)
            : SpecialZoneArray<Star1>(file,byte_swap,use_mmap,level,
                                      mag_min,mag_range,mag_steps) {}

    void updateHipIndex(HipIndexStruct hipIndex[]) const;
};

#endif // _ZONEARRAY_HPP_