gz/sim/gui/GuiEvents.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2020 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_GUIEVENTS_HH_
#define GZ_SIM_GUI_GUIEVENTS_HH_
 
#include <QEvent>
#include <QMap>
#include <QString>
 
#include <set>
#include <string>
#include <utility>
#include <vector>
 
#include <gz/math/Vector3.hh>
#include <gz/utils/ImplPtr.hh>
#include <sdf/Element.hh>
#include <sdf/Plugin.hh>
 
#include "gz/sim/gui/Export.hh"
#include "gz/sim/Entity.hh"
#include "gz/sim/config.hh"
 
namespace gz
{
namespace sim
{
namespace gui {
// Inline bracket to help doxygen filtering.
inline namespace GZ_SIM_VERSION_NAMESPACE {
namespace events
{
  class GZ_SIM_GUI_VISIBLE EntitiesSelected : public QEvent
  {
    public: explicit EntitiesSelected(
        const std::vector<Entity> &_entities,  // NOLINT
        bool _fromUser = false)
        : QEvent(kType), entities(_entities), fromUser(_fromUser)
    {
    }
 
    public: std::vector<Entity> Data() const
    {
      return this->entities;
    }
 
    public: bool FromUser() const
    {
      return this->fromUser;
    }
 
    static const QEvent::Type kType = QEvent::Type(QEvent::User + 1);
 
    private: std::vector<Entity> entities;
 
    private: bool fromUser{false};
  };
 
  class GZ_SIM_GUI_VISIBLE DeselectAllEntities : public QEvent
  {
    public: explicit DeselectAllEntities(bool _fromUser = false)
        : QEvent(kType), fromUser(_fromUser)
    {
    }
 
    public: bool FromUser() const
    {
      return this->fromUser;
    }
 
    static const QEvent::Type kType = QEvent::Type(QEvent::User + 2);
 
    private: bool fromUser{false};
  };
 
  class GZ_SIM_GUI_VISIBLE GuiNewRemovedEntities : public QEvent
  {
    public: GuiNewRemovedEntities(const std::set<Entity> &_newEntities,
                const std::set<Entity> &_removedEntities);
 
    public: const std::set<Entity> &NewEntities() const;
 
    public: const std::set<Entity> &RemovedEntities() const;
 
    static const QEvent::Type kType = QEvent::Type(QEvent::User + 3);
 
    GZ_UTILS_IMPL_PTR(dataPtr)
  };
 
  class GZ_SIM_GUI_VISIBLE NewRemovedEntities : public QEvent
  {
    public: NewRemovedEntities(const std::set<Entity> &_newEntities,
                const std::set<Entity> &_removedEntities);
 
    public: const std::set<Entity> &NewEntities() const;
 
    public: const std::set<Entity> &RemovedEntities() const;
 
    static const QEvent::Type kType = QEvent::Type(QEvent::User + 4);
 
    GZ_UTILS_IMPL_PTR(dataPtr)
  };
 
  class GZ_SIM_GUI_VISIBLE TransformControlModeActive : public QEvent
  {
    public: explicit TransformControlModeActive(const bool _tranformModeActive)
        : QEvent(kType), tranformModeActive(_tranformModeActive)
    {
    }
 
    static const QEvent::Type kType = QEvent::Type(QEvent::User + 6);
 
    public: bool TransformControlActive()
    {
      return this->tranformModeActive;
    }
 
    private: bool tranformModeActive;
  };
 
  class GZ_SIM_GUI_VISIBLE ModelEditorAddEntity : public QEvent
  {
    public: explicit ModelEditorAddEntity(QString _entity, QString _type,
                gz::sim::Entity _parent);
 
    public: QString Entity() const;
 
    public: QString EntityType() const;
 
 
    public: gz::sim::Entity ParentEntity() const;
 
    public: QMap<QString, QString> &Data();
 
    static const QEvent::Type kType = QEvent::Type(QEvent::User + 7);
 
    GZ_UTILS_IMPL_PTR(dataPtr)
  };
 
  class GZ_SIM_GUI_VISIBLE VisualPlugin: public QEvent
  {
    public: explicit GZ_DEPRECATED(7) VisualPlugin(gz::sim::Entity _entity,
                const sdf::ElementPtr &_elem);
 
    public: gz::sim::Entity Entity() const;
 
    public: sdf::ElementPtr Element() const;
 
    static const QEvent::Type kType = QEvent::Type(QEvent::User + 8);
 
    GZ_UTILS_IMPL_PTR(dataPtr)
  };
 
  class GZ_SIM_GUI_VISIBLE VisualPlugins: public QEvent
  {
    public: explicit VisualPlugins(gz::sim::Entity _entity,
                const sdf::Plugins &_plugins);
 
    public: gz::sim::Entity Entity() const;
 
    public: const sdf::Plugins &Plugins() const;
 
    static const QEvent::Type kType = QEvent::Type(QEvent::User + 9);
 
    GZ_UTILS_IMPL_PTR(dataPtr)
  };
}  // namespace events
}
}  // namespace gui
}  // namespace sim
}  // namespace gz
 
#endif  // GZ_SIM_GUI_GUIEVENTS_HH_