MIRA
ColormapProperty.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 by
3  * MetraLabs GmbH (MLAB), GERMANY
4  * and
5  * Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
6  * All rights reserved.
7  *
8  * Contact: info@mira-project.org
9  *
10  * Commercial Usage:
11  * Licensees holding valid commercial licenses may use this file in
12  * accordance with the commercial license agreement provided with the
13  * software or, alternatively, in accordance with the terms contained in
14  * a written agreement between you and MLAB or NICR.
15  *
16  * GNU General Public License Usage:
17  * Alternatively, this file may be used under the terms of the GNU
18  * General Public License version 3.0 as published by the Free Software
19  * Foundation and appearing in the file LICENSE.GPL3 included in the
20  * packaging of this file. Please review the following information to
21  * ensure the GNU General Public License version 3.0 requirements will be
22  * met: http://www.gnu.org/copyleft/gpl.html.
23  * Alternatively you may (at your option) use any later version of the GNU
24  * General Public License if such license has been publicly approved by
25  * MLAB and NICR (or its successors, if any).
26  *
27  * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
28  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
29  * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
30  * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
33  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
34  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
35  * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
36  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
37  */
38 
47 #ifndef _MIRA_COLORMAPPROPERTY_H_
48 #define _MIRA_COLORMAPPROPERTY_H_
49 
50 #include <QVector>
51 #include <QColor>
52 #include <QComboBox>
53 
57 
58 #include <image/Colormap.h>
59 
60 namespace mira {
61 
63 
72 {
73 public:
74 
75  struct ColormapDesc;
76 
77  template <typename Reflector>
78  void reflectRead(Reflector& r) {
79  r.delegate(mColormapIdentifier);
80  }
81 
82  template <typename Reflector>
83  void reflectWrite(Reflector& r) {
84  r.delegate(mColormapIdentifier);
85  update();
86  }
87 
89 
90 public:
91 
93  ColormapProperty() : mColormapDesc(NULL) {}
94 
96  ColormapProperty(const std::string& colormapIdentifier);
97 
99  bool isValid() const;
100 
102  ColormapProperty& operator=(const std::string& identifier) {
103  mColormapIdentifier = identifier;
104  update();
105  return *this;
106  }
107 
109  const std::string& str() const {
110  return mColormapIdentifier;
111  }
112 
117  const Colormap& getColormap() const;
118 
123  const QVector<QRgb>& getColorTable() const;
124 
125 
126 public:
127 
152  void setFilter(boost::function<bool(const Colormap*)> filterFunction);
153 
158  bool filter(const Colormap* colormap) const;
159 
168  static bool filterContinuous(const Colormap* colormap)
169  {
170  // check if colormap is a ContinuousColormap
171  return dynamic_cast<const ContinuousColormap*>(colormap) != NULL;
172  }
173 
174 private:
175 
176  void update();
177  void checkValid() const;
178 
179 
180 private:
181 
182  std::string mColormapIdentifier;
183  const ColormapDesc* mColormapDesc;
184 
185  boost::function<bool(const Colormap*)> mFilterFunction;
186 };
187 
188 template <typename SerializerTag>
189 class IsTransparentSerializable<ColormapProperty,SerializerTag> : public std::true_type {};
190 
192 
193 class ColormapPropertyComboBox : public QComboBox
194 {
195 Q_OBJECT
196 public:
197  ColormapPropertyComboBox(PropertyNode* p, QWidget* parent);
198 public slots:
199  void slotSetValue(int value);
200 public:
202 
203 private:
204  class ComboBoxDelegate;
205 };
206 
208 
209 }
210 
211 #endif
Abstract base class for all derived property node classes.
Definition: PropertyNode.h:202
ColormapPropertyComboBox(PropertyNode *p, QWidget *parent)
Type trait that indicates whether a type should be serialized "transparently", i.e.
Definition: IsTransparentSerializable.h:81
This file contains classes for different color colormaps (like Jet, HSV, etc.)
Declaration and implementation of the property node hierarchy.
Definition: ColormapProperty.h:193
specialize cv::DataType for our ImgPixel and inherit from cv::DataType<Vec>
Definition: IOService.h:67
#define MIRA_SPLIT_REFLECT_MEMBER
Macro that insert a class member reflect() method just splitting reflection into a reflectRead() and ...
Definition: SplitReflect.h:209
Base class for continuous color colormaps.
Definition: Colormap.h:217
Provides type trait that indicates whether a type should be serialized "transparently".
static bool filterContinuous(const Colormap *colormap)
A predefined filter function that filters all ContinuousColormap classes.
Definition: ColormapProperty.h:168
Provides MIRA_SPLIT_REFLECT macros.
const Colormap & getColormap() const
Returns the chosen color colormap.
bool isValid() const
Returns true, if a valid colormap was chosen.
PropertyNode * property
Definition: ColormapProperty.h:201
A special property class that can be used as member, if you want to provide a ComboBox where the user...
Definition: ColormapProperty.h:71
const QVector< QRgb > & getColorTable() const
Returns the chosen color colormap as color table in Qt compliant form.
void reflectRead(Reflector &r)
Definition: ColormapProperty.h:78
void setFilter(boost::function< bool(const Colormap *)> filterFunction)
Allows to specify a filter function.
ColormapProperty()
Creates property with no selected colormap.
Definition: ColormapProperty.h:93
Base class for color colormaps.
Definition: Colormap.h:62
bool filter(const Colormap *colormap) const
Returns true, if the specified colormap has passed the optional set filter.
void reflectWrite(Reflector &r)
Definition: ColormapProperty.h:83
const std::string & str() const
Returns the set colormap identifier as string.
Definition: ColormapProperty.h:109
ColormapProperty & operator=(const std::string &identifier)
Assigns colormap identifier string.
Definition: ColormapProperty.h:102