ResourceSpawner.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_RESOURCE_SPAWNER_HH_
#define GZ_SIM_GUI_RESOURCE_SPAWNER_HH_
 
#include <qobjectdefs.h>
#include <algorithm>
#include <memory>
#include <string>
#include <vector>
#include <gz/fuel_tools/ClientConfig.hh>
#include <gz/fuel_tools/FuelClient.hh>
 
#include <gz/gui/Plugin.hh>
 
namespace gz
{
namespace sim
{
  class ResourceSpawnerPrivate;
 
  struct Resource
  {
    std::string name = "";
 
    std::string owner = "";
 
    std::string sdfPath = "";
 
    std::string thumbnailPath = "";
 
    // cppcheck-suppress unusedStructMember
    bool isFuel = false;
 
    // cppcheck-suppress unusedStructMember
    bool isDownloaded = false;
  };
 
  struct Display
  {
    std::string searchKeyword = "";
 
    std::string sortMethod = "";
 
    std::string ownerPath = "";
 
    // cppcheck-suppress unusedStructMember
    bool isFuel = false;
  };
 
  class PathModel : public QStandardItemModel
  {
    Q_OBJECT
 
    public: explicit PathModel();
 
    public: ~PathModel() override = default;
 
    public: void AddPath(const std::string &_path);
 
    public: void RemovePath(const std::string &_path);
 
    // Documentation inherited
    public: QHash<int, QByteArray> roleNames() const override;
  };
 
  class ResourceModel : public QStandardItemModel
  {
    Q_OBJECT
 
    Q_PROPERTY(int totalCount MEMBER gridIndex NOTIFY sizeChanged)
 
    
    public: explicit ResourceModel();
 
    public: ~ResourceModel() override = default;
 
    public: void AddResource(const Resource &_resource);
 
    public: void AddResources(std::vector<Resource> &_resources);
 
    public: void Clear();
 
    public: void UpdateResourceModel(int index, Resource &_resource);
 
    // Documentation inherited
    public: QHash<int, QByteArray> roleNames() const override;
 
    public: signals: void sizeChanged();
 
    // \brief Index to keep track of the position of each resource in the qml
    // grid, used primarily to access currently loaded resources for updates.
    public: int gridIndex = 0;
  };
 
  class ResourceSpawner : public gz::gui::Plugin
  {
    Q_OBJECT
 
    public: ResourceSpawner();
 
    public: ~ResourceSpawner() override;
 
    // Documentation inherited
    public: void LoadConfig(const tinyxml2::XMLElement *_pluginElem) override;
 
    public slots: void OnResourceSpawn(const QString &_sdfPath);
 
    public: Resource LocalResource(const std::string &_path);
 
    public: void AddPath(const std::string &_path);
 
    public: std::vector<Resource> LocalResources(const std::string &_path);
 
    public: std::vector<Resource> FuelResources(const std::string &_owner);
 
    public: void Resources(std::vector<Resource> &_resources);
 
    public: void FilterResources(std::vector<Resource> &_resources);
 
    public: void SortResources(std::vector<Resource> &_resources);
 
    public slots: void DisplayResources();
 
    public slots: void OnPathClicked(const QString &_path);
 
    public slots: void OnOwnerClicked(const QString &_owner);
 
    public slots: void OnDownloadFuelResource(const QString &_path,
        const QString &_name, const QString &_owner, int index);
 
    public slots: void OnSortChosen(const QString &_sortType);
 
    public slots: void OnSearchEntered(const QString &_searchKeyword);
 
    public: void SetThumbnail(const std::string &_thumbnailPath,
                Resource &_resource);
 
    public: Q_INVOKABLE void UpdateOwnerListModel(gz::sim::Resource _resource);
 
    public: Q_INVOKABLE bool AddOwner(const QString &_owner);
 
    public: Q_INVOKABLE void RemoveOwner(const QString &_owner);
 
    public: Q_INVOKABLE bool IsDefaultOwner(const QString &_owner) const;
 
    signals: void resourceSpawnerError(const QString &_errorMsg);
 
    private: void RunFetchResourceListThread(const std::string &_owner);
 
    private: std::unique_ptr<ResourceSpawnerPrivate> dataPtr;
  };
}
}
 
#endif