Tape Measure Plugin

include/ignition/gazebo/gui/GuiEvents.hh

@@ -210,6 +210,58 @@ namespace events
     /// \brief The path of SDF file to be previewed.
     std::string filePath;
   };
+
+  /// \brief Event which is called to broadcast the 3D coordinates of a user's
+  /// mouse hover within the scene.
+  class HoverToScene : public QEvent
+  {
+    /// \brief Constructor
+    /// \param[in] _point The point at which the mouse is hovering within the
+    /// scene
+    public: explicit HoverToScene(const math::Vector3d &_point)
+        : QEvent(kType), point(_point)
+    {
+    }
+
+    /// \brief Unique type for this event.
+    static const QEvent::Type kType = QEvent::Type(QEvent::User + 6);
+
+    /// \brief Get the point within the scene over which the user is hovering.
+    /// \return The 3D point
+    public: math::Vector3d Point() const
+    {
+      return this->point;
+    }
+
+    /// \brief The 3D point over which the user is hovering.
+    private: math::Vector3d point;
+  };
+
+  /// \brief Event which is called to broadcast the 3D coordinates of a user's
+  /// left click within the scene.
+  class LeftClickToScene : public QEvent
+  {
+    /// \brief Constructor
+    /// \param[in] _point The point which the user has left clicked within the
+    /// scene
+    public: explicit LeftClickToScene(const math::Vector3d &_point)
+        : QEvent(kType), point(_point)
+    {
+    }
+
+    /// \brief Unique type for this event.
+    static const QEvent::Type kType = QEvent::Type(QEvent::User + 7);
+
+    /// \brief Get the point within the scene that the user clicked.
+    /// \return The 3D point.
+    public: math::Vector3d Point() const
+    {
+      return this->point;
+    }
+
+    /// \brief The 3D point that the user clicked within the scene.
+    private: math::Vector3d point;
+  };
 }  // namespace events
 }
 }  // namespace gui

src/gui/plugins/CMakeLists.txt

@@ -89,6 +89,7 @@ add_subdirectory(playback_scrubber)
 add_subdirectory(resource_spawner)
 add_subdirectory(scene3d)
 add_subdirectory(shapes)
+add_subdirectory(tape_measure)
 add_subdirectory(transform_control)
 add_subdirectory(video_recorder)
 add_subdirectory(view_angle)

src/gui/plugins/scene3d/Scene3D.cc

@@ -767,12 +767,44 @@ Entity IgnRenderer::UniqueId()
 void IgnRenderer::HandleMouseEvent()
 {
   std::lock_guard<std::mutex> lock(this->dataPtr->mutex);
+  this->BroadcastHoverPos();
+  this->BroadcastLeftClick();
   this->HandleMouseContextMenu();
   this->HandleModelPlacement();
   this->HandleMouseTransformControl();
   this->HandleMouseViewControl();
 }
 
+/////////////////////////////////////////////////
+void IgnRenderer::BroadcastHoverPos()
+{
+  if (this->dataPtr->hoverDirty)
+  {
+    math::Vector3d pos = this->ScreenToScene(this->dataPtr->mouseHoverPos);
+
+    gui::events::HoverToScene hoverToSceneEvent(pos);
+    ignition::gui::App()->sendEvent(
+        ignition::gui::App()->findChild<ignition::gui::MainWindow *>(),
+        &hoverToSceneEvent);
+  }
+}
+
+/////////////////////////////////////////////////
+void IgnRenderer::BroadcastLeftClick()
+{
+  if (this->dataPtr->mouseEvent.Button() == common::MouseEvent::LEFT &&
+      this->dataPtr->mouseEvent.Type() == common::MouseEvent::RELEASE &&
+      !this->dataPtr->mouseEvent.Dragging() && this->dataPtr->mouseDirty)
+  {
+    math::Vector3d pos = this->ScreenToScene(this->dataPtr->mouseEvent.Pos());
+
+    gui::events::LeftClickToScene leftClickToSceneEvent(pos);
+    ignition::gui::App()->sendEvent(
+        ignition::gui::App()->findChild<ignition::gui::MainWindow *>(),
+        &leftClickToSceneEvent);
+  }
+}
+
 /////////////////////////////////////////////////
 void IgnRenderer::HandleMouseContextMenu()
 {

src/gui/plugins/scene3d/Scene3D.hh

@@ -351,6 +351,12 @@ inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
     /// \brief Handle model placement requests
     private: void HandleModelPlacement();
 
+    /// \brief Broadcasts the currently hovered 3d scene location.
+    private: void BroadcastHoverPos();
+
+    /// \brief Broadcasts a left click within the scene
+    private: void BroadcastLeftClick();
+
     /// \brief Generate a unique entity id.
     /// \return The unique entity id
     private: Entity UniqueId();

src/gui/plugins/tape_measure/CMakeLists.txt

@@ -0,0 +1,6 @@
+gz_add_gui_plugin(TapeMeasure
+  SOURCES TapeMeasure.cc
+  QT_HEADERS TapeMeasure.hh
+  PRIVATE_LINK_LIBS
+    ${IGNITION-RENDERING_LIBRARIES}
+)