EntityTree.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2019 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 IGNITION_GAZEBO_GUI_ENTITYTREE_HH_
#define IGNITION_GAZEBO_GUI_ENTITYTREE_HH_

#include <map>
#include <memory>
#include <vector>

#include <ignition/gazebo/gui/GuiSystem.hh>

namespace ignition
{
namespace gazebo
{
  class EntityTreePrivate;

  class TreeModel : public QStandardItemModel
  {
    Q_OBJECT

    public: explicit TreeModel();

    public: ~TreeModel() override = default;

    // Documentation inherited
    public: QHash<int, QByteArray> roleNames() const override;

    public slots: void AddEntity(unsigned int _entity,
        const QString &_entityName,
        unsigned int _parentEntity = kNullEntity,
        const QString &_type = QString());

    public slots: void RemoveEntity(unsigned int _entity);

    public: Q_INVOKABLE QString EntityType(const QModelIndex &_index) const;

    public: Q_INVOKABLE QString ScopedName(const QModelIndex &_index) const;

    public: Q_INVOKABLE unsigned int EntityId(const QModelIndex &_index) const;

    private: std::map<Entity, QStandardItem *> entityItems;

    struct EntityInfo
    {
      // cppcheck-suppress unusedStructMember
      unsigned int entity;

      QString name;

      // cppcheck-suppress unusedStructMember
      unsigned int parentEntity;

      QString type;
    };

    private: std::vector<EntityInfo> pendingEntities;
  };

  class EntityTree : public ignition::gazebo::GuiSystem
  {
    Q_OBJECT

    public: EntityTree();

    public: ~EntityTree() override;

    // Documentation inherited
    public: void LoadConfig(const tinyxml2::XMLElement *_pluginElem) override;

    // Documentation inherited
    public: void Update(const UpdateInfo &, EntityComponentManager &) override;

    public: Q_INVOKABLE void OnEntitySelectedFromQml(unsigned int _entity);

    public: Q_INVOKABLE void DeselectAllEntities();

    // Documentation inherited
    protected: bool eventFilter(QObject *_obj, QEvent *_event) override;

    private: std::unique_ptr<EntityTreePrivate> dataPtr;
  };
}
}

#endif