display_visibility_property.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009, Willow Garage, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Willow Garage, Inc. nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef RVIZ_DISPLAY_VISIBILITY_PROPERTY_H_
#define RVIZ_DISPLAY_VISIBILITY_PROPERTY_H_
 
#include <stdint.h>
 
#include <map>
#include <string>
 
#include <QObject>
#include <QString>
 
#include "bool_property.h"
 
namespace rviz
{
class DisplayContext;
class Property;
class Display;
class BoolProperty;
class DisplayVisibilityProperty;
 
 
/*
 * @brief Changes one visibility bit of a given Display
 */
class DisplayVisibilityProperty : public BoolProperty
{
  Q_OBJECT
public:
  DisplayVisibilityProperty(uint32_t vis_bit,
                            Display* display,
                            const QString& name = QString(),
                            bool default_value = false,
                            const QString& description = QString(),
                            Property* parent = nullptr);
 
  template <typename Func, typename R>
  DisplayVisibilityProperty(uint32_t vis_bit,
                            Display* display,
                            const QString& name,
                            bool default_value,
                            const QString& description,
                            Property* parent,
                            Func&& changed_slot,
                            const R* receiver)
    : DisplayVisibilityProperty(vis_bit, display, name, default_value, description, parent)
  {
    connect(receiver, std::forward<Func>(changed_slot));
  }
 
  // this variant is required to allow omitting the receiver argument
  template <typename Func, typename P>
  DisplayVisibilityProperty(uint32_t vis_bit,
                            Display* display,
                            const QString& name,
                            bool default_value,
                            const QString& description,
                            P* parent,
                            Func&& changed_slot)
    : DisplayVisibilityProperty(vis_bit, display, name, default_value, description, parent)
  {
    connect(parent, std::forward<Func>(changed_slot));
  }
 
  ~DisplayVisibilityProperty() override;
 
  virtual void update();
 
  bool getBool() const override;
 
  Qt::ItemFlags getViewFlags(int column) const override;
 
public Q_SLOTS:
 
  bool setValue(const QVariant& new_value) override;
 
protected:
  uint32_t vis_bit_;
  Display* display_;
  bool custom_name_;
};
 
} // namespace rviz
 
#endif /* DISPLAY_VISIBILITY_MANAGER_H_ */