color_property.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012, Willow Garage, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Willow Garage, Inc. nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 #ifndef COLOR_PROPERTY_H
30 #define COLOR_PROPERTY_H
31 
32 #include <QColor>
33 
35 
37 
38 namespace rviz
39 {
40 class ColorProperty : public Property
41 {
42  Q_OBJECT
43 public:
44  ColorProperty(const QString& name = QString(),
45  const QColor& default_value = Qt::black,
46  const QString& description = QString(),
47  Property* parent = nullptr);
48 
49  template <typename Func, typename R>
50  ColorProperty(const QString& name,
51  const QColor& default_value,
52  const QString& description,
53  Property* parent,
54  Func&& changed_slot,
55  const R* receiver)
56  : ColorProperty(name, default_value, description, parent)
57  {
58  connect(receiver, std::forward<Func>(changed_slot));
59  }
60 
61  // this variant is required to allow omitting the receiver argument
62  template <typename Func, typename P>
63  ColorProperty(const QString& name,
64  const QColor& default_value,
65  const QString& description,
66  P* parent,
67  Func&& changed_slot)
68  : ColorProperty(name, default_value, description, parent)
69  {
70  connect(parent, std::forward<Func>(changed_slot));
71  }
72 
73  bool setValue(const QVariant& new_value) override;
74 
75  bool paint(QPainter* painter, const QStyleOptionViewItem& option) const override;
76 
77  QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option) override;
78 
79  virtual QColor getColor() const
80  {
81  return color_;
82  }
83  Ogre::ColourValue getOgreColor() const
84  {
85  return qtToOgre(color_);
86  }
87 
88 public Q_SLOTS:
89  virtual bool setColor(const QColor& color);
90 
91 private:
92  void updateString();
93 
94  QColor color_;
95 };
96 
97 } // end namespace rviz
98 
99 #endif // VECTOR_PROPERTY_H
rviz::ColorProperty::getColor
virtual QColor getColor() const
Definition: color_property.h:79
rviz::qtToOgre
Ogre::ColourValue qtToOgre(const QColor &c)
Definition: parse_color.cpp:83
rviz::ColorProperty::color_
QColor color_
Definition: color_property.h:94
property.h
description
description
rviz::ColorProperty::setValue
bool setValue(const QVariant &new_value) override
Set the new value for this property. Returns true if the new value is different from the old value,...
Definition: color_property.cpp:65
rviz::ColorProperty::paint
bool paint(QPainter *painter, const QStyleOptionViewItem &option) const override
Hook to provide custom painting of the value data (right-hand column) in a subclass.
Definition: color_property.cpp:85
rviz::ColorProperty::ColorProperty
ColorProperty(const QString &name=QString(), const QColor &default_value=Qt::black, const QString &description=QString(), Property *parent=nullptr)
Definition: color_property.cpp:41
rviz::ColorProperty
Definition: color_property.h:40
rviz::Property::connect
QMetaObject::Connection connect(const QObject *receiver, const char *slot, Qt::ConnectionType type=Qt::AutoConnection)
Connect changed() signal to given slot of receiver.
Definition: property.cpp:78
rviz::Property
A single element of a property tree, with a name, value, description, and possibly children.
Definition: property.h:100
rviz
Definition: add_display_dialog.cpp:54
rviz::ColorProperty::createEditor
QWidget * createEditor(QWidget *parent, const QStyleOptionViewItem &option) override
Create an editor widget to edit the value of this property.
Definition: color_property.cpp:105
default_value
def default_value(type_)
rviz::ColorProperty::ColorProperty
ColorProperty(const QString &name, const QColor &default_value, const QString &description, Property *parent, Func &&changed_slot, const R *receiver)
Definition: color_property.h:50
rviz::ColorProperty::updateString
void updateString()
Definition: color_property.cpp:80
rviz::ColorProperty::setColor
virtual bool setColor(const QColor &color)
Definition: color_property.cpp:50
rviz::ColorProperty::ColorProperty
ColorProperty(const QString &name, const QColor &default_value, const QString &description, P *parent, Func &&changed_slot)
Definition: color_property.h:63
rviz::ColorProperty::getOgreColor
Ogre::ColourValue getOgreColor() const
Definition: color_property.h:83
parse_color.h


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Sat Jun 1 2024 02:31:52