/*
 * Copyright (c) 2012, 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 FLOAT_PROPERTY_H
#define FLOAT_PROPERTY_H

#include <rviz/properties/property.h>

namespace rviz
{
/** @brief Property specialized to enforce floating point max/min. */
class FloatProperty : public Property
{
  Q_OBJECT
public:
  FloatProperty(const QString& name = QString(),
                float default_value = 0,
                const QString& description = QString(),
                Property* parent = nullptr,
                const char* changed_slot = nullptr,
                QObject* receiver = nullptr);

  /** @brief Set the new value for this property.  Returns true if the
   * new value is different from the old value, false if same.
   *
   * If the new value is different from the old value, this emits
   * aboutToChange() before changing the value and changed() after.
   *
   * Overridden from Property::setValue() to enforce minimum and maximum. */
  bool setValue(const QVariant& new_value) override;

  virtual float getFloat() const
  {
    return getValue().toFloat();
  }

  void setMin(float min);
  float getMin()
  {
    return min_;
  }
  void setMax(float max);
  float getMax()
  {
    return max_;
  }

public Q_SLOTS:
  /** @brief Float-typed "SLOT" version of setValue(). */
  bool setFloat(float new_value)
  {
    return setValue(new_value);
  }

  /** @brief Add the given @a delta to the property value. */
  bool add(float delta)
  {
    return setValue(delta + getValue().toFloat());
  }

  /** @brief Multiply the property value by the given @a factor. */
  bool multiply(float factor)
  {
    return setValue(factor * getValue().toFloat());
  }

private:
  float min_;
  float max_;
};

} // end namespace rviz

#endif // FLOAT_PROPERTY_H
