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 
33 
34 namespace rviz
35 {
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  Q_EMIT aboutToChange();
63  vector_ = new_vector;
64  ignore_child_updates_ = true;
65  x_->setValue( vector_.x );
66  y_->setValue( vector_.y );
67  z_->setValue( vector_.z );
68  ignore_child_updates_ = false;
69  updateString();
70  Q_EMIT changed();
71  return true;
72  }
73  return false;
74 }
75 
76 bool VectorProperty::setValue( const QVariant& new_value )
77 {
78  QStringList strings = new_value.toString().split( ';' );
79  if( strings.size() >= 3 )
80  {
81  bool x_ok = true;
82  float x = strings[ 0 ].toFloat( &x_ok );
83  bool y_ok = true;
84  float y = strings[ 1 ].toFloat( &y_ok );
85  bool z_ok = true;
86  float z = strings[ 2 ].toFloat( &z_ok );
87  if( x_ok && y_ok && z_ok )
88  {
89  return setVector( Ogre::Vector3( x, y, z ));
90  }
91  }
92  return false;
93 }
94 
96 {
98  {
99  vector_.x = x_->getValue().toFloat();
100  vector_.y = y_->getValue().toFloat();
101  vector_.z = z_->getValue().toFloat();
102  updateString();
103  Q_EMIT changed();
104  }
105 }
106 
108 {
109  if( !ignore_child_updates_ )
110  {
111  Q_EMIT aboutToChange();
112  }
113 }
114 
116 {
117  value_ = QString( "%1; %2; %3" )
118  .arg( vector_.x, 0, 'g', 5 )
119  .arg( vector_.y, 0, 'g', 5 )
120  .arg( vector_.z, 0, 'g', 5 );
121 }
122 
123 void VectorProperty::load( const Config& config )
124 {
125  float x, y, z;
126  if( config.mapGetFloat( "X", &x ) &&
127  config.mapGetFloat( "Y", &y ) &&
128  config.mapGetFloat( "Z", &z ))
129  {
130  // Calling setVector() once explicitly is better than letting the
131  // Property class load the X, Y, and Z children independently,
132  // which would result in at least 3 calls to setVector().
133  setVector( Ogre::Vector3( x, y, z ));
134  }
135 }
136 
137 void VectorProperty::save( Config config ) const
138 {
139  // Saving the child values explicitly avoids having Property::save()
140  // save the summary string version of the property.
141  config.mapSetValue( "X", x_->getValue() );
142  config.mapSetValue( "Y", y_->getValue() );
143  config.mapSetValue( "Z", z_->getValue() );
144 }
145 
146 void VectorProperty::setReadOnly( bool read_only )
147 {
148  Property::setReadOnly( read_only );
149  x_->setReadOnly( read_only );
150  y_->setReadOnly( read_only );
151  z_->setReadOnly( read_only );
152 }
153 
154 } // end namespace rviz
virtual bool setVector(const Ogre::Vector3 &vector)
void changed()
Emitted by setValue() just after the value has changed.
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:130
A single element of a property tree, with a name, value, description, and possibly children...
Definition: property.h:100
bool mapGetFloat(const QString &key, float *value_out) const
Convenience function for looking up a named float.
Definition: config.cpp:245
TFSIMD_FORCE_INLINE const tfScalar & y() const
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:440
void mapSetValue(const QString &key, QVariant value)
Set a named child to the given value.
Definition: config.cpp:185
Configuration data storage class.
Definition: config.h:125
virtual void setReadOnly(bool read_only)
Overridden from Property to propagate read-only-ness to children.
TFSIMD_FORCE_INLINE const tfScalar & x() const
Ogre::Vector3 vector_
TFSIMD_FORCE_INLINE const tfScalar & z() const
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...
Property(const QString &name=QString(), const QVariant default_value=QVariant(), const QString &description=QString(), Property *parent=0, const char *changed_slot=0, QObject *receiver=0)
Constructor.
Definition: property.cpp:54
void aboutToChange()
Emitted by setValue() just before the value has changed.
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:145
virtual void setReadOnly(bool read_only)
Prevent or allow users to edit this property from a PropertyTreeWidget.
Definition: property.h:397
virtual void save(Config config) const
Write the value of this property and/or its children into the given Config reference.
VectorProperty(const QString &name=QString(), const Ogre::Vector3 &default_value=Ogre::Vector3::ZERO, const QString &description=QString(), Property *parent=0, const char *changed_slot=0, QObject *receiver=0)
virtual void load(const Config &config)
Load the value of this property and/or its children from the given Config reference.


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Sat Apr 27 2019 02:33:42