display_wrapper.h
Go to the documentation of this file.00001 /* 00002 * Copyright (c) 2009, Willow Garage, Inc. 00003 * All rights reserved. 00004 * 00005 * Redistribution and use in source and binary forms, with or without 00006 * modification, are permitted provided that the following conditions are met: 00007 * 00008 * * Redistributions of source code must retain the above copyright 00009 * notice, this list of conditions and the following disclaimer. 00010 * * Redistributions in binary form must reproduce the above copyright 00011 * notice, this list of conditions and the following disclaimer in the 00012 * documentation and/or other materials provided with the distribution. 00013 * * Neither the name of the Willow Garage, Inc. nor the names of its 00014 * contributors may be used to endorse or promote products derived from 00015 * this software without specific prior written permission. 00016 * 00017 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00018 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00019 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 00020 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 00021 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 00022 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 00023 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 00024 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 00025 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 00026 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 00027 * POSSIBILITY OF SUCH DAMAGE. 00028 */ 00029 00030 #ifndef RVIZ_DISPLAY_WRAPPER_H 00031 #define RVIZ_DISPLAY_WRAPPER_H 00032 00033 #include "properties/forwards.h" 00034 00035 #include <boost/signals.hpp> 00036 00037 class wxConfigBase; 00038 00039 namespace rviz 00040 { 00041 00042 class Display; 00043 class VisualizationManager; 00044 struct PluginStatus; 00045 00046 class DisplayTypeInfo; 00047 typedef boost::shared_ptr<DisplayTypeInfo> DisplayTypeInfoPtr; 00048 class Plugin; 00049 typedef boost::shared_ptr<Plugin> PluginPtr; 00050 00051 class DisplayWrapper; 00052 typedef boost::signal<void(DisplayWrapper*)> DisplayWrapperSignal; 00053 00054 class DisplayWrapper : public boost::signals::trackable 00055 { 00056 public: 00057 DisplayWrapper(const std::string& package, const std::string& class_name, const PluginPtr& plugin, const std::string& name, VisualizationManager* manager); 00058 ~DisplayWrapper(); 00059 00060 bool isLoaded() const; 00061 const DisplayTypeInfoPtr& getTypeInfo() const { return typeinfo_; } 00062 const PluginPtr& getPlugin() const { return plugin_; } 00063 Display* getDisplay() const { return display_; } 00064 const std::string& getName() const { return name_; } 00065 const std::string& getPackage() const { return package_; } 00066 const std::string& getClassName() const { return class_name_; } 00067 00068 void setName(const std::string& name); 00069 00070 void setEnabled(bool enabled); 00071 bool isEnabled(); 00072 00073 void setPlugin(const PluginPtr& plugin); 00074 void createDisplay(); 00075 void destroyDisplay(); 00076 00077 void setPropertyManager(PropertyManager* property_manager, const CategoryPropertyWPtr& parent); 00078 const CategoryPropertyWPtr& getCategory() const { return category_; } 00079 00080 DisplayWrapperSignal& getDisplayCreatedSignal() { return display_created_; } 00081 DisplayWrapperSignal& getDisplayCreatingSignal() { return display_creating_; } 00082 DisplayWrapperSignal& getDisplayDestroyingSignal() { return display_destroying_; } 00083 DisplayWrapperSignal& getDisplayDestroyedSignal() { return display_destroyed_; } 00084 00085 protected: 00086 void onDisplaysConfigLoaded(const boost::shared_ptr<wxConfigBase>& config); 00087 void onDisplaysConfigSaved(const boost::shared_ptr<wxConfigBase>& config); 00088 00089 void onPluginLoaded(const PluginStatus&); 00090 void onPluginUnloading(const PluginStatus&); 00091 00092 void loadProperties(); 00093 00094 VisualizationManager* manager_; 00095 00096 std::string name_; 00097 std::string package_; 00098 std::string class_name_; 00099 00100 Display* display_; 00101 DisplayTypeInfoPtr typeinfo_; 00102 PluginPtr plugin_; 00103 00104 boost::shared_ptr<wxConfigBase> config_; 00105 00106 typedef std::map<std::string, std::string> M_string; 00107 M_string properties_; 00108 00109 DisplayWrapperSignal display_created_; 00110 DisplayWrapperSignal display_creating_; 00111 DisplayWrapperSignal display_destroying_; 00112 DisplayWrapperSignal display_destroyed_; 00113 00114 PropertyManager* property_manager_; 00115 CategoryPropertyWPtr category_; 00116 00117 bool enabled_; 00118 }; 00119 00120 } // namespace rviz 00121 00122 #endif // RVIZ_DISPLAY_WRAPPER_H