legend.h

Go to the documentation of this file.

/***************************************************************************
                          legend.h  -  K Desktop Planetarium
                             -------------------
    begin                : Thu May 26 2011
    copyright            : (C) 2011 by Rafał Kułaga
    email                : rl.kulaga@gmail.com
 ***************************************************************************/

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

#ifndef LEGEND_H
#define LEGEND_H

#include <QObject>
#include <QFont>
#include <QPoint>
#include <QColor>

class QPaintDevice;
class QPointF;
class QSize;

class SkyQPainter;
class SkyMap;
class ColorScheme;

class Legend
{
public:

    enum LEGEND_TYPE
    {
        LT_FULL,
        LT_SCALE_MAGNITUDES,
        LT_SCALE_ONLY,
        LT_MAGNITUDES_ONLY,
        LT_SYMBOLS_ONLY,
    };

    enum LEGEND_ORIENTATION
    {
        LO_HORIZONTAL,
        LO_VERTICAL
    };

    enum LEGEND_POSITION
    {
        LP_UPPER_LEFT,
        LP_UPPER_RIGHT,
        LP_LOWER_LEFT,
        LP_LOWER_RIGHT,
        LP_FLOATING
    };

    explicit Legend(LEGEND_ORIENTATION orientation = LO_HORIZONTAL, LEGEND_POSITION pos = LP_FLOATING);

    explicit Legend( const Legend &o );

    ~Legend();

    inline LEGEND_TYPE getType() { return m_Type; }

    inline LEGEND_ORIENTATION getOrientation() { return m_Orientation; }

    inline LEGEND_POSITION getPosition() { return m_Position; }

    inline QPoint getFloatingPosition() { return m_PositionFloating; }

    inline int getSymbolSize() { return m_SymbolSize; }

    inline int getBRectWidth() { return m_BRectWidth; }

    inline int getBRectHeight() { return m_BRectHeight; }

    inline int getMaxHScalePixels() { return m_MaxHScalePixels; }

    inline int getMaxVScalePixels() { return m_MaxVScalePixels; }

    inline int getXSymbolSpacing() { return m_XSymbolSpacing; }

    inline int getYSymbolSpacing() { return m_YSymbolSpacing; }

    inline QFont getFont() { return m_Font; }

    inline QColor getBgColor() { return m_BgColor; }

    inline bool getDrawFrame() { return m_DrawFrame; }

    inline void setType(LEGEND_TYPE type) { m_Type = type; }

    inline void setOrientation(LEGEND_ORIENTATION orientation) { m_Orientation = orientation; }

    inline void setPosition(LEGEND_POSITION pos) { m_Position = pos; }

    inline void setFloatingPosition(QPoint pos) { m_PositionFloating = pos; }

    inline void setSymbolSize(int size) { m_SymbolSize = size; }

    inline void setBRectWidth(int width) { m_BRectWidth = width; }

    inline void setBRectHeight(int height) { m_BRectHeight = height; }

    inline void setMaxHScalePixels(int pixels) { m_MaxHScalePixels = pixels; }

    inline void setMaxVScalePixels(int pixels) { m_MaxVScalePixels = pixels; }

    inline void setXSymbolSpacing(int spacing) { m_XSymbolSpacing = spacing; }

    inline void setYSymbolSpacing(int spacing) { m_YSymbolSpacing = spacing; }

    inline void setFont(const QFont &font) { m_Font = font; }

    inline void setBgColor(const QColor &color) { m_BgColor = color; }

    inline void setDrawFrame(bool draw) { m_DrawFrame = draw; }

    QSize calculateSize();

    void paintLegend(QPaintDevice *pd);

    void paintLegend(SkyQPainter *painter);

    void paintLegend(QPaintDevice *pd, LEGEND_TYPE type, LEGEND_POSITION pos);

    void paintLegend(SkyQPainter *painter, LEGEND_TYPE type, LEGEND_POSITION pos);

private:
    void paintSymbols(QPointF pos);

    void paintSymbol(QPointF pos, int type, float e, float angle, QString label);

    void paintMagnitudes(QPointF pos);

    void paintScale(QPointF pos);

    QPoint positionToDeviceCoord(QPaintDevice *pd);

    SkyQPainter *m_Painter;
    SkyMap *m_SkyMap;
    bool m_DeletePainter;

    LEGEND_TYPE m_Type;
    LEGEND_ORIENTATION m_Orientation;
    LEGEND_POSITION m_Position;
    QPoint m_PositionFloating;

    ColorScheme *m_cScheme;
    QFont m_Font;
    QColor m_BgColor;
    bool m_DrawFrame;

    int m_SymbolSize;
    int m_BRectWidth;
    int m_BRectHeight;
    int m_MaxHScalePixels;
    int m_MaxVScalePixels;
    int m_XSymbolSpacing;
    int m_YSymbolSpacing;
};

#endif // LEGEND_H