Implement McNames color maps, but discourage their use.
[gencolormap.git] / colormapwidgets.hpp
1 /*
2  * Copyright (C) 2015, 2016 Computer Graphics Group, University of Siegen
3  * Written by Martin Lambers <martin.lambers@uni-siegen.de>
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy
6  * of this software and associated documentation files (the "Software"), to deal
7  * in the Software without restriction, including without limitation the rights
8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9  * copies of the Software, and to permit persons to whom the Software is
10  * furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21  * SOFTWARE.
22  */
23
24 #ifndef COLORMAPWIDGETS_HPP
25 #define COLORMAPWIDGETS_HPP
26
27 #include <QVector>
28 #include <QWidget>
29
30 class QSpinBox;
31 class QSlider;
32 class QDoubleSpinBox;
33 class QPushButton;
34
35
36 // Internal helper class for a slider/spinbox combination
37 class ColorMapCombinedSliderSpinBox : public QObject
38 {
39 Q_OBJECT
40
41 private:
42     bool _update_lock;
43
44 public:
45     float minval, maxval, step;
46     QSlider* slider;
47     QDoubleSpinBox* spinbox;
48
49     ColorMapCombinedSliderSpinBox(float minval, float maxval, float step);
50     float value() const;
51     void setValue(float v);
52
53 private slots:
54     void sliderChanged();
55     void spinboxChanged();
56
57 signals:
58     void valueChanged(float);
59 };
60
61 /* The ColorMapWidget interface, implemented by all color map method widgets */
62 class ColorMapWidget : public QWidget
63 {
64 Q_OBJECT
65
66 public:
67     ColorMapWidget();
68     ~ColorMapWidget();
69
70     /* Reset all values to their method-specific defaults */
71     virtual void reset() = 0;
72
73     /* Get the color map corresponding to the current values as a vector of colors */
74     virtual QVector<QColor> colorMap() const = 0;
75
76     /* Get a color map as an image of the specified size. If width or height is zero,
77      * then it will be set to the number of colors in the color map. */
78     QImage colorMapImage(int width, int height);
79
80     /* Get a rich text string containing the relevant literature reference for this method */
81     virtual QString reference() const = 0;
82
83 signals:
84     void colorMapChanged();
85 };
86
87 class ColorMapBrewerSequentialWidget : public ColorMapWidget
88 {
89 Q_OBJECT
90 private:
91     bool _update_lock;
92     QSpinBox* _n_spinbox;
93     ColorMapCombinedSliderSpinBox* _hue_changer;
94     ColorMapCombinedSliderSpinBox* _warmth_changer;
95     ColorMapCombinedSliderSpinBox* _contrast_changer;
96     ColorMapCombinedSliderSpinBox* _saturation_changer;
97     ColorMapCombinedSliderSpinBox* _brightness_changer;
98 private slots:
99     void update();
100
101 public:
102     ColorMapBrewerSequentialWidget();
103     ~ColorMapBrewerSequentialWidget();
104
105     void reset() override;
106     QVector<QColor> colorMap() const override;
107     QString reference() const override;
108     void parameters(int& n, float& hue,
109             float& contrast, float& saturation, float& brightness, float& warmth) const;
110 };
111
112 class ColorMapBrewerDivergingWidget : public ColorMapWidget
113 {
114 Q_OBJECT
115 private:
116     bool _update_lock;
117     QSpinBox* _n_spinbox;
118     ColorMapCombinedSliderSpinBox* _hue_changer;
119     ColorMapCombinedSliderSpinBox* _divergence_changer;
120     ColorMapCombinedSliderSpinBox* _warmth_changer;
121     ColorMapCombinedSliderSpinBox* _contrast_changer;
122     ColorMapCombinedSliderSpinBox* _saturation_changer;
123     ColorMapCombinedSliderSpinBox* _brightness_changer;
124 private slots:
125     void update();
126
127 public:
128     ColorMapBrewerDivergingWidget();
129     ~ColorMapBrewerDivergingWidget();
130
131     void reset() override;
132     QVector<QColor> colorMap() const override;
133     QString reference() const override;
134     void parameters(int& n, float& hue, float& divergence,
135             float& contrast, float& saturation, float& brightness, float& warmth) const;
136 };
137
138 class ColorMapBrewerQualitativeWidget : public ColorMapWidget
139 {
140 Q_OBJECT
141 private:
142     bool _update_lock;
143     QSpinBox* _n_spinbox;
144     ColorMapCombinedSliderSpinBox* _hue_changer;
145     ColorMapCombinedSliderSpinBox* _divergence_changer;
146     ColorMapCombinedSliderSpinBox* _contrast_changer;
147     ColorMapCombinedSliderSpinBox* _saturation_changer;
148     ColorMapCombinedSliderSpinBox* _brightness_changer;
149 private slots:
150     void update();
151
152 public:
153     ColorMapBrewerQualitativeWidget();
154     ~ColorMapBrewerQualitativeWidget();
155
156     void reset() override;
157     QVector<QColor> colorMap() const override;
158     QString reference() const override;
159     void parameters(int& n, float& hue, float& divergence,
160             float& contrast, float& saturation, float& brightness) const;
161 };
162
163 class ColorMapCubeHelixWidget : public ColorMapWidget
164 {
165 Q_OBJECT
166 private:
167     bool _update_lock;
168     QSpinBox* _n_spinbox;
169     ColorMapCombinedSliderSpinBox* _hue_changer;
170     ColorMapCombinedSliderSpinBox* _rotations_changer;
171     ColorMapCombinedSliderSpinBox* _saturation_changer;
172     ColorMapCombinedSliderSpinBox* _gamma_changer;
173 private slots:
174     void update();
175
176 public:
177     ColorMapCubeHelixWidget();
178     ~ColorMapCubeHelixWidget();
179
180     void reset() override;
181     QVector<QColor> colorMap() const override;
182     QString reference() const override;
183     void parameters(int& n, float& hue, float& rotations,
184             float& saturation, float& gamma) const;
185 };
186
187 class ColorMapMorelandDivergingWidget : public ColorMapWidget
188 {
189 Q_OBJECT
190 private:
191     bool _update_lock;
192     QSpinBox* _n_spinbox;
193     QPushButton* _color0_button;
194     QPushButton* _color1_button;
195 private slots:
196     void chooseColor0();
197     void chooseColor1();
198     void update();
199
200 public:
201     ColorMapMorelandDivergingWidget();
202     ~ColorMapMorelandDivergingWidget();
203
204     void reset() override;
205     QVector<QColor> colorMap() const override;
206     QString reference() const override;
207     void parameters(int& n,
208             unsigned char& r0, unsigned char& g0, unsigned char& b0,
209             unsigned char& r1, unsigned char& g1, unsigned char& b1) const;
210 };
211
212 class ColorMapMcNamesSequentialWidget : public ColorMapWidget
213 {
214 Q_OBJECT
215 private:
216     bool _update_lock;
217     QSpinBox* _n_spinbox;
218     ColorMapCombinedSliderSpinBox* _periods_changer;
219 private slots:
220     void update();
221
222 public:
223     ColorMapMcNamesSequentialWidget();
224     ~ColorMapMcNamesSequentialWidget();
225
226     void reset() override;
227     QVector<QColor> colorMap() const override;
228     QString reference() const override;
229     void parameters(int& n, float& p) const;
230 };
231
232 #endif