failed_view_controller.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 FAILED_VIEW_CONTROLLER_H
30 #define FAILED_VIEW_CONTROLLER_H
31 
32 #include "view_controller.h"
33 
34 namespace rviz
35 {
47 {
48 public:
49  FailedViewController(const QString& desired_class_id, const QString& error_message);
50 
51  QString getDescription() const override;
52 
53  void onActivate() override;
54 
55  virtual int processMouseEvent(ViewportMouseEvent& /*event*/)
56  {
57  return 0;
58  }
59 
62  void load(const Config& config) override;
63 
65  void save(Config config) const override;
66 
67  void lookAt(const Ogre::Vector3& /*point*/) override
68  {
69  }
70  void reset() override
71  {
72  }
73 
74 private:
76  QString error_message_;
77 };
78 
79 } // end namespace rviz
80 
81 #endif // FAILED_VIEW_CONTROLLER_H
rviz::FailedViewController::getDescription
QString getDescription() const override
Return the description.
Definition: failed_view_controller.cpp:45
rviz::FailedViewController::processMouseEvent
virtual int processMouseEvent(ViewportMouseEvent &)
Definition: failed_view_controller.h:55
rviz::ViewportMouseEvent
Definition: viewport_mouse_event.h:45
rviz::FailedViewController::lookAt
void lookAt(const Ogre::Vector3 &) override
This should be implemented in each subclass to aim the camera at the given point in space (relative t...
Definition: failed_view_controller.h:67
rviz::FailedViewController::FailedViewController
FailedViewController(const QString &desired_class_id, const QString &error_message)
Definition: failed_view_controller.cpp:39
rviz::FailedViewController::reset
void reset() override
Definition: failed_view_controller.h:70
rviz::FailedViewController::error_message_
QString error_message_
Definition: failed_view_controller.h:76
rviz::FailedViewController::load
void load(const Config &config) override
Store the given Config data for later, so we can return it with save() when someone writes this back ...
Definition: failed_view_controller.cpp:51
rviz
Definition: add_display_dialog.cpp:54
rviz::FailedViewController::save
void save(Config config) const override
Write into config data equivalent to the last config sent to load().
Definition: failed_view_controller.cpp:57
rviz::FailedViewController
A FailedViewController instance represents a ViewController class we tried and failed to instantiate.
Definition: failed_view_controller.h:46
rviz::ViewController
Definition: view_controller.h:55
rviz::FailedViewController::onActivate
void onActivate() override
called by activate().
Definition: failed_view_controller.cpp:69
rviz::FailedViewController::saved_config_
Config saved_config_
Definition: failed_view_controller.h:75
view_controller.h
rviz::Config
Configuration data storage class.
Definition: config.h:124


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