Pulsar.hpp

/*
 * Copyright (C) 2012 Alexander Wolf
 *
 * 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 _PULSAR_HPP_
#define _PULSAR_HPP_ 1

#include <QVariant>
#include <QString>
#include <QStringList>
#include <QFont>
#include <QList>
#include <QDateTime>

#include "StelObject.hpp"
#include "StelTextureTypes.hpp"
#include "StelFader.hpp"

class StelPainter;


class Pulsar : public StelObject
{
    friend class Pulsars;
public:
    static const QString PULSAR_TYPE;

    Pulsar(const QVariantMap& map);
    ~Pulsar();

    // TODO: Add proper documentation of these fields!
    QVariantMap getMap(void) const;

    virtual QString getType(void) const
    {
        return PULSAR_TYPE;
    }

    virtual QString getID(void) const
    {
        return designation;
    }

    virtual float getSelectPriority(const StelCore* core) const;

    virtual QString getInfoString(const StelCore* core, const InfoStringGroup& flags) const;
    virtual QVariantMap getInfoMap(const StelCore *core) const;
    virtual Vec3f getInfoColor(void) const;
    virtual Vec3d getJ2000EquatorialPos(const StelCore*) const
    {
        return XYZ;
    }
    virtual float getVMagnitude(const StelCore* core) const;
    virtual float getVMagnitudeWithExtinction(const StelCore *core) const;
    virtual double getAngularSize(const StelCore* core) const;
    virtual QString getNameI18n(void) const
    {
        return designation;
    }
    virtual QString getEnglishName(void) const
    {
        return designation;
    }

    void update(double deltaTime);

private:
    bool initialized;

    Vec3d XYZ;                         // holds J2000 position  

    static StelTextureSP hintTexture;
    static StelTextureSP markerTexture;
    static bool distributionMode;
    static bool glitchFlag;
    static Vec3f markerColor;
    static Vec3f glitchColor;

    void draw(StelCore* core, StelPainter *painter);

    QString designation;    
    float RA;       
    float DE;       
    float parallax;     
    double period;      
    double frequency;   
    double pfrequency;      
    double pderivative; 
    double dmeasure;    
    double bperiod;     
    double eccentricity;    
    float w50;      
    float s400;     
    float s600;     
    float s1400;        
    float distance;     
    int glitch;     
    QString notes;      

    LinearFader labelsFader;

    double getEdot(double p0, double p1) const;

    double getP1(double p0, double f1) const;

    QString getPulsarTypeInfoString(QString pcode) const;

};

#endif // _PULSAR_HPP_