float_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 FLOAT_PROPERTY_H
30 #define FLOAT_PROPERTY_H
31 
33 
34 namespace rviz
35 {
37 class FloatProperty : public Property
38 {
39  Q_OBJECT
40 public:
41  FloatProperty(const QString& name = QString(),
42  float default_value = 0,
43  const QString& description = QString(),
44  Property* parent = nullptr);
45 
46  template <typename Func, typename R>
47  FloatProperty(const QString& name,
48  float default_value,
49  const QString& description,
50  Property* parent,
51  Func&& changed_slot,
52  const R* receiver)
53  : FloatProperty(name, default_value, description, parent)
54  {
55  connect(receiver, std::forward<Func>(changed_slot));
56  }
57 
58  // this variant is required to allow omitting the receiver argument
59  template <typename Func, typename P>
60  FloatProperty(const QString& name,
61  float default_value,
62  const QString& description,
63  P* parent,
64  Func&& changed_slot)
65  : FloatProperty(name, default_value, description, parent)
66  {
67  connect(parent, std::forward<Func>(changed_slot));
68  }
69 
77  bool setValue(const QVariant& new_value) override;
78 
79  virtual float getFloat() const
80  {
81  return getValue().toFloat();
82  }
83 
84  void setMin(float min);
85  float getMin()
86  {
87  return min_;
88  }
89  void setMax(float max);
90  float getMax()
91  {
92  return max_;
93  }
94 
95 public Q_SLOTS:
97  bool setFloat(float new_value)
98  {
99  return setValue(new_value);
100  }
101 
103  bool add(float delta)
104  {
105  return setValue(delta + getValue().toFloat());
106  }
107 
109  bool multiply(float factor)
110  {
111  return setValue(factor * getValue().toFloat());
112  }
113 
114 private:
115  float min_;
116  float max_;
117 };
118 
119 } // end namespace rviz
120 
121 #endif // FLOAT_PROPERTY_H
rviz::FloatProperty::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: float_property.cpp:46
property.h
rviz::FloatProperty::getMax
float getMax()
Definition: float_property.h:90
rviz::FloatProperty::setMax
void setMax(float max)
Definition: float_property.cpp:57
description
description
rviz::FloatProperty::add
bool add(float delta)
Add the given delta to the property value.
Definition: float_property.h:103
rviz::FloatProperty::max_
float max_
Definition: float_property.h:116
rviz::Property::getValue
virtual QVariant getValue() const
Return the value of this Property as a QVariant. If the value has never been set, an invalid QVariant...
Definition: property.cpp:150
rviz::FloatProperty::setMin
void setMin(float min)
Definition: float_property.cpp:51
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::FloatProperty
Property specialized to enforce floating point max/min.
Definition: float_property.h:37
rviz::Property
A single element of a property tree, with a name, value, description, and possibly children.
Definition: property.h:100
rviz::FloatProperty::FloatProperty
FloatProperty(const QString &name, float default_value, const QString &description, Property *parent, Func &&changed_slot, const R *receiver)
Definition: float_property.h:47
rviz::FloatProperty::getFloat
virtual float getFloat() const
Definition: float_property.h:79
rviz
Definition: add_display_dialog.cpp:54
rviz::FloatProperty::FloatProperty
FloatProperty(const QString &name=QString(), float default_value=0, const QString &description=QString(), Property *parent=nullptr)
Definition: float_property.cpp:38
rviz::FloatProperty::getMin
float getMin()
Definition: float_property.h:85
rviz::FloatProperty::setFloat
bool setFloat(float new_value)
Float-typed "SLOT" version of setValue().
Definition: float_property.h:97
default_value
def default_value(type_)
rviz::FloatProperty::FloatProperty
FloatProperty(const QString &name, float default_value, const QString &description, P *parent, Func &&changed_slot)
Definition: float_property.h:60
rviz::FloatProperty::min_
float min_
Definition: float_property.h:115
rviz::FloatProperty::multiply
bool multiply(float factor)
Multiply the property value by the given factor.
Definition: float_property.h:109


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Fri Dec 13 2024 03:31:02