linelistindex.h

/*
    SPDX-FileCopyrightText: 2007 James B. Bowlin <bowlin@mindspring.com>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include "skycomponent.h"
#include "skymesh.h"
 
#include <QMutex>
 
#include <memory>
#include <set>
 
class LineList;
class LineListLabel;
class SkipHashList;
class SkyPainter;
 
/**
 * @class LineListIndex
 * Contains almost all the code needed for indexing and drawing and clipping
 * lines and polygons.
 *
 * @author James B. Bowlin @version 0.1
 */
class LineListIndex : public SkyComponent
{
    friend class LinesItem; //Needs access to reindexLines
  public:
    /**
     * @short Constructor
     * Simply set the internal skyMesh, parent, and name.
     * @param parent Pointer to the parent SkyComponent object
     * @param name name of the subclass used for debugging
     */
    explicit LineListIndex(SkyComposite *parent, const QString &name = "");
 
    virtual ~LineListIndex() override = default;
 
    /**
     * @short The top level draw routine.  Draws all the LineLists for any
     * subclass in one fell swoop which minimizes some of the loop overhead.
     * Overridden by MilkWay so it can decide whether to draw outlines or
     * filled.  Therefore MilkyWay does not need to override preDraw().  The
     * MilkyWay draw() routine calls all of the more specific draw()
     * routines below.
     */
    void draw(SkyPainter *skyp) override;
 
#ifdef KSTARS_LITE
    /**
     * @short KStars Lite needs direct access to m_lineIndex for drawing the lines
     */
    inline LineListHash *lineIndex() const { return m_lineIndex.get(); }
    inline LineListHash *polyIndex() const { return m_polyIndex.get(); }
 
    /** @short returns MeshIterator for currently visible trixels */
    MeshIterator visibleTrixels();
 
#endif
    //Moved to public because KStars Lite uses it
    /**
     * @short this is called from within the draw routines when the updateID
     * of the lineList is stale.  It is virtual because different subclasses
     * have different update routines.  NoPrecessIndex doesn't precess in
     * the updates and ConstellationLines must update its points as stars,
     * not points.  that doesn't precess the points.
     */
    virtual void JITupdate(LineList *lineList);
 
  protected:
    /**
     * @short as the name says, recreates the lineIndex using the LineLists
     * in the previous index.  Since we are indexing everything at J2000
     * this is only used by ConstellationLines which needs to reindex
     * because of the proper motion of the stars.
     */
    void reindexLines();
 
    /** @short retrieve name of object */
    QString name() const { return m_name; }
 
    /**
     * @short displays a message that we are loading m_name.  Also prints
     * out the message if skyMesh debug is greater than zero.
     */
    void intro();
 
    /**
     * @short prints out some summary statistics if the skyMesh debug is
     * greater than 1.
     */
    void summary();
 
    /** @short Returns the SkyMesh object. */
    SkyMesh *skyMesh() { return m_skyMesh; }
 
    /**
     * @short Typically called from within a subclasses constructors.
     * Adds the trixels covering the outline of lineList to the lineIndex.
     */
    void appendLine(const std::shared_ptr<LineList> &lineList);
 
    void removeLine(const std::shared_ptr<LineList> &lineList);
 
    /**
     * @short Typically called from within a subclasses constructors.
     * Adds the trixels covering the full lineList to the polyIndex.
     */
    void appendPoly(const std::shared_ptr<LineList> &lineList);
 
    /**
     * @short a convenience method that adds a lineList to both the lineIndex and the polyIndex.
     */
    void appendBoth(const std::shared_ptr<LineList> &lineList);
 
    /**
     * @short Draws all the lines in m_listList as simple lines in float mode.
     */
    void drawLines(SkyPainter *skyp);
 
    /**
     * @short Draws all the lines in m_listList as filled polygons in float
     * mode.
     */
    void drawFilled(SkyPainter *skyp);
 
    /**
     * @short Gives the subclasses access to the top of the draw() method.
     * Typically used for setting the QPen, etc. in the QPainter being
     * passed in.  Defaults to setting a thin white pen.
     */
    virtual void preDraw(SkyPainter *skyp);
 
    /**
     * @short a callback overridden by NoPrecessIndex so it can use the
     * drawing code with the non-reverse-precessed mesh buffer.
     */
    virtual MeshBufNum_t drawBuffer() { return DRAW_BUF; }
 
    /**
     * @short Returns an IndexHash from the SkyMesh that contains the set of
     * trixels that cover lineList.  Overridden by SkipListIndex so it can
     * pass SkyMesh an IndexHash indicating which line segments should not
     * be indexed @param lineList contains the list of points to be covered.
     */
    virtual const IndexHash &getIndexHash(LineList *lineList);
 
    /**
     * @short Also overridden by SkipListIndex.
     * Controls skipping inside of the draw() routines.  The default behavior
     * is to simply return a null pointer.
     *
     * FIXME: I don't think that the SkipListIndex class even exists -- hdevalence
     */
    virtual SkipHashList *skipList(LineList *lineList);
 
    virtual LineListLabel *label() { return nullptr; }
 
    inline LineListList listList() const { return m_listList; }
 
  private:
    QString m_name;
 
    SkyMesh *m_skyMesh { nullptr };
    std::unique_ptr<LineListHash> m_lineIndex;
    std::unique_ptr<LineListHash> m_polyIndex;
 
    LineListList m_listList;
 
    QMutex mutex;
};