vector_property.cpp
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 
30 #include <QStringList>
31 
34 
35 namespace rviz
36 {
37 VectorProperty::VectorProperty(const QString& name,
38  const Ogre::Vector3& default_value,
39  const QString& description,
40  Property* parent,
41  const char* changed_slot,
42  QObject* receiver)
43  : Property(name, QVariant(), description, parent, changed_slot, receiver)
44  , vector_(default_value)
45  , ignore_child_updates_(false)
46 {
47  x_ = new Property("X", vector_.x, "X coordinate", this);
48  y_ = new Property("Y", vector_.y, "Y coordinate", this);
49  z_ = new Property("Z", vector_.z, "Z coordinate", this);
50  updateString();
51  connect(x_, SIGNAL(aboutToChange()), this, SLOT(emitAboutToChange()));
52  connect(y_, SIGNAL(aboutToChange()), this, SLOT(emitAboutToChange()));
53  connect(z_, SIGNAL(aboutToChange()), this, SLOT(emitAboutToChange()));
54  connect(x_, SIGNAL(changed()), this, SLOT(updateFromChildren()));
55  connect(y_, SIGNAL(changed()), this, SLOT(updateFromChildren()));
56  connect(z_, SIGNAL(changed()), this, SLOT(updateFromChildren()));
57 }
58 
59 bool VectorProperty::setVector(const Ogre::Vector3& new_vector)
60 {
61  if (new_vector != vector_)
62  {
63  Q_EMIT aboutToChange();
64  vector_ = new_vector;
65  ignore_child_updates_ = true;
66  x_->setValue(vector_.x);
67  y_->setValue(vector_.y);
68  z_->setValue(vector_.z);
69  ignore_child_updates_ = false;
70  updateString();
71  Q_EMIT changed();
72  if (model_)
73  model_->emitDataChanged(this);
74  return true;
75  }
76  return false;
77 }
78 
79 bool VectorProperty::setValue(const QVariant& new_value)
80 {
81  QStringList strings = new_value.toString().split(';');
82  if (strings.size() >= 3)
83  {
84  bool x_ok = true;
85  float x = strings[0].toFloat(&x_ok);
86  bool y_ok = true;
87  float y = strings[1].toFloat(&y_ok);
88  bool z_ok = true;
89  float z = strings[2].toFloat(&z_ok);
90  if (x_ok && y_ok && z_ok)
91  {
92  return setVector(Ogre::Vector3(x, y, z));
93  }
94  }
95  return false;
96 }
97 
99 {
101  {
102  vector_.x = x_->getValue().toFloat();
103  vector_.y = y_->getValue().toFloat();
104  vector_.z = z_->getValue().toFloat();
105  updateString();
106  Q_EMIT changed();
107  }
108 }
109 
111 {
113  {
114  Q_EMIT aboutToChange();
115  }
116 }
117 
119 {
120  value_ =
121  QString("%1; %2; %3").arg(vector_.x, 0, 'g', 5).arg(vector_.y, 0, 'g', 5).arg(vector_.z, 0, 'g', 5);
122 }
123 
124 void VectorProperty::load(const Config& config)
125 {
126  float x, y, z;
127  if (config.mapGetFloat("X", &x) && config.mapGetFloat("Y", &y) && config.mapGetFloat("Z", &z))
128  {
129  // Calling setVector() once explicitly is better than letting the
130  // Property class load the X, Y, and Z children independently,
131  // which would result in at least 3 calls to setVector().
132  setVector(Ogre::Vector3(x, y, z));
133  }
134 }
135 
136 void VectorProperty::save(Config config) const
137 {
138  // Saving the child values explicitly avoids having Property::save()
139  // save the summary string version of the property.
140  config.mapSetValue("X", x_->getValue());
141  config.mapSetValue("Y", y_->getValue());
142  config.mapSetValue("Z", z_->getValue());
143 }
144 
145 void VectorProperty::setReadOnly(bool read_only)
146 {
147  Property::setReadOnly(read_only);
148  x_->setReadOnly(read_only);
149  y_->setReadOnly(read_only);
150  z_->setReadOnly(read_only);
151 }
152 
153 } // end namespace rviz
virtual bool setVector(const Ogre::Vector3 &vector)
void changed()
Emitted by setValue() just after the value has changed.
PropertyTreeModel * model_
Pointer to the PropertyTreeModel managing this property tree.
Definition: property.h:496
virtual bool setValue(const QVariant &new_value)
Set the new value for this property. Returns true if the new value is different from the old value...
Definition: property.cpp:134
A single element of a property tree, with a name, value, description, and possibly children...
Definition: property.h:100
void setReadOnly(bool read_only) override
Overridden from Property to propagate read-only-ness to children.
QVariant value_
This is the central property value. If you set it directly in a subclass, do so with care because man...
Definition: property.h:482
void save(Config config) const override
Write the value of this property and/or its children into the given Config reference.
void mapSetValue(const QString &key, QVariant value)
Set a named child to the given value.
Definition: config.cpp:196
Configuration data storage class.
Definition: config.h:124
bool mapGetFloat(const QString &key, float *value_out) const
Convenience function for looking up a named float.
Definition: config.cpp:256
Property(const QString &name=QString(), const QVariant default_value=QVariant(), const QString &description=QString(), Property *parent=nullptr, const char *changed_slot=nullptr, QObject *receiver=nullptr)
Constructor.
Definition: property.cpp:58
Ogre::Vector3 vector_
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...
void load(const Config &config) override
Load the value of this property and/or its children from the given Config reference.
void aboutToChange()
Emitted by setValue() just before the value has changed.
void emitDataChanged(Property *property)
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
virtual void setReadOnly(bool read_only)
Prevent or allow users to edit this property from a PropertyTreeWidget.
Definition: property.h:433
VectorProperty(const QString &name=QString(), const Ogre::Vector3 &default_value=Ogre::Vector3::ZERO, const QString &description=QString(), Property *parent=nullptr, const char *changed_slot=nullptr, QObject *receiver=nullptr)


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Mon Aug 15 2022 02:05:17