annotate base/ColourMapper.h @ 335:02d2ad95ea52 spectrogram-cache-rejig

* Get storage advice for each cache in an FFT data server.  Allows us to be
  more confident about the actual memory situation and cut over from memory
  to disc part way through an FFT calculation if necessary.  StorageAdviser
  is now a bit too optimistic though (it's too keen to allocate large numbers
  of small blocks in memory).

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*
    Sonic Visualiser
    An audio file viewer and annotation editor.
    Centre for Digital Music, Queen Mary, University of London.
    This file copyright 2006-2007 Chris Cannam and QMUL.
    
    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.  See the file
    COPYING included with this distribution for more information.
*/

#ifndef _COLOUR_MAPPER_H_
#define _COLOUR_MAPPER_H_

#include <QObject>
#include <QColor>
#include <QString>

/**
 * A class for mapping intensity values onto various colour maps.
 */

class ColourMapper : public QObject
{
    Q_OBJECT

public:
    ColourMapper(int map, float minValue, float maxValue);
    virtual ~ColourMapper();

    enum StandardMap {
        DefaultColours,
        Sunset,
        WhiteOnBlack,
        BlackOnWhite,
        RedOnBlue,
        YellowOnBlack,
        BlueOnBlack,
        FruitSalad,
        Banded,
        Highlight,
        Printer
    };

    int getMap() const { return m_map; }
    float getMinValue() const { return m_min; }
    float getMaxValue() const { return m_max; }

    static int getColourMapCount();
    static QString getColourMapName(int n);

    QColor map(float value) const;

    QColor getContrastingColour() const; // for cursors etc
    bool hasLightBackground() const;

protected:
    int m_map;
    float m_min;
    float m_max;
};

#endif