StelSkyLayer.hpp

/*
 * Copyright (C) 2009 Fabien Chereau
 *
 * 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 STELSKYLAYER_HPP
#define STELSKYLAYER_HPP

#include <QObject>
#include <QString>
#include <QSharedPointer>
#include "StelCore.hpp"

#include "StelProjectorType.hpp"

class StelCore;

class StelSkyLayer : public QObject
{
    Q_OBJECT
public:
    StelSkyLayer(QObject* parent=NULL) : QObject(parent), frameType(StelCore::FrameUninitialized) {;}

    virtual void draw(StelCore* core, class StelRenderer* renderer, StelProjectorP projector, float opacity=1.)=0;

    virtual QString getShortName() const =0;

    virtual QString getShortServerCredits() const {return QString();}

    virtual QString getKeyHint() const {return getShortName();}

    virtual QString getLayerDescriptionHtml() const {return "No description.";}

    void setFrameType(StelCore::FrameType ft) {frameType = ft;}

    StelCore::FrameType getFrameType() {return frameType;}

signals:
    void loadingStateChanged(bool b);

    void percentLoadedChanged(int percentage);
private:
    StelCore::FrameType frameType;
};


typedef QSharedPointer<StelSkyLayer> StelSkyLayerP;

#endif // STELSKYLAYER_HPP