graphicsviewadapter.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright 2015 Haye Hinrichsen, Christoph Wick
 *
 * This file is part of Entropy Piano Tuner.
 *
 * Entropy Piano Tuner 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 3 of the License, or (at your
 * option) any later version.
 *
 * Entropy Piano Tuner 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
 * Entropy Piano Tuner. If not, see http://www.gnu.org/licenses/.
 *****************************************************************************/

//============================================================================
//               Adapter for viewing graphical elements
//============================================================================

#ifndef GRAPHICSVIEWADAPTER_H
#define GRAPHICSVIEWADAPTER_H

#include <vector>
#include <complex>

#include "../drawers/graphicsitem.h"


class GraphicsViewAdapter
{
public:
    using RoleType = GraphicsItem::RoleType;


    struct Point
    {
        double x;               
        double y;               
    };


    enum PenType
    {
        PEN_THIN_BLACK,
        PEN_MEDIUM_BLACK,
        PEN_THIN_VERY_LIGHT_GRAY,
        PEN_THIN_LIGHT_GRAY,
        PEN_THIN_DARK_GRAY,
        PEN_MEDIUM_LIGHT_GRAY,
        PEN_MEDIUM_DARK_GRAY,
        PEN_MEDIUM_GRAY,
        PEN_THIN_CYAN,
        PEN_MEDIUM_CYAN,
        PEN_MEDIUM_ORANGE,
        PEN_MEDIUM_MAGENTA,
        PEN_THIN_MAGENTA,
        PEN_THIN_RED,
        PEN_MEDIUM_RED,
        PEN_THIN_BLUE,
        PEN_THIN_TRANSPARENT,
        PEN_MEDIUM_DARK_GREEN,
    };


    enum FillTypes
    {
        FILL_TRANSPARENT,
        FILL_LIGHT_GRAY,
        FILL_RED,
        FILL_ORANGE,
        FILL_GREEN,
        FILL_LIGHT_GREEN,
        FILL_BLUE,
    };

public:

    GraphicsViewAdapter() {}            
    ~GraphicsViewAdapter() {clear();}   

    virtual void clear();               // Clear graphics panel


    GraphicItemsList        &getGraphicItems();
    const GraphicItemsList  &getGraphicItems() const;
    GraphicsItem            *getGraphicItem (int keyIndex, RoleType role);
    GraphicsItem            *getGraphicItemByRole (RoleType role);
    GraphicItemsList        getGraphicItems (int keyIndex);
    GraphicItemsList        getGraphicItemsByRole (RoleType role);
    GraphicItemsList        getGraphicItems (int keyIndex, RoleType role);



    virtual GraphicsItem* drawLine(double x1, double y1,
                          double x2, double y2,
                          PenType pen = PEN_THIN_BLACK) = 0;


    virtual GraphicsItem* drawChart(const std::vector<Point> &points,
                           PenType pen = PEN_THIN_BLACK) = 0;



    virtual GraphicsItem* drawFilledRect(double x, double y,
                                double w, double h,
                                PenType pen = PEN_THIN_BLACK,
                                FillTypes fill = FILL_RED) = 0;



    using ComplexVector = std::vector<std::complex<double>>;
    virtual void drawStroboscope (const ComplexVector &data) = 0;


private:
    GraphicItemsList mGraphicItems; 
};

#endif // GRAPHICSVIEWADAPTER_H