starblock.h

Go to the documentation of this file.

/***************************************************************************
                    starblock.h  -  K Desktop Planetarium
                             -------------------
    begin                : 8 Jun 2008
    copyright            : (C) 2008 by Akarsh Simha
    email                : [email protected]
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#pragma once

#include "typedef.h"
#include "starblocklist.h"

#include <QVector>

class StarObject;
class StarBlockList;
class PointSourceNode;
struct StarData;
struct DeepStarData;

#ifdef KSTARS_LITE
#include "starobject.h"

struct StarNode
{
    StarNode();
    ~StarNode();

    StarObject star;
    PointSourceNode *starNode;
};
#endif

class StarBlock
{
  public:
// StarBlockEntry is the data type held by the StarBlock's QVector
#ifdef KSTARS_LITE
    typedef StarNode StarBlockEntry;
#else
    typedef StarObject StarBlockEntry;
#endif

    explicit StarBlock(int nstars = 100);

    ~StarBlock() = default;

    StarBlockEntry *addStar(const StarData &data);
    StarBlockEntry *addStar(const DeepStarData &data);

    inline bool isFull() const { return nStars == size(); }

    inline int size() const { return stars.size(); }

    inline StarBlockEntry *star(int i) { return &stars[i]; }

    inline QVector<StarBlockEntry> &contents() { return stars; }

    // These methods are there because we might want to make faintMag and brightMag private at some point
    inline float getBrightMag() const { return brightMag; }

    inline float getFaintMag() const { return faintMag; }

    inline int getStarCount() const { return nStars; }

    void reset();

    float faintMag { 0 };
    float brightMag { 0 };
    StarBlockList *parent;
    std::shared_ptr<StarBlock> prev;
    std::shared_ptr<StarBlock> next;
    quint32 drawID { 0 };

  private:
    // Disallow copying and assignment. Just in case.
    StarBlock(const StarBlock &);
    StarBlock &operator=(const StarBlock &);

    int nStars { 0 };
    QVector<StarBlockEntry> stars;
};