quaternion_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 QUATERNION_PROPERTY_H
30 #define QUATERNION_PROPERTY_H
31 
32 #include <OgreQuaternion.h>
33 
35 
36 namespace rviz
37 {
39 {
40  Q_OBJECT
41 public:
42  QuaternionProperty(const QString& name = QString(),
43  const Ogre::Quaternion& default_value = Ogre::Quaternion::IDENTITY,
44  const QString& description = QString(),
45  Property* parent = nullptr);
46 
47  template <typename Func, typename R>
48  QuaternionProperty(const QString& name,
49  const Ogre::Quaternion& default_value,
50  const QString& description,
51  Property* parent,
52  Func&& changed_slot,
53  const R* receiver)
55  {
56  connect(receiver, std::forward<Func>(changed_slot));
57  }
58 
59  // this variant is required to allow omitting the receiver argument
60  template <typename Func, typename P>
61  QuaternionProperty(const QString& name,
62  const Ogre::Quaternion& default_value,
63  const QString& description,
64  P* parent,
65  Func&& changed_slot)
67  {
68  connect(parent, std::forward<Func>(changed_slot));
69  }
70 
71  virtual bool setQuaternion(const Ogre::Quaternion& quaternion);
72  virtual Ogre::Quaternion getQuaternion() const
73  {
74  return quaternion_;
75  }
76 
77  bool setValue(const QVariant& new_value) override;
78 
81  void load(const Config& config) override;
82 
83  void save(Config config) const override;
84 
86  void setReadOnly(bool read_only) override;
87 
88 private Q_SLOTS:
89  void updateFromChildren();
90  void emitAboutToChange();
91 
92 private:
93  void updateString();
94 
95  Ogre::Quaternion quaternion_;
101 };
102 
103 } // end namespace rviz
104 
105 #endif // QUATERNION_PROPERTY_H
rviz::QuaternionProperty::updateFromChildren
void updateFromChildren()
Definition: quaternion_property.cpp:102
rviz::QuaternionProperty::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: quaternion_property.cpp:81
rviz::QuaternionProperty::z_
Property * z_
Definition: quaternion_property.h:98
rviz::QuaternionProperty::QuaternionProperty
QuaternionProperty(const QString &name=QString(), const Ogre::Quaternion &default_value=Ogre::Quaternion::IDENTITY, const QString &description=QString(), Property *parent=nullptr)
Definition: quaternion_property.cpp:37
property.h
rviz::QuaternionProperty::x_
Property * x_
Definition: quaternion_property.h:96
description
description
rviz::QuaternionProperty::setReadOnly
void setReadOnly(bool read_only) override
Overridden from Property to propagate read-only-ness to children.
Definition: quaternion_property.cpp:158
rviz::QuaternionProperty::QuaternionProperty
QuaternionProperty(const QString &name, const Ogre::Quaternion &default_value, const QString &description, P *parent, Func &&changed_slot)
Definition: quaternion_property.h:61
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::QuaternionProperty
Definition: quaternion_property.h:38
rviz::Property
A single element of a property tree, with a name, value, description, and possibly children.
Definition: property.h:100
rviz::QuaternionProperty::load
void load(const Config &config) override
Load the value of this property and/or its children from the given Config node.
Definition: quaternion_property.cpp:132
rviz::QuaternionProperty::QuaternionProperty
QuaternionProperty(const QString &name, const Ogre::Quaternion &default_value, const QString &description, Property *parent, Func &&changed_slot, const R *receiver)
Definition: quaternion_property.h:48
rviz
Definition: add_display_dialog.cpp:54
rviz::QuaternionProperty::ignore_child_updates_
bool ignore_child_updates_
Definition: quaternion_property.h:100
rviz::QuaternionProperty::setQuaternion
virtual bool setQuaternion(const Ogre::Quaternion &quaternion)
Definition: quaternion_property.cpp:60
rviz::QuaternionProperty::emitAboutToChange
void emitAboutToChange()
Definition: quaternion_property.cpp:115
rviz::QuaternionProperty::y_
Property * y_
Definition: quaternion_property.h:97
default_value
def default_value(type_)
rviz::QuaternionProperty::quaternion_
Ogre::Quaternion quaternion_
Definition: quaternion_property.h:95
rviz::QuaternionProperty::getQuaternion
virtual Ogre::Quaternion getQuaternion() const
Definition: quaternion_property.h:72
rviz::QuaternionProperty::updateString
void updateString()
Definition: quaternion_property.cpp:123
rviz::QuaternionProperty::save
void save(Config config) const override
Write the value of this property and/or its children into the given Config reference.
Definition: quaternion_property.cpp:146
rviz::Config
Configuration data storage class.
Definition: config.h:124
rviz::QuaternionProperty::w_
Property * w_
Definition: quaternion_property.h:99


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Fri Aug 2 2024 08:43:10