Plot3D.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2021 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 GZ_SIM_GUI_3DPLOT_HH_
#define GZ_SIM_GUI_3DPLOT_HH_
 
#include <memory>
 
#include <gz/sim/gui/GuiSystem.hh>
 
#include "gz/gui/qt.h"
 
#ifndef _WIN32
#  define Plot3D_EXPORTS_API __attribute__ ((visibility ("default")))
#else
#  if (defined(Plot3D_EXPORTS))
#    define Plot3D_EXPORTS_API __declspec(dllexport)
#  else
#    define Plot3D_EXPORTS_API __declspec(dllimport)
#  endif
#endif
 
namespace gz
{
namespace sim
{
namespace gui
{
  class Plot3DPrivate;
 
  class Plot3D_EXPORTS_API Plot3D : public gz::sim::GuiSystem
  {
    Q_OBJECT
 
    Q_PROPERTY(
      Entity targetEntity
      READ TargetEntity
      WRITE SetTargetEntity
      NOTIFY TargetEntityChanged
    )
 
    
    Q_PROPERTY(
      QString targetName
      READ TargetName
      WRITE SetTargetName
      NOTIFY TargetNameChanged
    )
 
    Q_PROPERTY(
      bool locked
      READ Locked
      WRITE SetLocked
      NOTIFY LockedChanged
    )
 
    Q_PROPERTY(
      QVector3D offset
      READ Offset
      WRITE SetOffset
      NOTIFY OffsetChanged
    )
 
    Q_PROPERTY(
      QVector3D color
      READ Color
      WRITE SetColor
      NOTIFY ColorChanged
    )
 
    Q_PROPERTY(
      double minDistance
      READ MinDistance
      WRITE SetMinDistance
      NOTIFY MinDistanceChanged
    )
 
    Q_PROPERTY(
      int maxPoints
      READ MaxPoints
      WRITE SetMaxPoints
      NOTIFY MaxPointsChanged
    )
 
    public: Plot3D();
 
    public: ~Plot3D() override;
 
    // Documentation inherited
    public: void LoadConfig(const tinyxml2::XMLElement *_pluginElem) override;
 
    // Documentation inherited
    public: void Update(const UpdateInfo &_info,
        EntityComponentManager &_ecm) override;
 
    public: Q_INVOKABLE Entity TargetEntity() const;
 
    public: Q_INVOKABLE void SetTargetEntity(Entity _entity);
 
    signals: void TargetEntityChanged();
 
    public: Q_INVOKABLE QString TargetName() const;
 
    public: Q_INVOKABLE void SetTargetName(const QString &_name);
 
    signals: void TargetNameChanged();
 
    public: Q_INVOKABLE bool Locked() const;
 
    public: Q_INVOKABLE void SetLocked(bool _locked);
 
    signals: void LockedChanged();
 
    public: Q_INVOKABLE QVector3D Offset() const;
 
    public: Q_INVOKABLE void SetOffset(const QVector3D &_offset);
 
    signals: void OffsetChanged();
 
    public: Q_INVOKABLE QVector3D Color() const;
 
    public: Q_INVOKABLE void SetColor(const QVector3D &_color);
 
    signals: void ColorChanged();
 
    public: Q_INVOKABLE double MinDistance() const;
 
    public: Q_INVOKABLE void SetMinDistance(double _minDistance);
 
    signals: void MinDistanceChanged();
 
    public: Q_INVOKABLE int MaxPoints() const;
 
    public: Q_INVOKABLE void SetMaxPoints(int _maxPoints);
 
    signals: void MaxPointsChanged();
 
    // Documentation inherited
    protected: bool eventFilter(QObject *_obj, QEvent *_event) override;
 
    private: void ClearPlot();
 
    private: std::unique_ptr<Plot3DPrivate> dataPtr;
  };
}
}
}
 
#endif