EnvironmentLoader.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2022 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_ENVIRONMENTLOADER_HH_
#define GZ_SIM_GUI_ENVIRONMENTLOADER_HH_
 
#include <memory>
 
#include "gz/sim/gui/GuiSystem.hh"
#include "gz/gui/qt.h"
 
namespace gz
{
namespace sim
{
// Inline bracket to help doxygen filtering.
inline namespace GZ_SIM_VERSION_NAMESPACE
{
  class EnvironmentLoaderPrivate;
 
  class EnvironmentLoader : public gz::sim::GuiSystem
  {
    Q_OBJECT
 
    Q_PROPERTY(
      QString dataPath
      READ DataPath
      WRITE SetDataPath
      NOTIFY DataPathChanged
    )
 
    
    Q_PROPERTY(
      QStringList dimensionList
      READ DimensionList
      NOTIFY DimensionListChanged
    )
 
    Q_PROPERTY(
      QStringList unitList
      READ UnitList
    )
 
    Q_PROPERTY(
      QString unit
      READ Unit
      WRITE SetUnit
      NOTIFY UnitChanged
    )
 
    Q_PROPERTY(
      int timeIndex
      READ TimeIndex
      WRITE SetTimeIndex
      NOTIFY TimeIndexChanged
    )
 
    Q_PROPERTY(
      int xIndex
      READ XIndex
      WRITE SetXIndex
      NOTIFY XIndexChanged
    )
 
    Q_PROPERTY(
      int yIndex
      READ YIndex
      WRITE SetYIndex
      NOTIFY YIndexChanged
    )
 
    Q_PROPERTY(
      int zIndex
      READ ZIndex
      WRITE SetZIndex
      NOTIFY ZIndexChanged
    )
 
    Q_PROPERTY(
      QStringList referenceList
      READ ReferenceList
    )
 
    Q_PROPERTY(
      QString reference
      READ Reference
      WRITE SetReference
      NOTIFY ReferenceChanged
    )
 
    Q_PROPERTY(
      bool configured
      READ IsConfigured
      NOTIFY IsConfiguredChanged
    )
 
    public: EnvironmentLoader();
 
    public: ~EnvironmentLoader() override;
 
    // Documentation inherited
    public: void LoadConfig(const tinyxml2::XMLElement *_pluginElem) override;
 
    // Documentation inherited
    public: void Update(const UpdateInfo &,
                        EntityComponentManager &_ecm) override;
 
    public: Q_INVOKABLE QString DataPath() const;
 
    signals: void DataPathChanged();
 
    public: Q_INVOKABLE void SetDataPath(QString _dataPath);
 
    public: Q_INVOKABLE void SetDataUrl(QUrl _dataUrl);
 
    public: Q_INVOKABLE QStringList DimensionList() const;
 
    public: Q_INVOKABLE QStringList UnitList() const;
 
    signals: void DimensionListChanged();
 
    public: Q_INVOKABLE int TimeIndex() const;
 
    public: Q_INVOKABLE void SetTimeIndex(int _timeIndex);
 
    signals: void TimeIndexChanged() const;
 
    public: Q_INVOKABLE int XIndex() const;
 
    public: Q_INVOKABLE void SetXIndex(int _xIndex);
 
    signals: void XIndexChanged() const;
 
    public: Q_INVOKABLE int YIndex() const;
 
    signals: void YIndexChanged() const;
 
    public: Q_INVOKABLE void SetYIndex(int _yIndex);
 
    public: Q_INVOKABLE int ZIndex() const;
 
    public: Q_INVOKABLE void SetZIndex(int _zIndex);
 
    signals: void ZIndexChanged() const;
 
    public: Q_INVOKABLE QStringList ReferenceList() const;
 
    public: Q_INVOKABLE QString Reference() const;
 
    public: Q_INVOKABLE void SetReference(QString _reference);
 
    signals: void ReferenceChanged() const;
 
    public: Q_INVOKABLE QString Unit() const;
 
    public: Q_INVOKABLE void SetUnit(QString _unit);
 
    signals: void UnitChanged() const;
 
    public: Q_INVOKABLE bool IsConfigured() const;
 
    signals: void IsConfiguredChanged();
 
    public: Q_INVOKABLE void ScheduleLoad();
 
    private: std::unique_ptr<EnvironmentLoaderPrivate> dataPtr;
  };
}
}
}
#endif