MeteorShower.hpp

/*
 * Stellarium: Meteor Showers Plug-in
 * Copyright (C) 2013-2015 Marcos Cardinot
 *
 * 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 _METEORSHOWER_HPP_
#define _METEORSHOWER_HPP_

#include "MeteorObj.hpp"
#include "MeteorShowersMgr.hpp"
#include "StelFader.hpp"
#include "StelObject.hpp"
#include "StelPainter.hpp"
#include "StelTextureTypes.hpp"
#include "StelTranslator.hpp"


class MeteorShower : public StelObject
{
public:
    static const QString METEORSHOWER_TYPE;

    enum Status {
        INVALID,          // not initialized properly
        UNDEFINED,        // it's loaded but with 'activity' undefined
        INACTIVE,         // inactive radiant
        ACTIVE_CONFIRMED, // active radiant - confirmed data
        ACTIVE_GENERIC    // active radiant - generic data
    };

    typedef struct
    {
        int year;                  
        int zhr;                   
        QList<int> variable;       
        QDate start;               
        QDate finish;              
        QDate peak;                
    } Activity;

    MeteorShower(MeteorShowersMgr* mgr, const QVariantMap& map);

    ~MeteorShower();

    void update(StelCore *core, double deltaTime);

    void draw(StelCore *core);

    Activity hasGenericShower(QDate date, bool &found) const;

    Activity hasConfirmedShower(QDate date, bool &found) const;

    bool enabled() const;

    QString getDesignation() const;

    Status getStatus() { return m_status; }

    QDate getPeak() { return m_activity.peak; }

    int getZHR() { return m_activity.zhr; }

    //
    // Methods defined in StelObject class
    //
    virtual QString getInfoString(const StelCore* core, const InfoStringGroup& flags) const;

    // TODO: Describe the fields!
    virtual QVariantMap getInfoMap(const StelCore *core) const;
    virtual QString getType(void) const { return METEORSHOWER_TYPE; }
    virtual QString getID(void) const { return m_showerID; }
    virtual QString getEnglishName(void) const { return m_designation.trimmed(); }
    virtual QString getNameI18n(void) const { return q_(m_designation.trimmed()); }
    virtual Vec3d getJ2000EquatorialPos(const StelCore*) const { return m_position; }
    virtual float getSelectPriority(const StelCore*) const { return -4.0; }
    virtual Vec3f getInfoColor(void) const;
    virtual double getAngularSize(const StelCore*) const { return 0.001; }

private:
    MeteorShowersMgr* m_mgr;           
    Status m_status;                   

    // data from catalog
    QString m_showerID;                
    QString m_designation;             
    QList<Activity> m_activities;      
    int m_speed;                       
    float m_rAlphaPeak;                
    float m_rDeltaPeak;                
    float m_driftAlpha;                
    float m_driftDelta;                
    QString m_parentObj;               
    float m_pidx;                      
    QList<Meteor::ColorPair> m_colors; 

    //current information
    Vec3d m_position;                  
    double m_radiantAlpha;             
    double m_radiantDelta;             
    Activity m_activity;               

    QList<MeteorObj*> m_activeMeteors; 

    void drawRadiant(StelCore* core);

    void drawMeteors(StelCore* core);

    int calculateZHR(const double& currentJD);

    static QString getSolarLongitude(QDate date);
};

#endif /*_METEORSHOWER_HPP_*/