IncrementalPlot.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef GAZEBO_GUI_PLOT_INCREMENTALPLOT_HH_
#define GAZEBO_GUI_PLOT_INCREMENTALPLOT_HH_

#include <memory>
#include <string>
#include <vector>

#include <ignition/math/Vector2.hh>

#include "gazebo/gui/qt.h"
#include "gazebo/gui/plot/qwt_gazebo.h"
#include "gazebo/gui/plot/PlottingTypes.hh"
#include "gazebo/util/system.hh"

class QwtPlotCurve;

namespace gazebo
{
  namespace common
  {
    class Time;
  }

  namespace gui
  {
    // Forward declare private data class
    class IncrementalPlotPrivate;

    class GZ_GUI_VISIBLE IncrementalPlot : public QwtPlot
    {
      Q_OBJECT

      public: enum PlotAxis
      {
        X_BOTTOM_AXIS = 0,

        X_TOP_AXIS = 1,

        Y_LEFT_AXIS = 2,

        Y_RIGHT_AXIS = 3
      };

      public: explicit IncrementalPlot(QWidget *_parent = nullptr);

      public: virtual ~IncrementalPlot();

      public: PlotCurveWeakPtr AddCurve(const std::string &_label);

      public: void AddPoint(const unsigned int _id,
          const ignition::math::Vector2d &_pt);

      public: void AddPoints(const unsigned int _id,
          const std::vector<ignition::math::Vector2d> &_pts);

      public: void Clear();

      public: PlotCurveWeakPtr Curve(const std::string &_label) const;

      public: PlotCurveWeakPtr Curve(const unsigned int _id) const;

      public: void Update();

      public: void RemoveCurve(const unsigned int _id);

      public: void SetPeriod(const common::Time &_time);

      public: void AttachCurve(PlotCurveWeakPtr _curve);

      public: PlotCurvePtr DetachCurve(const unsigned int _id);

      public: void SetCurveLabel(const unsigned int _id,
        const std::string &_label);

      public: void ShowAxisLabel(const PlotAxis _axis, const bool _show);

      public: void ShowGrid(const bool _show);

      public: bool IsShowGrid() const;

      public: void ShowHoverLine(const bool _show);

      public: bool IsShowHoverLine() const;

      public: std::vector<PlotCurveWeakPtr> Curves() const;

      public: virtual QSize sizeHint() const;

      protected: void dragEnterEvent(QDragEnterEvent *_evt);

      protected: void dropEvent(QDropEvent *_evt);

      Q_SIGNALS: void VariableAdded(const std::string &_name);

      private: std::unique_ptr<IncrementalPlotPrivate> dataPtr;
    };
  }
}
#endif