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 IGNITION_GUI_GUIEVENTS_HH_
#define IGNITION_GUI_GUIEVENTS_HH_

#include <QEvent>
#include <memory>
#include <string>
#include <utility>
#include <vector>

#include <ignition/common/KeyEvent.hh>
#include <ignition/common/MouseEvent.hh>
#include <ignition/math/Vector2.hh>
#include <ignition/math/Vector3.hh>
#include <ignition/msgs/world_control.pb.h>
#include <ignition/utils/ImplPtr.hh>

#include "ignition/gui/Export.hh"

namespace ignition
{
  namespace gui
  {
    namespace events
    {

      class Render : public QEvent
      {
        public: Render()
            : QEvent(kType)
        {
        }
        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser);
      };

      class IGNITION_GUI_VISIBLE SnapIntervals : public QEvent
      {
        public: SnapIntervals(
                    const math::Vector3d &_xyz,
                    const math::Vector3d &_rpy,
                    const math::Vector3d &_scale);

        public: math::Vector3d Position() const;

        public: math::Vector3d Rotation() const;

        public: math::Vector3d Scale() const;

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 1);

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE SpawnFromDescription : public QEvent
      {
        public: explicit SpawnFromDescription(const std::string &_description);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 2);

        public: const std::string &Description() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE SpawnFromPath : public QEvent
      {
        public: explicit SpawnFromPath(const std::string &_filePath);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 3);

        public: const std::string &FilePath() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE HoverToScene : public QEvent
      {
        public: explicit HoverToScene(const math::Vector3d &_point);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 4);

        public: math::Vector3d Point() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE LeftClickToScene : public QEvent
      {
        public: explicit LeftClickToScene(const math::Vector3d &_point);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 5);

        public: math::Vector3d Point() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE RightClickToScene : public QEvent
      {
        public: explicit RightClickToScene(const math::Vector3d &_point);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 6);

        public: math::Vector3d Point() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE DropdownMenuEnabled : public QEvent
      {
        public: explicit DropdownMenuEnabled(bool _menuEnabled);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 7);

        public: bool MenuEnabled() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE KeyReleaseOnScene : public QEvent
      {
        public: explicit KeyReleaseOnScene(const common::KeyEvent &_key);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 8);

        public: common::KeyEvent Key() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE KeyPressOnScene : public QEvent
      {
        public: explicit KeyPressOnScene(const common::KeyEvent &_key);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 9);

        public: common::KeyEvent Key() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE LeftClickOnScene : public QEvent
      {
        public: explicit LeftClickOnScene(
          const common::MouseEvent &_mouse);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 10);

        public: const common::MouseEvent &Mouse() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE RightClickOnScene : public QEvent
      {
        public: RightClickOnScene(
          const common::MouseEvent &_mouse);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 11);

        public: const common::MouseEvent &Mouse() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE BlockOrbit : public QEvent
      {
        public: explicit BlockOrbit(const bool &_block);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 12);

        public: bool Block() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE HoverOnScene : public QEvent
      {
        public: explicit HoverOnScene(const common::MouseEvent &_mouse);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 13);

        public: common::MouseEvent Mouse() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE SpawnCloneFromName : public QEvent
      {
        public: explicit SpawnCloneFromName(const std::string &_name);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 14);

        public: const std::string &Name() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE DropOnScene : public QEvent
      {
        public: explicit DropOnScene(
          const std::string &_dropText,
          const ignition::math::Vector2i &_dropMouse);

        public: const std::string &DropText() const;

        public: const ignition::math::Vector2i &Mouse() const;

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 15);

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE ScrollOnScene : public QEvent
      {
        public: explicit ScrollOnScene(const common::MouseEvent &_mouse);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 16);

        public: const common::MouseEvent &Mouse() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE DragOnScene : public QEvent
      {
        public: explicit DragOnScene(const common::MouseEvent &_mouse);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 17);

        public: common::MouseEvent Mouse() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE MousePressOnScene : public QEvent
      {
        public: MousePressOnScene(
          const common::MouseEvent &_mouse);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 18);

        public: const common::MouseEvent &Mouse() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE WorldControl : public QEvent
      {
        public: explicit WorldControl(const msgs::WorldControl &_worldControl);

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 19);

        public: const msgs::WorldControl &WorldControlInfo() const;

        IGN_UTILS_IMPL_PTR(dataPtr)
      };

      class IGNITION_GUI_VISIBLE PreRender : public QEvent
      {
        public: PreRender();

        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 20);

        IGN_UTILS_IMPL_PTR(dataPtr)
      };
    }
  }
}

#endif  // IGNITION_GUI_GUIEVENTS_HH_